Introduce dropScope

README.md

@@ -242,6 +242,15 @@ Another example could be a shopping basket where you want to ensure that not a c
  /// If no scope with [name] exists, nothing is popped and `false` is returned
  Future<bool> popScopesTill(String name, {bool inclusive = true});
 
+ /// Disposes all registered factories and singletons in the provided scope,
+ /// then destroys (drops) the scope. If the dropped scope was the last one,
+ /// the previous scope becomes active again.
+ /// if you provided dispose functions on registration, they will be called.
+ /// if you passed a dispose function when you pushed this scope it will be
+ /// called before the scope is dropped.
+ /// As dispose functions can be async, you should await this function.
+ Future<void> dropScope(String scopeName);
+
  /// Clears all registered types for the current scope
  /// If you provided dispose function when registering they will be called
  /// [dispose] if `false` it only resets without calling any dispose

lib/get_it.dart

@@ -402,8 +402,7 @@ abstract class GetIt {
  /// if you passed a dispose function when you pushed this scope it will be
  /// called before the scope is popped.
  /// As dispose functions can be async, you should await this function.
- /// If [scopeName] is provided, only the scope with that name will be popped.
- Future<void> popScope({String? scopeName});
+ Future<void> popScope();
 
  /// if you have a lot of scopes with names you can pop (see [popScope]) all
  /// scopes above the scope with [name] including that scope unless [inclusive]= false
@@ -412,6 +411,15 @@ abstract class GetIt {
  /// If no scope with [name] exists, nothing is popped and `false` is returned
  Future<bool> popScopesTill(String name, {bool inclusive = true});
 
+ /// Disposes all registered factories and singletons in the provided scope,
+ /// then destroys (drops) the scope. If the dropped scope was the last one,
+ /// the previous scope becomes active again.
+ /// if you provided dispose functions on registration, they will be called.
+ /// if you passed a dispose function when you pushed this scope it will be
+ /// called before the scope is dropped.
+ /// As dispose functions can be async, you should await this function.
+ Future<void> dropScope(String scopeName);
+
  /// Returns the name of the current scope if it has one otherwise null
  /// if you are already on the baseScope it returns 'baseScope'
  String? get currentScopeName;

lib/get_it_impl.dart

@@ -842,6 +842,33 @@ class _GetItImplementation implements GetIt {
  return true;
  }
 
+ /// Disposes all registered factories and singletons in the provided scope,
+ /// then drops (destroys) the scope. If the dropped scope was the last one,
+ /// the previous scope becomes active again.
+ /// if you provided dispose functions on registration, they will be called.
+ /// if you passed a dispose function when you pushed this scope it will be
+ /// called before the scope is dropped.
+ /// As dispose functions can be async, you should await this function.
+ @override
+ Future<void> dropScope(String scopeName) async {
+ if (currentScopeName == scopeName) {
+ return popScope();
+ }
+ throwIfNot(
+ _scopes.length > 1,
+ StateError(
+ "GetIt: You are already on the base scope. you can't drop this one",
+ ),
+ );
+ final scope = _scopes.lastWhere(
+ (s) => s.name == scopeName,
+ orElse: () => throw ArgumentError("Scope $scopeName not found"),
+ );
+ await scope.dispose();
+ await scope.reset(dispose: true);
+ _scopes.remove(scope);
+ }
+
  @override
  String? get currentScopeName => _currentScope.name;
 

test/scope_test.dart

@@ -365,45 +365,6 @@ void main() {
  throwsA(const TypeMatcher<AssertionError>()),
  );
  });
- test('popscope named', () async {
- final getIt = GetIt.instance;
- constructorCounter = 0;
-
- getIt.registerSingleton<TestClass>(TestClass('Basescope'));
-
- getIt.pushNewScope(scopeName: 'scope2');
- getIt.registerSingleton<TestClass>(TestClass('2. scope'));
- getIt.registerSingleton<TestClass2>(TestClass2('2. scope'));
-
- getIt.pushNewScope();
- getIt.registerSingleton<TestClass3>(TestClass3());
-
- final instanceTestClassScope2 = getIt.get<TestClass>();
-
- expect(instanceTestClassScope2 is TestClass, true);
- expect(instanceTestClassScope2.id, '2. scope');
-
- await getIt.popScope(scopeName: 'scope2');
-
- final instanceTestClassScope1 = getIt.get<TestClass>();
-
- expect(instanceTestClassScope1.id, 'Basescope');
- expect(() => getIt.get<TestClass2>(),
- throwsA(const TypeMatcher<AssertionError>()));
-
- final instanceTestClass3Scope3 = getIt.get<TestClass3>();
- expect(instanceTestClass3Scope3 is TestClass3, true);
- });
- test('popscope throws if scope with name not found', () async {
- final getIt = GetIt.instance;
- constructorCounter = 0;
-
- getIt.pushNewScope(scopeName: 'scope2');
- await expectLater(
- () => getIt.popScope(scopeName: 'scope'),
- throwsA(const TypeMatcher<ArgumentError>()),
- );
- });
  test('popscopeuntil inclusive=true', () async {
  final getIt = GetIt.instance;
  constructorCounter = 0;
@@ -521,6 +482,45 @@ void main() {
 
  expect(() => getIt.popScope(), throwsA(const TypeMatcher<StateError>()));
  });
+ test('dropScope', () async {
+ final getIt = GetIt.instance;
+
+ getIt.registerSingleton<TestClass>(TestClass('Basescope'));
+
+ getIt.pushNewScope(scopeName: 'scope2');
+ getIt.registerSingleton<TestClass>(TestClass('2. scope'));
+ getIt.registerSingleton<TestClass2>(TestClass2('2. scope'));
+
+ getIt.pushNewScope();
+ getIt.registerSingleton<TestClass3>(TestClass3());
+
+ final instanceTestClassScope2 = getIt.get<TestClass>();
+
+ expect(instanceTestClassScope2 is TestClass, true);
+ expect(instanceTestClassScope2.id, '2. scope');
+
+ await getIt.dropScope('scope2');
+
+ final instanceTestClassScope1 = getIt.get<TestClass>();
+
+ expect(instanceTestClassScope1.id, 'Basescope');
+ expect(
+ () => getIt.get<TestClass2>(),
+ throwsA(const TypeMatcher<AssertionError>()),
+ );
+
+ final instanceTestClass3Scope3 = getIt.get<TestClass3>();
+ expect(instanceTestClass3Scope3 is TestClass3, true);
+ });
+ test('dropScope throws if scope with name not found', () async {
+ final getIt = GetIt.instance;
+
+ getIt.pushNewScope(scopeName: 'scope2');
+ await expectLater(
+ () => getIt.dropScope('scope'),
+ throwsA(const TypeMatcher<ArgumentError>()),
+ );
+ });
 
  test('resetScope', () async {
  final getIt = GetIt.instance;