Merge pull request #15 from jinyus/patch-1

[Fix] Add dispose param to singleton registration methods

Merged! Thankyou! 🙏🏼

lib/ioc_container.dart

@@ -21,11 +21,7 @@ class ServiceDefinition<T> {
     this.isSingleton = false,
     this.dispose,
     this.disposeAsync,
-  })  : assert(
-          !isSingleton || dispose == null,
-          'Singleton factories cannot have a dispose method',
-        ),
-        assert(
+  }) : assert(
           dispose == null || disposeAsync == null,
           "Service definitions can't have both dispose and disposeAsync",
         );
@@ -154,12 +150,14 @@ class IocContainerBuilder {
   void addSingleton<T>(
     T Function(
       IocContainer container,
-    ) factory,
-  ) =>
+    ) factory, {
+    void Function(T service)? dispose,
+  }) =>
       addServiceDefinition<T>(
         ServiceDefinition<T>(
           (container) => factory(container),
           isSingleton: true,
+          dispose: dispose,
         ),
       );
 
@@ -196,12 +194,14 @@ class IocContainerBuilder {
   void addSingletonAsync<T>(
     Future<T> Function(
       IocContainer container,
-    ) factory,
-  ) =>
+    ) factory, {
+    Future<void> Function(T service)? disposeAsync,
+  }) =>
       addServiceDefinition<Future<T>>(
         ServiceDefinition<Future<T>>(
           isSingleton: true,
           (container) async => factory(container),
+          disposeAsync: (service) async => disposeAsync?.call(await service),
         ),
       );
 }

test/ioc_container_test.dart

@@ -33,6 +33,8 @@ extension TestIocContainerExtensions on IocContainer {
 class A {
   A(this.name);
   final String name;
+  bool disposed = false;
+  void dispose() => disposed = true;
 }
 
 class B {
@@ -157,7 +159,10 @@ void main() {
   test('With Scoping And Disposing', () async {
     final a = A('a');
     final builder = IocContainerBuilder()
-      ..addSingleton((c) => a)
+      ..addSingleton<A>(
+        (c) => a,
+        dispose: (a) => a.dispose(),
+      )
       ..add((i) => B(i.get<A>()))
       ..add<C>(
         (i) => C(i.get<B>()),
@@ -177,6 +182,7 @@ void main() {
     //This also works if we don't use await above
     //await Future<void>.delayed(const Duration(milliseconds: 100));
 
+    expect(a.disposed, true);
     expect(d.disposed, true);
     expect(d.c.disposed, true);
     expect(container<D>().disposed, false);
@@ -878,7 +884,7 @@ void main() {
     );
   });
 
-  test('Test addAsyncSingleton', () async {
+  test('Test addAsyncSingleton With Dispose', () async {
     var futureCounter = 0;
 
     final builder = IocContainerBuilder()
@@ -892,6 +898,7 @@ void main() {
             return A('a');
           },
         ),
+        disposeAsync: (service) async => service.dispose(),
       );
     final container = builder.toContainer();
 
@@ -911,5 +918,10 @@ void main() {
 
     //Expect the future only ran once
     expect(futureCounter, 1);
+
+    final scope = container.scoped(useExistingSingletons: true);
+    await scope.dispose();
+
+    expect(as[0].disposed, true);
   });
 }