Merge pull request angular-ui#399 from angular-ui/decorators

Decorator API

Author: nateabele

src/state.js

@@ -102,7 +102,9 @@ function $StateProvider(   $urlRouterProvider,   $urlMatcherFactory,           $
       var includes = state.parent ? extend({}, state.parent.includes) : {};
       includes[state.name] = true;
       return includes;
-    }
+    },
+
+    $delegates: {}
   };
 
   function isRelative(stateName) {
@@ -155,7 +157,7 @@ function $StateProvider(   $urlRouterProvider,   $urlMatcherFactory,           $
     if (states[name]) throw new Error("State '" + name + "'' is already defined");
 
     for (var key in stateBuilder) {
-      state[key] = stateBuilder[key](state);
+      if (isFunction(stateBuilder[key])) state[key] = stateBuilder[key](state, stateBuilder.$delegates[key]);
     }
     states[name] = state;
 
@@ -181,6 +183,25 @@ function $StateProvider(   $urlRouterProvider,   $urlMatcherFactory,           $
   root.navigable = null;
 
 
+  // .decorator()
+  // .decorator(name)
+  // .decorator(name, function)
+  this.decorator = decorator;
+  function decorator(name, func) {
+    /*jshint validthis: true */
+    if (isString(name) && !isDefined(func)) {
+      return stateBuilder[name];
+    }
+    if (!isFunction(func) || !isString(name)) {
+      return this;
+    }
+    if (stateBuilder[name] && !stateBuilder.$delegates[name]) {
+      stateBuilder.$delegates[name] = stateBuilder[name];
+    }
+    stateBuilder[name] = func;
+    return this;
+  }
+
   // .state(state)
   // .state(name, state)
   this.state = state;

test/stateSpec.js

@@ -1,6 +1,6 @@
 describe('state', function () {
 
-  var locationProvider, templateParams;
+  var stateProvider, locationProvider, templateParams;
 
   beforeEach(module('ui.router', function($locationProvider) {
     locationProvider = $locationProvider;
@@ -33,6 +33,7 @@ describe('state', function () {
       state.onEnter = callbackLogger('onEnter');
       state.onExit = callbackLogger('onExit');
     });
+    stateProvider = $stateProvider;
 
     $stateProvider
       .state('A', A)
@@ -501,4 +502,60 @@ describe('state', function () {
       expect(templateParams).toEqual({ item: "foo" });
     }));
   });
+
+  describe('provider decorators', function () {
+
+    it('should return built-in decorators', function () {
+      expect(stateProvider.decorator('parent')({ parent: A }).self.name).toBe("A");
+    });
+
+    it('should allow built-in decorators to be overridden', inject(function ($state, $q) {
+      stateProvider.decorator('data', function(state) {
+        return angular.extend(state.data || {}, { foo: "bar" });
+      });
+      stateProvider.state('AA', { parent: A, data: { baz: "true" } });
+
+      $state.transitionTo('AA');
+      $q.flush();
+      expect($state.current.data).toEqual({ baz: 'true', foo: 'bar' });
+    }));
+
+    it('should allow new decorators to be added', inject(function ($state, $q) {
+      stateProvider.decorator('custom', function(state) {
+        return function() { return "Custom functionality for state '" + state + "'" };
+      });
+      stateProvider.state('decoratorTest', {});
+
+      $state.transitionTo('decoratorTest');
+      $q.flush();
+      expect($state.$current.custom()).toBe("Custom functionality for state 'decoratorTest'");
+    }));
+
+    it('should allow built-in decorators to be extended', inject(function ($state, $q, $httpBackend) {
+      stateProvider.decorator('views', function(state, parent) {
+        var result = {};
+
+        angular.forEach(parent(state), function(config, name) {
+          result[name] = angular.extend(config, { templateProvider: function() {
+            return "Template for " + name;
+          }});
+        });
+        return result;
+      });
+
+      stateProvider.state('viewTest', {
+        views: {
+          viewA: {},
+          viewB: {}
+        }
+      });
+
+      $state.transitionTo('viewTest');
+      $q.flush();
+
+      expect($state.$current.views['viewA@'].templateProvider()).toBe('Template for viewA@');
+      expect($state.$current.views['viewB@'].templateProvider()).toBe('Template for viewB@');
+    }));
+
+  });
 });