jquery-turbolinks 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWZlNDExMDMwMjVjZTAzN2EwYTVhMWFjNzIxM2FjNjk0N2JkZDYzNQ==
+  data.tar.gz: !binary |-
+    ZDgzMzg4YmJiMGI2NGE1ODBhNjYzMDRiZjE5MWYzMGRmNmE4M2UwZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDg3N2QzYmI2Y2I5MjBmNzEyMjAyNzgyZTg4NGRmN2E2NjU3MGIyYmUwNjk4
+    NzA0ZjQ0ZmQ3ODEwZTcyNWJjYTlhZTkzNWIyNGE1MjA5MDg5MTdkOTgxMjk0
+    NzFlNGQzZGY1MTQ5ZjQ5Y2MyODZhZDA3OTE1Y2RjNGQ0MDBlNzI=
+  data.tar.gz: !binary |-
+    MDk0NjQwZDk1NDgzODljMmRhYzJhNDNlMmQ3N2QwNDA0ODM1OWM5OTE5NzYz
+    MGJhZDQ5NzE2NGRhNTAwMzA0ZDQ4YjdiNmViMmQwMzc1MDkwZDkzNmJjNDhh
+    OGQ5MTg0YzYyODVhZDQxMDIyNzU0NzIyNTIzNDZmYzFkMWI4MTg=

data/.gitignore

@@ -1,3 +1,4 @@
 node_modules
 *.gem
 Gemfile.lock
+.ruby-version

data/NOTES.md

@@ -0,0 +1,36 @@
+# Development notes
+
+Version bumping
+---------------
+
+Edit the following files:
+
+ * lib/jquery-turbolinks/version.rb
+ * package.json
+ * src/jquery.turbolinks.coffee
+
+Updating .js files
+------------------
+
+Update the .js files from the source CoffeeScript file using:
+
+    $ rake js:bulid js:uglify
+
+Testing
+-------
+
+Simply use npm/mocha:
+
+    $ npm install
+    $ npm test
+
+Or:
+
+    $ rake test
+
+Releasing
+---------
+
+Release it into npm/rubygems using:
+
+    $ rake release

data/README.md

@@ -12,41 +12,47 @@ Initially sponsored by [Evil Martians](http://evilmartians.com/).
 
 This project is a member of the [OSS Manifesto](http://ossmanifesto.org/).
 
+## Important
+
+This readme points to the `master` version (v2.0.0) of jQuery Turbolinks. For 
+older versions, see [v1.0.0rc2 README][oldreadme].
+
 ## Usage
 
 Gemfile:
+
 ``` js
 gem 'jquery-turbolinks'
 ```
 
-JavaScript manifest file:
+Add it to your JavaScript manifest file, in this order:
+
 ``` js
+//= require jquery
 //= require jquery.turbolinks
+//
+// ... your other scripts here ...
+//
+//= require turbolinks
 ```
 
 And it just works!
 
-## Customization
-
-### $.setReadyEvent
+## API and Customization
 
-By default [ready](https://github.com/kossnocorp/jquery.turbolinks/blob/master/src/jquery.turbolinks.coffee#L17:L18) function is bound to [page:load](https://github.com/rails/turbolinks/#events) event.
+### $.turbo.use
 
-If you want to change it use `$.setReadyEvent` function:
+By default, jQuery.Turbolinks is bound to [page:load] and [page:fetch]. To use 
+different events (say, if you're not using Turbolinks), use:
 
 ``` js
-$.setReadyEvent('page:change');
+$.turbo.use('pjax:start', 'pjax:end');
 ```
 
-### $.setFetchEvent
-
-By default right after trigger `page:fetch` `$.isReady` is set to false. And after `page:load` is set to true.
+## $.turbo.isReady
 
-If you want to change default behaviour you can use `$.setFetchEvent`:
-
-``` js
-$.setReadyEvent('custom_loading_event');
-```
+You can check if the page is ready by checking `$.turbo.isReady`, which will be 
+either `true` or `false` depending on whether the page is loading.
 
 ## Troubleshooting
 
@@ -72,6 +78,11 @@ $(document).on('click', 'button', function() { ... })
 
 This project uses [Semantic Versioning](http://semver.org/) for release numbering.
 
+### 2.0.0 (unreleased - master)
+
+* Rewritten, smaller, with a completely new API. This deprecates the old 
+`$.setFetchEvent` and `$.setReadyEvent` API.
+
 ### 1.0.0 (April 5, 2013)
 
 * Add uglified version.
@@ -112,3 +123,7 @@ Initial idea and code by [@kossnocorp](http://koss.nocorp.me/), with special tha
 ## License
 
 [The MIT License](https://github.com/kossnocorp/jquery.turbolinks/blob/master/LICENSE.md)
+
+[page:load]: https://github.com/rails/turbolinks/#events
+[page:fetch]: https://github.com/rails/turbolinks/#events
+[oldreadme]: https://github.com/kossnocorp/jquery.turbolinks/blob/v1.0.0.rc2/README.md

data/lib/jquery-turbolinks/version.rb

@@ -1,3 +1,3 @@
 module JqueryTurbolinks
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jquery.turbolinks",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "author": "Sasha Koss <kossnocorp@gmail.com>",
   "description": "jQuery plugin for drop-in fix binded events problem caused by Turbolinks",
 

data/spec/jquery.turbolinks_spec.coffee

@@ -24,9 +24,7 @@ describe '$ Turbolinks', ->
   describe "DOM isn't ready", ->
 
     beforeEach ->
-      $.setReadyEvent('page:load')
-      $.setFetchEvent('page:fetch')
-      $.isReady = false
+      $.turbo.isReady = false
 
       $(callback1 = sinon.spy())
       $(callback2 = sinon.spy())
@@ -41,19 +39,12 @@ describe '$ Turbolinks', ->
          callback1.should.have.been.calledOnce
          callback2.should.have.been.calledOnce
 
-    it 'should pass jQuery object to callbacks', ->
-      $(document).trigger('page:load')
-
-      callback1.should.have.been.calledWith($)
-
-    describe '$.setReadyEvent', ->
-
+    describe '$.turbo.use', ->
       beforeEach ->
-        $.setReadyEvent('page:load')
-        $.setFetchEvent('page:fetch')
+        $.turbo.use('page:load', 'page:fetch')
 
       it 'should unbind default (page:load) event', ->
-        $.setReadyEvent('random_event_name')
+        $.turbo.use('other1', 'other2')
 
         $(document).trigger('page:load')
 
@@ -61,8 +52,6 @@ describe '$ Turbolinks', ->
         callback2.should.have.not.been.called
 
       it 'should bind ready to passed function', ->
-        $.setReadyEvent('page:change')
-
         $(document)
           .trigger('page:load')
           .trigger('page:change')
@@ -73,26 +62,24 @@ describe '$ Turbolinks', ->
     describe '$.setFetchEvent', ->
 
       beforeEach ->
-        $.setReadyEvent('page:load')
-        $.setFetchEvent('page:fetch')
-        $.isReady = true
+        $.turbo.use('page:load', 'page:fetch')
+        $.turbo.isReady = true
 
       it 'should unbind default (page:fetch) event', ->
-        $.setFetchEvent('random_event_name')
+        $.turbo.use('page:load', 'random_event_name')
         $(document).trigger('page:fetch')
-        $.isReady.should.to.be.true
+        $.turbo.isReady.should.to.be.true
         
       it 'should bind passed fetch event', ->
-        $.setFetchEvent('page:loading')
+        $.turbo.use('page:load', 'page:loading')
         $(document).trigger('page:loading')
-        $.isReady.should.to.be.false
+        $.turbo.isReady.should.to.be.false
 
   describe 'DOM is ready', ->
 
     beforeEach ->
-      $.setReadyEvent('page:load')
-      $.setFetchEvent('page:fetch')
-      $.isReady = true
+      $.turbo.use('page:load', 'page:fetch')
+      $.turbo.isReady = true
 
     it 'should call trigger right after add to waiting list', ->
       $(callback = sinon.spy())

data/src/jquery.turbolinks.coffee

@@ -1,53 +1,48 @@
 ###
-  jquery.turbolinks.js ~ v1.0.0 ~ https://github.com/kossnocorp/jquery.turbolinks
+jQuery.Turbolinks ~ https://github.com/kossnocorp/jquery.turbolinks
+jQuery plugin for drop-in fix binded events problem caused by Turbolinks
 
-  jQuery plugin for drop-in fix binded events problem caused by Turbolinks
-
-  The MIT License
-
-  Copyright (c) 2012 Sasha Koss
+The MIT License
+Copyright (c) 2012-2013 Sasha Koss & Rico Sta. Cruz
 ###
 
 $ = window.jQuery or require?('jquery')
-
-# List for store callbacks passed to `$` or `$.ready`
-callbacks = []
-
-# Call each callback in list
-ready = ->
-  callback($) for callback in callbacks
-
-# Turbolinks ready event
-turbolinksReady = ->
-  $.isReady = true
-  ready()
-
-# Fetch event handler
-fetch = ->
-  $.isReady = false
-
-# Bind `ready` to DOM ready event
-$(ready)
-
-# Store callbacks in list on `$` and `$.ready`
-$.fn.ready = (callback) ->
-  callbacks.push(callback)
-  callback($) if $.isReady
-
-# Bind ready to passed event
-$.setReadyEvent = (event) ->
-  $(document)
-    .off('.turbolinks-ready')
-    .on(event + '.turbolinks-ready', turbolinksReady)
-
-# Bind fetch event
-$.setFetchEvent = (event) ->
-  $(document)
-    .off('.turbolinks-fetch')
-    .on(event + '.turbolinks-fetch', fetch)
-
-# Bind `ready` to Tubolinks page:load
-$.setReadyEvent('page:load')
-
-# Bind fetch to Turbolinks page:fetch
-$.setFetchEvent('page:fetch')
+$document = $(document)
+
+$.turbo =
+  version: '2.0.0'
+
+  isReady: false
+
+  # Hook onto the events that Turbolinks triggers.
+  use: (load, fetch) ->
+    $document
+      .off('.turbo')
+      .on("#{load}.turbo", @onLoad)
+      .on("#{fetch}.turbo", @onFetch)
+
+  addCallback: (callback) ->
+    $document.on('turbo:ready', callback)
+    callback($) if $.turbo.isReady
+
+  onLoad: ->
+    $.turbo.isReady = true
+    $document.trigger('turbo:ready')
+
+  onFetch: ->
+    $.turbo.isReady = false
+
+  # Registers jQuery.Turbolinks by monkey-patching jQuery's
+  # `ready` handler. (Internal)
+  #
+  # [1] Trigger the stored `ready` events on first load.
+  # [2] Override `$(function)` and `$(document).ready(function)` by
+  #     registering callbacks under a new event called `turbo:ready`.
+  #
+  register: ->
+    $(@onLoad) #[1]
+    $.fn.ready = @addCallback #[2]
+
+# Use with Turbolinks.
+$.turbo.register()
+$.turbo.use('page:load', 'page:fetch')

data/vendor/assets/javascripts/jquery.turbolinks.js

@@ -1,61 +1,47 @@
-// Generated by CoffeeScript 1.4.0
-
+// Generated by CoffeeScript 1.6.3
 /*
-  jquery.turbolinks.js ~ v1.0.0 ~ https://github.com/kossnocorp/jquery.turbolinks
-
-  jQuery plugin for drop-in fix binded events problem caused by Turbolinks
+jQuery.Turbolinks ~ https://github.com/kossnocorp/jquery.turbolinks
+jQuery plugin for drop-in fix binded events problem caused by Turbolinks
 
-  The MIT License
-
-  Copyright (c) 2012 Sasha Koss
+The MIT License
+Copyright (c) 2012-2013 Sasha Koss & Rico Sta. Cruz
 */
 
 
 (function() {
-  var $, callbacks, fetch, ready, turbolinksReady;
+  var $, $document;
 
   $ = window.jQuery || (typeof require === "function" ? require('jquery') : void 0);
 
-  callbacks = [];
-
-  ready = function() {
-    var callback, _i, _len, _results;
-    _results = [];
-    for (_i = 0, _len = callbacks.length; _i < _len; _i++) {
-      callback = callbacks[_i];
-      _results.push(callback($));
-    }
-    return _results;
-  };
-
-  turbolinksReady = function() {
-    $.isReady = true;
-    return ready();
-  };
-
-  fetch = function() {
-    return $.isReady = false;
-  };
-
-  $(ready);
-
-  $.fn.ready = function(callback) {
-    callbacks.push(callback);
-    if ($.isReady) {
-      return callback($);
+  $document = $(document);
+
+  $.turbo = {
+    version: '2.0.0',
+    isReady: false,
+    use: function(load, fetch) {
+      return $document.off('.turbo').on("" + load + ".turbo", this.onLoad).on("" + fetch + ".turbo", this.onFetch);
+    },
+    addCallback: function(callback) {
+      $document.on('turbo:ready', callback);
+      if ($.turbo.isReady) {
+        return callback($);
+      }
+    },
+    onLoad: function() {
+      $.turbo.isReady = true;
+      return $document.trigger('turbo:ready');
+    },
+    onFetch: function() {
+      return $.turbo.isReady = false;
+    },
+    register: function() {
+      $(this.onLoad);
+      return $.fn.ready = this.addCallback;
     }
   };
 
-  $.setReadyEvent = function(event) {
-    return $(document).off('.turbolinks-ready').on(event + '.turbolinks-ready', turbolinksReady);
-  };
-
-  $.setFetchEvent = function(event) {
-    return $(document).off('.turbolinks-fetch').on(event + '.turbolinks-fetch', fetch);
-  };
-
-  $.setReadyEvent('page:load');
+  $.turbo.register();
 
-  $.setFetchEvent('page:fetch');
+  $.turbo.use('page:load', 'page:fetch');
 
 }).call(this);

data/vendor/assets/javascripts/jquery.turbolinks.min.js

@@ -1 +1 @@
-(function(){var e,t,n,r,i;e=window.jQuery||(typeof require=="function"?require("jquery"):void 0),t=[],r=function(){var n,r,i,s;s=[];for(r=0,i=t.length;r<i;r++)n=t[r],s.push(n(e));return s},i=function(){return e.isReady=!0,r()},n=function(){return e.isReady=!1},e(r),e.fn.ready=function(n){t.push(n);if(e.isReady)return n(e)},e.setReadyEvent=function(t){return e(document).off(".turbolinks-ready").on(t+".turbolinks-ready",i)},e.setFetchEvent=function(t){return e(document).off(".turbolinks-fetch").on(t+".turbolinks-fetch",n)},e.setReadyEvent("page:load"),e.setFetchEvent("page:fetch")}).call(this);
+!function(){var r,o;r=window.jQuery||("function"==typeof require?require("jquery"):void 0),o=r(document),r.turbo={version:"2.0.0",isReady:!1,use:function(r,t){return o.off(".turbo").on(""+r+".turbo",this.onLoad).on(""+t+".turbo",this.onFetch)},addCallback:function(t){return o.on("turbo:ready",t),r.turbo.isReady?t(r):void 0},onLoad:function(){return r.turbo.isReady=!0,o.trigger("turbo:ready")},onFetch:function(){return r.turbo.isReady=!1},register:function(){return r(this.onLoad),r.fn.ready=this.addCallback}},r.turbo.register(),r.turbo.use("page:load","page:fetch")}.call(this);

metadata

@@ -1,48 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jquery-turbolinks
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sasha Koss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  name: railties
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-    none: false
-  name: railties
-  type: :runtime
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-    none: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  name: turbolinks
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: turbolinks
-  type: :runtime
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+  type: :runtime
 description: jQuery plugin for drop-in fix binded events problem caused by Turbolinks
 email: koss@nocorp.me
 executables: []
@@ -55,6 +50,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.md
+- NOTES.md
 - README.md
 - Rakefile
 - jquery-turbolinks.gemspec
@@ -69,6 +65,7 @@ files:
 homepage: https://github.com/kossnocorp/jquery.turbolinks
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -78,18 +75,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: jquery-turbolinks
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: jQuery plugin for drop-in fix binded events problem caused by Turbolinks
 test_files:
 - spec/jquery.turbolinks_spec.coffee
+has_rdoc: