feat($breadcrumb): add a configuration property for skipping a state …

…in the breadcrumb

A state with 'data.ncyBreadcrumbSkip = true' is not included in the chain of states.

Closes #9

dist/angular-breadcrumb.js

@@ -1,4 +1,4 @@
-/*! angular-breadcrumb - v0.1.0 - 2014-05-01
+/*! angular-breadcrumb - v0.1.0 - 2014-05-08
 * https://github.com/ncuillery/angular-breadcrumb
 * Copyright (c) 2014 Nicolas Cuillery; Licensed MIT */
 
@@ -54,7 +54,12 @@ function $Breadcrumb() {
                     stateAlreadyInChain = true;
                 }
             });
-            if(!stateAlreadyInChain && !state.abstract) {
+
+            var skipStep = angular.isDefined(state.data) &&
+                state.data.ncyBreadcrumbSkip &&
+                !$$isInherited(state, 'ncyBreadcrumbSkip');
+
+            if(!stateAlreadyInChain && !state.abstract && !skipStep) {
                 // Insert at first or second index.
                 if(prefixStateInserted) {
                     chain.splice(1, 0, state);
@@ -125,7 +130,6 @@ function $Breadcrumb() {
             }
         };
     }];
-
 }
 
 function BreadcrumbDirective($interpolate, $breadcrumb, $rootScope) {
@@ -182,5 +186,4 @@ BreadcrumbDirective.$inject = ['$interpolate', '$breadcrumb', '$rootScope'];
 angular.module('ncy-angular-breadcrumb', ['ui.router.state'])
     .provider('$breadcrumb', $Breadcrumb)
     .directive('ncyBreadcrumb', BreadcrumbDirective);
-
 })(window, window.angular);

sample/app.js

@@ -75,6 +75,9 @@ angular.module('ncy-sample', ['ui.router.state', 'ui.bootstrap', 'ncy-angular-br
           }, function(result) {
             return $state.go("^");
           });
+        },
+        data: {
+            ncyBreadcrumbSkip: true
         }
       })
       .state('room', {

src/angular-breadcrumb.js

@@ -49,7 +49,12 @@ function $Breadcrumb() {
                     stateAlreadyInChain = true;
                 }
             });
-            if(!stateAlreadyInChain && !state.abstract) {
+
+            var skipStep = angular.isDefined(state.data) &&
+                state.data.ncyBreadcrumbSkip &&
+                !$$isInherited(state, 'ncyBreadcrumbSkip');
+
+            if(!stateAlreadyInChain && !state.abstract && !skipStep) {
                 // Insert at first or second index.
                 if(prefixStateInserted) {
                     chain.splice(1, 0, state);

test/mock/test-modules.js

@@ -8,7 +8,9 @@ angular.module('ncy-basic-conf', []).config(function($stateProvider) {
         .state('A', {url: '/a', data: {ncyBreadcrumbLabel: 'State A'}})
         .state('A.B', {url: '/b', data: {ncyBreadcrumbLabel: 'State B'}})
         .state('A.B.C', {url: '/c', data: {ncyBreadcrumbLabel: 'State C'}})
-        .state('D', {parent: 'A.B.C', url: '/d', data: {ncyBreadcrumbLabel: 'State D'}}); // Explicit parent
+        .state('D', {parent: 'A.B.C', url: '/d', data: {ncyBreadcrumbLabel: 'State D'}}) // Explicit parent
+        .state('D.E', {url: '/e', data: {ncyBreadcrumbLabel: 'State E', ncyBreadcrumbSkip: true}})
+        .state('D.E.F', {url: '/f', data: {ncyBreadcrumbLabel: 'State F'}});
 });
 
 /**

test/spec/service-basic-test.js

@@ -30,4 +30,17 @@ describe('Service with basic conf', function() {
         expect(statesChain[2].ncyBreadcrumbLink).toBe('#/a/b/c');
         expect(statesChain[3].ncyBreadcrumbLink).toBe('#/a/b/c/d');
     }));
+
+    it('should not return the step for E state', inject(function($breadcrumb) {
+        goToState('D.E');
+        var statesChain = $breadcrumb.getStatesChain();
+        expect(stringifyStateChain(statesChain)).toBe('A --> A.B --> A.B.C --> D');
+    }));
+
+    it('should have a 5-step route to F state (E skipped)', inject(function($breadcrumb) {
+        goToState('D.E.F');
+        var statesChain = $breadcrumb.getStatesChain();
+        expect(stringifyStateChain(statesChain)).toBe('A --> A.B --> A.B.C --> D --> D.E.F');
+    }));
+
 });