added path functionality

Author: benmarch

app/tour_controller.js

@@ -3,11 +3,13 @@
 (function angularBootstrapTour(app) {
     'use strict';
 
-    app.controller('TourController', ['$filter', function ($filter) {
+    app.controller('TourController', ['$filter', '$timeout', function ($filter, $timeout) {
 
         var self = this,
             steps = [],
-            tour;
+            tour,
+            newStepFound = angular.noop,
+            dummyStep = {};
 
         /**
          * Sorts steps based on "order" and set next and prev options appropriately
@@ -30,6 +32,20 @@
          * As steps are linked, add them to the tour options
          */
         self.refreshTour = function () {
+            //remove dummy steps that were previously added
+            steps = steps.filter(function (step) {
+                return step !== dummyStep;
+            });
+
+            //if the first or last step redirects to another page, BT needs a step (dummyStep)
+            if (steps[0] && steps[0].redirectPrev) {
+                steps.unshift(dummyStep);
+            }
+            if (steps[steps.length-1] && steps[steps.length-1].redirectNext) {
+                steps.push(dummyStep);
+            }
+
+            //refresh
             if (tour) {
                 tour._options.steps = [];
                 tour.addSteps(orderSteps(steps));
@@ -48,6 +64,7 @@
 
             steps.push(step);
             self.refreshTour();
+            newStepFound(step);
         };
 
         /**
@@ -73,6 +90,23 @@
             return steps;
         };
 
+        /**
+         * Tells the tour to pause while ngView loads
+         *
+         * @param waitForStep
+         */
+        self.waitFor = function (waitForStep) {
+            tour.end();
+            newStepFound = function (step) {
+                if (step.stepId === waitForStep) {
+                    tour.setCurrentStep(steps.indexOf(step));
+                    $timeout(function () {
+                        tour.start(true);
+                    });
+                }
+            };
+        };
+
         /**
          * Initialize the tour
          *

app/tour_helpers.js

@@ -5,7 +5,8 @@
 
     app.factory('TourHelpers', ['$templateCache', '$compile', 'TourConfig', function ($templateCache, $compile, TourConfig) {
 
-        var helpers = {};
+        var helpers = {},
+            safeApply;
 
         /**
          * Helper function that calls scope.$apply if a digest is not currently in progress
@@ -14,7 +15,7 @@
          * @param {$rootScope.Scope} scope
          * @param {Function} fn
          */
-        function safeApply(scope, fn) {
+        safeApply = helpers.safeApply = function(scope, fn) {
             var phase = scope.$$phase;
             if (phase === '$apply' || phase === '$digest') {
                 if (fn && (typeof(fn) === 'function')) {
@@ -23,7 +24,7 @@
             } else {
                 scope.$apply(fn);
             }
-        }
+        };
 
         /**
          * Compiles and links a template to the provided scope

app/tour_step_directive.js

@@ -4,7 +4,7 @@
     'use strict';
 
     function directive() {
-        return ['TourHelpers', 'TourConfig', function (TourHelpers, TourConfig) {
+        return ['TourHelpers', '$location', '$rootScope', function (TourHelpers, $location, $rootScope) {
 
             return {
                 restrict: 'EA',
@@ -14,14 +14,17 @@
 
                     //Assign required options
                     var step = {
-                            element: element
+                            element: element,
+                            stepId: attrs.tourStep
                         },
                         events = 'onShow onShown onHide onHidden onNext onPrev onPause onResume'.split(' '),
-                        options = 'content title path animation container placement backdrop redirect orphan reflex'.split(' ');
+                        options = 'content title path animation container placement backdrop redirect orphan reflex path nextStep prevStep nextPath prevPath'.split(' '),
+                        orderWatch,
+                        skipWatch;
 
                     //Pass interpolated values through
                     TourHelpers.attachInterpolatedValues(attrs, step, options);
-                    attrs.$observe(TourHelpers.getAttrName('order'), function (order) {
+                    orderWatch = attrs.$observe(TourHelpers.getAttrName('order'), function (order) {
                         step.order = !isNaN(order*1) ? order*1 : 0;
                         ctrl.refreshTour();
                     });
@@ -43,25 +46,46 @@
                         }
                         return skipped;
                     }
-                    scope.$watch(stepIsSkipped, function (skip) {
+                    skipWatch = scope.$watch(stepIsSkipped, function (skip) {
                         if (skip) {
                             ctrl.removeStep(step);
                         } else {
                             ctrl.addStep(step);
                         }
                     });
 
+                    scope.$on('$destroy', function () {
+                        ctrl.removeStep(step);
+                        orderWatch();
+                        skipWatch();
+                    });
+
                     //If there is an options argument passed, just use that instead
                     if (attrs[TourHelpers.getAttrName('options')]) {
                         angular.extend(step, scope.$eval(attrs[TourHelpers.getAttrName('options')]));
                     }
 
                     //set up redirects
-                    if (attrs[TourHelpers.getAttrName('path')]) {
-                        step.path = document.location.pathname + '#' + scope.$eval(TourHelpers.getAttrName('path'));
+                    function setRedirect(direction, path, targetName) {
+                        var oldHandler = step[direction];
+                        step[direction] = function (tour) {
+                            if (oldHandler) {
+                                oldHandler(tour);
+                            }
+                            ctrl.waitFor(targetName);
+
+                            TourHelpers.safeApply(scope, function () {
+                                $location.path(path);
+                            });
+                        };
+                    }
+                    if (step.nextPath) {
+                        step.redirectNext = true;
+                        setRedirect('onNext', step.nextPath, step.nextStep);
                     }
-                    if (attrs[TourHelpers.getAttrName('abspath')]) {
-                        step.path = scope.$eval(TourHelpers.getAttrName('abspath'));
+                    if (step.prevPath) {
+                        step.redirectPrev = true;
+                        setRedirect('onPrev', step.prevPath, step.prevStep);
                     }
 
                     //Add step to tour

bower.json

@@ -18,10 +18,15 @@
     "angular": "~1.2.23",
     "bootstrap-tour": "~0.9.3",
     "jquery": "1.11.1",
-    "bootstrap": "3.0.3"
+    "bootstrap": "3.0.3",
+    "angular-route": "1.2.16"
   },
   "devDependencies": {
     "html5shiv": "~3.7.2",
     "respond": "~1.4.2"
+  },
+  "resolutions": {
+    "angular": "1.2.16",
+    "angular-route": "1.2.16"
   }
 }