more-di 3.1.0

Provides support for dependency injection (DI)
Documentation
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
use crate::{KeyedRef, KeyedRefMut, Mut, Ref, RefMut, ServiceProvider};
use spin::Once;
use std::any::Any;

/// Represents a holder for lazily-initialized service resolution.
pub struct Lazy<T> {
    services: ServiceProvider,
    resolve: fn(&ServiceProvider) -> T,
    value: Once<T>,
}

impl<T> Lazy<T> {
    fn new(services: ServiceProvider, resolve: fn(&ServiceProvider) -> T) -> Self {
        Self {
            services,
            resolve,
            value: Once::new(),
        }
    }

    /// Resolves and returns a reference to the underlying, lazy-initialized service.
    pub fn value(&self) -> &T {
        self.value.call_once(|| (self.resolve)(&self.services))
    }
}

fn to_vec<T: Any + ?Sized>(services: &ServiceProvider) -> Vec<Ref<T>> {
    services.get_all::<T>().collect()
}

fn to_vec_mut<T: Any + ?Sized>(services: &ServiceProvider) -> Vec<RefMut<T>> {
    services.get_all_mut::<T>().collect()
}

fn to_keyed_vec<TKey, TSvc: Any + ?Sized>(services: &ServiceProvider) -> Vec<KeyedRef<TKey, TSvc>> {
    services.get_all_by_key::<TKey, TSvc>().collect()
}

fn to_keyed_vec_mut<TKey, TSvc: Any + ?Sized>(
    services: &ServiceProvider,
) -> Vec<KeyedRefMut<TKey, TSvc>> {
    services.get_all_by_key_mut::<TKey, TSvc>().collect()
}

/// Creates and returns a holder for a lazily-initialized, required service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn exactly_one<T: Any + ?Sized>(services: ServiceProvider) -> Lazy<Ref<T>> {
    Lazy::new(services, ServiceProvider::get_required::<T>)
}

/// Creates and returns a holder for a lazily-initialized, required, mutable service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn exactly_one_mut<T: Any + ?Sized>(services: ServiceProvider) -> Lazy<RefMut<T>> {
    Lazy::new(services, ServiceProvider::get_required_mut::<T>)
}

/// Creates and returns a holder for a lazily-initialized, keyed, required service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn exactly_one_with_key<TKey, TSvc: Any + ?Sized>(
    services: ServiceProvider,
) -> Lazy<KeyedRef<TKey, TSvc>> {
    Lazy::new(services, ServiceProvider::get_required_by_key::<TKey, TSvc>)
}

/// Creates and returns a holder for a lazily-initialized, keyed, required, mutable service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn exactly_one_with_key_mut<TKey, TSvc: Any + ?Sized>(
    services: ServiceProvider,
) -> Lazy<KeyedRefMut<TKey, TSvc>> {
    Lazy::new(
        services,
        ServiceProvider::get_required_by_key_mut::<TKey, TSvc>,
    )
}

/// Creates and returns a holder for a lazily-initialized, optional service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn zero_or_one<T: Any + ?Sized>(services: ServiceProvider) -> Lazy<Option<Ref<T>>> {
    Lazy::new(services, ServiceProvider::get::<T>)
}

/// Creates and returns a holder for a lazily-initialized, optional, mutable service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn zero_or_one_mut<T: Any + ?Sized>(services: ServiceProvider) -> Lazy<Option<RefMut<T>>> {
    Lazy::new(services, ServiceProvider::get_mut::<T>)
}

/// Creates and returns a holder for a lazily-initialized, keyed, optional service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn zero_or_one_with_key<TKey, TSvc: Any + ?Sized>(
    services: ServiceProvider,
) -> Lazy<Option<KeyedRef<TKey, TSvc>>> {
    Lazy::new(services, ServiceProvider::get_by_key::<TKey, TSvc>)
}

/// Creates and returns a holder for a lazily-initialized, keyed, optional, mutable service.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the service
#[inline]
pub fn zero_or_one_with_key_mut<TKey, TSvc: Any + ?Sized>(
    services: ServiceProvider,
) -> Lazy<Option<KeyedRefMut<TKey, TSvc>>> {
    Lazy::new(services, ServiceProvider::get_by_key_mut::<TKey, TSvc>)
}

/// Creates and returns a holder for multiple, lazily-initialized services.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the services
#[inline]
pub fn zero_or_more<T: Any + ?Sized>(services: ServiceProvider) -> Lazy<Vec<Ref<T>>> {
    Lazy::new(services, to_vec::<T>)
}

/// Creates and returns a holder for multiple, lazily-initialized, mutable services.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the services
#[inline]
pub fn zero_or_more_mut<T: Any + ?Sized>(services: ServiceProvider) -> Lazy<Vec<RefMut<T>>> {
    Lazy::new(services, to_vec_mut::<T>)
}

/// Creates and returns a holder for multiple, lazily-initialized, keyed services.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the services
#[inline]
pub fn zero_or_more_with_key<TKey, TSvc: Any + ?Sized>(
    services: ServiceProvider,
) -> Lazy<Vec<KeyedRef<TKey, TSvc>>> {
    Lazy::new(services, to_keyed_vec::<TKey, TSvc>)
}

/// Creates and returns a holder for multiple, lazily-initialized, keyed, mutable services.
///
/// # Arguments
///
/// * `services` - The [`ServiceProvider`](crate::ServiceProvider) used to resolve the services
#[inline]
pub fn zero_or_more_with_key_mut<TKey, TSvc: Any + ?Sized>(
    services: ServiceProvider,
) -> Lazy<Vec<KeyedRefMut<TKey, TSvc>>> {
    Lazy::new(services, to_keyed_vec_mut::<TKey, TSvc>)
}

/// Creates and return a holder for a lazy-initialized, optional service that is missing.
#[inline]
pub fn missing<T: Any + ?Sized>() -> Lazy<Option<Ref<T>>> {
    Lazy::new(ServiceProvider::default(), ServiceProvider::get::<T>)
}

/// Creates and return a holder for a lazy-initialized, keyed, optional service that is missing.
#[inline]
pub fn missing_with_key<TKey, TSvc: Any + ?Sized>() -> Lazy<Option<KeyedRef<TKey, TSvc>>> {
    Lazy::new(
        ServiceProvider::default(),
        ServiceProvider::get_by_key::<TKey, TSvc>,
    )
}

/// Creates and return a holder for any empty collection of lazy-initialized services.
#[inline]
pub fn empty<T: Any + ?Sized>() -> Lazy<Vec<Ref<T>>> {
    Lazy::new(ServiceProvider::default(), to_vec::<T>)
}

/// Creates and return a holder for any empty collection of lazy-initialized, keyed services.
#[inline]
pub fn empty_with_key<TKey, TSvc: Any + ?Sized>() -> Lazy<Vec<KeyedRef<TKey, TSvc>>> {
    Lazy::new(ServiceProvider::default(), to_keyed_vec::<TKey, TSvc>)
}

/// Creates and returns a holder from an existing instance.
/// 
/// # Arguments
/// 
/// * `instance` - The existing instance used to initialize with
pub fn init<T: Any + ?Sized>(instance: Box<T>) -> Lazy<Ref<T>> {
    Lazy {
        resolve: |_| unimplemented!(),
        services: ServiceProvider::default(),
        value: Once::initialized(Ref::from(instance)),
    }
}

/// Creates and returns a holder from an existing, mutable instance.
/// 
/// # Arguments
/// 
/// * `instance` - The existing instance used to initialize with
pub fn init_mut<T: Any + ?Sized>(instance: Box<Mut<T>>) -> Lazy<RefMut<T>> {
    Lazy {
        resolve: |_| unimplemented!(),
        services: ServiceProvider::default(),
        value: Once::initialized(RefMut::from(instance)),
    }
}

/// Creates and returns a holder from an existing instance with a key.
/// 
/// # Arguments
/// 
/// * `instance` - The existing instance used to initialize with
pub fn init_with_key<TKey, TSvc: Any + ?Sized>(instance: Box<TSvc>) -> Lazy<KeyedRef<TKey, TSvc>> {
    Lazy {
        resolve: |_| unimplemented!(),
        services: ServiceProvider::default(),
        value: Once::initialized(KeyedRef::<TKey, TSvc>::new(Ref::from(instance))),
    }
}

/// Creates and returns a holder from an existing, mutable instance with a key.
/// 
/// # Arguments
/// 
/// * `instance` - The existing instance used to initialize with
pub fn init_with_key_mut<TKey, TSvc: Any + ?Sized>(
    instance: Box<Mut<TSvc>>,
) -> Lazy<KeyedRefMut<TKey, TSvc>> {
    Lazy {
        resolve: |_| unimplemented!(),
        services: ServiceProvider::default(),
        value: Once::initialized(KeyedRefMut::<TKey, TSvc>::new(Ref::from(instance))),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::*;
    use cfg_if::cfg_if;

    #[derive(Default)]
    struct Bar;

    struct Foo {
        bar: Lazy<Ref<Bar>>,
    }

    struct Foo2 {
        bar: Lazy<Option<Ref<Bar>>>,
    }

    impl Bar {
        fn echo(&self) -> &str {
            "Delayed!"
        }
    }

    impl Foo {
        fn new(bar: Lazy<Ref<Bar>>) -> Self {
            Self { bar }
        }

        fn echo(&self) -> &str {
            self.bar.value().echo()
        }
    }

    impl Foo2 {
        fn new(bar: Lazy<Option<Ref<Bar>>>) -> Self {
            Self { bar }
        }

        fn echo(&self) -> Option<&str> {
            match self.bar.value() {
                Some(bar) => Some(bar.echo()),
                _ => None,
            }
        }
    }

    trait IPityTheFoo {
        fn speak(&self) -> &str;
    }

    struct FooImpl;

    impl IPityTheFoo for FooImpl {
        fn speak(&self) -> &str {
            "I pity the foo!"
        }
    }

    #[test]
    fn lazy_should_return_required_service() {
        // arrange
        let provider = ServiceCollection::new()
            .add(transient_as_self::<Bar>().from(|_| Ref::new(Bar::default())))
            .add(
                transient_as_self::<Foo>()
                    .depends_on(crate::exactly_one::<Bar>())
                    .from(|sp| Ref::new(Foo::new(lazy::exactly_one::<Bar>(sp.clone())))),
            )
            .build_provider()
            .unwrap();

        // act
        let foo = provider.get_required::<Foo>();

        // assert
        assert_eq!("Delayed!", foo.echo());
    }

    #[test]
    fn lazy_should_return_optional_service() {
        // arrange
        let provider = ServiceCollection::new()
            .add(transient_as_self::<Bar>().from(|_| Ref::new(Bar::default())))
            .add(
                transient_as_self::<Foo2>()
                    .depends_on(crate::zero_or_one::<Bar>())
                    .from(|sp| Ref::new(Foo2::new(lazy::zero_or_one::<Bar>(sp.clone())))),
            )
            .build_provider()
            .unwrap();

        // act
        let foo = provider.get_required::<Foo2>();

        // assert
        assert_eq!("Delayed!", foo.echo().unwrap());
    }

    #[test]
    fn lazy_should_allow_missing_optional_service() {
        // arrange
        let provider = ServiceCollection::new()
            .add(
                transient_as_self::<Foo2>()
                    .depends_on(crate::zero_or_one::<Bar>())
                    .from(|sp| Ref::new(Foo2::new(lazy::zero_or_one::<Bar>(sp.clone())))),
            )
            .build_provider()
            .unwrap();

        // act
        let foo = provider.get_required::<Foo2>();

        // assert
        assert_eq!(None, foo.echo());
    }

    #[test]
    fn missing_should_initialize_lazy() {
        // arrange
        let lazy = lazy::missing::<Bar>();

        // act
        let value = lazy.value();

        // assert
        assert!(value.is_none());
    }

    #[test]
    fn empty_should_initialize_lazy() {
        // arrange
        let lazy = lazy::empty::<Bar>();

        // act
        let value = lazy.value();

        // assert
        assert!(value.is_empty());
    }

    #[test]
    #[allow(clippy::vtable_address_comparisons)]
    fn lazy_should_return_same_scoped_service() {
        // arrange
        let provider = ServiceCollection::new()
            .add(scoped_factory(|_| Ref::new(Bar::default())))
            .add(
                transient_as_self::<Foo>()
                    .depends_on(crate::exactly_one::<Bar>())
                    .from(|sp| Ref::new(Foo::new(lazy::exactly_one::<Bar>(sp.clone())))),
            )
            .build_provider()
            .unwrap();

        // act
        let foo = provider.get_required::<Foo>();
        let bar1 = provider.get_required::<Bar>();
        let bar2 = provider.clone().get_required::<Bar>();

        // assert
        assert!(Ref::ptr_eq(foo.bar.value(), &bar1));
        assert!(Ref::ptr_eq(&bar1, &bar2));
    }

    #[test]
    fn init_should_create_lazy_from_instance() {
        // arrange
        let instance: Box<dyn IPityTheFoo> = Box::new(FooImpl);

        // act
        let lazy = lazy::init(instance);

        // assert
        assert_eq!(lazy.value().speak(), "I pity the foo!");
    }

    #[test]
    fn init_with_key_should_create_lazy_from_instance() {
        // arrange
        let instance = FooImpl;

        // act
        let lazy = lazy::init_with_key::<Bar, dyn IPityTheFoo>(Box::new(instance));

        // assert
        assert_eq!(lazy.value().speak(), "I pity the foo!");
    }

    #[test]
    fn init_mut_should_create_lazy_from_instance() {
        // arrange
        let instance: Box<Mut<dyn IPityTheFoo>> = Box::new(Mut::new(FooImpl));

        // act
        let lazy = lazy::init_mut(instance);

        // assert
        cfg_if! {
            if #[cfg(feature = "async")] {
                assert_eq!(lazy.value().read().unwrap().speak(), "I pity the foo!");
            } else {
                assert_eq!(lazy.value().borrow().speak(), "I pity the foo!");
            }
        }
    }

    #[test]
    fn init_with_key_mut_should_create_lazy_from_instance() {
        // arrange
        let instance: Box<Mut<dyn IPityTheFoo>> = Box::new(Mut::new(FooImpl));

        // act
        let lazy = lazy::init_with_key_mut::<Bar, _>(instance);

        // assert
        cfg_if! {
            if #[cfg(feature = "async")] {
                assert_eq!(lazy.value().write().unwrap().speak(), "I pity the foo!");
            } else {
                assert_eq!(lazy.value().borrow().speak(), "I pity the foo!");
            }
        }
    }
}