Fix generated code with $ in identifier names

simolus3 · Nov 30, 2023 · 5740eb8 · 5740eb8
1 parent 99bb9e0
commit 5740eb8
Show file tree

Hide file tree

Showing 9 changed files with 371 additions and 35 deletions.
diff --git a/drift/example/main.dart b/drift/example/main.dart
@@ -6,6 +6,16 @@ import 'package:drift/native.dart';
 
 part 'main.g.dart';
 
+class Todo extends Table {
+  TextColumn get id => text()();
+
+  TextColumn get listid => text().nullable()();
+
+  TextColumn get text$ => text().named('text').nullable()();
+
+  BoolColumn get completed => boolean()();
+}
+
 @DataClassName('TodoCategory')
 class TodoCategories extends Table {
   IntColumn get id => integer().autoIncrement()();
@@ -57,6 +67,7 @@ abstract class TodoItemWithCategoryNameView extends View {
 }
 
 @DriftDatabase(tables: [
+  Todo,
   TodoItems,
   TodoCategories,
 ], views: [

diff --git a/drift/example/main.g.dart b/drift/example/main.g.dart
diff --git a/drift_dev/lib/src/writer/tables/data_class_writer.dart b/drift_dev/lib/src/writer/tables/data_class_writer.dart
@@ -143,7 +143,7 @@ class DataClassWriter {
 
     for (final column in columns) {
       final getter = column.nameInDart;
-      final jsonKey = column.getJsonKey(scope.options);
+      final jsonKeyString = asDartLiteral(column.getJsonKey(scope.options));
       String deserialized;
 
       final typeConverter = column.typeConverter;
@@ -154,13 +154,14 @@ class DataClassWriter {
           type = '$type?';
         }
 
-        final fromConverter = "serializer.fromJson<$type>(json['$jsonKey'])";
+        final fromConverter =
+            "serializer.fromJson<$type>(json[$jsonKeyString])";
         final converterField = _converter(column);
         deserialized = '$converterField.fromJson($fromConverter)';
       } else {
         final type = _columnType(column);
 
-        deserialized = "serializer.fromJson<$type>(json['$jsonKey'])";
+        deserialized = "serializer.fromJson<$type>(json[$jsonKeyString])";
       }
 
       _buffer.write('$getter: $deserialized,');
@@ -186,7 +187,7 @@ class DataClassWriter {
         'return <String, dynamic>{\n');
 
     for (final column in columns) {
-      final name = column.getJsonKey(scope.options);
+      final nameLiteral = asDartLiteral(column.getJsonKey(scope.options));
       final getter = column.nameInDart;
       final needsThis = getter == 'serializer';
       var value = needsThis ? 'this.$getter' : getter;
@@ -199,7 +200,7 @@ class DataClassWriter {
         dartType = _jsonType(column);
       }
 
-      _buffer.write("'$name': serializer.toJson<$dartType>($value),");
+      _buffer.write("$nameLiteral: serializer.toJson<$dartType>($value),");
     }
 
     _buffer.write('};}');

diff --git a/drift_dev/lib/src/writer/tables/table_writer.dart b/drift_dev/lib/src/writer/tables/table_writer.dart
@@ -454,10 +454,11 @@ class TableWriter extends TableOrViewWriter {
   void _writeColumnVerificationMeta(DriftColumn column) {
     if (!_skipVerification) {
       final meta = emitter.drift('VerificationMeta');
+      final arg = asDartLiteral(column.nameInDart);
 
       buffer
         ..write('static const $meta ${_fieldNameForColumnMeta(column)} = ')
-        ..writeln("const $meta('${column.nameInDart}');");
+        ..writeln("const $meta($arg);");
     }
   }
 

diff --git a/drift_dev/lib/src/writer/utils/override_toString.dart b/drift_dev/lib/src/writer/utils/override_toString.dart
@@ -26,7 +26,13 @@ void overrideToString(
   for (var i = 0; i < properties.length; i++) {
     final property = properties[i];
 
-    into.write("..write('$property: \$$property");
+    if (property.contains(r'$')) {
+      final asKey = property.replaceAll('\$', '\\\$');
+      into.write("..write('$asKey: \${$property}");
+    } else {
+      into.write("..write('$property: \$$property");
+    }
+
     if (i != properties.length - 1) into.write(', ');
 
     into.write("')");