feat(dart/transform): Add a di transformer

Add a transformer for `di` which generates `.ng_deps.dart` files for all
`.dart` files it is run on. These `.ng_deps.dart` files register
metadata for any `@Injectable` classes.

Fix unit tests for changes introduced by the di transformer.

When using `pub (build|serve) --mode=ngstatic`, we will also generate
getters and setters, parse templates, and remove import of `dart:mirrors`
in the Angular transform. Because this is still relatively immature, we
use the mode to keep it opt-in for now.

Closes angular#700

Author: Tim Blasi

modules/angular2/pubspec.yaml

@@ -15,5 +15,7 @@ dependencies:
   dart_style: '^0.1.3'
   html: '^0.12.0'
   stack_trace: '^1.1.1'
+transformers:
+  - angular2/src/transform/di_transformer
 dev_dependencies:
   guinness: "^0.1.17"

modules/angular2/src/transform/common/names.dart

@@ -7,3 +7,4 @@ const REGISTER_TYPE_METHOD_NAME = 'registerType';
 const REGISTER_GETTERS_METHOD_NAME = 'registerGetters';
 const REGISTER_SETTERS_METHOD_NAME = 'registerSetters';
 const REGISTER_METHODS_METHOD_NAME = 'registerMethods';
+const TRANSFORM_MODE = 'ngstatic';

modules/angular2/src/transform/common/options.dart

@@ -13,9 +13,14 @@ class TransformerOptions {
   /// application's [ReflectionCapabilities] are set.
   final String reflectionEntryPoint;
 
-  TransformerOptions._internal(this.entryPoint, this.reflectionEntryPoint);
+  /// The `BarbackMode#name` we are running in.
+  final String modeName;
 
-  factory TransformerOptions(String entryPoint, {String reflectionEntryPoint}) {
+  TransformerOptions._internal(
+      this.entryPoint, this.reflectionEntryPoint, this.modeName);
+
+  factory TransformerOptions(String entryPoint,
+      {String reflectionEntryPoint, String modeName: 'release'}) {
     if (entryPoint == null) {
       throw new ArgumentError.notNull(ENTRY_POINT_PARAM);
     } else if (entryPoint.isEmpty) {
@@ -24,6 +29,7 @@ class TransformerOptions {
     if (reflectionEntryPoint == null || entryPoint.isEmpty) {
       reflectionEntryPoint = entryPoint;
     }
-    return new TransformerOptions._internal(entryPoint, reflectionEntryPoint);
+    return new TransformerOptions._internal(
+        entryPoint, reflectionEntryPoint, modeName);
   }
 }

modules/angular2/src/transform/di_transformer.dart

@@ -0,0 +1,26 @@
+library angular2.src.transform.di_transformer;
+
+import 'package:barback/barback.dart';
+import 'package:dart_style/dart_style.dart';
+
+import 'directive_linker/transformer.dart';
+import 'directive_processor/transformer.dart';
+import 'bind_generator/transformer.dart';
+import 'reflection_remover/transformer.dart';
+import 'common/formatter.dart' as formatter;
+import 'common/options.dart';
+
+export 'common/options.dart';
+
+/// Removes the mirror-based initialization logic and replaces it with static
+/// logic.
+class DiTransformerGroup extends TransformerGroup {
+  DiTransformerGroup()
+      : super([[new DirectiveProcessor(null)], [new DirectiveLinker()]]) {
+    formatter.init(new DartFormatter());
+  }
+
+  factory DiTransformerGroup.asPlugin(BarbackSettings settings) {
+    return new DiTransformerGroup();
+  }
+}

modules/angular2/src/transform/directive_linker/transformer.dart

@@ -16,9 +16,7 @@ import 'linker.dart';
 /// `setupReflection` call the necessary `setupReflection` method in all
 /// dependencies.
 class DirectiveLinker extends Transformer {
-  final TransformerOptions options;
-
-  DirectiveLinker(this.options);
+  DirectiveLinker();
 
   @override
   bool isPrimary(AssetId id) => id.path.endsWith(DEPS_EXTENSION);
@@ -28,10 +26,11 @@ class DirectiveLinker extends Transformer {
     log.init(transform);
 
     try {
+      var reader = new AssetReader.fromTransform(transform);
       var assetId = transform.primaryInput.id;
-      var transformedCode =
-          await linkNgDeps(new AssetReader.fromTransform(transform), assetId);
-      var formattedCode = formatter.format(transformedCode, uri: assetId.path);
+      var assetPath = assetId.path;
+      var transformedCode = await linkNgDeps(reader, assetId);
+      var formattedCode = formatter.format(transformedCode, uri: assetPath);
       transform.addOutput(new Asset.fromString(assetId, formattedCode));
     } catch (ex, stackTrace) {
       log.logger.error('Linking ng directives failed.\n'

modules/angular2/src/transform/directive_processor/rewriter.dart

@@ -16,17 +16,13 @@ import 'visitors.dart';
 /// If no Angular 2 `Directive`s are found in [code], returns the empty
 /// string unless [forceGenerate] is true, in which case an empty ngDeps
 /// file is created.
-String createNgDeps(String code, String path, {bool forceGenerate: false}) {
+String createNgDeps(String code, String path) {
   // TODO(kegluneq): Shortcut if we can determine that there are no
-  // [Directive]s present.
+  // [Directive]s present, taking into account `export`s.
   var writer = new PrintStringWriter();
   var visitor = new CreateNgDepsVisitor(writer, path);
   parseCompilationUnit(code, name: path).accept(visitor);
-  if (visitor.foundNgDirectives || forceGenerate) {
-    return writer.toString();
-  } else {
-    return '';
-  }
+  return '$writer';
 }
 
 /// Visitor responsible for processing [CompilationUnit] and creating an
@@ -35,8 +31,8 @@ class CreateNgDepsVisitor extends Object
     with SimpleAstVisitor<Object>, VisitorMixin {
   final PrintWriter writer;
   final _Tester _tester = const _Tester();
-  bool foundNgDirectives = false;
-  bool wroteImport = false;
+  bool _foundNgDirectives = false;
+  bool _wroteImport = false;
   final ToSourceVisitor _copyVisitor;
   final FactoryTransformVisitor _factoryVisitor;
   final ParameterTransformVisitor _paramsVisitor;
@@ -61,33 +57,35 @@ class CreateNgDepsVisitor extends Object
     return null;
   }
 
-  void _writeImport() {
+  /// Write the import to the file the .ng_deps.dart file is based on if it
+  /// has not yet been written.
+  void _maybeWriteImport() {
+    if (_wroteImport) return;
+    _wroteImport = true;
     writer.print('''import '${path.basename(importPath)}';''');
   }
 
   @override
   Object visitImportDirective(ImportDirective node) {
-    if (!wroteImport) {
-      _writeImport();
-      wroteImport = true;
-    }
+    _maybeWriteImport();
     return node.accept(_copyVisitor);
   }
 
   @override
   Object visitExportDirective(ExportDirective node) {
+    _maybeWriteImport();
     return node.accept(_copyVisitor);
   }
 
   void _openFunctionWrapper() {
-    // TODO(kegluneq): Use a [PrintWriter] with a length getter.
+    _maybeWriteImport();
     writer.print('bool _visited = false;'
         'void ${SETUP_METHOD_NAME}(${REFLECTOR_VAR_NAME}) {'
         'if (_visited) return; _visited = true;');
   }
 
   void _closeFunctionWrapper() {
-    if (foundNgDirectives) {
+    if (_foundNgDirectives) {
       writer.print(';');
     }
     writer.print('}');
@@ -135,10 +133,10 @@ class CreateNgDepsVisitor extends Object
     if (shouldProcess) {
       var ctor = _getCtor(node);
 
-      if (!foundNgDirectives) {
+      if (!_foundNgDirectives) {
         // The receiver for cascaded calls.
         writer.print(REFLECTOR_VAR_NAME);
-        foundNgDirectives = true;
+        _foundNgDirectives = true;
       }
       writer.print('..registerType(');
       visitNode(node.name);
@@ -168,7 +166,14 @@ class CreateNgDepsVisitor extends Object
   }
 
   @override
-  Object visitLibraryDirective(LibraryDirective node) => _nodeToSource(node);
+  Object visitLibraryDirective(LibraryDirective node) {
+    if (node != null && node.name != null) {
+      writer.print('library ');
+      _nodeToSource(node.name);
+      writer.print('$DEPS_EXTENSION;');
+    }
+    return null;
+  }
 
   @override
   Object visitPartOfDirective(PartOfDirective node) {
@@ -194,6 +199,7 @@ class _Tester {
     var metaName = meta.name.toString();
     return metaName == 'Component' ||
         metaName == 'Decorator' ||
+        metaName == 'Injectable' ||
         metaName == 'Template';
   }
 }

modules/angular2/src/transform/directive_processor/transformer.dart

@@ -32,14 +32,13 @@ class DirectiveProcessor extends Transformer {
     log.init(transform);
 
     try {
-      var assetCode = await transform.primaryInput.readAsString();
-      var ngDepsSrc = createNgDeps(assetCode, transform.primaryInput.id.path,
-          forceGenerate: transform.primaryInput.id.path == options.entryPoint);
+      var asset = transform.primaryInput;
+      var assetCode = await asset.readAsString();
+      var ngDepsSrc = createNgDeps(assetCode, asset.id.path);
       if (ngDepsSrc != null && ngDepsSrc.isNotEmpty) {
         var ngDepsAssetId =
             transform.primaryInput.id.changeExtension(DEPS_EXTENSION);
-        var exists = await transform.hasInput(ngDepsAssetId);
-        if (exists) {
+        if (await transform.hasInput(ngDepsAssetId)) {
           log.logger.error('Clobbering ${ngDepsAssetId}. '
               'This probably will not end well');
         }

modules/angular2/src/transform/directive_processor/visitors.dart

@@ -29,8 +29,13 @@ class _CtorTransformVisitor extends ToSourceVisitor with VisitorMixin {
       var suffix = type != null ? ', ' : '';
       visitNodeListWithSeparatorAndSuffix(metadata, ', ', suffix);
     }
-    if (_withParameterTypes) {
-      visitNodeWithSuffix(type, ' ');
+    var needCompileTimeConstants = !_withParameterNames;
+    if (_withParameterTypes && type != null) {
+      visitNodeWithSuffix(type.name, ' ');
+      if (!needCompileTimeConstants) {
+        // Types with arguments are not compile-time constants.
+        visitNodeWithSuffix(type.typeArguments, ' ');
+      }
     }
     if (_withParameterNames) {
       visitNode(name);

modules/angular2/src/transform/reflection_remover/rewriter.dart

@@ -81,7 +81,7 @@ class Rewriter {
 
   String _commentedNode(AstNode node) {
     // TODO(kegluneq): Return commented code once we generate all needed code.
-    return _code.substring(node.offset, node.end);
+    return '/*${_code.substring(node.offset, node.end)}*/';
   }
 }
 

modules/angular2/src/transform/transformer.dart

@@ -9,20 +9,27 @@ import 'bind_generator/transformer.dart';
 import 'reflection_remover/transformer.dart';
 import 'template_compiler/transformer.dart';
 import 'common/formatter.dart' as formatter;
+import 'common/names.dart';
 import 'common/options.dart';
 
 export 'common/options.dart';
 
 /// Replaces Angular 2 mirror use with generated code.
 class AngularTransformerGroup extends TransformerGroup {
-  AngularTransformerGroup(TransformerOptions options) : super([
-        [new DirectiveProcessor(options)],
-        [new DirectiveLinker(options)],
+  AngularTransformerGroup._(phases) : super(phases) {
+    formatter.init(new DartFormatter());
+  }
+
+  factory AngularTransformerGroup(TransformerOptions options) {
+    var phases = [[new DirectiveProcessor(options)], [new DirectiveLinker()]];
+    if (options.modeName == TRANSFORM_MODE) {
+      phases.addAll([
         [new BindGenerator(options)],
         [new TemplateComplier(options)],
         [new ReflectionRemover(options)]
-      ]) {
-    formatter.init(new DartFormatter());
+      ]);
+    }
+    return new AngularTransformerGroup._(phases);
   }
 
   factory AngularTransformerGroup.asPlugin(BarbackSettings settings) {
@@ -33,5 +40,6 @@ class AngularTransformerGroup extends TransformerGroup {
 TransformerOptions _parseOptions(BarbackSettings settings) {
   var config = settings.configuration;
   return new TransformerOptions(config[ENTRY_POINT_PARAM],
-      reflectionEntryPoint: config[REFLECTION_ENTRY_POINT_PARAM]);
+      reflectionEntryPoint: config[REFLECTION_ENTRY_POINT_PARAM],
+      modeName: settings.mode.name);
 }