Fix toString() not escaping class names

Closes #3454

drift_dev/CHANGELOG.md

@@ -6,6 +6,8 @@
   generation mode.
 - Allow generating manager references across different files in modular
   generation mode.
+- Fix class names with dollar signs not being escaped in drift-generated
+  `toString()`.
 
 ## 2.24.0
 

drift_dev/lib/src/writer/utils/override_toString.dart

@@ -1,5 +1,7 @@
 // ignore_for_file: file_names
 
+import '../../utils/string_escaper.dart';
+
 /// Generates a `toString` override into the [into] buffer.
 ///
 /// The override looks like this:
@@ -21,7 +23,7 @@ void overrideToString(
 ) {
   into
     ..write('@override\nString toString() {')
-    ..write("return (StringBuffer('$className(')");
+    ..write("return (StringBuffer('${escapeForDart(className)}(')");
 
   for (var i = 0; i < properties.length; i++) {
     final property = properties[i];

drift_dev/test/writer/utils/override_tostring_test.dart

@@ -0,0 +1,29 @@
+import 'package:drift_dev/src/analysis/options.dart';
+import 'package:drift_dev/src/writer/import_manager.dart';
+import 'package:drift_dev/src/writer/utils/override_toString.dart';
+import 'package:drift_dev/src/writer/writer.dart';
+import 'package:test/test.dart';
+
+void main() {
+  late Writer writer;
+
+  setUp(() {
+    final imports = LibraryImportManager(Uri.parse('drift:test'));
+    final generationOptions =
+        GenerationOptions(imports: imports, isModular: true);
+    writer = Writer(const DriftOptions.defaults(),
+        generationOptions: generationOptions);
+    imports.linkToWriter(writer);
+  });
+
+  test('overrides toString on class with dollar sign in name', () {
+    overrideToString(r'$Foo', ['a', 'b'], writer.leaf().buffer);
+
+    expect(
+        writer.writeGenerated(),
+        '@override\n'
+        'String toString() {'
+        r"return (StringBuffer('\$Foo(')..write('a: $a, ')..write('b: $b')..write(')')).toString();"
+        '}\n');
+  });
+}