historyjs-rails 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--tty

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (C) 2012 Phil Ostler
+
+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,84 @@
+# History.js for Rails ![Build Status][travis_ci_build_status]
+
+Provides History.js (1.7.1) for use with Rails 3
+
+[RubyGems][ruby_gems] | [Ruby Toolbox][ruby_toolbox] | [GitHub][github] | [Travis CI][travis_ci] | [RubyDoc][ruby_doc]
+
+## Installation
+### Rails 3.1+
+To use History.js with your Rails 3.1+ application, add the following to your Gemfile
+
+```
+gem "historyjs-rails"
+``` 
+Run ```bundle install``` and History.js will be available for you to use via the asset pipeline. Add one of the following lines (depending on your framework) into your ```app/assets/javascripts/application.js``` file...
+
+```
+# HTML4 & 5 support (with hash fallback)
+//= require history_jquery    # jQuery 1.3+
+//= require history_mootools  # Mootools 1.3+
+//= require history_right     # Right.js 2.2+
+//= require history_zepto     # Zepto 0.5+
+//= require history_native    # For everything else
+
+# HTML5 only support
+//= require history_jquery_html5    # jQuery 1.3+
+//= require history_mootools_html5  # Mootools 1.3+
+//= require history_right_html5     # Right.js 2.2+
+//= require history_zepto_html5     # Zepto 0.5+
+//= require history_native_html5    # For everything else
+```
+...or for the minified version in development
+
+```
+# HTML4 & 5 support (with hash fallback)
+//= require history_jquery.min    # jQuery 1.3+
+//= require history_mootools.min  # Mootools 1.3+
+//= require history_right.min     # Right.js 2.2+
+//= require history_zepto.min     # Zepto 0.5+
+//= require history_native.min    # For everything else
+
+# HTML5 only support
+//= require history_jquery_html5.min    # jQuery 1.3+
+//= require history_mootools_html5.min  # Mootools 1.3+
+//= require history_right_html5.min     # Right.js 2.2+
+//= require history_zepto_html5.min     # Zepto 0.5+
+//= require history_native_html5.min    # For everything else
+```
+History.js is now installed. Woop!
+
+### Rails 3.0
+To use History.js with your Rails 3.0 application, add the following to your Gemfile
+
+```
+gem "historyjs-rails"
+``` 
+Run ```bundle install``` followed by the install generator (with the desired framework option)
+
+```
+# HTML4 & 5 support (with hash fallback)
+rails generate historyjs:install --jquery    # jQuery 1.3+
+rails generate historyjs:install --mootools  # Mootools 1.3+
+rails generate historyjs:install --right     # Right.js 2.2+
+rails generate historyjs:install --zepto     # Zepto 0.5+
+rails generate historyjs:install --native    # For everything else
+
+# HTML5 only support
+rails generate historyjs:install --jquery --html5    # jQuery 1.3+
+rails generate historyjs:install --mootools --html5  # Mootools 1.3+
+rails generate historyjs:install --right --html5     # Right.js 2.2+
+rails generate historyjs:install --zepto --html5     # Zepto 0.5+
+rails generate historyjs:install --native --html5    # For everything else
+```
+History.js is now installed. Woop!
+
+##History.js Resources
+[GitHub][historyjs_github]
+
+[github]: http://github.com/philostler/historyjs-rails
+[ruby_doc]: http://rubydoc.info/github/philostler/historyjs-rails/master/frames
+[ruby_gems]: http://rubygems.org/gems/historyjs-rails
+[travis_ci]: http://travis-ci.org/philostler/historyjs-rails
+[travis_ci_build_status]: https://secure.travis-ci.org/philostler/historyjs-rails.png
+[ruby_toolbox]: http://www.ruby-toolbox.com/projects/historyjs-rails
+[historyjs_github]: http://github.com/balupton/history.js

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new :spec

data/historyjs-rails.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/historyjs/rails/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "historyjs-rails"
+  s.version     = Historyjs::Rails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Phil Ostler"
+  s.email       = "philostler@gmail.com"
+  s.homepage    = "http://github.com/philostler/historyjs-rails"
+  s.summary     = %q{History.js for Rails}
+  s.description = %q{Provides History.js for use with Rails 3}
+
+  s.add_dependency "railties", "~> 3.0"
+
+  s.add_development_dependency "rspec", "~> 2.0"
+
+  s.files = Dir[".gitignore"] +
+            Dir[".rspec"] +
+            Dir["Gemfile"] +
+            Dir["historyjs-rails.gemspec"] +
+            Dir["LICENSE"] +
+            Dir["Rakefile"] +
+            Dir["README.md"] +
+            Dir["**/*.js"] +
+            Dir["**/*.rb"]
+  s.require_paths = ["lib"]
+end

data/lib/generators/historyjs/install/install_generator.rb

@@ -0,0 +1,72 @@
+require "rails"
+
+module Historyjs
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "This generator installs History.js (#{Historyjs::Rails::HISTORYJS_VERSION})"
+      class_option :jquery, :type => :boolean, :default => false, :desc => "For jQuery 1.3+"
+      class_option :mootools, :type => :boolean, :default => false, :desc => "For Mootools 1.3+"
+      class_option :right, :type => :boolean, :default => false, :desc => "For Right.js 2.2+"
+      class_option :zepto, :type => :boolean, :default => false, :desc => "For Zepto 0.5+"
+      class_option :native, :type => :boolean, :default => false, :desc => "For everything else"
+      class_option :html5, :type => :boolean, :default => false, :desc => "For HTML5 only support"
+      source_root File.expand_path "../../../../../vendor/assets/javascripts", __FILE__
+
+      def copy_historyjs
+        say_status "copying", "History.js (#{Historyjs::Rails::HISTORYJS_VERSION})", :green
+
+        copy_file "json2.js",     "public/javascripts/json2.js"
+        copy_file "json2.min.js", "public/javascripts/json2.min.js"
+        copy_file "history_core.js",     "public/javascripts/history_core.js"
+        copy_file "history_core.min.js", "public/javascripts/history_core.min.js"
+
+        unless options.html5?
+          copy_file "history_html4.js",     "public/javascripts/history_html4.js"
+          copy_file "history_html4.min.js", "public/javascripts/history_html4.min.js"
+
+          if options.jquery?
+            copy_file "history_jquery.js",     "public/javascripts/history_jquery.js"
+            copy_file "history_jquery.min.js", "public/javascripts/history_jquery.min.js"
+          end
+          if options.mootools?
+            copy_file "history_mootools.js",     "public/javascripts/history_mootools.js"
+            copy_file "history_mootools.min.js", "public/javascripts/history_mootools.min.js"
+          end
+          if options.right?
+            copy_file "history_right.js",     "public/javascripts/history_right.js"
+            copy_file "history_right.min.js", "public/javascripts/history_right.min.js"
+          end
+          if options.zepto?
+            copy_file "history_zepto.js",     "public/javascripts/history_zepto.js"
+            copy_file "history_zepto.min.js", "public/javascripts/history_zepto.min.js"
+          end
+          if options.native?
+            copy_file "history_native.js",     "public/javascripts/history_native.js"
+            copy_file "history_native.min.js", "public/javascripts/history_native.min.js"
+          end
+        else
+          if options.jquery?
+            copy_file "history_jquery_html5.js",     "public/javascripts/history_jquery_html5.js"
+            copy_file "history_jquery_html5.min.js", "public/javascripts/history_jquery_html5.min.js"
+          end
+          if options.mootools?
+            copy_file "history_mootools_html5.js",     "public/javascripts/history_mootools_html5.js"
+            copy_file "history_mootools_html5.min.js", "public/javascripts/history_mootools_html5.min.js"
+          end
+          if options.right?
+            copy_file "history_right_html5.js",     "public/javascripts/history_right_html5.js"
+            copy_file "history_right_html5.min.js", "public/javascripts/history_right_html5.min.js"
+          end
+          if options.zepto?
+            copy_file "history_zepto_html5.js",     "public/javascripts/history_zepto_html5.js"
+            copy_file "history_zepto_html5.min.js", "public/javascripts/history_zepto_html5.min.js"
+          end
+          if options.native?
+            copy_file "history_native_html5.js",     "public/javascripts/history_native_html5.js"
+            copy_file "history_native_html5.min.js", "public/javascripts/history_native_html5.min.js"
+          end
+        end
+      end
+    end
+  end
+end if ::Rails.version < 3.1

data/lib/historyjs-rails.rb

@@ -0,0 +1 @@
+require "historyjs/rails"

data/lib/historyjs/rails.rb

@@ -0,0 +1,10 @@
+module Historyjs
+  module Rails
+    if ::Rails.version < "3.1"
+      require "historyjs/rails/railtie"
+    else
+      require "historyjs/rails/engine"
+    end
+    require "historyjs/rails/version"
+  end
+end

data/lib/historyjs/rails/engine.rb

@@ -0,0 +1,6 @@
+module Historyjs
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/historyjs/rails/railtie.rb

@@ -0,0 +1,6 @@
+module Historyjs
+  module Rails
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/historyjs/rails/version.rb

@@ -0,0 +1,6 @@
+module Historyjs
+  module Rails
+    VERSION = "1.0.0"
+    HISTORYJS_VERSION = "1.7.1";
+  end
+end

data/spec/historyjs/rails/version_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe Historyjs::Rails do
+  it { Historyjs::Rails::VERSION.should == "1.0.0" }
+  it { Historyjs::Rails::HISTORYJS_VERSION.should == "1.7.1" }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rails/all"
+
+require "historyjs-rails"

data/vendor/assets/javascripts/history_adapter_jquery.js

@@ -0,0 +1,77 @@
+/**
+ * History.js jQuery Adapter
+ * @author Benjamin Arthur Lupton <contact@balupton.com>
+ * @copyright 2010-2011 Benjamin Arthur Lupton <contact@balupton.com>
+ * @license New BSD License <http://creativecommons.org/licenses/BSD/>
+ */
+
+// Closure
+(function(window,undefined){
+	"use strict";
+
+	// Localise Globals
+	var
+		History = window.History = window.History||{},
+		jQuery = window.jQuery;
+
+	// Check Existence
+	if ( typeof History.Adapter !== 'undefined' ) {
+		throw new Error('History.js Adapter has already been loaded...');
+	}
+
+	// Add the Adapter
+	History.Adapter = {
+		/**
+		 * History.Adapter.bind(el,event,callback)
+		 * @param {Element|string} el
+		 * @param {string} event - custom and standard events
+		 * @param {function} callback
+		 * @return {void}
+		 */
+		bind: function(el,event,callback){
+			jQuery(el).bind(event,callback);
+		},
+
+		/**
+		 * History.Adapter.trigger(el,event)
+		 * @param {Element|string} el
+		 * @param {string} event - custom and standard events
+		 * @param {Object=} extra - a object of extra event data (optional)
+		 * @return {void}
+		 */
+		trigger: function(el,event,extra){
+			jQuery(el).trigger(event,extra);
+		},
+
+		/**
+		 * History.Adapter.extractEventData(key,event,extra)
+		 * @param {string} key - key for the event data to extract
+		 * @param {string} event - custom and standard events
+		 * @param {Object=} extra - a object of extra event data (optional)
+		 * @return {mixed}
+		 */
+		extractEventData: function(key,event,extra){
+			// jQuery Native then jQuery Custom
+			var result = (event && event.originalEvent && event.originalEvent[key]) || (extra && extra[key]) || undefined;
+
+			// Return
+			return result;
+		},
+
+		/**
+		 * History.Adapter.onDomLoad(callback)
+		 * @param {function} callback
+		 * @return {void}
+		 */
+		onDomLoad: function(callback) {
+			jQuery(callback);
+		}
+	};
+
+	// Try and Initialise History
+	if ( typeof History.init !== 'undefined' ) {
+		History.init();
+	}
+
+})(window);
+

data/vendor/assets/javascripts/history_adapter_jquery.min.js

@@ -0,0 +1 @@
+(function(a,b){"use strict";var c=a.History=a.History||{},d=a.jQuery;if(typeof c.Adapter!="undefined")throw new Error("History.js Adapter has already been loaded...");c.Adapter={bind:function(a,b,c){d(a).bind(b,c)},trigger:function(a,b,c){d(a).trigger(b,c)},extractEventData:function(a,c,d){var e=c&&c.originalEvent&&c.originalEvent[a]||d&&d[a]||b;return e},onDomLoad:function(a){d(a)}},typeof c.init!="undefined"&&c.init()})(window)

data/vendor/assets/javascripts/history_adapter_mootools.js

@@ -0,0 +1,84 @@
+/**
+ * History.js MooTools Adapter
+ * @author Benjamin Arthur Lupton <contact@balupton.com>
+ * @copyright 2010-2011 Benjamin Arthur Lupton <contact@balupton.com>
+ * @license New BSD License <http://creativecommons.org/licenses/BSD/>
+ */
+
+// Closure
+(function(window,undefined){
+	"use strict";
+
+	// Localise Globals
+	var
+		History = window.History = window.History||{},
+		MooTools = window.MooTools,
+		Element = window.Element;
+
+	// Check Existence
+	if ( typeof History.Adapter !== 'undefined' ) {
+		throw new Error('History.js Adapter has already been loaded...');
+	}
+
+	// Make MooTools aware of History.js Events
+	Object.append(Element.NativeEvents,{
+		'popstate':2,
+		'hashchange':2
+	});
+
+	// Add the Adapter
+	History.Adapter = {
+		/**
+		 * History.Adapter.bind(el,event,callback)
+		 * @param {Element|string} el
+		 * @param {string} event - custom and standard events
+		 * @param {function} callback
+		 * @return {void}
+		 */
+		bind: function(el,event,callback){
+			var El = typeof el === 'string' ? document.id(el) : el;
+			El.addEvent(event,callback);
+		},
+
+		/**
+		 * History.Adapter.trigger(el,event)
+		 * @param {Element|string} el
+		 * @param {string} event - custom and standard events
+		 * @param {Object=} extra - a object of extra event data (optional)
+		 * @return void
+		 */
+		trigger: function(el,event,extra){
+			var El = typeof el === 'string' ? document.id(el) : el;
+			El.fireEvent(event,extra);
+		},
+
+		/**
+		 * History.Adapter.extractEventData(key,event,extra)
+		 * @param {string} key - key for the event data to extract
+		 * @param {string} event - custom and standard events
+		 * @return {mixed}
+		 */
+		extractEventData: function(key,event){
+			// MooTools Native then MooTools Custom
+			var result = (event && event.event && event.event[key]) || (event && event[key]) || undefined;
+
+			// Return
+			return result;
+		},
+
+		/**
+		 * History.Adapter.onDomLoad(callback)
+		 * @param {function} callback
+		 * @return {void}
+		 */
+		onDomLoad: function(callback) {
+			window.addEvent('domready',callback);
+		}
+	};
+
+	// Try and Initialise History
+	if ( typeof History.init !== 'undefined' ) {
+		History.init();
+	}
+
+})(window);

data/vendor/assets/javascripts/history_adapter_mootools.min.js

@@ -0,0 +1 @@
+(function(a,b){"use strict";var c=a.History=a.History||{},d=a.MooTools,e=a.Element;if(typeof c.Adapter!="undefined")throw new Error("History.js Adapter has already been loaded...");Object.append(e.NativeEvents,{popstate:2,hashchange:2}),c.Adapter={bind:function(a,b,c){var d=typeof a=="string"?document.id(a):a;d.addEvent(b,c)},trigger:function(a,b,c){var d=typeof a=="string"?document.id(a):a;d.fireEvent(b,c)},extractEventData:function(a,c){var d=c&&c.event&&c.event[a]||c&&c[a]||b;return d},onDomLoad:function(b){a.addEvent("domready",b)}},typeof c.init!="undefined"&&c.init()})(window)

data/vendor/assets/javascripts/history_adapter_native.js

@@ -0,0 +1,121 @@
+/**
+ * History.js Native Adapter
+ * @author Benjamin Arthur Lupton <contact@balupton.com>
+ * @copyright 2010-2011 Benjamin Arthur Lupton <contact@balupton.com>
+ * @license New BSD License <http://creativecommons.org/licenses/BSD/>
+ */
+
+// Closure
+(function(window,undefined){
+	"use strict";
+
+	// Localise Globals
+	var History = window.History = window.History||{};
+
+	// Check Existence
+	if ( typeof History.Adapter !== 'undefined' ) {
+		throw new Error('History.js Adapter has already been loaded...');
+	}
+
+	// Add the Adapter
+	History.Adapter = {
+		/**
+		 * History.Adapter.handlers[uid][eventName] = Array
+		 */
+		handlers: {},
+
+		/**
+		 * History.Adapter._uid
+		 * The current element unique identifier
+		 */
+		_uid: 1,
+
+		/**
+		 * History.Adapter.uid(element)
+		 * @param {Element} element
+		 * @return {String} uid
+		 */
+		 uid: function(element){
+			return element._uid || (element._uid = History.Adapter._uid++);
+		 },
+
+		/**
+		 * History.Adapter.bind(el,event,callback)
+		 * @param {Element} element
+		 * @param {String} eventName - custom and standard events
+		 * @param {Function} callback
+		 * @return
+		 */
+		bind: function(element,eventName,callback){
+			// Prepare
+			var uid = History.Adapter.uid(element);
+
+			// Apply Listener
+			History.Adapter.handlers[uid] = History.Adapter.handlers[uid] || {};
+			History.Adapter.handlers[uid][eventName] = History.Adapter.handlers[uid][eventName] || [];
+			History.Adapter.handlers[uid][eventName].push(callback);
+
+			// Bind Global Listener
+			element['on'+eventName] = (function(element,eventName){
+				return function(event){
+					History.Adapter.trigger(element,eventName,event);
+				};
+			})(element,eventName);
+		},
+
+		/**
+		 * History.Adapter.trigger(el,event)
+		 * @param {Element} element
+		 * @param {String} eventName - custom and standard events
+		 * @param {Object} event - a object of event data
+		 * @return
+		 */
+		trigger: function(element,eventName,event){
+			// Prepare
+			event = event || {};
+			var uid = History.Adapter.uid(element),
+				i,n;
+
+			// Apply Listener
+			History.Adapter.handlers[uid] = History.Adapter.handlers[uid] || {};
+			History.Adapter.handlers[uid][eventName] = History.Adapter.handlers[uid][eventName] || [];
+
+			// Fire Listeners
+			for ( i=0,n=History.Adapter.handlers[uid][eventName].length; i<n; ++i ) {
+				History.Adapter.handlers[uid][eventName][i].apply(this,[event]);
+			}
+		},
+
+		/**
+		 * History.Adapter.extractEventData(key,event,extra)
+		 * @param {String} key - key for the event data to extract
+		 * @param {String} event - custom and standard events
+		 * @return {mixed}
+		 */
+		extractEventData: function(key,event){
+			var result = (event && event[key]) || undefined;
+			return result;
+		},
+
+		/**
+		 * History.Adapter.onDomLoad(callback)
+		 * @param {Function} callback
+		 * @return
+		 */
+		onDomLoad: function(callback) {
+			var timeout = window.setTimeout(function(){
+				callback();
+			},2000);
+			window.onload = function(){
+				clearTimeout(timeout);
+				callback();
+			};
+		}
+	};
+
+	// Try and Initialise History
+	if ( typeof History.init !== 'undefined' ) {
+		History.init();
+	}
+
+})(window);