Moving name reservation into Scope

drift_dev/lib/src/writer/schema_version_writer.dart

@@ -71,21 +71,6 @@ class SchemaVersionWriter {
   final Map<String, String> _columnCodeToFactory = {};
   final Map<_TableShape, String> _shapes = {};
 
-  // A list of member names already in use in the generated class. This is used
-  // to prevent table getters from conflicting with other class members.
-  final Set<String> _usedNames = {};
-
-  void _resetUsedNames() {
-    _usedNames.clear();
-    _usedNames.addAll([
-      'database',
-      'entities',
-      'version',
-      'stepByStepHelper',
-      'runMigrationSteps',
-    ]);
-  }
-
   SchemaVersionWriter(this.versions, this.libraryScope) {
     assert(versions.isSortedBy<num>((element) => element.version));
   }
@@ -173,15 +158,6 @@ class SchemaVersionWriter {
     });
   }
 
-  String _getNonCollidingGetterName(DriftSchemaElement element) {
-    var name = element.dbGetterName!;
-    while (_usedNames.contains(name)) {
-      name = '$name${_suffixForElement(element)}';
-    }
-    _usedNames.add(name);
-    return name;
-  }
-
   String _suffixForElement(DriftSchemaElement element) => switch (element) {
         DriftTable() => 'Table',
         DriftView() => 'View',
@@ -191,8 +167,10 @@ class SchemaVersionWriter {
       };
 
   String _writeWithResultSet(
-      DriftElementWithResultSet entity, TextEmitter writer) {
-    final getterName = _getNonCollidingGetterName(entity);
+    String getterName,
+    DriftElementWithResultSet entity,
+    TextEmitter writer,
+  ) {
     final shape = _shapeClass(entity);
     writer
       ..write('late final $shape $getterName = ')
@@ -298,19 +276,20 @@ class SchemaVersionWriter {
     required DriftSchemaElement element,
     required TextEmitter definition,
   }) {
-    String name;
+    final name = definition.parent!.getNonConflictingName(
+      element.dbGetterName!,
+      (name) => name + _suffixForElement(element),
+    );
 
     if (element is DriftElementWithResultSet) {
-      name = _writeWithResultSet(element, definition);
+      _writeWithResultSet(name, element, definition);
     } else if (element is DriftIndex) {
-      name = _getNonCollidingGetterName(element);
       final index = definition.drift('Index');
 
       definition
         ..write('final $index $name = ')
         ..writeln(DatabaseWriter.createIndex(definition.parent!, element));
     } else if (element is DriftTrigger) {
-      name = _getNonCollidingGetterName(element);
       final trigger = definition.drift('Trigger');
 
       definition
@@ -345,7 +324,14 @@ class SchemaVersionWriter {
       final versionNo = version.version;
       final versionClass = '_S$versionNo';
       final versionScope = libraryScope.child();
-      _resetUsedNames();
+
+      versionScope.reserveNames([
+        'database',
+        'entities',
+        'version',
+        'stepByStepHelper',
+        'runMigrationSteps',
+      ]);
 
       // Write an _S<x> class for each schema version x.
       versionScope.leaf()

drift_dev/lib/src/writer/writer.dart

@@ -1,10 +1,10 @@
 import 'package:drift/drift.dart';
+import 'package:path/path.dart' show url;
 import 'package:recase/recase.dart';
 import 'package:sqlparser/sqlparser.dart' as sql;
-import 'package:path/path.dart' show url;
 
-import '../analysis/results/results.dart';
 import '../analysis/options.dart';
+import '../analysis/results/results.dart';
 import 'import_manager.dart';
 import 'queries/sql_writer.dart';
 
@@ -298,6 +298,10 @@ class Scope extends _Node {
   /// This can be used to generated methods which must have a unique name-
   int counter = 0;
 
+  /// The set of names already used in this scope. Used by methos like
+  /// [getNonConflictingName] to prevent name collisions.
+  final Set<String> _usedNames = {};
+
   Scope({required Scope? parent, Writer? writer})
       : writer = writer ?? parent!.writer,
         super(parent);
@@ -325,6 +329,28 @@ class Scope extends _Node {
     _children.add(child);
     return child;
   }
+
+  /// Reserve a collection of names in this scope. See [getNonConflictingName]
+  /// for more information.
+  void reserveNames(Iterable<String> names) {
+    _usedNames.addAll(names);
+  }
+
+  /// Returns a variation of [name] that does not conflict with any names
+  /// already in use in this [Scope].
+  ///
+  /// If [name] does not conflict with any existing names then it is returned
+  /// unmodified. If a conflict is detected then [name] is repeatedly passed to
+  /// [modify] until the result no longer conflicts. Each result returned from
+  /// this method is recorded in an internal set, so subsequent calls with the
+  /// same name will produce a different, non-conflicting result.
+  String getNonConflictingName(String name, String Function(String) modify) {
+    while (_usedNames.contains(name)) {
+      name = modify(name);
+    }
+    _usedNames.add(name);
+    return name;
+  }
 }
 
 class TextEmitter extends _Node {