bootstrap-tour-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bootstrap-tour-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tien Le
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Bootstrap::Tour::Rails
+
+Bootstrap is a toolkit from Twitter designed to kickstart development of webapps
+and sites. It includes base CSS and HTML for typography, forms, buttons, tables,
+grids, navigation, and more.
+
+    http://twitter.github.com/bootstrap/
+
+Bootstrap tour is a plugin for Bootstrap. It provides quick and easy product
+tours with Twitter Bootstrap Popovers.
+
+    https://github.com/sorich87/bootstrap-tour
+
+Bootstrap-tour-rails project integrates it with Rails 3.1+ assets
+pipeline.
+
+    https://github.com/tienle/bootstrap-tour-rails
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bootstrap-tour-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bootstrap-tour-rails
+
+
+Assumes that you already have `bootstrap` and `jquery`.
+
+## Configuration
+
+Add necessary javascript(s) files to app/assets/javascripts/application.js
+
+```javascript
+//= require bootstrap-tour
+```
+
+You may need to restart your rails server.
+
+## Usage
+
+Reference here: http://sorich87.github.com/bootstrap-tour/index.html
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bootstrap-tour-rails.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bootstrap-tour-rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tien Le"]
+  gem.email         = ["tienlx@gmail.com"]
+  gem.description   = %q{Quick and easy product tours with Twitter Bootstrap Popovers.}
+  gem.summary       = %q{ Bootstrap tour is a plugin for Bootstrap. It provides quick and easy product tours with Twitter Bootstrap Popovers.}
+  gem.homepage      = "https://github.com/tienle/bootstrap-tour-rails"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "bootstrap-tour-rails"
+  gem.require_paths = ["lib"]
+  gem.version       = Bootstrap::Tour::Rails::VERSION
+end

data/lib/bootstrap-tour-rails.rb

@@ -0,0 +1,14 @@
+require 'rails'
+require 'bootstrap-tour-rails/version'
+
+module Bootstrap
+  module Tour
+    module Rails
+      class Engine < ::Rails::Engine
+        initializer "BootstrapTourRails precompile hook", :group => :all do |app|
+          app.config.assets.precompile += %w(bootstrap-tour.js)
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,320 @@
+// Generated by CoffeeScript 1.4.0
+
+/* ============================================================
+# bootstrap-tour.js v0.1
+# http://pushly.github.com/bootstrap-tour/
+# ==============================================================
+# Copyright 2012 Push.ly
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# 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: {
+            end: 'End tour',
+            next: 'Next »',
+            prev: '« Prev'
+          },
+          keyboard: true,
+          useLocalStorage: false,
+          afterSetState: function(key, value) {},
+          afterGetState: function(key, value) {},
+          onStart: function(tour) {},
+          onEnd: function(tour) {},
+          onShow: function(tour) {},
+          onHide: function(tour) {},
+          onShown: function(tour) {}
+        }, options);
+        this._steps = [];
+        this.setCurrentStep();
+        this._onresize(function() {
+          if (!_this.ended) {
+            return _this.showStep(_this._current);
+          }
+        });
+      }
+
+      Tour.prototype.setState = function(key, value) {
+        if (this._options.useLocalStorage) {
+          window.localStorage.setItem("" + this._options.name + "_" + key, value);
+        } else {
+          $.cookie("" + this._options.name + "_" + key, value, {
+            expires: 36500,
+            path: '/'
+          });
+        }
+        return this._options.afterSetState(key, value);
+      };
+
+      Tour.prototype.getState = function(key) {
+        var value;
+        if (this._options.useLocalStorage) {
+          value = window.localStorage.getItem("" + this._options.name + "_" + key);
+        } else {
+          value = $.cookie("" + this._options.name + "_" + key);
+        }
+        this._options.afterGetState(key, value);
+        return value;
+      };
+
+      Tour.prototype.addStep = function(step) {
+        return this._steps.push(step);
+      };
+
+      Tour.prototype.getStep = function(i) {
+        if (this._steps[i] != null) {
+          return $.extend({
+            path: "",
+            placement: "right",
+            title: "",
+            content: "",
+            next: i === this._steps.length - 1 ? -1 : i + 1,
+            prev: i - 1,
+            animation: true,
+            onShow: this._options.onShow,
+            onHide: this._options.onHide,
+            onShown: this._options.onShown
+          }, this._steps[i]);
+        }
+      };
+
+      Tour.prototype.start = function(force) {
+        var _this = this;
+        if (force == null) {
+          force = false;
+        }
+        if (this.ended() && !force) {
+          return;
+        }
+        $(document).off("click.bootstrap-tour", ".popover .next").on("click.bootstrap-tour", ".popover .next", function(e) {
+          e.preventDefault();
+          return _this.next();
+        });
+        $(document).off("click.bootstrap-tour", ".popover .prev").on("click.bootstrap-tour", ".popover .prev", function(e) {
+          e.preventDefault();
+          return _this.prev();
+        });
+        $(document).off("click.bootstrap-tour", ".popover .end").on("click.bootstrap-tour", ".popover .end", function(e) {
+          e.preventDefault();
+          return _this.end();
+        });
+        this._setupKeyboardNavigation();
+        if (this._options.onStart != null) {
+          this._options.onStart(this);
+        }
+        return this.showStep(this._current);
+      };
+
+      Tour.prototype.next = function() {
+        this.hideStep(this._current);
+        return this.showNextStep();
+      };
+
+      Tour.prototype.prev = function() {
+        this.hideStep(this._current);
+        return 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);
+        }
+      };
+
+      Tour.prototype.ended = function() {
+        return !!this.getState("end");
+      };
+
+      Tour.prototype.restart = function() {
+        this.setState("current_step", null);
+        this.setState("end", null);
+        this.setCurrentStep(0);
+        return this.start();
+      };
+
+      Tour.prototype.hideStep = function(i) {
+        var step;
+        step = this.getStep(i);
+        if (step.onHide != null) {
+          step.onHide(this);
+        }
+        return $(step.element).popover("hide");
+      };
+
+      Tour.prototype.showStep = function(i) {
+        var step;
+        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);
+        }
+      };
+
+      Tour.prototype.setCurrentStep = function(value) {
+        if (value != null) {
+          this._current = value;
+          return this.setState("current_step", value);
+        } else {
+          this._current = this.getState("current_step");
+          if (this._current === null || this._current === "null") {
+            return this._current = 0;
+          } else {
+            return this._current = parseInt(this._current);
+          }
+        }
+      };
+
+      Tour.prototype.showNextStep = function() {
+        var step;
+        step = this.getStep(this._current);
+        return this.showStep(step.next);
+      };
+
+      Tour.prototype.showPrevStep = function() {
+        var step;
+        step = this.getStep(this._current);
+        return this.showStep(step.prev);
+      };
+
+      Tour.prototype._showPopover = function(step, i) {
+        var content, nav, options, tip,
+          _this = this;
+        content = "" + step.content + "<br /><p>";
+        options = $.extend({}, this._options);
+        if (step.options) {
+          $.extend(options, step.options);
+        }
+        if (step.reflex) {
+          $(step.element).css("cursor", "pointer");
+          $(step.element).on("click", function(e) {
+            $(step.element).css("cursor", "auto");
+            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>";
+        $(step.element).popover('destroy').popover({
+          placement: step.placement,
+          trigger: "manual",
+          title: step.title,
+          content: content,
+          html: true,
+          animation: step.animation
+        }).popover("show");
+        tip = $(step.element).data("popover").tip();
+        this._reposition(tip);
+        return this._scrollIntoView(tip);
+      };
+
+      Tour.prototype._reposition = function(tip) {
+        var offsetBottom, offsetRight, tipOffset;
+        tipOffset = tip.offset();
+        offsetBottom = $(document).outerHeight() - tipOffset.top - $(tip).outerHeight();
+        if (offsetBottom < 0) {
+          tipOffset.top = tipOffset.top + offsetBottom;
+        }
+        offsetRight = $(document).outerWidth() - tipOffset.left - $(tip).outerWidth();
+        if (offsetRight < 0) {
+          tipOffset.left = tipOffset.left + offsetRight;
+        }
+        if (tipOffset.top < 0) {
+          tipOffset.top = 0;
+        }
+        if (tipOffset.left < 0) {
+          tipOffset.left = 0;
+        }
+        return tip.offset(tipOffset);
+      };
+
+      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())) {
+          return tip.get(0).scrollIntoView(true);
+        }
+      };
+
+      Tour.prototype._onresize = function(cb, timeout) {
+        return $(window).resize(function() {
+          clearTimeout(timeout);
+          return timeout = setTimeout(cb, 100);
+        });
+      };
+
+      Tour.prototype._setupKeyboardNavigation = function() {
+        var _this = this;
+        if (this._options.keyboard) {
+          return $(document).on("keyup.bootstrap-tour", function(e) {
+            if (!e.which) {
+              return;
+            }
+            switch (e.which) {
+              case 39:
+                e.preventDefault();
+                if (_this._current < _this._steps.length - 1) {
+                  return _this.next();
+                }
+                break;
+              case 37:
+                e.preventDefault();
+                if (_this._current > 0) {
+                  return _this.prev();
+                }
+            }
+          });
+        }
+      };
+
+      return Tour;
+
+    })();
+    return window.Tour = Tour;
+  })(jQuery, window);
+
+}).call(this);

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

@@ -0,0 +1,2 @@
+//= require ./jquery.cookie
+//= require ./bootstrap-tour

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

@@ -0,0 +1,90 @@
+/*!
+ * jQuery Cookie Plugin v1.3.1
+ * https://github.com/carhartl/jquery-cookie
+ *
+ * Copyright 2013 Klaus Hartl
+ * Released under the MIT license
+ */
+(function ($, document, undefined) {
+
+    var pluses = /\+/g;
+
+    function raw(s) {
+        return s;
+    }
+
+    function decoded(s) {
+        return unRfc2068(decodeURIComponent(s.replace(pluses, ' ')));
+    }
+
+    function unRfc2068(value) {
+        if (value.indexOf('"') === 0) {
+            // This is a quoted cookie as according to RFC2068, unescape
+            value = value.slice(1, -1).replace(/\\"/g, '"').replace(/\\\\/g, '\\');
+        }
+        return value;
+    }
+
+    function fromJSON(value) {
+        return config.json ? JSON.parse(value) : value;
+    }
+
+    var config = $.cookie = function (key, value, options) {
+
+        // write
+        if (value !== undefined) {
+            options = $.extend({}, config.defaults, options);
+
+            if (value === null) {
+                options.expires = -1;
+            }
+
+            if (typeof options.expires === 'number') {
+                var days = options.expires, t = options.expires = new Date();
+                t.setDate(t.getDate() + days);
+            }
+
+            value = config.json ? JSON.stringify(value) : String(value);
+
+            return (document.cookie = [
+                encodeURIComponent(key), '=', config.raw ? value : encodeURIComponent(value),
+                options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
+                options.path    ? '; path=' + options.path : '',
+                options.domain  ? '; domain=' + options.domain : '',
+                options.secure  ? '; secure' : ''
+            ].join(''));
+        }
+
+        // read
+        var decode = config.raw ? raw : decoded;
+        var cookies = document.cookie.split('; ');
+        var result = key ? null : {};
+        for (var i = 0, l = cookies.length; i < l; i++) {
+            var parts = cookies[i].split('=');
+            var name = decode(parts.shift());
+            var cookie = decode(parts.join('='));
+
+            if (key && key === name) {
+                result = fromJSON(cookie);
+                break;
+            }
+
+            if (!key) {
+                result[name] = fromJSON(cookie);
+            }
+        }
+
+        return result;
+    };
+
+    config.defaults = {};
+
+    $.removeCookie = function (key, options) {
+        if ($.cookie(key) !== null) {
+            $.cookie(key, null, options);
+            return true;
+        }
+        return false;
+    };
+
+})(jQuery, document);

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap-tour-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tien Le
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies: []
+description: Quick and easy product tours with Twitter Bootstrap Popovers.
+email:
+- tienlx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bootstrap-tour-rails.gemspec
+- lib/bootstrap-tour-rails.rb
+- lib/bootstrap-tour-rails/version.rb
+- vendor/assets/javascripts/bootstrap-tour/bootstrap-tour.js
+- vendor/assets/javascripts/bootstrap-tour/index.js
+- vendor/assets/javascripts/bootstrap-tour/jquery.cookie.js
+homepage: https://github.com/tienle/bootstrap-tour-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Bootstrap tour is a plugin for Bootstrap. It provides quick and easy product
+  tours with Twitter Bootstrap Popovers.
+test_files: []