turbolinks 0.3.3 → 0.4.0

data/README.md

@@ -3,11 +3,19 @@ Turbolinks
 
 Turbolinks makes following links in your web application faster. Instead of letting the browser recompile the JavaScript and CSS between each page change, we keep the current page instance alive and replace only the body and the title in the head (and potentially spend extra HTTP requests checking if the assets are up-to-date). Think CGI vs persistent process.
 
-This is similar to pjax, but instead of worrying about what element on the page to replace, and tailoring the server-side response to fit, we replace the entire body. This means that you get the bulk of the speed benefits from pjax (no recompiling of the JavaScript or CSS) without having to tailor the server-side response. It just works.
+This is similar to [pjax](https://github.com/defunkt/jquery-pjax), but instead of worrying about what element on the page to replace, and tailoring the server-side response to fit, we replace the entire body. This means that you get the bulk of the speed benefits from pjax (no recompiling of the JavaScript or CSS) without having to tailor the server-side response. It just works.
 
 By default, all internal links will be funneled through Turbolinks, but you can opt out by marking links with data-no-turbolink.
 
 
+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.
+
+
 No jQuery or any other framework
 --------------------------------
 

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

@@ -1,6 +1,8 @@
 pageCache    = []
 currentState = null
 initialized  = false
+referer      = document.location.href
+
 
 visit = (url) ->
   if browserSupportsPushState
@@ -13,12 +15,13 @@ visit = (url) ->
 
 fetchReplacement = (url) ->
   triggerEvent 'page:fetch'
-
   xhr = new XMLHttpRequest
   xhr.open 'GET', url, true
   xhr.setRequestHeader 'Accept', 'text/html, application/xhtml+xml, application/xml'
+  xhr.setRequestHeader 'X-XHR-Referer', referer
   xhr.onload  = ->
     changePage extractTitleAndBody(xhr.responseText)...
+    reflectRedirectedUrl xhr
     triggerEvent 'page:load'
   xhr.onabort = -> console.log 'Aborted turbolink fetch!'
   xhr.send()
@@ -47,21 +50,28 @@ cacheCurrentPage = ->
   constrainPageCacheTo(10)
 
 constrainPageCacheTo = (limit) ->
-  delete pageCache[currentState.position - limit] if currentState.position == window.history.length - 1
-
+  delete pageCache[currentState.position - limit]
 
 changePage = (title, body) ->
   document.title = title
   document.documentElement.replaceChild body, document.body
-
+  executeScriptTags()
   currentState = window.history.state
   triggerEvent 'page:change'
 
+executeScriptTags = ->
+  eval(script.innerHTML) for script in document.body.getElementsByTagName 'script'
+
 
 reflectNewUrl = (url) ->
   if url isnt document.location.href
+    referer = document.location.href
     window.history.pushState { turbolinks: true, position: currentState.position + 1 }, '', url
 
+reflectRedirectedUrl = (xhr) ->
+  if (location = xhr.getResponseHeader('X-XHR-Current-Location'))
+    window.history.replaceState currentState, '', location
+
 rememberCurrentUrl = ->
   window.history.replaceState { turbolinks: true, position: window.history.length - 1 }, '', document.location.href
 
@@ -89,7 +99,7 @@ extractTitleAndBody = (html) ->
   title = doc.querySelector 'title'
   [ title?.textContent, doc.body ]
 
-createDocument = do ->
+createDocument = (html) ->
   createDocumentUsingParser = (html) ->
     (new DOMParser).parseFromString html, 'text/html'
 
@@ -104,17 +114,24 @@ createDocument = do ->
     testDoc = createDocumentUsingParser '<html><body><p>test'
 
   if testDoc?.body?.childNodes.length is 1
-    createDocumentUsingParser
+    createDocumentUsingParser html
   else
-    createDocumentUsingWrite
+    createDocumentUsingWrite html
 
 
+installClickHandlerLast = (event) ->
+  unless event.defaultPrevented
+    document.removeEventListener 'click', handleClick
+    document.addEventListener 'click', handleClick
+
 handleClick = (event) ->
-  link = extractLink event
+  unless event.defaultPrevented
+    link = extractLink event
+    if link.nodeName is 'A' and !ignoreClick(event, link)
+      link = extractLink event
+      visit link.href
+      event.preventDefault()
 
-  if link.nodeName is 'A' and !ignoreClick(event, link)
-    visit link.href
-    event.preventDefault()
 
 extractLink = (event) ->
   link = event.target
@@ -134,30 +151,28 @@ anchoredLink = (link) ->
 nonHtmlLink = (link) ->
   link.href.match(/\.[a-z]+(\?.*)?$/g) and not link.href.match(/\.html?(\?.*)?$/g)
 
-remoteLink = (link) ->
-  link.getAttribute('data-remote')?
-
 noTurbolink = (link) ->
-  link.getAttribute('data-no-turbolink')?
+  until ignore or link is document
+    ignore = link.getAttribute('data-no-turbolink')?
+    link = link.parentNode
+  ignore
 
-newTabClick = (event) ->
-  event.which > 1 or event.metaKey or event.ctrlKey
+nonStandardClick = (event) ->
+  event.which > 1 or event.metaKey or event.ctrlKey or event.shiftKey or event.altKey
 
 ignoreClick = (event, link) ->
-  samePageLink(link) or crossOriginLink(link) or anchoredLink(link) or
-  nonHtmlLink(link)  or remoteLink(link)      or noTurbolink(link)  or 
-  newTabClick(event)
+  crossOriginLink(link) or anchoredLink(link) or nonHtmlLink(link) or
+  noTurbolink(link)     or nonStandardClick(event)
 
 
 browserSupportsPushState =
-  window.history and window.history.pushState and window.history.replaceState
+  window.history and window.history.pushState and window.history.replaceState and window.history.state != undefined
 
 if browserSupportsPushState
   window.addEventListener 'popstate', (event) ->
     fetchHistory event.state if event.state?.turbolinks
 
-  document.addEventListener 'click', (event) ->
-    handleClick event
+  document.addEventListener 'click', installClickHandlerLast, true
 
 # Call Turbolinks.visit(url) from client code
-@Turbolinks = visit: visit
+@Turbolinks = { visit }

data/lib/turbolinks.rb

@@ -1,4 +1,31 @@
 module Turbolinks
+  module XHRHeaders
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :_compute_redirect_to_location, :xhr_referer
+    end
+
+    private
+      def _compute_redirect_to_location_with_xhr_referer(options)
+        if options == :back && request.headers["X-XHR-Referer"]
+          _compute_redirect_to_location_without_xhr_referer(request.headers["X-XHR-Referer"])
+        else
+          _compute_redirect_to_location_without_xhr_referer(options)
+        end
+      end
+
+      def set_xhr_current_location
+        response.headers['X-XHR-Current-Location'] = request.fullpath
+      end
+  end
+
   class Engine < ::Rails::Engine
+    initializer :turbolinks_xhr_headers do |config|
+      ActionController::Base.class_eval do
+        include XHRHeaders
+        after_filter :set_xhr_current_location
+      end
+    end
   end
-end
+end

data/test/index.html

@@ -15,6 +15,7 @@
     <li><a href="/other.html">Other page</a></li>
     <li><a href="/other.html"><span>Wrapped link</span></a></li>
     <li><a href="http://www.google.com/">Cross origin</a></li>
+    <li><a href="/other.html" onclick="if(!confirm('follow link?')) { return false}">Confirm Fire Order</a></li>
     <li><a href="/dummy.gif?12345">Query Param Image Link</a></li>
     <li><a href="#">Hash link</a></li>
   </ul>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbolinks
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: david@loudthinking.com
@@ -45,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Turbolinks makes following links in your web application faster (use with