1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
//! A minimalistic [IoC] library.
//!
//! # Examples
//! ```
//! use wonderbox::Container;
//!
//! trait Foo {}
//!
//! #[derive(Debug, Default)]
//! struct FooImpl {
//!     stored_string: String,
//! }
//!
//! impl FooImpl {
//!     fn new(stored_string: String) -> Self {
//!         Self { stored_string }
//!     }
//! }
//!
//! impl Foo for FooImpl {}
//!
//! let mut container = Container::new();
//! container.register(|_| "foo".to_string());
//! container.register(|container| Box::new(FooImpl::new(container.resolve())) as Box<dyn Foo>);
//!
//! let foo = container.try_resolve::<Box<dyn Foo>>();
//! assert!(foo.is_some())
//! ```
//!
//! [IoC]: https://en.wikipedia.org/wiki/Inversion_of_control

#![feature(core_intrinsics)]
#![warn(missing_docs, clippy::dbg_macro, clippy::unimplemented)]
#![deny(
    rust_2018_idioms,
    future_incompatible,
    missing_debug_implementations,
    clippy::default_trait_access,
    clippy::enum_glob_use,
    clippy::needless_borrow,
    clippy::large_digit_groups,
    clippy::explicit_into_iter_loop
)]

use std::any::Any;
use std::collections::HashMap;
use std::sync::Arc;

/// The IoC container
#[derive(Default, Debug, Clone)]
pub struct Container {
    registered_types: HashMap<&'static str, Arc<dyn Any + Send + Sync>>,
    registered_type_factories: HashMap<&'static str, Arc<dyn Any + Send + Sync>>,
}

type ImplementationFactory<T> = dyn Fn(&Container) -> T + Send + Sync;

impl Container {
    /// Create a new empty [`Container`].
    pub fn new() -> Self {
        Self::default()
    }

    /// Register a function that returns the implementation of a type.
    /// Can be used to try_resolve dependencies.
    ///
    /// # Examples
    ///
    /// Registering a simple factory:
    /// ```
    /// use wonderbox::Container;
    ///
    /// let mut container = Container::new();
    /// container.register(|_| String::new());
    /// ```
    ///
    /// Registering a factory for a trait object with dependencies:
    /// ```
    /// use std::rc::Rc;
    /// use wonderbox::Container;
    ///
    /// let mut container = Container::new();
    /// container.register(|_| "I'm a dependency".to_string());
    /// container.register(|container| {
    ///     let dependency = container.try_resolve::<String>().unwrap();
    ///     let registered_type = FooImpl {
    ///         stored_string: dependency,
    ///     };
    ///     Box::new(registered_type) as Box<dyn Foo>
    /// });
    ///
    /// trait Foo {}
    /// struct FooImpl {
    ///     stored_string: String,
    /// }
    /// impl Foo for FooImpl {}
    /// ```
    ///
    /// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html
    pub fn register<T>(
        &mut self,
        implementation_factory: impl Fn(&Container) -> T + 'static + Send + Sync + Clone,
    ) -> &mut Self
    where
        T: 'static,
    {
        let registered_implementation_factory: Box<ImplementationFactory<T>> = {
            let implementation_factory = implementation_factory.clone();
            Box::new(move |container| implementation_factory(container))
        };
        self.registered_types.insert(
            type_name::<T>(),
            Arc::new(registered_implementation_factory),
        );

        let partially_applied_implementation_factory: Box<
            ImplementationFactory<Box<dyn Fn() -> T>>,
        > = Box::new(move |container: &Container| {
            let implementation_factory = implementation_factory.clone();
            let container = container.clone();
            Box::new(move || implementation_factory(&container))
        });

        self.registered_type_factories.insert(
            type_name::<Box<dyn Fn() -> T>>(),
            Arc::new(partially_applied_implementation_factory),
        );

        self
    }

    /// Register all the element from another container into this container.
    /// # Examples
    /// ```
    /// use wonderbox::Container;
    ///
    /// let mut first_container = Container::new();
    /// first_container.register(|_| "foo".to_string());
    ///
    /// let mut second_container = Container::new();
    /// second_container.register(|container| {
    ///     let dependency = container.try_resolve::<String>().unwrap();
    ///     let foo = FooImpl {
    ///         stored_string: dependency,
    ///     };
    ///     Box::new(foo) as Box<dyn Foo>
    /// });
    ///
    /// first_container.extend(second_container);
    ///
    /// trait Foo {}
    /// struct FooImpl {
    ///     stored_string: String,
    /// }
    /// impl Foo for FooImpl {}
    /// ```
    pub fn extend(&mut self, container: Container) -> &mut Self {
        self.registered_types
            .extend(container.registered_types.into_iter());
        self
    }

    /// Retrieves the registered implementation of the specified type.
    /// # Errors
    /// Returns `None` if the type was not registered
    /// # Examples
    /// Resolve a simple registered type
    /// ```
    /// use wonderbox::Container;
    ///
    /// let mut container = Container::new();
    /// container.register(|_| "some dependency".to_string());
    ///
    /// let resolved = container.try_resolve::<String>();
    /// assert!(resolved.is_some())
    /// ```
    ///
    /// Resolve a trait object
    /// ```
    /// use wonderbox::Container;
    ///
    /// let mut container = Container::new();
    ///
    /// container.register(|_| "foo".to_string());
    /// container.register(|container| {
    ///     let dependency = container.try_resolve::<String>().unwrap();
    ///     let foo = FooImpl {
    ///         stored_string: dependency,
    ///     };
    ///     Box::new(foo) as Box<dyn Foo>
    /// });
    ///
    /// let resolved = container.try_resolve::<Box<dyn Foo>>();
    /// assert!(resolved.is_some());
    ///
    /// trait Foo {}
    /// struct FooImpl {
    ///     stored_string: String,
    /// }
    /// impl Foo for FooImpl {}
    /// ```
    pub fn try_resolve<T>(&self) -> Option<T>
    where
        T: 'static,
    {
        let key = type_name::<T>();
        let resolvable_type = self
            .registered_types
            .get(key)
            .or_else(|| self.registered_type_factories.get(key))?;
        let implementation_factory = resolvable_type
            .downcast_ref::<Box<ImplementationFactory<T>>>()
            .unwrap_or_else(|| {
                panic!(
                    "Internal error: Couldn't downcast internally stored registered type to resolved \
                     type `{}`.\nYou've encountered a Wonderbox bug. Please consider opening an \
                     issue at https://github.com/jnferner/wonderbox/issues/new\nAdditional info: {}",
                    type_name::<T>(),
                    self.resolution_failure_help()
                )
            });
        let value = implementation_factory(self);
        Some(value)
    }

    /// Retrieves the registered implementation of the specified type.
    /// # Errors
    /// Panics with a nice error message if the type was not registered
    /// # Examples
    /// Resolve a simple registered type
    /// ```
    /// use wonderbox::Container;
    ///
    /// let mut container = Container::new();
    /// container.register(|_| "some dependency".to_string());
    ///
    /// let resolved = container.try_resolve::<String>();
    /// assert!(resolved.is_some())
    /// ```
    ///
    /// Resolve a trait object
    /// ```
    /// use wonderbox::Container;
    ///
    /// let mut container = Container::new();
    ///
    /// container.register(|_| "foo".to_string());
    /// container.register(|container| {
    ///     let dependency = container.try_resolve::<String>().unwrap();
    ///     let foo = FooImpl {
    ///         stored_string: dependency,
    ///     };
    ///     Box::new(foo) as Box<dyn Foo>
    /// });
    ///
    /// let resolved = container.resolve::<Box<dyn Foo>>();
    ///
    /// trait Foo {}
    /// struct FooImpl {
    ///     stored_string: String,
    /// }
    /// impl Foo for FooImpl {}
    /// ```
    pub fn resolve<T>(&self) -> T
    where
        T: 'static,
    {
        self.try_resolve::<T>().unwrap_or_else(|| {
            panic!(
                "Wonderbox failed to resolve the type `{}`.\nHelp: {}",
                type_name::<T>(),
                self.resolution_failure_help()
            )
        })
    }

    fn resolution_failure_help(&self) -> String {
        if self.registered_types.is_empty() {
            "No registered types were found.".into()
        } else {
            format!(
                "The following registered types were found.\n{}{}",
                self.pretty_print_registered_types(),
                "In addition, the following factories were generated for each type `T`.\n- \
                 std::boxed::Box<dyn Fn() -> T>"
            )
        }
    }

    fn pretty_print_registered_types(&self) -> String {
        // Chosen arbitrarily
        const AVERAGE_LENGTH_OF_TYPE_NAME: usize = 20;

        let initial_capacity = self.registered_types.len() * AVERAGE_LENGTH_OF_TYPE_NAME;
        let mut registered_type_names = self.registered_type_names();
        registered_type_names.sort();

        registered_type_names
            .iter()
            .map(|type_name| format!("- {}\n", type_name))
            .fold(String::with_capacity(initial_capacity), |acc, type_name| {
                acc + &type_name
            })
    }

    fn registered_type_names(&self) -> Vec<String> {
        self.registered_types
            .keys()
            .map(|&key| String::from(key))
            .collect()
    }
}

fn type_name<T>() -> &'static str {
    unsafe { std::intrinsics::type_name::<T>() }
}

#[cfg(test)]
#[allow(clippy::blacklisted_name)]
mod tests {
    use super::*;
    use std::rc::Rc;

    #[test]
    fn resolves_none_when_not_registered() {
        let container = Container::new();
        let resolved = container.try_resolve::<String>();
        assert!(resolved.is_none())
    }

    #[test]
    #[should_panic(expected = "Wonderbox failed to resolve the type \
                               `std::string::String`.\nHelp: No registered types were found.")]
    fn panics_when_unwraping_type_that_is_not_registered() {
        let container = Container::new();
        let _resolved = container.resolve::<String>();
    }

    #[test]
    #[should_panic(
        expected = "Wonderbox failed to resolve the type `std::boxed::Box<dyn std::ops::Fn() -> \
                    std::boxed::Box<dyn tests::Foo>>`.\nHelp: No registered types were found."
    )]
    fn panics_when_unwraping_trait_object_that_is_not_registered() {
        let container = Container::new();
        let _resolved = container.resolve::<Box<dyn Fn() -> Box<dyn Foo>>>();
    }

    #[test]
    #[should_panic(
        expected = "Wonderbox failed to resolve the type `std::boxed::Box<dyn \
                    tests::Bar>`.\nHelp: The following registered types were found.\n- \
                    std::boxed::Box<dyn tests::Foo>\n- std::string::String\nIn addition, the \
                    following factories were generated for each type `T`.\n- std::boxed::Box<dyn \
                    Fn() -> T>"
    )]
    fn panics_when_unwraping_trait_object_that_is_not_registered_when_other_types_are_registered() {
        let mut container = Container::new();
        container.register(|_| "foo".to_string());
        container.register(|_| Box::new(FooImpl::new()) as Box<dyn Foo>);
        let _resolved = container.resolve::<Box<dyn Bar>>();
    }

    #[test]
    fn resolves_factory_of_rc_of_trait_object() {
        let mut container = Container::new();
        let factory = |_container: &Container| Rc::new(FooImpl::new()) as Rc<dyn Foo>;
        container.register(factory);

        let resolved = container.try_resolve::<Rc<dyn Foo>>();
        assert!(resolved.is_some())
    }

    #[test]
    fn resolves_factory_of_box_of_trait_object() {
        let mut container = Container::new();
        let factory = |_container: &Container| Box::new(FooImpl::new()) as Box<dyn Foo>;
        container.register(factory);

        let resolved = container.try_resolve::<Box<dyn Foo>>();
        assert!(resolved.is_some())
    }

    #[test]
    fn resolves_and_unwraps_factory_of_box_of_trait_object() {
        let mut container = Container::new();
        let factory = |_container: &Container| Box::new(FooImpl::new()) as Box<dyn Foo>;
        container.register(factory);

        let _resolved = container.resolve::<Box<dyn Foo>>();
    }

    #[test]
    fn resolves_boxed_factory_of_box_of_trait_object() {
        let mut container = Container::new();
        let factory = |_container: &Container| Box::new(FooImpl::new()) as Box<dyn Foo>;
        let boxed_factory = Box::new(factory);
        container.register(boxed_factory);

        let resolved = container.try_resolve::<Box<dyn Foo>>();
        assert!(resolved.is_some())
    }

    #[test]
    fn resolves_boxed_factory_with_clone_dependency() {
        let mut container = Container::new();

        container.register(|_| "foo".to_string());
        container.register(|container| {
            let dependency = container.try_resolve::<String>().unwrap();
            let bar = BarImpl::new(dependency);
            Box::new(bar) as Box<dyn Bar>
        });

        let resolved = container.try_resolve::<Box<dyn Bar>>();
        assert!(resolved.is_some())
    }

    #[test]
    fn resolves_boxed_factory_with_factory_dependency() {
        let mut container = Container::new();

        container.register(|_| "foo".to_string());
        container.register(|_container: &Container| Box::new(FooImpl::new()) as Box<dyn Foo>);
        container.register(|container| {
            let clone_dependency = container.try_resolve::<String>().unwrap();
            let _factory_dependency = container.try_resolve::<Box<dyn Foo>>().unwrap();

            let bar = BarImpl::new(clone_dependency);
            Box::new(bar) as Box<dyn Bar>
        });

        let resolved = container.try_resolve::<Box<dyn Bar>>();
        assert!(resolved.is_some())
    }

    #[test]
    fn generates_factory_from_type_with_dependency() {
        let mut container = Container::new();

        container.register(|_| "foo".to_string());
        container.register(|_container: &Container| Box::new(FooImpl::new()) as Box<dyn Foo>);
        container.register(|container| {
            let clone_dependency = container.try_resolve::<String>().unwrap();
            let _factory_dependency = container.try_resolve::<Box<dyn Foo>>().unwrap();

            let bar = BarImpl::new(clone_dependency);
            Box::new(bar) as Box<dyn Bar>
        });

        let resolved = container.try_resolve::<Box<dyn Fn() -> Box<dyn Bar>>>();
        assert!(resolved.is_some())
    }

    #[test]
    fn resolves_type_from_merged_containers() {
        let mut first_container = Container::new();
        first_container.register(|_| "foo".to_string());

        let mut second_container = Container::new();
        second_container.register(|container| {
            let dependency = container.try_resolve::<String>().unwrap();
            let bar = BarImpl::new(dependency);
            Box::new(bar) as Box<dyn Bar>
        });

        first_container.extend(second_container);

        let resolved = first_container.try_resolve::<Box<dyn Bar>>();
        assert!(resolved.is_some())
    }

    trait Foo {}

    struct FooImpl {}

    impl FooImpl {
        fn new() -> Self {
            FooImpl {}
        }
    }

    impl Foo for FooImpl {}

    trait Bar {}

    struct BarImpl {
        _stored_string: String,
    }

    impl BarImpl {
        fn new(stored_string: String) -> Self {
            BarImpl {
                _stored_string: stored_string,
            }
        }
    }

    impl Bar for BarImpl {}
}