bootstrap-tour-rails 0.0.1 → 0.4.0

data/lib/bootstrap-tour-rails/version.rb

@@ -1,7 +1,7 @@
 module Bootstrap
   module Tour
     module Rails
-      VERSION = "0.0.1"
+      VERSION = "0.4.0"
     end
   end
 end

data/vendor/assets/javascripts/bootstrap-tour/bootstrap-tour.js

@@ -1,10 +1,8 @@
-// Generated by CoffeeScript 1.4.0
-
-/* ============================================================
-# bootstrap-tour.js v0.1
-# http://pushly.github.com/bootstrap-tour/
+/* ===========================================================
+# bootstrap-tour - v0.4.0
+# http://bootstraptour.com
 # ==============================================================
-# Copyright 2012 Push.ly
+# Copyright 2012-2013 Ulrich Sossou
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,17 +16,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 */
-
-
 (function() {
-
   (function($, window) {
     var Tour, document;
     document = window.document;
     Tour = (function() {
-
       function Tour(options) {
-        var _this = this;
         this._options = $.extend({
           name: 'tour',
           labels: {
@@ -36,30 +29,44 @@
             next: 'Next »',
             prev: '« Prev'
           },
+          template: "<div class='popover tour'>            <div class='arrow'></div>            <h3 class='popover-title'></h3>            <div class='popover-content'></div>          </div>",
+          container: 'body',
           keyboard: true,
           useLocalStorage: false,
+          debug: false,
+          backdrop: false,
+          redirect: true,
+          basePath: '',
           afterSetState: function(key, value) {},
           afterGetState: function(key, value) {},
+          afterRemoveState: function(key) {},
           onStart: function(tour) {},
           onEnd: function(tour) {},
           onShow: function(tour) {},
+          onShown: function(tour) {},
           onHide: function(tour) {},
-          onShown: function(tour) {}
+          onHidden: function(tour) {},
+          onNext: function(tour) {},
+          onPrev: function(tour) {}
         }, options);
+        if (!this._options.useLocalStorage && !$.cookie) {
+          this._debug("jQuery.cookie is not loaded.");
+        }
         this._steps = [];
         this.setCurrentStep();
-        this._onresize(function() {
-          if (!_this.ended) {
-            return _this.showStep(_this._current);
-          }
-        });
+        this.backdrop = {
+          overlay: null,
+          step: null,
+          background: null
+        };
       }
 
       Tour.prototype.setState = function(key, value) {
+        key = "" + this._options.name + "_" + key;
         if (this._options.useLocalStorage) {
-          window.localStorage.setItem("" + this._options.name + "_" + key, value);
+          window.localStorage.setItem(key, value);
         } else {
-          $.cookie("" + this._options.name + "_" + key, value, {
+          $.cookie(key, value, {
             expires: 36500,
             path: '/'
           });
@@ -67,6 +74,18 @@
         return this._options.afterSetState(key, value);
       };
 
+      Tour.prototype.removeState = function(key) {
+        key = "" + this._options.name + "_" + key;
+        if (this._options.useLocalStorage) {
+          window.localStorage.removeItem(key);
+        } else {
+          $.removeCookie(key, {
+            path: '/'
+          });
+        }
+        return this._options.afterRemoveState(key);
+      };
+
       Tour.prototype.getState = function(key) {
         var value;
         if (this._options.useLocalStorage) {
@@ -74,10 +93,23 @@
         } else {
           value = $.cookie("" + this._options.name + "_" + key);
         }
+        if (value === void 0 || value === "null") {
+          value = null;
+        }
         this._options.afterGetState(key, value);
         return value;
       };
 
+      Tour.prototype.addSteps = function(steps) {
+        var step, _i, _len, _results;
+        _results = [];
+        for (_i = 0, _len = steps.length; _i < _len; _i++) {
+          step = steps[_i];
+          _results.push(this.addStep(step));
+        }
+        return _results;
+      };
+
       Tour.prototype.addStep = function(step) {
         return this._steps.push(step);
       };
@@ -89,23 +121,32 @@
             placement: "right",
             title: "",
             content: "",
+            id: "step-" + i,
             next: i === this._steps.length - 1 ? -1 : i + 1,
             prev: i - 1,
             animation: true,
+            backdrop: this._options.backdrop,
+            redirect: this._options.redirect,
             onShow: this._options.onShow,
+            onShown: this._options.onShown,
             onHide: this._options.onHide,
-            onShown: this._options.onShown
+            onHidden: this._options.onHidden,
+            onNext: this._options.onNext,
+            onPrev: this._options.onPrev,
+            template: this._options.template,
+            container: this._options.container
           }, this._steps[i]);
         }
       };
 
       Tour.prototype.start = function(force) {
-        var _this = this;
+        var promise,
+          _this = this;
         if (force == null) {
           force = false;
         }
         if (this.ended() && !force) {
-          return;
+          return this._debug("Tour ended, start prevented.");
         }
         $(document).off("click.bootstrap-tour", ".popover .next").on("click.bootstrap-tour", ".popover .next", function(e) {
           e.preventDefault();
@@ -119,30 +160,41 @@
           e.preventDefault();
           return _this.end();
         });
+        this._onresize(function() {
+          return _this.showStep(_this._current);
+        });
         this._setupKeyboardNavigation();
-        if (this._options.onStart != null) {
-          this._options.onStart(this);
-        }
-        return this.showStep(this._current);
+        promise = this._makePromise(this._options.onStart != null ? this._options.onStart(this) : void 0);
+        return this._callOnPromiseDone(promise, this.showStep, this._current);
       };
 
       Tour.prototype.next = function() {
-        this.hideStep(this._current);
-        return this.showNextStep();
+        var promise;
+        promise = this.hideStep(this._current);
+        return this._callOnPromiseDone(promise, this.showNextStep);
       };
 
       Tour.prototype.prev = function() {
-        this.hideStep(this._current);
-        return this.showPrevStep();
+        var promise;
+        promise = this.hideStep(this._current);
+        return this._callOnPromiseDone(promise, this.showPrevStep);
       };
 
       Tour.prototype.end = function() {
-        this.hideStep(this._current);
-        $(document).off(".bootstrap-tour");
-        this.setState("end", "yes");
-        if (this._options.onEnd != null) {
-          return this._options.onEnd(this);
-        }
+        var endHelper, hidePromise,
+          _this = this;
+        endHelper = function(e) {
+          $(document).off("click.bootstrap-tour");
+          $(document).off("keyup.bootstrap-tour");
+          $(window).off("resize.bootstrap-tour");
+          _this.setState("end", "yes");
+          _this._hideBackdrop();
+          if (_this._options.onEnd != null) {
+            return _this._options.onEnd(_this);
+          }
+        };
+        hidePromise = this.hideStep(this._current);
+        return this._callOnPromiseDone(hidePromise, endHelper);
       };
 
       Tour.prototype.ended = function() {
@@ -150,43 +202,66 @@
       };
 
       Tour.prototype.restart = function() {
-        this.setState("current_step", null);
-        this.setState("end", null);
+        this.removeState("current_step");
+        this.removeState("end");
         this.setCurrentStep(0);
         return this.start();
       };
 
       Tour.prototype.hideStep = function(i) {
-        var step;
+        var hideStepHelper, promise, step,
+          _this = this;
         step = this.getStep(i);
-        if (step.onHide != null) {
-          step.onHide(this);
-        }
-        return $(step.element).popover("hide");
+        promise = this._makePromise((step.onHide != null ? step.onHide(this) : void 0));
+        hideStepHelper = function(e) {
+          var $element;
+          $element = $(step.element).popover("hide");
+          if (step.reflex) {
+            $element.css("cursor", "").off("click.boostrap-tour");
+          }
+          if (step.backdrop) {
+            _this._hideBackdrop();
+          }
+          if (step.onHidden != null) {
+            return step.onHidden(_this);
+          }
+        };
+        this._callOnPromiseDone(promise, hideStepHelper);
+        return promise;
       };
 
       Tour.prototype.showStep = function(i) {
-        var step;
+        var promise, showStepHelper, step,
+          _this = this;
         step = this.getStep(i);
         if (!step) {
           return;
         }
-        this.setCurrentStep(i);
-        if (step.path !== "" && document.location.pathname !== step.path && document.location.pathname.replace(/^.*[\\\/]/, '') !== step.path) {
-          document.location.href = step.path;
-          return;
-        }
-        if (step.onShow != null) {
-          step.onShow(this);
-        }
-        if (!((step.element != null) && $(step.element).length !== 0 && $(step.element).is(":visible"))) {
-          this.showNextStep();
-          return;
-        }
-        this._showPopover(step, i);
-        if (step.onShown != null) {
-          return step.onShown(this);
-        }
+        promise = this._makePromise((step.onShow != null ? step.onShow(this) : void 0));
+        showStepHelper = function(e) {
+          var current_path, path;
+          _this.setCurrentStep(i);
+          path = typeof step.path === "function" ? step.path.call() : _this._options.basePath + step.path;
+          current_path = [document.location.pathname, document.location.hash].join('');
+          if (_this._isRedirect(path, current_path)) {
+            _this._redirect(step, path);
+            return;
+          }
+          if (!((step.element != null) && $(step.element).length !== 0 && $(step.element).is(":visible"))) {
+            _this._debug("Skip the step " + (_this._current + 1) + ". The element does not exist or is not visible.");
+            _this.showNextStep();
+            return;
+          }
+          if (step.backdrop) {
+            _this._showBackdrop(step.element);
+          }
+          _this._showPopover(step, i);
+          if (step.onShown != null) {
+            step.onShown(_this);
+          }
+          return _this._debug("Step " + (_this._current + 1) + " of " + _this._steps.length);
+        };
+        return this._callOnPromiseDone(promise, showStepHelper);
       };
 
       Tour.prototype.setCurrentStep = function(value) {
@@ -195,7 +270,7 @@
           return this.setState("current_step", value);
         } else {
           this._current = this.getState("current_step");
-          if (this._current === null || this._current === "null") {
+          if (this._current === null) {
             return this._current = 0;
           } else {
             return this._current = parseInt(this._current);
@@ -204,19 +279,61 @@
       };
 
       Tour.prototype.showNextStep = function() {
-        var step;
+        var promise, showNextStepHelper, step,
+          _this = this;
         step = this.getStep(this._current);
-        return this.showStep(step.next);
+        showNextStepHelper = function(e) {
+          return _this.showStep(step.next);
+        };
+        promise = this._makePromise((step.onNext != null ? step.onNext(this) : void 0));
+        return this._callOnPromiseDone(promise, showNextStepHelper);
       };
 
       Tour.prototype.showPrevStep = function() {
-        var step;
+        var promise, showPrevStepHelper, step,
+          _this = this;
         step = this.getStep(this._current);
-        return this.showStep(step.prev);
+        showPrevStepHelper = function(e) {
+          return _this.showStep(step.prev);
+        };
+        promise = this._makePromise((step.onPrev != null ? step.onPrev(this) : void 0));
+        return this._callOnPromiseDone(promise, showPrevStepHelper);
+      };
+
+      Tour.prototype._debug = function(text) {
+        if (this._options.debug) {
+          return window.console.log("Bootstrap Tour '" + this._options.name + "' | " + text);
+        }
+      };
+
+      Tour.prototype._isRedirect = function(path, currentPath) {
+        return (path != null) && path !== "" && path.replace(/\?.*$/, "").replace(/\/?$/, "") !== currentPath.replace(/\/?$/, "");
+      };
+
+      Tour.prototype._redirect = function(step, path) {
+        if (typeof step.redirect === 'function') {
+          return step.redirect.call(this, path);
+        } else if (step.redirect === true) {
+          this._debug("Redirect to " + path);
+          return document.location.href = path;
+        }
+      };
+
+      Tour.prototype._renderNavigation = function(step, options) {
+        var content, nav;
+        nav = [];
+        if (step.prev >= 0) {
+          nav.push("<a href='#" + step.prev + "' class='prev'>" + options.labels.prev + "</a>");
+        }
+        if (step.next >= 0) {
+          nav.push("<a href='#" + step.next + "' class='next'>" + options.labels.next + "</a>");
+        }
+        content = nav.join(" | ");
+        return content += "<a href='#' class='pull-right end'>" + options.labels.end + "</a>";
       };
 
       Tour.prototype._showPopover = function(step, i) {
-        var content, nav, options, tip,
+        var $tip, content, options,
           _this = this;
         content = "" + step.content + "<br /><p>";
         options = $.extend({}, this._options);
@@ -224,42 +341,39 @@
           $.extend(options, step.options);
         }
         if (step.reflex) {
-          $(step.element).css("cursor", "pointer");
-          $(step.element).on("click", function(e) {
-            $(step.element).css("cursor", "auto");
+          $(step.element).css("cursor", "pointer").on("click.bootstrap-tour", function(e) {
             return _this.next();
           });
         }
-        nav = [];
-        if (step.prev >= 0) {
-          nav.push("<a href='#" + step.prev + "' class='prev'>" + options.labels.prev + "</a>");
-        }
-        if (step.next >= 0) {
-          nav.push("<a href='#" + step.next + "' class='next'>" + options.labels.next + "</a>");
-        }
-        content += nav.join(" | ");
-        content += "<a href='#' class='pull-right end'>" + options.labels.end + "</a>";
+        content += this._renderNavigation(step, options);
         $(step.element).popover('destroy').popover({
           placement: step.placement,
           trigger: "manual",
           title: step.title,
           content: content,
           html: true,
-          animation: step.animation
+          animation: step.animation,
+          container: step.container,
+          template: step.template
         }).popover("show");
-        tip = $(step.element).data("popover").tip();
-        this._reposition(tip);
-        return this._scrollIntoView(tip);
+        $tip = $(step.element).data("popover").tip();
+        $tip.attr("id", step.id);
+        this._reposition($tip, step);
+        return this._scrollIntoView($tip);
       };
 
-      Tour.prototype._reposition = function(tip) {
-        var offsetBottom, offsetRight, tipOffset;
+      Tour.prototype._reposition = function(tip, step) {
+        var offsetBottom, offsetRight, original_left, original_offsetHeight, original_offsetWidth, original_top, tipOffset;
+        original_offsetWidth = tip[0].offsetWidth;
+        original_offsetHeight = tip[0].offsetHeight;
         tipOffset = tip.offset();
+        original_left = tipOffset.left;
+        original_top = tipOffset.top;
         offsetBottom = $(document).outerHeight() - tipOffset.top - $(tip).outerHeight();
         if (offsetBottom < 0) {
           tipOffset.top = tipOffset.top + offsetBottom;
         }
-        offsetRight = $(document).outerWidth() - tipOffset.left - $(tip).outerWidth();
+        offsetRight = $("html").outerWidth() - tipOffset.left - $(tip).outerWidth();
         if (offsetRight < 0) {
           tipOffset.left = tipOffset.left + offsetRight;
         }
@@ -269,19 +383,32 @@
         if (tipOffset.left < 0) {
           tipOffset.left = 0;
         }
-        return tip.offset(tipOffset);
+        tip.offset(tipOffset);
+        if (step.placement === 'bottom' || step.placement === 'top') {
+          if (original_left !== tipOffset.left) {
+            return this._replaceArrow(tip, (tipOffset.left - original_left) * 2, original_offsetWidth, 'left');
+          }
+        } else {
+          if (original_top !== tipOffset.top) {
+            return this._replaceArrow(tip, (tipOffset.top - original_top) * 2, original_offsetHeight, 'top');
+          }
+        }
+      };
+
+      Tour.prototype._replaceArrow = function(tip, delta, dimension, position) {
+        return tip.find(".arrow").css(position, delta ? 50 * (1 - delta / dimension) + "%" : '');
       };
 
       Tour.prototype._scrollIntoView = function(tip) {
         var tipRect;
         tipRect = tip.get(0).getBoundingClientRect();
-        if (!(tipRect.top > 0 && tipRect.bottom < $(window).height() && tipRect.left > 0 && tipRect.right < $(window).width())) {
+        if (!(tipRect.top >= 0 && tipRect.bottom < $(window).height() && tipRect.left >= 0 && tipRect.right < $(window).width())) {
           return tip.get(0).scrollIntoView(true);
         }
       };
 
       Tour.prototype._onresize = function(cb, timeout) {
-        return $(window).resize(function() {
+        return $(window).on("resize.bootstrap-tour", function() {
           clearTimeout(timeout);
           return timeout = setTimeout(cb, 100);
         });
@@ -299,6 +426,8 @@
                 e.preventDefault();
                 if (_this._current < _this._steps.length - 1) {
                   return _this.next();
+                } else {
+                  return _this.end();
                 }
                 break;
               case 37:
@@ -306,11 +435,84 @@
                 if (_this._current > 0) {
                   return _this.prev();
                 }
+                break;
+              case 27:
+                e.preventDefault();
+                return _this.end();
             }
           });
         }
       };
 
+      Tour.prototype._makePromise = function(result) {
+        if (result && $.isFunction(result.then)) {
+          return result;
+        } else {
+          return null;
+        }
+      };
+
+      Tour.prototype._callOnPromiseDone = function(promise, cb, arg) {
+        var _this = this;
+        if (promise) {
+          return promise.then(function(e) {
+            return cb.call(_this, arg);
+          });
+        } else {
+          return cb.call(this, arg);
+        }
+      };
+
+      Tour.prototype._showBackdrop = function(el) {
+        if (this.backdrop.overlay !== null) {
+          return;
+        }
+        this._showOverlay();
+        return this._showOverlayElement(el);
+      };
+
+      Tour.prototype._hideBackdrop = function() {
+        if (this.backdrop.overlay === null) {
+          return;
+        }
+        this._hideOverlayElement();
+        return this._hideOverlay();
+      };
+
+      Tour.prototype._showOverlay = function() {
+        this.backdrop = $('<div/>');
+        this.backdrop.addClass('tour-backdrop');
+        this.backdrop.height($(document).innerHeight());
+        return $('body').append(this.backdrop);
+      };
+
+      Tour.prototype._hideOverlay = function() {
+        this.backdrop.remove();
+        return this.backdrop.overlay = null;
+      };
+
+      Tour.prototype._showOverlayElement = function(el) {
+        var background, offset, padding, step;
+        step = $(el);
+        padding = 5;
+        offset = step.offset();
+        offset.top = offset.top - padding;
+        offset.left = offset.left - padding;
+        background = $('<div/>');
+        background.width(step.innerWidth() + padding).height(step.innerHeight() + padding).addClass('tour-step-background').offset(offset);
+        step.addClass('tour-step-backdrop');
+        $('body').append(background);
+        this.backdrop.step = step;
+        return this.backdrop.background = background;
+      };
+
+      Tour.prototype._hideOverlayElement = function() {
+        this.backdrop.step.removeClass('tour-step-backdrop');
+        this.backdrop.background.remove();
+        this.backdrop.step = null;
+        return this.backdrop.background = null;
+      };
+
       return Tour;
 
     })();

data/vendor/assets/stylesheets/bootstrap-tour/bootstrap-tour.css

@@ -0,0 +1,19 @@
+.tour-backdrop {
+  position: absolute;
+  z-index: 1009;
+  background: #000;
+  opacity: 0.8;
+  top: 0;
+  left: 0;
+  width: 100%;
+}
+.tour-step-backdrop {
+  position: relative;
+  z-index: 1011;
+}
+.tour-step-background {
+  position: absolute;
+  z-index: 1010;
+  background: #fff;
+  border-radius: 6px;
+}

metadata

@@ -1,23 +1,33 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: bootstrap-tour-rails
-version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
-authors:
+authors: 
 - Tien Le
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+
+date: 2013-06-27 00:00:00 +07:00
+default_executable: 
 dependencies: []
+
 description: Quick and easy product tours with Twitter Bootstrap Popovers.
-email:
+email: 
 - tienlx@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE
@@ -29,29 +39,36 @@ files:
 - vendor/assets/javascripts/bootstrap-tour/bootstrap-tour.js
 - vendor/assets/javascripts/bootstrap-tour/index.js
 - vendor/assets/javascripts/bootstrap-tour/jquery.cookie.js
+- vendor/assets/stylesheets/bootstrap-tour/bootstrap-tour.css
+has_rdoc: true
 homepage: https://github.com/tienle/bootstrap-tour-rails
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Bootstrap tour is a plugin for Bootstrap. It provides quick and easy product
-  tours with Twitter Bootstrap Popovers.
+summary: Bootstrap tour is a plugin for Bootstrap. It provides quick and easy product tours with Twitter Bootstrap Popovers.
 test_files: []
+