feat(dart/transform): Record property metadata

Update the transformer to generate code registering annotations on class
properties, getters, and setters.

Closes angular#1800, angular#3267, angular#4003

Author: Tim Blasi

modules_dart/transform/lib/src/transform/common/code/reflection_info_code.dart

@@ -5,6 +5,7 @@ import 'package:angular2/src/transform/common/annotation_matcher.dart';
 import 'package:angular2/src/transform/common/logging.dart';
 import 'package:angular2/src/transform/common/model/reflection_info_model.pb.dart';
 import 'package:angular2/src/transform/common/names.dart';
+import 'package:angular2/src/transform/common/property_utils.dart';
 import 'package:barback/barback.dart' show AssetId;
 
 import 'annotation_code.dart';
@@ -16,20 +17,26 @@ class ReflectionInfoVisitor extends RecursiveAstVisitor<ReflectionInfoModel> {
   /// The file we are processing.
   final AssetId assetId;
 
+  /// Responsible for testing whether [Annotation]s are those recognized by
+  /// Angular 2, for example `@Component`.
+  final AnnotationMatcher _annotationMatcher;
+
   final AnnotationVisitor _annotationVisitor;
   final ParameterVisitor _parameterVisitor = new ParameterVisitor();
+  final _PropertyMetadataVisitor _propMetadataVisitor;
 
   /// Whether an Angular 2 `Reflection` has been found.
   bool _foundNgReflection = false;
 
-  /// Responsible for testing whether [Annotation]s are those recognized by
-  /// Angular 2, for example `@Component`.
-  final AnnotationMatcher _annotationMatcher;
+  ReflectionInfoVisitor._(this.assetId, this._annotationMatcher,
+      this._annotationVisitor, this._propMetadataVisitor);
 
-  ReflectionInfoVisitor(AssetId assetId, AnnotationMatcher annotationMatcher)
-      : this.assetId = assetId,
-        _annotationMatcher = annotationMatcher,
-        _annotationVisitor = new AnnotationVisitor(assetId, annotationMatcher);
+  factory ReflectionInfoVisitor(
+      AssetId assetId, AnnotationMatcher annotationMatcher) {
+    var annotationVisitor = new AnnotationVisitor(assetId, annotationMatcher);
+    return new ReflectionInfoVisitor._(assetId, annotationMatcher,
+        annotationVisitor, new _PropertyMetadataVisitor(annotationVisitor));
+  }
 
   bool get shouldCreateNgDeps => _foundNgReflection;
 
@@ -92,9 +99,44 @@ class ReflectionInfoVisitor extends RecursiveAstVisitor<ReflectionInfoModel> {
       model.interfaces.addAll(node.implementsClause.interfaces
           .map((interface) => '${interface.name}'));
     }
+
+    // Record annotations attached to properties.
+    for (var member in node.members) {
+      var propMetaList = member.accept(_propMetadataVisitor);
+      if (propMetaList != null) {
+        model.propertyMetadata.addAll(propMetaList);
+      }
+    }
+    _coalesce(model.propertyMetadata);
+
     return model;
   }
 
+  // If a class has a getter & a setter with the same name and each has
+  // individual metadata, collapse to a single entry.
+  void _coalesce(List<PropertyMetadataModel> propertyMetadata) {
+    if (propertyMetadata.isEmpty) return;
+
+    var firstSeenIdxMap = <String, int>{};
+    firstSeenIdxMap[propertyMetadata[0].name] = 0;
+    var i = 1;
+    while (i < propertyMetadata.length) {
+      var propName = propertyMetadata[i].name;
+      if (firstSeenIdxMap.containsKey(propName)) {
+        var propNameIdx = firstSeenIdxMap[propName];
+        // We have seen this name before, combine the metadata lists.
+        propertyMetadata[propNameIdx]
+            .annotations
+            .addAll(propertyMetadata[i].annotations);
+        // Remove the higher index, okay since we directly check `length` above.
+        propertyMetadata.removeAt(i);
+      } else {
+        firstSeenIdxMap[propName] = i;
+        ++i;
+      }
+    }
+  }
+
   @override
   ReflectionInfoModel visitFunctionDeclaration(FunctionDeclaration node) {
     if (!node.metadata
@@ -126,6 +168,53 @@ class ReflectionInfoVisitor extends RecursiveAstVisitor<ReflectionInfoModel> {
   }
 }
 
+/// Visitor responsible for parsing [ClassMember]s into
+/// [PropertyMetadataModel]s.
+class _PropertyMetadataVisitor
+    extends SimpleAstVisitor<List<PropertyMetadataModel>> {
+  final AnnotationVisitor _annotationVisitor;
+
+  _PropertyMetadataVisitor(this._annotationVisitor);
+
+  @override
+  List<PropertyMetadataModel> visitFieldDeclaration(FieldDeclaration node) {
+    var retVal = null;
+    for (var variable in node.fields.variables) {
+      var propModel = new PropertyMetadataModel()..name = '${variable.name}';
+      for (var meta in node.metadata) {
+        var annotationModel = meta.accept(_annotationVisitor);
+        if (annotationModel != null) {
+          propModel.annotations.add(annotationModel);
+        }
+      }
+      if (propModel.annotations.isNotEmpty) {
+        if (retVal == null) {
+          retVal = <PropertyMetadataModel>[];
+        }
+        retVal.add(propModel);
+      }
+    }
+    return retVal;
+  }
+
+  @override
+  List<PropertyMetadataModel> visitMethodDeclaration(MethodDeclaration node) {
+    if (node.isGetter || node.isSetter) {
+      var propModel = new PropertyMetadataModel()..name = '${node.name}';
+      for (var meta in node.metadata) {
+        var annotationModel = meta.accept(_annotationVisitor);
+        if (annotationModel != null) {
+          propModel.annotations.add(annotationModel);
+        }
+      }
+      if (propModel.annotations.isNotEmpty) {
+        return <PropertyMetadataModel>[propModel];
+      }
+    }
+    return null;
+  }
+}
+
 /// Defines the format in which an [ReflectionInfoModel] is expressed as Dart
 /// code in a `.ng_deps.dart` file.
 abstract class ReflectionWriterMixin
@@ -171,9 +260,25 @@ abstract class ReflectionWriterMixin
       _writeListWithSeparator(model.parameters, writeParameterModelForImpl,
           prefix: '(', suffix: ')');
       // Interfaces
+      var hasPropertyMetadata =
+          model.propertyMetadata != null && model.propertyMetadata.isNotEmpty;
       if (model.interfaces != null && model.interfaces.isNotEmpty) {
         _writeListWithSeparator(model.interfaces, buffer.write,
             prefix: ',\nconst [', suffix: ']');
+      } else if (hasPropertyMetadata) {
+        buffer.write(',\nconst []');
+      }
+      // Property Metadata
+      if (hasPropertyMetadata) {
+        buffer.write(',\nconst {');
+        for (var propMeta in model.propertyMetadata) {
+          if (propMeta != model.propertyMetadata.first) {
+            buffer.write(', ');
+          }
+          _writeListWithSeparator(propMeta.annotations, writeAnnotationModel,
+              prefix: "\n'${sanitize(propMeta.name)}': const [", suffix: ']');
+        }
+        buffer.write('}');
       }
     }
     buffer.writeln(')\n)');

modules_dart/transform/lib/src/transform/common/model/reflection_info_model.pb.dart

@@ -5,6 +5,14 @@ import "parameter_model.proto";
 
 package angular2.src.transform.common.model.proto;
 
+message PropertyMetadataModel {
+  // The name of the property with metadata attached.
+  required string name = 1;
+
+  // The metadata attached to the property.
+  repeated AnnotationModel annotations = 2;
+}
+
 message ReflectionInfoModel {
   // The (potentially prefixed) name of this Injectable.
   // This can be a `Type` or a function name.
@@ -21,4 +29,7 @@ message ReflectionInfoModel {
   repeated ParameterModel parameters = 5;
 
   repeated string interfaces = 6;
+
+  // Entries for all properties with associated metadata.
+  repeated PropertyMetadataModel propertyMetadata = 7;
 }

modules_dart/transform/lib/src/transform/common/model/reflection_info_model.proto

@@ -292,6 +292,61 @@ void allTests() {
     });
   });
 
+  describe('property metadata', () {
+    it('should be recorded on fields', () async {
+      var model = await _testCreateModel('prop_metadata_files/fields.dart');
+
+      expect(model.reflectables.first.propertyMetadata).toBeNotNull();
+      expect(model.reflectables.first.propertyMetadata.isNotEmpty).toBeTrue();
+      expect(model.reflectables.first.propertyMetadata.first.name)
+          .toEqual('field');
+      expect(model.reflectables.first.propertyMetadata.first.annotations
+          .firstWhere((a) => a.name == 'FieldDecorator',
+              orElse: () => null)).toBeNotNull();
+    });
+
+    it('should be recorded on getters', () async {
+      var model = await _testCreateModel('prop_metadata_files/getters.dart');
+
+      expect(model.reflectables.first.propertyMetadata).toBeNotNull();
+      expect(model.reflectables.first.propertyMetadata.isNotEmpty).toBeTrue();
+      expect(model.reflectables.first.propertyMetadata.first.name)
+          .toEqual('getVal');
+      expect(model.reflectables.first.propertyMetadata.first.annotations
+              .firstWhere((a) => a.name == 'GetDecorator', orElse: () => null))
+          .toBeNotNull();
+    });
+
+    it('should be recorded on setters', () async {
+      var model = await _testCreateModel('prop_metadata_files/setters.dart');
+
+      expect(model.reflectables.first.propertyMetadata).toBeNotNull();
+      expect(model.reflectables.first.propertyMetadata.isNotEmpty).toBeTrue();
+      expect(model.reflectables.first.propertyMetadata.first.name)
+          .toEqual('setVal');
+      expect(model.reflectables.first.propertyMetadata.first.annotations
+              .firstWhere((a) => a.name == 'SetDecorator', orElse: () => null))
+          .toBeNotNull();
+    });
+
+    it('should be coalesced when getters and setters have the same name',
+        () async {
+      var model = await _testCreateModel(
+          'prop_metadata_files/getters_and_setters.dart');
+
+      expect(model.reflectables.first.propertyMetadata).toBeNotNull();
+      expect(model.reflectables.first.propertyMetadata.length).toBe(1);
+      expect(model.reflectables.first.propertyMetadata.first.name)
+          .toEqual('myVal');
+      expect(model.reflectables.first.propertyMetadata.first.annotations
+              .firstWhere((a) => a.name == 'GetDecorator', orElse: () => null))
+          .toBeNotNull();
+      expect(model.reflectables.first.propertyMetadata.first.annotations
+              .firstWhere((a) => a.name == 'SetDecorator', orElse: () => null))
+          .toBeNotNull();
+    });
+  });
+
   it('should not throw/hang on invalid urls', () async {
     var logger = new RecordingLogger();
     var model =

modules_dart/transform/test/transform/directive_processor/all_tests.dart

@@ -0,0 +1,8 @@
+library fields;
+
+import 'package:angular2/src/core/metadata.dart';
+
+@Component(selector: '[fields]')
+class FieldComponent {
+  @FieldDecorator("field") String field;
+}

modules_dart/transform/test/transform/directive_processor/prop_metadata_files/fields.dart

@@ -0,0 +1,8 @@
+library fields;
+
+import 'package:angular2/src/core/metadata.dart';
+
+@Component(selector: '[getters]')
+class FieldComponent {
+  @GetDecorator("get") String get getVal => 'a';
+}

modules_dart/transform/test/transform/directive_processor/prop_metadata_files/getters.dart

@@ -0,0 +1,10 @@
+library fields;
+
+import 'package:angular2/src/core/metadata.dart';
+
+@Component(selector: '[getters-and-setters]')
+class FieldComponent {
+  String _val;
+  @GetDecorator("get") String get myVal => _val;
+  @SetDecorator("set") String set myVal(val) => _val = val;
+}

modules_dart/transform/test/transform/directive_processor/prop_metadata_files/getters_and_setters.dart

@@ -0,0 +1,8 @@
+library fields;
+
+import 'package:angular2/src/core/metadata.dart';
+
+@Component(selector: '[setters]')
+class FieldComponent {
+  @SetDecorator("set") String set setVal(val) => null;
+}