jquery-turbolinks 1.0.0.rc1 → 1.0.0.rc2

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# How to contribute
+
+## Run tests
+
+``` sh
+# Bundle gems
+bundle
+
+# Install npm packages
+npm install
+
+# Run tests 
+rake test
+
+# ... or run auto tests
+bundle exec guard
+```
+
+## Sending pull-request
+
+1. Fork
+2. Run the tests
+3. Add test for your change
+4. Make tests green
+5. Push
+6. Send pull-request
+
+## Please do not
+
+* Driving drunk
+* Hide the fact of finding Bigfoot
+* Mess with versions, gemspec file, package.json etc

data/README.md

@@ -4,9 +4,11 @@ Do you like [Turbolinks](https://github.com/rails/turbolinks)? It's easy and fas
 
 But if you have a large codebase with lots of `$(el).bind(...)` Turbolinks will surprise you. Most part of your JavaScripts will stop working in usual way. It's because the nodes on which you bind events no longer exist.
 
-I wrote jquery.turbolinks to solve this problem in [my project](http://amplifr.com). It's easy to use: just require it *after* `jquery.js` and `tubrolinks.js`, but before other scripts.
+I wrote jquery.turbolinks to solve this problem in [my project](http://amplifr.com). It's easy to use: just require it *immediately after* `jquery.js`. Your other scripts should be loaded after `jquery.turbolinks.js`, and `turbolinks.js` should be after your other scripts.
 
-Sponsored by [Evil Martians](http://evilmartians.com/).
+Initially sponsored by [Evil Martians](http://evilmartians.com/).
+
+This project is a member of the [OSS Manifesto](http://ossmanifesto.org/).
 
 ## Usage
 
@@ -22,9 +24,11 @@ JavaScript manifest file:
 
 And it just works!
 
-## `$.setReadyEvent`
+## Customization
+
+### $.setReadyEvent
 
-By default [ready](https://github.com/kossnocorp/jquery.turbolinks/blob/master/src/jquery.turbolinks.coffee#L17:L18) function is binded to [page:load](https://github.com/rails/turbolinks/#events) event.
+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.
 
 If you want to change it use `$.setReadyEvent` function:
 
@@ -32,7 +36,7 @@ If you want to change it use `$.setReadyEvent` function:
 $.setReadyEvent('page:change');
 ```
 
-## `$.setFetchEvent`
+### $.setFetchEvent
 
 By default right after trigger `page:fetch` `$.isReady` is set to false. And after `page:load` is set to true.
 
@@ -42,36 +46,63 @@ If you want to change default behaviour you can use `$.setFetchEvent`:
 $.setReadyEvent('custom_loading_event');
 ```
 
-# Changelog
+## Troubleshooting
+
+### Events firing twice or more
+
+If you find that some events are being fired multiple times after using jQuery Turbolinks, you may have been binding your `document` events inside a `$(function())` block. For instance, this example below can be a common occurrence and should be avoided:
+
+``` javascript
+/* BAD: don't bind 'document' events while inside $()! */
+$(function() {
+  $(document).on('click', 'button', function() { ... })
+});
+```
+
+You should be binding your events outside a `$(function())` block. This will ensure that your events will only ever be bound once.
+
+``` javascript
+/* Good: events are bound outside a $() wrapper. */
+$(document).on('click', 'button', function() { ... })
+```
+
+## Changelog
 
 This project uses [Semantic Versioning](http://semver.org/) for release numbering.
 
-## 1.0.0-rc1 (November 28, 2012)
+### 1.0.0-rc2 (January 31, 2013)
+
+* Fix problem with 3rd-party libraries [#12](https://github.com/kossnocorp/jquery.turbolinks/issues/12), [#15](https://github.com/kossnocorp/jquery.turbolinks/issues/15) (kudos to [@rstacruz](https://github.com/rstacruz));
+* Reopen [#8](https://github.com/kossnocorp/jquery.turbolinks/issues/8).
+
+### 1.0.0-rc1 (November 28, 2012)
 
 * Set $.isReady to false after `page:fetch` [#6](https://github.com/kossnocorp/jquery.turbolinks/issues/6);
 * add `$.setFetchEvent` function;
-* remove all delegated events after trigger fetch event [#8](https://github.com/kossnocorp/jquery.turbolinks/issues/8);
+* remove all delegated events after trigger fetch event [#8](https://github.com/kossnocorp/jquery.turbolinks/issues/8).
 
-## 1.0.0-rc (November 8, 2012)
+### 1.0.0-rc (November 8, 2012)
 
 * Add turbolinks as dependency (kudos to [@gbchaosmaster](https://github.com/gbchaosmaster));
 * run callback after adding to waiting list if `$.isReady` [#6](https://github.com/kossnocorp/jquery.turbolinks/issues/6).
 
-## 0.2.1 (October 15, 2012)
+### 0.2.1 (October 15, 2012)
 
 * Pass jQuery object to each callback [#4](https://github.com/kossnocorp/jquery.turbolinks/issues/4)
 
-## 0.2.0 (October 10, 2012)
+### 0.2.0 (October 10, 2012)
 
 * Change event: `page:change` -> `page:load` (kudos to [@davydotcom](https://github.com/davydotcom));
 * added ability to change ready event via `$.setReadyEvent`
 
-## 0.1.0 (October 3, 2012)
+### 0.1.0 (October 3, 2012)
 
 * First, initial release
 
-# Contributors
+## Contributors
+
+Initial idea and code by [@kossnocorp](http://koss.nocorp.me/), with special thanks to [@rstacruz](https://github.com/rstacruz) and other the project's [contributors](https://github.com/kossnocorp/jquery.turbolinks/graphs/contributors).
 
-Idea and code by [@kossnocorp](http://koss.nocorp.me/).
+## License
 
-# [The MIT License](https://github.com/kossnocorp/jquery.turbolinks/blob/master/LICENSE.md)
+[The MIT License](https://github.com/kossnocorp/jquery.turbolinks/blob/master/LICENSE.md)

data/Rakefile

@@ -9,7 +9,7 @@ namespace :release do
   task :build_gem do
     system 'gem build jquery-turbolinks.gemspec'
   end
-  
+
   task gem: :build_gem do
     system "gem push jquery-turbolinks-#{JqueryTurbolinks::VERSION}.gem"
   end
@@ -26,7 +26,8 @@ namespace :js do
     command = [
       './node_modules/coffee-script/bin/coffee',
       '--compile',
-      '--output ./vendor/assets/javascripts/ ./src/jquery.turbolinks.coffee' 
+      '--output ./vendor/assets/javascripts/',
+      './src/jquery.turbolinks.coffee'
     ]
     system command.join(' ')
   end

data/jquery-turbolinks.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |gem|
 
   gem.rubygems_version  = '1.8.15'
 
-  gem.add_dependency 'rails', '>= 3.1.0'
+  gem.add_dependency 'railties', '>= 3.1.0'
   gem.add_dependency 'turbolinks'
 end

data/lib/jquery-turbolinks/version.rb

@@ -1,3 +1,3 @@
 module JqueryTurbolinks
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc2'
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jquery.turbolinks",
-  "version": "1.0.0-rc1",
+  "version": "1.0.0-rc2",
   "author": "Sasha Koss <koss@nocorp.me>",
   "description": "jQuery plugin for drop-in fix binded events problem caused by Turbolinks",
 

data/spec/jquery.turbolinks_spec.coffee

@@ -46,24 +46,6 @@ describe '$ Turbolinks', ->
 
       callback1.should.have.been.calledWith($)
 
-    it '''
-         should remove all events delegated to
-         document after trigger fetch 
-       ''', ->
-         id       = getUniqId()
-         selector = '#' + id
-         addEl    = ->
-                      $('body').empty()
-                      $('<div>').attr(id: id).appendTo('body')
-
-         addEl()
-         $(document).on('event_name', selector, callback1)
-         $(selector).trigger('event_name')
-         $(document).trigger('page:fetch')
-         addEl()
-         $(selector).trigger('event_name')
-         callback1.should.have.been.calledOnce
-
     describe '$.setReadyEvent', ->
 
       beforeEach ->

data/src/jquery.turbolinks.coffee

@@ -1,5 +1,5 @@
 ###
-  jquery.turbolinks.js ~ v1.0.0-rc1 ~ https://github.com/kossnocorp/jquery.turbolinks
+  jquery.turbolinks.js ~ v1.0.0-rc2 ~ https://github.com/kossnocorp/jquery.turbolinks
 
   jQuery plugin for drop-in fix binded events problem caused by Turbolinks
 
@@ -8,7 +8,7 @@
   Copyright (c) 2012 Sasha Koss
 ###
 
-$ = require?('jquery') || window.jQuery
+$ = window.jQuery or require?('jquery')
 
 # List for store callbacks passed to `$` or `$.ready`
 callbacks = []
@@ -24,7 +24,6 @@ turbolinksReady = ->
 
 # Fetch event handler
 fetch = ->
-  $(document).off(undefined, '**')
   $.isReady = false
 
 # Bind `ready` to DOM ready event

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

@@ -1,7 +1,7 @@
-// Generated by CoffeeScript 1.3.3
+// Generated by CoffeeScript 1.4.0
 
 /*
-  jquery.turbolinks.js ~ v1.0.0-rc1 ~ https://github.com/kossnocorp/jquery.turbolinks
+  jquery.turbolinks.js ~ v1.0.0-rc2 ~ https://github.com/kossnocorp/jquery.turbolinks
 
   jQuery plugin for drop-in fix binded events problem caused by Turbolinks
 
@@ -14,7 +14,7 @@
 (function() {
   var $, callbacks, fetch, ready, turbolinksReady;
 
-  $ = (typeof require === "function" ? require('jquery') : void 0) || window.jQuery;
+  $ = window.jQuery || (typeof require === "function" ? require('jquery') : void 0);
 
   callbacks = [];
 
@@ -34,7 +34,6 @@
   };
 
   fetch = function() {
-    $(document).off(void 0, '**');
     return $.isReady = false;
   };
 

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jquery-turbolinks
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
   prerelease: 6
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Sasha Koss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: turbolinks
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -50,6 +50,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.md
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: jquery-turbolinks
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: jQuery plugin for drop-in fix binded events problem caused by Turbolinks