fixes #13: tour steps were not passing inherited properties to $uibTooltip

fixes #16: unregisters tours when their scopes are destroyed

Author: benmarch

app/tour-controller.js

@@ -3,7 +3,7 @@
 (function (app) {
     'use strict';
 
-    app.controller('uiTourController', ['$timeout', '$q', '$filter', 'TourConfig', 'uiTourBackdrop', 'uiTourService', function ($timeout, $q, $filter, TourConfig, uiTourBackdrop, uiTourService) {
+    app.controller('uiTourController', ['$timeout', '$q', '$filter', 'TourConfig', 'uiTourBackdrop', 'uiTourService', 'ezEventEmitter', function ($timeout, $q, $filter, TourConfig, uiTourBackdrop, uiTourService, EventEmitter) {
 
         var self = this,
             stepList = [],
@@ -17,6 +17,8 @@
             tourStatus = statuses.OFF,
             options = TourConfig.getAll();
 
+        EventEmitter.mixin(self);
+
         /**
          * Closer to $evalAsync, just resolves a promise
          * after the next digest cycle
@@ -300,8 +302,19 @@
             options = angular.extend(options, opts);
             self.options = options;
             uiTourService._registerTour(self);
+            self.initialized = true;
+            self.emit('init');
             return self;
         };
+
+        /**
+         * Unregisters with the tour service when tour is destroyed
+         *
+         * @protected
+         */
+        self.destroy = function () {
+            uiTourService._unregisterTour(self);
+        };
         //------------------ end Protected API ------------------
 
 

app/tour-directive.js

@@ -34,6 +34,10 @@
                 if (typeof tour.onReady === 'function') {
                     tour.onReady();
                 }
+
+                scope.$on('$destroy', function () {
+                    ctrl.destroy();
+                });
             }
         };
 

app/tour-helpers.js

@@ -42,6 +42,23 @@
             return string;
         }
 
+        /**
+         * This will attach the properties native to Angular UI Tooltips. If there is a tour-level value set
+         * for any of them, this passes that value along to the step
+         *
+         * @param {$rootScope.Scope} scope The tour step's scope
+         * @param {Attributes} attrs The tour step's Attributes
+         * @param {Object} step Represents the tour step object
+         * @param {Array} properties The list of Tooltip properties
+         */
+        helpers.attachTourConfigProperties = function (scope, attrs, step, properties) {
+            angular.forEach(properties, function (property) {
+                if (!attrs[helpers.getAttrName(property)] && angular.isDefined(step.config(property))) {
+                    attrs.$set(helpers.getAttrName(property), String(step.config(property)));
+                }
+            });
+        };
+
         /**
          * Helper function that attaches event handlers to options
          *

app/tour-service.js

@@ -39,12 +39,21 @@
          *
          * @protected
          * @param tour
-         * @private
          */
         service._registerTour = function (tour) {
             tours.push(tour);
         };
 
+        /**
+         * Used by uiTourController to remove a destroyed tour from the registry
+         *
+         * @protected
+         * @param tour
+         */
+        service._unregisterTour = function (tour) {
+            tours.splice(tours.indexOf(tour), 1);
+        };
+
         return service;
 
     }]);

app/tour-step-directive.js

@@ -37,14 +37,23 @@
                         },
                         events = 'onShow onShown onHide onHidden onNext onPrev'.split(' '),
                         options = 'content title animation placement backdrop orphan popupDelay popupCloseDelay fixed preventScrolling nextStep prevStep nextPath prevPath scrollOffset'.split(' '),
+                        tooltipAttrs = 'animation appendToBody placement popupDelay popupCloseDelay'.split(' '),
                         orderWatch,
                         enabledWatch;
 
+                    //Will add values to pass to $uibTooltip
+                    function configureInheritedProperties() {
+                        TourHelpers.attachTourConfigProperties(scope, attrs, step, tooltipAttrs, 'tourStep');
+                        tourStepLinker(scope, element, attrs);
+                    }
+
                     //Pass interpolated values through
                     TourHelpers.attachInterpolatedValues(attrs, step, options);
                     orderWatch = attrs.$observe(TourHelpers.getAttrName('order'), function (order) {
                         step.order = !isNaN(order*1) ? order*1 : 0;
-                        ctrl.reorderStep(step);
+                        if (ctrl.hasStep(step)) {
+                            ctrl.reorderStep(step);
+                        }
                     });
                     enabledWatch = attrs.$observe(TourHelpers.getAttrName('enabled'), function (isEnabled) {
                         step.enabled = isEnabled !== 'false';
@@ -81,10 +90,17 @@
                     step.trustedContent = $sce.trustAsHtml(step.content);
 
                     //Add step to tour
-                    ctrl.addStep(step);
                     scope.tourStep = step;
                     scope.tour = scope.tour || ctrl;
-                    tourStepLinker(scope, element, attrs);
+                    if (ctrl.initialized) {
+                        configureInheritedProperties();
+                        ctrl.addStep(step);
+                    } else {
+                        ctrl.once('init', function () {
+                            configureInheritedProperties();
+                            ctrl.addStep(step);
+                        });
+                    }
 
                     //clean up when element is destroyed
                     scope.$on('$destroy', function () {