turbolinks 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2bb9ae664cef07039bfb5326ff85ebcfbbca0e8
+  data.tar.gz: 2b55c3358f99361d016329ccfa661872599069ba
+SHA512:
+  metadata.gz: edd2489816d02cbfd4754b28f82a95d64c4b1290c41ee28984d3333c432c339c437d27c9d4cef1b526c0b9d076ea8d0c2f5fd50a0807cd5c98aed5cec8389af7
+  data.tar.gz: 1fbb34bbd7831d6e72ebfc36a9aba4a019535118e0fc95db586d445f74700261a6f6bf9f26936019726f8dad510aede638671245369e43c406cb3f6744033a07

data/README.md

@@ -13,7 +13,7 @@ How much faster is it really?
 
 It depends. The more CSS and JavaScript you have, the bigger the benefit of not throwing away the browser instance and recompiling all of it for every page. Just like a CGI script that says "hello world" will be fast, but a CGI script loading Rails on every request will not.
 
-In any case, the benefit ranges from [twice as fast](https://github.com/steveklabnik/turbolinks_test) on apps with little JS/CSS, to [three times as fast](https://github.com/steveklabnik/turbolinks_test/tree/all_the_assets) in apps with lots of it. Of course, your mileage may vary, be dependent on your browser version, the moon cycle, and all other factors affecting performance testing. But at least it's a yardstick.
+In any case, the benefit can be up to [twice as fast](https://github.com/steveklabnik/turbolinks_test/tree/all_the_assets) in apps with lots of JS and CSS. Of course, your mileage may vary, be dependent on your browser version, the moon cycle, and all other factors affecting performance testing. But at least it's a yardstick.
 
 The best way to find out just how fast it is? Try it on your own application. It hardly takes any effort at all.
 
@@ -33,6 +33,7 @@ Since pages will change without a full reload with Turbolinks, you can't by defa
 * `page:load`    fetched page is being retrieved fresh from the server.
 * `page:restore` fetched page is being retrieved from the 10-slot client-side cache.
 * `page:change`  page has changed to the newly fetched version.
+* `page:receive` page has been fetched from the server, but not yet parsed.
 
 So if you wanted to have a client-side spinner, you could listen for `page:fetch` to start it and `page:change` to stop it. If you have DOM transformation that are not idempotent (the best way), you can hook them to happen only on `page:load` instead of `page:change` (as that would run them again on the cached pages).
 
@@ -62,6 +63,19 @@ Note that internal links to files not ending in .html, or having no extension, w
 Also, Turbolinks is installed as the last click handler for links. So if you install another handler that calls event.preventDefault(), Turbolinks will not run. This ensures that you can safely use Turbolinks with stuff like `data-method`, `data-remote`, or `data-confirm` from Rails.
 
 
+jquery.turbolinks
+-----------------
+
+If you have a lot of existing JavaScript that binds elements on jQuery.ready(), you can pull the [jquery.turbolinks](https://github.com/kossnocorp/jquery.turbolinks) library into your project that will trigger ready() when Turbolinks triggers the the `page:load` event. It may restore functionality of some libraries.
+
+Add the gem to your project, then add the following line to your JavaScript manifest file, after `jquery.js` but before `turbolinks.js`:
+
+``` js
+//= require jquery.turbolinks
+```
+
+Additional details and configuration options can be found in the [jquery.turbolinks README](https://github.com/kossnocorp/jquery.turbolinks/blob/master/README.md).
+
 Asset change detection
 ----------------------
 
@@ -79,6 +93,7 @@ Evaluating script tags
 
 Turbolinks will evaluate any script tags in pages it visit, if those tags do not have a type or if the type is text/javascript. All other script tags will be ignored.
 
+As a rule of thumb when switching to Turbolinks, move all of your javascript tags inside the `head` and then work backwards, only moving javascript code back to the body if absolutely necessary.
 
 Triggering a Turbolinks visit manually
 ---------------------------------------
@@ -97,7 +112,7 @@ Compatibility
 
 Turbolinks is designed to work with any browser that fully supports pushState and all the related APIs. This includes Safari 6.0+ (but not Safari 5.1.x!), IE10, and latest Chromes and Firefoxes.
 
-Do note that existing JavaScript libraries may not all be compatible with Turbolinks out of the box due to the change in instantiation cycle. You might very well have to modify them to work with Turbolinks' new set of events.
+Do note that existing JavaScript libraries may not all be compatible with Turbolinks out of the box due to the change in instantiation cycle. You might very well have to modify them to work with Turbolinks' new set of events.  For help with this, check out the [Turbolinks Compatibility](http://reed.github.com/turbolinks-compatibility) project.
 
 
 Installation
@@ -112,4 +127,4 @@ Installation
 Credits
 -------
 
-Thanks to Chris Wanstrath for his original work on Pjax. Thanks to Sam Stephenson and Josh Peek for their additional work on Pjax and Stacker and their help with getting Turbolinks released. Thanks to David Estes for handling the lion's share of post-release issues and feature requests. And thanks to everyone else who's fixed or reported an issue!
+Thanks to Chris Wanstrath for his original work on Pjax. Thanks to Sam Stephenson and Josh Peek for their additional work on Pjax and Stacker and their help with getting Turbolinks released. Thanks to David Estes and Nick Reed for handling the lion's share of post-release issues and feature requests. And thanks to everyone else who's fixed or reported an issue!

data/lib/assets/javascripts/turbolinks.js.coffee

@@ -22,17 +22,16 @@ fetchReplacement = (url) ->
   # Remove hash from url to ensure IE 10 compatibility
   safeUrl = removeHash url
 
-  xhr.abort() if xhr
+  xhr?.abort()
   xhr = new XMLHttpRequest
   xhr.open 'GET', safeUrl, true
   xhr.setRequestHeader 'Accept', 'text/html, application/xhtml+xml, application/xml'
   xhr.setRequestHeader 'X-XHR-Referer', referer
-  xhr.onabort = ->
-    xhr = null
-  xhr.onload = =>
-    doc = createDocument xhr.responseText
 
-    if assetsChanged doc
+  xhr.onload = =>
+    triggerEvent 'page:receive'
+    
+    if invalidContent(xhr) or assetsChanged (doc = createDocument xhr.responseText)
       document.location.reload()
     else
       changePage extractTitleAndBody(doc)...
@@ -42,11 +41,10 @@ fetchReplacement = (url) ->
       else
         resetScrollPosition()
       triggerEvent 'page:load'
-    xhr = null
 
-  xhr.onerror = ->
-    document.location.href = url
-    xhr = null
+  xhr.onloadend = -> xhr = null
+  xhr.onabort   = -> rememberCurrentUrl()
+  xhr.onerror   = -> document.location.href = url
 
   xhr.send()
 
@@ -54,6 +52,7 @@ fetchHistory = (state) ->
   cacheCurrentPage()
 
   if page = pageCache[state.position]
+    xhr?.abort()
     changePage page.title, page.body
     recallScrollPosition page
     triggerEvent 'page:restore'
@@ -80,12 +79,14 @@ constrainPageCacheTo = (limit) ->
 changePage = (title, body, runScripts) ->
   document.title = title
   document.documentElement.replaceChild body, document.body
+  removeNoscriptTags()
   executeScriptTags() if runScripts
   currentState = window.history.state
   triggerEvent 'page:change'
 
 executeScriptTags = ->
-  for script in document.body.getElementsByTagName 'script' when script.type in ['', 'text/javascript']
+  scripts = Array::slice.call document.body.getElementsByTagName 'script'
+  for script in scripts when script.type in ['', 'text/javascript']
     copy = document.createElement 'script'
     copy.setAttribute attr.name, attr.value for attr in script.attributes
     copy.appendChild document.createTextNode script.innerHTML
@@ -93,6 +94,9 @@ executeScriptTags = ->
     parentNode.removeChild script
     parentNode.insertBefore copy, nextSibling
 
+removeNoscriptTags = ->
+  noscriptTags = Array::slice.call document.body.getElementsByTagName 'noscript'
+  noscript.parentNode.removeChild noscript for noscript in noscriptTags
 
 reflectNewUrl = (url) ->
   if url isnt document.location.href
@@ -136,6 +140,9 @@ triggerEvent = (name) ->
   document.dispatchEvent event
 
 
+invalidContent = (xhr) ->
+  !xhr.getResponseHeader('Content-Type').match /^(?:text\/html|application\/xhtml\+xml|application\/xml)(?:;|$)/
+
 extractTrackAssets = (doc) ->
   (node.src || node.href) for node in doc.head.childNodes when node.getAttribute?('data-turbolinks-track')?
 
@@ -156,6 +163,11 @@ browserCompatibleDocumentParser = ->
   createDocumentUsingParser = (html) ->
     (new DOMParser).parseFromString html, 'text/html'
 
+  createDocumentUsingDOM = (html) ->
+    doc = document.implementation.createHTMLDocument ''
+    doc.documentElement.innerHTML = html
+    doc
+
   createDocumentUsingWrite = (html) ->
     doc = document.implementation.createHTMLDocument ''
     doc.open 'replace'
@@ -163,19 +175,32 @@ browserCompatibleDocumentParser = ->
     doc.close()
     doc
 
-  if window.DOMParser
-    testDoc = createDocumentUsingParser '<html><body><p>test'
-
-  if testDoc?.body?.childNodes.length is 1
-    createDocumentUsingParser
-  else
-    createDocumentUsingWrite
+  # Use createDocumentUsingParser if DOMParser is defined and natively
+  # supports 'text/html' parsing (Firefox 12+, IE 10)
+  #
+  # Use createDocumentUsingDOM if createDocumentUsingParser throws an exception
+  # due to unsupported type 'text/html' (Firefox < 12, Opera)
+  #
+  # Use createDocumentUsingWrite if:
+  #  - DOMParser isn't defined
+  #  - createDocumentUsingParser returns null due to unsupported type 'text/html' (Chrome, Safari)
+  #  - createDocumentUsingDOM doesn't create a valid HTML document (safeguarding against potential edge cases)
+  try
+    if window.DOMParser
+      testDoc = createDocumentUsingParser '<html><body><p>test'
+      createDocumentUsingParser
+  catch e
+    testDoc = createDocumentUsingDOM '<html><body><p>test'
+    createDocumentUsingDOM
+  finally
+    unless testDoc?.body?.childNodes.length is 1
+      return createDocumentUsingWrite
 
 
 installClickHandlerLast = (event) ->
   unless event.defaultPrevented
-    document.removeEventListener 'click', handleClick
-    document.addEventListener 'click', handleClick
+    document.removeEventListener 'click', handleClick, false
+    document.addEventListener 'click', handleClick, false
 
 handleClick = (event) ->
   unless event.defaultPrevented
@@ -198,7 +223,8 @@ anchoredLink = (link) ->
     (link.href is location.href + '#')
 
 nonHtmlLink = (link) ->
-  link.href.match(/\.[a-z]+(\?.*)?$/g) and not link.href.match(/\.html?(\?.*)?$/g)
+  url = removeHash link
+  url.match(/\.[a-z]+(\?.*)?$/g) and not url.match(/\.html?(\?.*)?$/g)
 
 noTurbolink = (link) ->
   until ignore or link is document
@@ -220,6 +246,7 @@ initializeTurbolinks = ->
   document.addEventListener 'click', installClickHandlerLast, true
   window.addEventListener 'popstate', (event) ->
     fetchHistory event.state if event.state?.turbolinks
+  , false
 
 browserSupportsPushState =
   window.history and window.history.pushState and window.history.replaceState and window.history.state != undefined

data/lib/turbolinks.rb

@@ -26,12 +26,37 @@ module Turbolinks
         cookies[:request_method] = request.request_method
       end
   end
-  
+
+  module XDomainBlocker
+    private
+    def same_origin?(a, b)
+      a = URI.parse(a)
+      b = URI.parse(b)
+      [a.scheme, a.host, a.port] == [b.scheme, b.host, b.port]
+    end
+
+    def abort_xdomain_redirect
+      to_uri = response.headers['Location'] || ""
+      current = request.headers['X-XHR-Referer'] || ""
+      unless to_uri.blank? || current.blank? || same_origin?(current, to_uri)
+        self.status = 403
+      end
+    end
+  end
+
   class Engine < ::Rails::Engine
     initializer :turbolinks_xhr_headers do |config|
       ActionController::Base.class_eval do
-        include XHRHeaders, Cookies
+        include XHRHeaders, Cookies, XDomainBlocker
         before_filter :set_xhr_current_location, :set_request_method_cookie
+        after_filter :abort_xdomain_redirect
+      end
+      
+      ActionDispatch::Request.class_eval do
+        def referer
+          self.headers['X-XHR-Referer'] || super
+        end
+        alias referrer referer
       end
     end
   end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: turbolinks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -46,27 +43,26 @@ files:
 - test/reload.html
 homepage: 
 licenses: []
+metadata: {}
 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.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Turbolinks makes following links in your web application faster (use with
   Rails Asset Pipeline)
 test_files: []