Merge pull request #9 from google/minor-fixes

Fail on dynamic fields. Export BuiltSet. Allow part statements with double quote.

Author: davidmorgan

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.0.4
+
+ - Fail on dynamic fields.
+ - Export BuiltSet.
+ - Allow part statements with double quote.
+
 ## 0.0.3
 
  - Support multiple enums in one file by allowing arbitrary generated identifiers.

enum_class/lib/enum_class.dart

@@ -4,6 +4,8 @@
 
 library enum_class;
 
+export 'package:built_collection/built_collection.dart' show BuiltSet;
+
 /// Enum Class base class.
 ///
 /// Extend this class then use the enum_class.dart code generation

enum_class/pubspec.yaml

@@ -1,5 +1,5 @@
 name: enum_class
-version: 0.0.3
+version: 0.0.4
 description: >
   Dart classes as enums. This library is the runtime dependency.
 authors:

enum_class_generator/lib/enum_class_generator.dart

@@ -51,7 +51,10 @@ class EnumClassGenerator extends Generator {
     final fileName =
         classElement.library.source.shortName.replaceAll('.dart', '');
     final expectedCode = "part '$fileName.g.dart';";
-    return classElement.library.source.contents.data.contains(expectedCode)
+    final alternativeExpectedCode = 'part "$fileName.g.dart";';
+    final source = classElement.library.source.contents.data;
+    return source.contains(expectedCode) ||
+            source.contains(alternativeExpectedCode)
         ? <String>[]
         : <String>['Import generated part: $expectedCode'];
   }
@@ -61,7 +64,8 @@ class EnumClassGenerator extends Generator {
     final result = <FieldElement>[];
     for (final field in classElement.fields) {
       final type = field.getter.returnType.displayName;
-      if (!field.isSynthetic && type == enumName) result.add(field);
+      if (!field.isSynthetic && (type == enumName || type == 'dynamic')) result
+          .add(field);
     }
     return result;
   }
@@ -70,7 +74,10 @@ class EnumClassGenerator extends Generator {
     final result = <String>[];
     for (final field in fields) {
       final fieldName = field.displayName;
-      if (!field.isConst && !field.isStatic) {
+      if (field.getter.returnType.displayName == 'dynamic') {
+        result.add('Specify a type for field "$fieldName".');
+        continue;
+      } else if (!field.isConst && !field.isStatic) {
         result.add('Make field "$fieldName" static const.');
         continue;
       } else if (!field.isConst) {

enum_class_generator/pubspec.yaml

@@ -1,5 +1,5 @@
 name: enum_class_generator
-version: 0.0.3
+version: 0.0.4
 description: >
   Dart classes as enums. This library is the dev dependency.
 authors:
@@ -12,7 +12,7 @@ environment:
 dependencies:
   analyzer: '>=0.26.1 <1.0.0'
   built_collection: '^1.0.0'
-  enum_class: '^0.0.3'
+  enum_class: '^0.0.4'
   source_gen: '>=0.4.3 <1.0.0'
   quiver: '>=0.21.0 <0.22.0'
 

enum_class_generator/test/enum_class_generator_test.dart

@@ -12,7 +12,6 @@ import 'package:test/test.dart';
 final String correctInput = r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -64,13 +63,46 @@ void main() {
       expect(await generate(correctInput), endsWith(correctOutput));
     });
 
+    test('allows part statement with double quotes', () async {
+      expect(
+          await generate(correctInput.replaceAll(
+              "part 'test_enum.g.dart'", 'part "test_enum.g.dart"')),
+          endsWith(correctOutput));
+    });
+
+    test('ignores fields of different type', () async {
+      expect(
+          await generate(correctInput.replaceAll(
+              'class TestEnum extends EnumClass {',
+              'class TestEnum extends EnumClass {\n'
+              '  static const int anInt = 3;')),
+          endsWith(correctOutput));
+    });
+
+    test('fails on dynamic fields', () async {
+      expect(
+          await generate(correctInput.replaceAll(
+              'class TestEnum extends EnumClass {',
+              'class TestEnum extends EnumClass {\n'
+              '  static const anInt = 3;')),
+          endsWith(r'''
+part of test_enum;
+
+// **************************************************************************
+// Generator: EnumClassGenerator
+// Target: class TestEnum
+// **************************************************************************
+
+// Error: Please make changes to use EnumClass.
+// TODO: Specify a type for field "anInt".
+'''));
+    });
+
     // TODO(davidmorgan): it would be better to fail with an error message.
     test('fails silently on missing enum_class import', () async {
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
-
 part 'test_enum.g.dart';
 
 class TestEnum extends EnumClass {
@@ -90,7 +122,6 @@ class TestEnum extends EnumClass {
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'src_par.dart';
@@ -122,7 +153,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -154,7 +184,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -186,7 +215,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -209,7 +237,6 @@ class TestEnum extends EnumClass {
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -258,7 +285,6 @@ final BuiltSet<TestEnum> _$values =
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -307,7 +333,6 @@ final BuiltSet<TestEnum> _$vls =
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -339,7 +364,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -371,7 +395,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -401,7 +424,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -433,7 +455,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -469,7 +490,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';
@@ -500,7 +520,6 @@ part of test_enum;
       expect(await generate(r'''
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';

example/lib/test_enum.dart

@@ -4,7 +4,6 @@
 
 library test_enum;
 
-import 'package:built_collection/built_collection.dart';
 import 'package:enum_class/enum_class.dart';
 
 part 'test_enum.g.dart';

example/pubspec.yaml

@@ -10,7 +10,7 @@ environment:
   sdk: '>=1.8.0 <2.0.0'
 
 dependencies:
-  enum_class: '^0.0.3'
+  enum_class: '^0.0.4'
 
 dev_dependencies:
-  enum_class_generator: '^0.0.3'
+  enum_class_generator: '^0.0.4'