turbolinks 0.6.1 → 1.0.0

data/README.md

@@ -37,6 +37,21 @@ Since pages will change without a full reload with Turbolinks, you can't by defa
 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).
 
 
+Initialization
+--------------
+
+Turbolinks will be enabled **only** if the server has rendered a `GET` request.
+
+Some examples, given a standard RESTful resource:
+
+* `POST :create` => resource successfully created => redirect to `GET :show`
+  * Turbolinks **ENABLED**
+* `POST :create` => resource creation failed => render `:new`
+  * Turbolinks **DISABLED**
+
+**Why not all request types?** Some browsers track the request method of each page load, but triggering pushState methods don't change this value.  This could lead to the situation where pressing the browser's reload button on a page that was fetched with Turbolinks would attempt a `POST` (or something other than `GET`) because the last full page load used that method.
+
+
 Opting out of Turbolinks
 ------------------------
 

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

@@ -4,6 +4,8 @@ referer        = document.location.href
 loadedAssets   = null
 pageCache      = {}
 createDocument = null
+requestMethod  = document.cookie.match(/request_method=(\w+)/)?[1].toUpperCase() or ''
+xhr            = null
 
 visit = (url) ->
   if browserSupportsPushState
@@ -17,11 +19,16 @@ visit = (url) ->
 fetchReplacement = (url) ->
   triggerEvent 'page:fetch'
 
+  # Remove hash from url to ensure IE 10 compatibility
+  safeUrl = removeHash url
+
+  xhr.abort() if xhr
   xhr = new XMLHttpRequest
-  xhr.open 'GET', url, true
+  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
 
@@ -30,10 +37,16 @@ fetchReplacement = (url) ->
     else
       changePage extractTitleAndBody(doc)...
       reflectRedirectedUrl xhr
-      resetScrollPosition()
+      if document.location.hash
+        document.location.href = document.location.href
+      else
+        resetScrollPosition()
       triggerEvent 'page:load'
+    xhr = null
 
-  xhr.onabort = -> console.log 'Aborted turbolink fetch!'
+  xhr.onerror = ->
+    document.location.href = url
+    xhr = null
 
   xhr.send()
 
@@ -73,15 +86,12 @@ changePage = (title, body, runScripts) ->
 
 executeScriptTags = ->
   for script in document.body.getElementsByTagName 'script' when script.type in ['', 'text/javascript']
-    if script.src? and script.src isnt '' and not script.getAttribute('data-turbolinks-evaluated')?
-      copy = document.createElement 'script'
-      copy.setAttribute attr.name, attr.value for attr in script.attributes
-      copy.setAttribute 'data-turbolinks-evaluated', ''
-      parent = script.parentNode
-      parent.removeChild script
-      parent.insertBefore copy, parent.childNodes[0]
-    else
-      window.eval(script.innerHTML)
+    copy = document.createElement 'script'
+    copy.setAttribute attr.name, attr.value for attr in script.attributes
+    copy.appendChild document.createTextNode script.innerHTML
+    { parentNode, nextSibling } = script
+    parentNode.removeChild script
+    parentNode.insertBefore copy, nextSibling
 
 
 reflectNewUrl = (url) ->
@@ -90,7 +100,7 @@ reflectNewUrl = (url) ->
     window.history.pushState { turbolinks: true, position: currentState.position + 1 }, '', url
 
 reflectRedirectedUrl = (xhr) ->
-  unless (location = xhr.getResponseHeader 'X-XHR-Current-Location') is document.location.pathname + document.location.search
+  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
 
 rememberCurrentUrl = ->
@@ -112,6 +122,13 @@ recallScrollPosition = (page) ->
 resetScrollPosition = ->
   window.scrollTo 0, 0
 
+removeHash = (url) ->
+  link = url
+  unless url.href?
+    link = document.createElement 'A'
+    link.href = url
+  link.href.replace link.hash, ''
+
 
 triggerEvent = (name) ->
   event = document.createEvent 'Events'
@@ -163,7 +180,7 @@ installClickHandlerLast = (event) ->
 handleClick = (event) ->
   unless event.defaultPrevented
     link = extractLink event
-    if link?.nodeName is 'A' and !ignoreClick(event, link)
+    if link.nodeName is 'A' and !ignoreClick(event, link)
       visit link.href
       event.preventDefault()
 
@@ -177,7 +194,7 @@ crossOriginLink = (link) ->
   location.protocol isnt link.protocol or location.host isnt link.host
 
 anchoredLink = (link) ->
-  ((link.hash and link.href.replace(link.hash, '')) is location.href.replace(location.hash, '')) or
+  ((link.hash and removeHash(link)) is removeHash(location)) or
     (link.href is location.href + '#')
 
 nonHtmlLink = (link) ->
@@ -199,14 +216,21 @@ ignoreClick = (event, link) ->
   crossOriginLink(link) or anchoredLink(link) or nonHtmlLink(link) or noTurbolink(link) or targetLink(link) or nonStandardClick(event)
 
 
+initializeTurbolinks = ->
+  document.addEventListener 'click', installClickHandlerLast, true
+  window.addEventListener 'popstate', (event) ->
+    fetchHistory event.state if event.state?.turbolinks
+
 browserSupportsPushState =
   window.history and window.history.pushState and window.history.replaceState and window.history.state != undefined
 
-if browserSupportsPushState
-  document.addEventListener 'click', installClickHandlerLast, true
+browserIsntBuggy =
+  !navigator.userAgent.match /CriOS\//
 
-  window.addEventListener 'popstate', (event) ->
-    fetchHistory event.state if event.state?.turbolinks
+requestMethodIsSafe =
+  requestMethod in ['GET','']
+
+initializeTurbolinks() if browserSupportsPushState and browserIsntBuggy and requestMethodIsSafe
 
 # Call Turbolinks.visit(url) from client code
 @Turbolinks = { visit }

data/lib/turbolinks.rb

@@ -20,11 +20,18 @@ module Turbolinks
       end
   end
 
+  module Cookies
+    private
+      def set_request_method_cookie
+        cookies[:request_method] = request.request_method
+      end
+  end
+  
   class Engine < ::Rails::Engine
     initializer :turbolinks_xhr_headers do |config|
       ActionController::Base.class_eval do
-        include XHRHeaders
-        before_filter :set_xhr_current_location
+        include XHRHeaders, Cookies
+        before_filter :set_xhr_current_location, :set_request_method_cookie
       end
     end
   end

data/test/index.html

@@ -20,9 +20,13 @@
     <li><a href="/dummy.gif?12345">Query Param Image Link</a></li>
     <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="/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>
 </body>
 </html>

data/test/manifest.appcache

@@ -0,0 +1,10 @@
+CACHE MANIFEST
+
+CACHE:
+/offline.html
+
+NETWORK:
+*
+
+FALLBACK:
+/fallback.html /offline.html

data/test/offline.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en" manifest="/manifest.appcache">
+<head>
+  <meta charset="utf-8">
+  <title>Home</title>
+  <script type="text/javascript" src="/js/turbolinks.js"></script>
+  <script type="text/javascript">
+    document.addEventListener("page:change", function() {
+      console.log("page changed");
+    });
+  </script>
+</head>
+<body class="page-offline">
+  <h1>Offline Mode Fallback</h1>
+  <ul>
+    <li><a href="/index.html">Home</a></li>
+  </ul>
+</body>
+</html>

metadata

@@ -1,32 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: turbolinks
 version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  version: 0.6.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-04 00:00:00.000000000 Z
+date: 2013-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: coffee-rails
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: 
 email: david@loudthinking.com
 executables: []
@@ -40,6 +40,8 @@ files:
 - test/config.ru
 - test/dummy.gif
 - test/index.html
+- test/manifest.appcache
+- test/offline.html
 - test/other.html
 - test/reload.html
 homepage: 
@@ -49,17 +51,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23