turbolinks 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7189329adf13178c8d0734735e1affc9f7cabbcd
-  data.tar.gz: ee154008520bd38704aa60fe9519fa71a74fb43b
+  metadata.gz: 81b3f537e66ca790fc7d3582de6eb2eab6d1b9b9
+  data.tar.gz: b9f0c3ed62c42062e678b92676012d08ad8decfc
 SHA512:
-  metadata.gz: be97d3f28a06864e225e9d384d0aa714c175163410fd9079a4d3770e0d17d581b35bfa043b674480d4cf0ec17e76614615032d1fed2c4a652ce04e8ffdbe0248
-  data.tar.gz: 6553c4009a6b45a5163456f31c6bab1dd33a3f49e7fa0513f346f4c781f8bee57660e5b4a8d7fbae7202a4b284b2e0a211a330bed69c73008d479aab7a66d5fb
+  metadata.gz: 34ec20469fdcfa96705c4b3b1639c963196568cf78c46f9d24083849d93c4193acb5cca47b28e2caf7edcc2907586e1793394aa04a80304afe607fd3d8f91429
+  data.tar.gz: faf3469bb52dc2adba9e96634946c5b5cc775c5be9a77ead70cde60a80a29b3737f3634b68d7e1d31a5bb6ab1bed3891bbd40219d99cdc26b89387fc08757892

data/README.md

@@ -27,20 +27,26 @@ Turbolinks is designed to be as light-weight as possible (so you won't think twi
 Events
 ------
 
-Since pages will change without a full reload with Turbolinks, you can't by default rely on `DOMContentLoaded` to trigger your JavaScript code or jQuery.ready(). Instead, Turbolinks fires events on `document` to provide hooks into the lifecycle of the page:
+With Turbolinks pages will change without a full reload, so you can't rely on `DOMContentLoaded` or `jQuery.ready()` to trigger your code. Instead Turbolinks fires events on `document` to provide hooks into the lifecycle of the page:
 
-* `page:fetch`   starting to fetch the target page (only called if loading fresh, not from cache).
-* `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.
+*Load* a fresh version of a page from the server:
+* `page:fetch` starting to fetch a new target page
+* `page:receive` the page has been fetched from the server, but not yet parsed
+* `page:change` the page has been parsed and changed to the new version
+* `page:load` is fired at the end of the loading process.
+
+Turbolinks caches 10 of these page loads. It listens to the [popstate](https://developer.mozilla.org/en-US/docs/DOM/Manipulating_the_browser_history#The_popstate_event) event and attempts restore page state from the cache when it's triggered. When `popstate` is fired the following process happens:
+
+*Restore* a cached page from the client-side cache:
+* `page:change` page has changed to the cached page.
+* `page:restore` is fired at the end of restore process.
 
 So if you wanted to have a client-side spinner, you could listen for `page:fetch` to start it and `page:receive` to stop it.
 
     document.addEventListener("page:fetch", startSpinner);
     document.addEventListener("page:receive", stopSpinner);
     
-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).
+DOM transformations that are idempotent are best. If you have transformations that are not, hook them to happen only on `page:load` instead of `page:change` (as that would run them again on the cached pages).
 
 Initialization
 --------------
@@ -62,6 +68,13 @@ Opting out of Turbolinks
 
 By default, all internal HTML links will be funneled through Turbolinks, but you can opt out by marking links or their parent container with `data-no-turbolink`. For example, if you mark a div with `data-no-turbolink`, then all links inside of that div will be treated as regular links. If you mark the body, every link on that entire page will be treated as regular links.
 
+```html
+<a href="/">Home (via Turbolinks)</a>
+<div id="some-div" data-no-turbolink>
+  <a href="/">Home (without Turbolinks)</a>
+</div>
+```
+
 Note that internal links to files not ending in .html, or having no extension, will automatically be opted out of Turbolinks. So links to /images/panda.gif will just work as expected.
 
 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.
@@ -97,7 +110,13 @@ 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.
+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. If you have any script tags in the body you do not want to be re-evaluated then you can set the `data-turbolinks-eval` attribute to `false`:
+
+```html
+<script type="text/javascript" data-turbolinks-eval=false>
+  console.log("I'm only run once on the initial page load");
+</script>
+```
 
 Triggering a Turbolinks visit manually
 ---------------------------------------
@@ -116,7 +135,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.  For help with this, check out the [Turbolinks Compatibility](http://reed.github.com/turbolinks-compatibility) project.
+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.io/turbolinks-compatibility) project.
 
 
 Installation

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

@@ -28,14 +28,12 @@ fetchReplacement = (url) ->
   xhr.setRequestHeader 'Accept', 'text/html, application/xhtml+xml, application/xml'
   xhr.setRequestHeader 'X-XHR-Referer', referer
 
-  xhr.onload = =>
+  xhr.onload = ->
     triggerEvent 'page:receive'
-    
-    if invalidContent(xhr) or assetsChanged (doc = createDocument xhr.responseText)
-      document.location.reload()
-    else
+
+    if doc = validateResponse()
       changePage extractTitleAndBody(doc)...
-      reflectRedirectedUrl xhr
+      reflectRedirectedUrl()
       if document.location.hash
         document.location.href = document.location.href
       else
@@ -87,7 +85,7 @@ changePage = (title, body, csrfToken, runScripts) ->
   triggerEvent 'page:change'
 
 executeScriptTags = ->
-  scripts = Array::slice.call document.body.getElementsByTagName 'script'
+  scripts = Array::slice.call document.body.querySelectorAll 'script:not([data-turbolinks-eval="false"])'
   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
@@ -107,9 +105,10 @@ reflectNewUrl = (url) ->
     referer = document.location.href
     window.history.pushState { turbolinks: true, position: currentState.position + 1 }, '', url
 
-reflectRedirectedUrl = (xhr) ->
-  if (location = xhr.getResponseHeader 'X-XHR-Current-Location') and location isnt document.location.pathname + document.location.search
-    window.history.replaceState currentState, '', location + document.location.hash
+reflectRedirectedUrl = ->
+  if location = xhr.getResponseHeader 'X-XHR-Redirected-To'
+    preservedHash = if removeHash(location) is location then document.location.hash else ''
+    window.history.replaceState currentState, '', location + preservedHash
 
 rememberCurrentUrl = ->
   window.history.replaceState { turbolinks: true, position: Date.now() }, '', document.location.href
@@ -137,27 +136,42 @@ removeHash = (url) ->
     link.href = url
   link.href.replace link.hash, ''
 
-
 triggerEvent = (name) ->
   event = document.createEvent 'Events'
   event.initEvent name, true, true
   document.dispatchEvent event
 
 
-invalidContent = (xhr) ->
-  !xhr.getResponseHeader('Content-Type').match /^(?:text\/html|application\/xhtml\+xml|application\/xml)(?:;|$)/
+validateResponse = ->
+  clientOrServerError = ->
+    400 <= xhr.status < 600
+
+  invalidContent = ->
+    !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')?
 
-extractTrackAssets = (doc) ->
-  (node.src || node.href) for node in doc.head.childNodes when node.getAttribute?('data-turbolinks-track')?
+  assetsChanged = (doc) ->
+    loadedAssets ||= extractTrackAssets document
+    fetchedAssets  = extractTrackAssets doc
+    fetchedAssets.length isnt loadedAssets.length or intersection(fetchedAssets, loadedAssets).length isnt loadedAssets.length
 
-assetsChanged = (doc) ->
-  loadedAssets ||= extractTrackAssets document
-  fetchedAssets  = extractTrackAssets doc
-  fetchedAssets.length isnt loadedAssets.length or intersection(fetchedAssets, loadedAssets).length isnt loadedAssets.length
+  intersection = (a, b) ->
+    [a, b] = [b, a] if a.length > b.length
+    value for value in a when value in b
 
-intersection = (a, b) ->
-  [a, b] = [b, a] if a.length > b.length
-  value for value in a when value in b
+  if clientOrServerError()
+    # Workaround for WebKit bug (https://bugs.webkit.org/show_bug.cgi?id=93506)
+    url = document.location.href
+    window.history.replaceState null, '', '#'
+    window.location.replace url
+    false
+  else if invalidContent() or assetsChanged (doc = createDocument xhr.responseText)
+    window.location.reload()
+    false
+  else
+    doc
 
 extractTitleAndBody = (doc) ->
   title = doc.querySelector 'title'
@@ -167,12 +181,12 @@ CSRFToken =
   get: (doc = document) ->
     node:   tag = doc.querySelector 'meta[name="csrf-token"]'
     token:  tag?.getAttribute? 'content'
-    
+
   update: (latest) ->
     current = @get()
     if current.token? and latest? and current.token isnt latest
       current.node.setAttribute 'content', latest
-      
+
 browserCompatibleDocumentParser = ->
   createDocumentUsingParser = (html) ->
     (new DOMParser).parseFromString html, 'text/html'

data/lib/turbolinks.rb

@@ -8,15 +8,18 @@ module Turbolinks
 
     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
+        session[:_turbolinks_redirect_to] =
+          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
+      def set_xhr_redirected_to
+        if session[:_turbolinks_redirect_to]
+          response.headers['X-XHR-Redirected-To'] = session.delete :_turbolinks_redirect_to
+        end
       end
   end
 
@@ -30,8 +33,8 @@ module Turbolinks
   module XDomainBlocker
     private
     def same_origin?(a, b)
-      a = URI.parse(a)
-      b = URI.parse(b)
+      a = URI.parse URI.escape(a)
+      b = URI.parse URI.escape(b)
       [a.scheme, a.host, a.port] == [b.scheme, b.host, b.port]
     end
 
@@ -48,10 +51,10 @@ module Turbolinks
     initializer :turbolinks_xhr_headers do |config|
       ActionController::Base.class_eval do
         include XHRHeaders, Cookies, XDomainBlocker
-        before_filter :set_xhr_current_location, :set_request_method_cookie
+        before_filter :set_xhr_redirected_to, :set_request_method_cookie
         after_filter :abort_xdomain_redirect
       end
-      
+
       ActionDispatch::Request.class_eval do
         def referer
           self.headers['X-XHR-Referer'] || super

data/test/config.ru

@@ -11,4 +11,10 @@ map "/js" do
   run Assets
 end
 
-run Rack::Directory.new(File.join(Root, "test"))
+map "/500" do
+  # throw Internal Server Error (500)
+end
+
+map "/" do
+  run Rack::Directory.new(File.join(Root, "test"))
+end

data/test/index.html

@@ -21,12 +21,17 @@
     <li><a href="#">Hash link</a></li>
     <li><a href="/reload.html#foo">New assets track with hash link</a></li>
     <li><h5>If you stop the server or go into airplane/offline mode</h5></li>
-    <li><a href="/doesnotexist.html">A page that errors should error out</a></li>
+    <li><a href="/doesnotexist.html">A page with client error (4xx, rfc2616 sec. 10.4) should error out</a></li>
+    <li><a href="/500">Also server errors (5xx, rfc2616 sec. 10.5) should error out</a></li>
     <li><a href="/fallback.html">A page that has a fallback in appcache should fallback</a></li>
   </ul>
 
   <div style="background:#ccc;height:5000px;width:200px;">
   </div>
   <iframe height='1' scrolling='no' src='/offline.html' style='display: none;' width='1'></iframe>
+
+  <script type="text/javascript" data-turbolinks-eval=false>
+    console.log("turbolinks-eval-false script fired. This should only happen on the initial page load.");
+  </script>
 </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbolinks
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails