Merge pull request #17 from davidmorgan/master

Add mixin generation for use with Angular templates.

Author: davidmorgan

CHANGELOG.md

@@ -1,28 +1,32 @@
 # Changelog
 
+## 0.2.0
+
+- Add mixin generation for use with Angular templates.
+
 ## 0.1.0
 
- - Upgrade to source_gen 0.5.0.
- - Breaking change; see example for required changes to build.dart.
+- Upgrade to source_gen 0.5.0.
+- Breaking change; see example for required changes to build.dart.
 
 ## 0.0.6
 
- - Check for missing import statement.
- - Fix constraints for source_gen.
+- Check for missing import statement.
+- Fix constraints for source_gen.
 
 ## 0.0.5
 
- - Fix generation across multiple files, allow reuse of generated identifiers.
+- Fix generation across multiple files, allow reuse of generated identifiers.
 
 ## 0.0.4
 
- - Fail on dynamic fields.
- - Export BuiltSet.
- - Allow part statements with double quote.
+- 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.
+- Support multiple enums in one file by allowing arbitrary generated identifiers.
 
 ## 0.0.2
 

enum_class/pubspec.yaml

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

enum_class_generator/lib/enum_class_generator.dart

@@ -53,15 +53,25 @@ class EnumClassGenerator extends Generator {
       _checkConstructor(classElement),
       _checkValuesGetter(classElement),
       _checkValueOf(classElement)
-    ]);
+    ]).toList();
+
+    final mixinElement = classElement.library.getType(enumName + 'Mixin');
+    final shouldGenerateMixin = mixinElement != null;
+    if (shouldGenerateMixin) {
+      final expectedCode =
+          'abstract class ${enumName}Mixin = Object with _\$${enumName}Mixin;';
+      if (mixinElement.computeNode().toString() != expectedCode) {
+        errors.add('Mixin: $expectedCode');
+      }
+    }
 
     if (errors.isNotEmpty) {
       throw new InvalidGenerationSourceError(
           'Please make changes to use EnumClass.',
           todo: errors.join(' '));
     }
 
-    return _generateCode(classElement, enumName, fields);
+    return _generateCode(classElement, enumName, fields, shouldGenerateMixin);
   }
 
   Iterable<String> _checkPart(ClassElement classElement) {
@@ -81,8 +91,9 @@ class EnumClassGenerator extends Generator {
     final result = <FieldElement>[];
     for (final field in classElement.fields) {
       final type = field.getter.returnType.displayName;
-      if (!field.isSynthetic && (type == enumName || type == 'dynamic')) result
-          .add(field);
+      if (!field.isSynthetic && (type == enumName || type == 'dynamic')) {
+        result.add(field);
+      }
     }
     return result;
   }
@@ -171,7 +182,7 @@ class EnumClassGenerator extends Generator {
   }
 
   String _generateCode(ClassElement classElement, String enumName,
-      Iterable<FieldElement> fields) {
+      Iterable<FieldElement> fields, bool generateMixin) {
     final result = new StringBuffer();
 
     for (final field in fields) {
@@ -205,6 +216,28 @@ class EnumClassGenerator extends Generator {
     }
     result.writeln(']);');
 
+    if (generateMixin) result.write(_generateMixin(enumName, fields));
+
+    return result.toString();
+  }
+
+  String _generateMixin(String enumName, Iterable<FieldElement> fields) {
+    final result = new StringBuffer();
+
+    result.writeln('class _\$${enumName}Meta {');
+    result.writeln('const _\$${enumName}Meta();');
+    for (final field in fields) {
+      final fieldName = field.displayName;
+      result
+          .writeln('$enumName get $fieldName => _\$${_getGeneratedIdentifier(
+          field)};');
+    }
+    result.writeln('}');
+    result.writeln('abstract class _\$${enumName}Mixin {');
+    result.writeln(
+        '_\$${enumName}Meta get $enumName => const _\$${enumName}Meta();');
+    result.writeln('}');
+
     return result.toString();
   }
 
@@ -215,8 +248,9 @@ class EnumClassGenerator extends Generator {
 
   String _getValueOfIdentifier(String source, String enumName) {
     final matches = new RegExp(r'static ' +
-        enumName +
-        r' valueOf\(String name\) \=\> \_\$(\w+)\(name\)\;').allMatches(source);
+            enumName +
+            r' valueOf\(String name\) \=\> \_\$(\w+)\(name\)\;')
+        .allMatches(source);
     return matches.isEmpty ? null : matches.first.group(1);
   }
 

enum_class_generator/pubspec.yaml

@@ -1,5 +1,5 @@
 name: enum_class_generator
-version: 0.1.0
+version: 0.2.0
 description: >
   Dart classes as enums. This library is the dev dependency.
 authors:
@@ -13,7 +13,7 @@ dependencies:
   analyzer: '>=0.26.1 <1.0.0'
   build: '^0.3.0'
   built_collection: '^1.0.0'
-  enum_class: '^0.1.0'
+  enum_class: '^0.2.0'
   source_gen: '>=0.5.0 <0.6.0'
   quiver: '>=0.21.0 <0.22.0'
 

enum_class_generator/test/enum_class_generator_test.dart

@@ -27,6 +27,8 @@ class TestEnum extends EnumClass {
   static BuiltSet<TestEnum> get values => _$values;
   static TestEnum valueOf(String name) => _$valueOf(name);
 }
+
+abstract class TestEnumMixin = Object with _$TestEnumMixin;
 ''';
 
 final String correctOutput = r'''
@@ -56,6 +58,17 @@ TestEnum _$valueOf(String name) {
 
 final BuiltSet<TestEnum> _$values =
     new BuiltSet<TestEnum>(const [_$yes, _$no, _$maybe,]);
+
+class _$TestEnumMeta {
+  const _$TestEnumMeta();
+  TestEnum get yes => _$yes;
+  TestEnum get no => _$no;
+  TestEnum get maybe => _$maybe;
+}
+
+abstract class _$TestEnumMixin {
+  _$TestEnumMeta get TestEnum => const _$TestEnumMeta();
+}
 ''';
 
 void main() {
@@ -247,6 +260,8 @@ class TestEnum extends EnumClass {
   static BuiltSet<TestEnum> get values => _$values;
   static TestEnum valueOf(String name) => _$valueOf(name);
 }
+
+abstract class TestEnumMixin = Object with _$TestEnumMixin;
 '''), endsWith(correctOutput));
     });
 
@@ -560,6 +575,37 @@ part of test_enum;
 
 // Error: Please make changes to use EnumClass.
 // TODO: Method: static TestEnum valueOf(String name) => _$valueOf(name)
+'''));
+    });
+
+    test('fails with error on wrong mixin declaration', () async {
+      expect(await generate(r'''
+library test_enum;
+
+import 'package:enum_class/enum_class.dart';
+
+part 'test_enum.g.dart';
+
+class TestEnum extends EnumClass {
+  static const TestEnum yes = _$yes;
+
+  const TestEnum._(String name) : super(name);
+
+  static BuiltSet<TestEnum> get values => _$values;
+  static TestEnum valueOf(String name) => _$valueOf(name);
+}
+
+class TestEnumMixin = Object with _$TestEnumMixin;
+'''), endsWith(r'''
+part of test_enum;
+
+// **************************************************************************
+// Generator: EnumClassGenerator
+// Target: class TestEnum
+// **************************************************************************
+
+// Error: Please make changes to use EnumClass.
+// TODO: Mixin: abstract class TestEnumMixin = Object with _$TestEnumMixin;
 '''));
     });
   });

example/lib/test_enum.dart

@@ -28,6 +28,14 @@ class TestEnum extends EnumClass {
   static TestEnum valueOf(String name) => _$valueOf(name);
 }
 
+/// Optionally, enum_class can generate a mixin to go with your enum for use
+/// with Angular. It exposes your enum constants as getters. So, if you mix it
+/// in to your Dart component class, the values become available to the
+/// corresponding Angular template.
+///
+/// Trigger mixin generation by writing a line like this one next to your enum.
+abstract class TestEnumMixin = Object with _$TestEnumMixin;
+
 /// It's possible to have multiple enums in the same file.
 ///
 /// For this to work, you need to change any generated names that clash. For

example/lib/test_enum.g.dart

@@ -1,5 +1,5 @@
 name: example
-version: 0.1.0
+version: 0.2.0
 description: >
   Just an example, not for publishing.
 authors:
@@ -10,7 +10,7 @@ environment:
   sdk: '>=1.8.0 <2.0.0'
 
 dependencies:
-  enum_class: '^0.1.0'
+  enum_class: '^0.2.0'
 
 dev_dependencies:
-  enum_class_generator: '^0.1.0'
+  enum_class_generator: '^0.2.0'