refactor(DirectiveInjector): better var names and comments

Author: vicb

lib/core_dom/directive_injector.dart

@@ -65,6 +65,7 @@ EventHandler eventHandler(DirectiveInjector di) => di._eventHandler;
 
 class DirectiveInjector implements DirectiveBinder {
   static bool _isInit = false;
+
   static initUID() {
     if (_isInit) return;
     _isInit = true;
@@ -91,6 +92,7 @@ class DirectiveInjector implements DirectiveBinder {
       if (_KEYS[i].uid != i) throw 'MISSORDERED KEYS ARRAY: ${_KEYS} at $i';
     }
   }
+
   static List<Key> _KEYS =
       [ UNDEFINED_ID
       , INJECTOR_KEY
@@ -128,6 +130,7 @@ class DirectiveInjector implements DirectiveBinder {
   NgElement _ngElement;
   ElementProbe _elementProbe;
 
+  // Keys, instances, parameter keys and factory functions
   Key _key0 = null; dynamic _obj0; List<Key> _pKeys0; Function _factory0;
   Key _key1 = null; dynamic _obj1; List<Key> _pKeys1; Function _factory1;
   Key _key2 = null; dynamic _obj2; List<Key> _pKeys2; Function _factory2;
@@ -148,11 +151,11 @@ class DirectiveInjector implements DirectiveBinder {
   @Deprecated("Deprecated. Use getFromParent instead.")
   Object get parent => this._parent;
 
-  static _toVisId(Visibility v) => identical(v, Visibility.LOCAL)
+  static _toVisibilityId(Visibility v) => identical(v, Visibility.LOCAL)
       ? VISIBILITY_LOCAL
       : (identical(v, Visibility.CHILDREN) ? VISIBILITY_CHILDREN : VISIBILITY_DIRECT_CHILD);
 
-  static _toVis(int id) {
+  static Visibility _toVisibility(int id) {
     switch (id) {
       case VISIBILITY_LOCAL:                  return Visibility.LOCAL;
       case VISIBILITY_DIRECT_CHILD:           return Visibility.DIRECT_CHILD;
@@ -185,7 +188,7 @@ class DirectiveInjector implements DirectiveBinder {
             toInstanceOf,
             inject: const[],
             Visibility visibility: Visibility.LOCAL}) {
-    if (key == null) throw 'Key is required';
+    assert(key != null);
     if (key is! Key) key = new Key(key);
     if (inject is! List) inject = [inject];
 
@@ -197,13 +200,13 @@ class DirectiveInjector implements DirectiveBinder {
 
   void bindByKey(Key key, Function factory, List<Key> parameterKeys, [Visibility visibility]) {
     if (visibility == null) visibility = Visibility.CHILDREN;
-    int visibilityId = _toVisId(visibility);
+    int visibilityId = _toVisibilityId(visibility);
     int keyVisId = key.uid;
     if (keyVisId != visibilityId) {
       if (keyVisId == null) {
         key.uid = visibilityId;
       } else {
-        throw "Can not set $visibility on $key, it alread has ${_toVis(keyVisId)}";
+        throw "Can not set $visibility on $key, it already has ${_toVisibility(keyVisId)}";
       }
     }
     if      (_key0 == null || identical(_key0, key)) { _key0 = key; _pKeys0 = parameterKeys; _factory0 = factory; }
@@ -253,17 +256,17 @@ class DirectiveInjector implements DirectiveBinder {
     }
   }
 
-  num _getDepth(int visType) {
-    switch(visType) {
+  num _getDepth(int visibility) {
+    switch(visibility) {
       case VISIBILITY_LOCAL:        return 0;
       case VISIBILITY_DIRECT_CHILD: return 1;
       case VISIBILITY_CHILDREN:     return _MAX_TREE_DEPTH;
       default: throw null;
     }
   }
 
-  _getDirectiveByKey(Key k, int visType, Injector appInjector) {
-    num treeDepth = _getDepth(visType);
+  _getDirectiveByKey(Key k, int visibility, Injector appInjector) {
+    num treeDepth = _getDepth(visibility);
     // ci stands for currentInjector, abbreviated for readability.
     var ci = this;
     while (ci != null && treeDepth >= 0) {
@@ -379,7 +382,6 @@ class DirectiveInjector implements DirectiveBinder {
     return obj;
   }
 
-
   ElementProbe get elementProbe {
     if (_elementProbe == null) {
       ElementProbe parentProbe = _parent == null ? null : _parent.elementProbe;
@@ -472,7 +474,7 @@ class ComponentDirectiveInjector extends DirectiveInjector {
 
   // Add 1 to visibility to allow to skip over current component injector.
   // For example, a local directive is visible from its component injector children.
-  num _getDepth(int visType) => super._getDepth(visType) + 1;
+  num _getDepth(int visibility) => super._getDepth(visibility) + 1;
 }
 
 

lib/core_dom/shadow_dom_component_factory.dart

@@ -194,8 +194,8 @@ class _ComponentAssetKey {
 
   _ComponentAssetKey(String tag, String assetUrl)
       : _key = "$tag|$assetUrl",
-        this.tag = tag,
-        this.assetUrl = assetUrl;
+        tag = tag,
+        assetUrl = assetUrl;
 
   @override
   String toString() => _key;
@@ -204,9 +204,9 @@ class _ComponentAssetKey {
   int get hashCode => _key.hashCode;
 
   bool operator ==(key) =>
-      key is _ComponentAssetKey
-      && tag == key.tag
-      && assetUrl == key.assetUrl;
+      key is _ComponentAssetKey &&
+      tag == key.tag &&
+      assetUrl == key.assetUrl;
 }
 
 @Injectable()

lib/core_dom/view.dart

@@ -54,7 +54,7 @@ class ViewPort {
     _parentView.addViewPort(this);
   }
 
-  View insertNew(ViewFactory viewFactory, { View insertAfter, Scope viewScope}) {
+  View insertNew(ViewFactory viewFactory, {View insertAfter, Scope viewScope}) {
     if (viewScope == null) viewScope = scope.createChild(new PrototypeMap(scope.context));
     View view = viewFactory.call(viewScope, directiveInjector);
     return insert(view, insertAfter: insertAfter);

lib/directive/ng_include.dart

@@ -27,31 +27,28 @@ class NgInclude {
   final DirectiveMap directives;
 
   View _view;
-  Scope _scope;
+  Scope _childScope;
 
   NgInclude(this.element, this.scope, this.viewCache,
             this.directiveInjector, this.directives);
 
   _cleanUp() {
     if (_view == null) return;
-
     _view.nodes.forEach((node) => node.remove);
-    _scope.destroy();
+    _childScope.destroy();
+    _childScope = null;
     element.innerHtml = '';
-
     _view = null;
-    _scope = null;
   }
 
   _updateContent(ViewFactory viewFactory) {
     // create a new scope
-    _scope = scope.createChild(new PrototypeMap(scope.context));
-    _view = viewFactory(_scope, directiveInjector);
+    _childScope = scope.createChild(new PrototypeMap(scope.context));
+    _view = viewFactory(_childScope, directiveInjector);
 
     _view.nodes.forEach((node) => element.append(node));
   }
 
-
   set url(value) {
     _cleanUp();
     if (value != null && value != '') {

test/core_dom/directive_injector_spec.dart

@@ -149,7 +149,7 @@ void main() {
         it('should not allow reseting visibility', () {
           addDirective(_Type0, Visibility.LOCAL);
           expect(() => addDirective(_Type0, Visibility.DIRECT_CHILD)).toThrow(
-              'Can not set Visibility: DIRECT_CHILD on _Type0, it alread has Visibility: LOCAL');
+              'Can not set Visibility: DIRECT_CHILD on _Type0, it already has Visibility: LOCAL');
         });
 
         it('should allow child injector to see types declared at parent injector', () {