Version 1.2.0

- Deprecated `setNestedState` in favor of `state`, to match `$stateProvider`.
- Added support for chaining `state` calls.
- Updated dependencies

README.md

@@ -8,47 +8,52 @@ A helper module for AngularUI Router, which allows you to define your states as
 
 ## Usage
 ``` javascript
-angular.module('myApp', ['ui.router', 'ui.router.stateHelper'])
-	.config(function(stateHelperProvider){
-		stateHelperProvider.setNestedState({
-			name: 'root',
-			templateUrl: 'root.html',
-			children: [
-				{
-					name: 'contacts',
-					templateUrl: 'contacts.html',
-					children: [
-						{
-							name: 'list',
-							templateUrl: 'contacts.list.html'
-						}
-					]
-				},
-				{
-					name: 'products',
-					templateUrl: 'products.html',
-					children: [
-						{
-							name: 'list',
-							templateUrl: 'products.list.html'
-						}
-					]
-				}
-			]
-		});
-	});
+angular.module('myApp', [ 'ui.router', 'ui.router.stateHelper' ])
+    .config(function(stateHelperProvider){
+        stateHelperProvider
+            .state({
+                name: 'root',
+                templateUrl: 'root.html',
+                children: [
+                    {
+                        name: 'contacts',
+                        templateUrl: 'contacts.html',
+                        children: [
+                            {
+                                name: 'list',
+                                templateUrl: 'contacts.list.html'
+                            }
+                        ]
+                    },
+                    {
+                        name: 'products',
+                        templateUrl: 'products.html',
+                        children: [
+                            {
+                                name: 'list',
+                                templateUrl: 'products.list.html'
+                            }
+                        ]
+                    }
+                ]
+            })
+            .state({
+                name: 'rootSibling',
+                templateUrl: 'rootSibling.html'
+            });
+    });
 ```
 
 ## Options
 ### Dot notation name conversion
 By default, all state names are converted to use ui-router's dot notation (e.g. `parentStateName.childStateName`).
-This can be disabled by calling `.setNestedState()` with an optional second parameter of `true`.
+This can be disabled by calling `.state()` with an optional second parameter of `true`.
 For example:
 
 ``` javascript
 angular.module('myApp', ['ui.router', 'ui.router.stateHelper'])
 	.config(function(stateHelperProvider){
-		stateHelperProvider.setNestedState({
+		stateHelperProvider.state({
 			name: 'root',
 			templateUrl: 'root.html',
 			children: [
@@ -60,3 +65,6 @@ angular.module('myApp', ['ui.router', 'ui.router.stateHelper'])
 		}, true);
 	});
 ```
+
+## Name change
+Before 1.2.0 `.setNestedState` was used instead of `.state`. In 1.2.0 `setNestedState` was deprecated in favour of `.state`, and chaining was added. This makes it easier to switch between `$stateProvider` and `stateHelperProvider`.

bower.json

@@ -1,7 +1,7 @@
 {
   "name": "angular-ui-router.stateHelper",
   "main": "statehelper.js",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "homepage": "https://github.com/marklagendijk/ui-router.stateHelper",
   "authors": [
     "Mark Lagendijk <[email protected]>"
@@ -27,10 +27,10 @@
     "config"
   ],
   "dependencies": {
-    "angular": "~1.2.13",
-    "angular-ui-router": "~0.2.7"
+    "angular": ">=1.2.0",
+    "angular-ui-router": "~0.2.11"
   },
   "devDependencies": {
-    "angular-mocks": "~1.2.8"
+    "angular-mocks": ">=1.2.8"
   }
 }

gulpfile.js

@@ -1,5 +1,5 @@
 var gulp = require("gulp");
-var ngmin = require('gulp-ngmin');
+var ngmin = require('gulp-ng-annotate');
 var uglify = require("gulp-uglify");
 var rename = require("gulp-rename");
 var karma = require("gulp-karma");

package.json

@@ -1,17 +1,17 @@
 {
   "dependencies": {},
   "devDependencies": {
-    "karma": "~0.11.9",
+    "gulp": "~3.8.0",
+    "gulp-karma": "0.0.1",
+    "gulp-ng-annotate": "^0.3.3",
+    "gulp-rename": "~0.2.1",
+    "gulp-uglify": "~0.1.0",
+    "karma": "^0.12.24",
     "karma-chrome-launcher": "~0.1.2",
-    "karma-jasmine": "~0.1.5",
     "karma-firefox-launcher": "~0.1.3",
+    "karma-jasmine": "~0.1.5",
     "karma-phantomjs-launcher": "~0.1.1",
     "karma-requirejs": "~0.2.1",
-    "karma-script-launcher": "~0.1.0",
-    "gulp": "~3.3.0",
-    "gulp-uglify": "~0.1.0",
-    "gulp-karma": "0.0.1",
-    "gulp-rename": "~0.2.1",
-    "gulp-ngmin": "^0.1.2"
+    "karma-script-launcher": "~0.1.0"
   }
 }

statehelper.js

@@ -3,7 +3,7 @@
  * @author Mark Lagendijk <[email protected]>
  * @license MIT
  */
-angular.module('ui.router.stateHelper', ['ui.router'])
+angular.module('ui.router.stateHelper', [ 'ui.router' ])
     .provider('stateHelper', function($stateProvider){
         var self = this;
 
@@ -19,8 +19,8 @@ angular.module('ui.router.stateHelper', ['ui.router'])
          * @param {Array} [state.children] - An optional array of child states.
          * @param {Boolean} keepOriginalNames - An optional flag that prevents conversion of names to dot notation if true.
          */
-        this.setNestedState = function(state, keepOriginalNames){
-            if (!keepOriginalNames){
+        this.state = function(state, keepOriginalNames){
+            if(!keepOriginalNames){
                 fixStateName(state);
             }
             $stateProvider.state(state);
@@ -31,8 +31,12 @@ angular.module('ui.router.stateHelper', ['ui.router'])
                     self.setNestedState(childState, keepOriginalNames);
                 });
             }
+
+            return self;
         };
 
+        this.setNestedState = this.state;
+
         self.$get = angular.noop;
 
         /**
@@ -44,5 +48,4 @@ angular.module('ui.router.stateHelper', ['ui.router'])
                 state.name = state.parent.name + '.' + state.name;
             }
         }
-    })
-;
+    });

test/statehelperSpec.js

@@ -29,7 +29,7 @@ describe('ui-router.stateHelper', function(){
 		spyOn($stateProvider, 'state');
 	}));
 
-	describe('.setNestedState', function(){
+	describe('.state', function(){
         beforeEach(inject(function(){
             expectedState = {
                 name: 'root',
@@ -49,7 +49,7 @@ describe('ui-router.stateHelper', function(){
                 ]
             };
 
-            stateHelperProvider.setNestedState(rootState);
+            stateHelperProvider.state(rootState);
         }));
 
 		it('should set each state', function(){
@@ -67,9 +67,13 @@ describe('ui-router.stateHelper', function(){
 
 			expect($stateProvider.state.argsForCall[0][0]).toEqual(expectedState);
 		});
+
+        it('should return itself to support chaining', function(){
+            expect($stateProvider.state(rootState)).toBe($stateProvider);
+        })
 	});
 
-    describe('.setNestedState with keepOriginalNames set to true', function(){
+    describe('.state with keepOriginalNames set to true', function(){
         beforeEach(inject(function(){
             expectedState = {
                 name: 'root',
@@ -89,7 +93,7 @@ describe('ui-router.stateHelper', function(){
                 ]
             };
 
-            stateHelperProvider.setNestedState(rootState, true);
+            stateHelperProvider.state(rootState, true);
         }));
 
         it('should not convert names to dot notation, set parent references', function(){
@@ -104,6 +108,13 @@ describe('ui-router.stateHelper', function(){
             expect($stateProvider.state.argsForCall[0][0]).toEqual(expectedState);
         });
     });
+
+    describe('.setNestedState', function(){
+        it('should support .setNestedState as legacy name', function(){
+            stateHelperProvider.setNestedState(rootState);
+            expect($stateProvider.state.callCount).toBe(4);
+        });
+    });
 });