turbolinks 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa1a853f7bfa398507ab56f01f6f60e701e5d610
-  data.tar.gz: 1b905b7d3b6d6d536766371fecada3d7c8e033e3
+  metadata.gz: 42e6215f4902695d105228b3ee98d24219a2d690
+  data.tar.gz: 57aa487dbbb45d7cd209b295cc0006e6c602c853
 SHA512:
-  metadata.gz: 4e41529e84e22f5c3ca8bcf57587888efb44b670bd28e1c1cb1712e8c46fe4dc4576b0caf7287ebcea260970885d02dbb76fc3c2930785d6dcd845f21ad08f2b
-  data.tar.gz: 734e50ff840b75516f8645985e20c47419a74a3ec378a3d08396935eac562b3afebba6d7680d14a3ecf3195ad474b433e26ae7d40caf82c4507c7d77ed705e92
+  metadata.gz: d0619a0efb53282613f6e745e89d2eb3bf21673b8b460e9aba14f4bbf6f41df1dd59fb2d555c43ad399a3600f2de8d647764c9af1a32755a693faaf805becefc
+  data.tar.gz: 0e983e4382e1ec55236bc832c4c0021b5fb5766fa3b78e51a5d6d637329eff87a5329c76d281d7c31cb84f0bbd2cf39f913d21077cfecfb5690398879672644d

data/README.md

@@ -18,10 +18,10 @@ In any case, the benefit can be up to [twice as fast](https://github.com/stevekl
 The best way to find out just how fast it is? Try it on your own application. It hardly takes any effort at all.
 
 
-No jQuery or any other framework
+No jQuery or any other library
 --------------------------------
 
-Turbolinks is designed to be as light-weight as possible (so you won't think twice about using it even for mobile stuff). It does not require jQuery or any other framework to work. But it works great _with_ jQuery or Prototype or whatever else have you.
+Turbolinks is designed to be as light-weight as possible (so you won't think twice about using it even for mobile stuff). It does not require jQuery or any other library to work. But it works great _with_ the jQuery or Prototype framework, or whatever else have you.
 
 
 Events
@@ -33,10 +33,11 @@ With Turbolinks pages will change without a full reload, so you can't rely on `D
 * `page:before-change` a Turbolinks-enabled link has been clicked *(see below for more details)*
 * `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:change` the page has been parsed and changed to the new version and on DOMContentLoaded
+* `page:update` is triggered whenever page:change is PLUS on jQuery's ajaxSucess, if jQuery is available (otherwise you can manually trigger it when calling XMLHttpRequest in your own code)
 * `page:load` is fired at the end of the loading process.
 
-Handlers bound to the `page:before-change` event may return `false`, which will cancel the Turbolinks process. 
+Handlers bound to the `page:before-change` event may return `false`, which will cancel the Turbolinks process.
 
 By default, 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 to restore page state from the cache when it's triggered. When `popstate` is fired the following process happens:
 
@@ -58,7 +59,7 @@ To implement a client-side spinner, you could listen for `page:fetch` to start i
 
     document.addEventListener("page:fetch", startSpinner);
     document.addEventListener("page:receive", stopSpinner);
-    
+
 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
@@ -88,7 +89,7 @@ By default, all internal HTML links will be funneled through Turbolinks, but you
 </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.
+Note that internal links to files containing a file extension other than **.html** 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.
 
@@ -139,6 +140,8 @@ Triggering a Turbolinks visit manually
 
 You can use `Turbolinks.visit(path)` to go to a URL through Turbolinks.
 
+You can also use `redirect_via_turbolinks_to` in Rails to perform a redirect via Turbolinks.
+
 
 Full speed for pushState browsers, graceful fallback for everything else
 ------------------------------------------------------------------------
@@ -165,7 +168,10 @@ Installation
 Language Ports
 --------------
 
+*These projects are not affiliated with or endorsed by the Rails Turbolinks team.*
+
 * [Flask Turbolinks](https://github.com/lepture/flask-turbolinks) (Python Flask)
+* [ASP.NET MVC Turbolinks](https://github.com/kazimanzurrashid/aspnetmvcturbolinks)
 
 Credits
 -------

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

@@ -1,22 +1,22 @@
+pageCache      = {}
 cacheSize      = 10
 currentState   = null
-referer        = null
 loadedAssets   = null
-pageCache      = {}
+
+referer        = null
+
 createDocument = null
-requestMethod  = document.cookie.match(/request_method=(\w+)/)?[1].toUpperCase() or ''
 xhr            = null
 
 
-fetchReplacement = (url) ->
-  triggerEvent 'page:fetch'
-
-  # Remove hash from url to ensure IE 10 compatibility
-  safeUrl = removeHash url
+fetchReplacement = (url) ->  
+  rememberReferer()
+  cacheCurrentPage()
+  triggerEvent 'page:fetch', url: url
 
   xhr?.abort()
   xhr = new XMLHttpRequest
-  xhr.open 'GET', safeUrl, true
+  xhr.open 'GET', removeHashForIE10compatiblity(url), true
   xhr.setRequestHeader 'Accept', 'text/html, application/xhtml+xml, application/xml'
   xhr.setRequestHeader 'X-XHR-Referer', referer
 
@@ -27,10 +27,7 @@ fetchReplacement = (url) ->
       reflectNewUrl url
       changePage extractTitleAndBody(doc)...
       reflectRedirectedUrl()
-      if document.location.hash
-        document.location.href = document.location.href
-      else
-        resetScrollPosition()
+      resetScrollPosition()
       triggerEvent 'page:load'
     else
       document.location.href = url
@@ -41,12 +38,11 @@ fetchReplacement = (url) ->
 
   xhr.send()
 
-fetchHistory = (position) ->
+fetchHistory = (cachedPage) ->
   cacheCurrentPage()
-  page = pageCache[position]
   xhr?.abort()
-  changePage page.title, page.body
-  recallScrollPosition page
+  changePage cachedPage.title, cachedPage.body
+  recallScrollPosition cachedPage
   triggerEvent 'page:restore'
 
 
@@ -76,6 +72,7 @@ changePage = (title, body, csrfToken, runScripts) ->
   executeScriptTags() if runScripts
   currentState = window.history.state
   triggerEvent 'page:change'
+  triggerEvent 'page:update'
 
 executeScriptTags = ->
   scripts = Array::slice.call document.body.querySelectorAll 'script:not([data-turbolinks-eval="false"])'
@@ -102,6 +99,9 @@ reflectRedirectedUrl = ->
     preservedHash = if removeHash(location) is location then document.location.hash else ''
     window.history.replaceState currentState, '', location + preservedHash
 
+rememberReferer = ->
+  referer = document.location.href
+
 rememberCurrentUrl = ->
   window.history.replaceState { turbolinks: true, position: Date.now() }, '', document.location.href
 
@@ -112,7 +112,15 @@ recallScrollPosition = (page) ->
   window.scrollTo page.positionX, page.positionY
 
 resetScrollPosition = ->
-  window.scrollTo 0, 0
+  if document.location.hash
+    document.location.href = document.location.href
+  else
+    window.scrollTo 0, 0
+
+
+# Intention revealing function alias
+removeHashForIE10compatiblity = (url) ->
+  removeHash url
 
 removeHash = (url) ->
   link = url
@@ -121,8 +129,14 @@ removeHash = (url) ->
     link.href = url
   link.href.replace link.hash, ''
 
-triggerEvent = (name) ->
+popCookie = (name) ->
+  value = document.cookie.match(new RegExp(name+"=(\\w+)"))?[1].toUpperCase() or ''
+  document.cookie = name + '=; expires=Thu, 01-Jan-70 00:00:01 GMT; path=/'
+  value
+
+triggerEvent = (name, data) ->
   event = document.createEvent 'Events'
+  event.data = data if data
   event.initEvent name, true, true
   document.dispatchEvent event
 
@@ -250,20 +264,33 @@ nonStandardClick = (event) ->
 ignoreClick = (event, link) ->
   crossOriginLink(link) or anchoredLink(link) or nonHtmlLink(link) or noTurbolink(link) or targetLink(link) or nonStandardClick(event)
 
+
+installDocumentReadyPageEventTriggers = ->
+  document.addEventListener 'DOMContentLoaded', ( ->
+    triggerEvent 'page:change'
+    triggerEvent 'page:update'
+  ), true
+
+installJqueryAjaxSuccessPageUpdateTrigger = ->
+  if typeof jQuery isnt 'undefined'
+    jQuery(document).on 'ajaxSuccess', (event, xhr, settings) ->
+      return unless jQuery.trim xhr.responseText
+      triggerEvent 'page:update'
+
+installHistoryChangeHandler = (event) ->
+  if event.state?.turbolinks
+    if cachedPage = pageCache[event.state.position]
+      fetchHistory cachedPage
+    else
+      visit event.target.location.href
+
 initializeTurbolinks = ->
   rememberCurrentUrl()
   rememberCurrentState()
   createDocument = browserCompatibleDocumentParser()
-  document.addEventListener 'click', installClickHandlerLast, true
-  window.addEventListener 'popstate', (event) ->
-    state = event.state
 
-    if state?.turbolinks
-      if pageCache[state.position]
-        fetchHistory state.position
-      else
-        visit event.target.location.href
-  , false
+  document.addEventListener 'click', installClickHandlerLast, true
+  window.addEventListener 'popstate', installHistoryChangeHandler, false
 
 browserSupportsPushState =
   window.history and window.history.pushState and window.history.replaceState and window.history.state != undefined
@@ -272,21 +299,22 @@ browserIsntBuggy =
   !navigator.userAgent.match /CriOS\//
 
 requestMethodIsSafe =
-  requestMethod in ['GET','']
+  popCookie('request_method') in ['GET','']
+
+browserSupportsTurbolinks = browserSupportsPushState and browserIsntBuggy and requestMethodIsSafe
 
-if browserSupportsPushState and browserIsntBuggy and requestMethodIsSafe
-  visit = (url) ->
-    referer = document.location.href
-    cacheCurrentPage()
-    fetchReplacement url
+installDocumentReadyPageEventTriggers()
+installJqueryAjaxSuccessPageUpdateTrigger()
 
+if browserSupportsTurbolinks
+  visit = fetchReplacement
   initializeTurbolinks()
 else
-  visit = (url) ->
-    document.location.href = url
+  visit = (url) -> document.location.href = url
 
 # Public API
 #   Turbolinks.visit(url)
-#   Turbolinks.pagesCached() 
+#   Turbolinks.pagesCached()
 #   Turbolinks.pagesCached(20)
-@Turbolinks = { visit, pagesCached }
+#   Turbolinks.supported
+@Turbolinks = { visit, pagesCached, supported: browserSupportsTurbolinks }

data/lib/turbolinks.rb

@@ -47,10 +47,22 @@ module Turbolinks
     end
   end
 
+  module Redirection
+    extend ActiveSupport::Concern
+    
+    def redirect_via_turbolinks_to(url = {}, response_status = {})
+      redirect_to(url, response_status)
+
+      self.status           = 200
+      self.response_body    = "Turbolinks.visit('#{location}');"
+      response.content_type = Mime::JS
+    end
+  end
+
   class Engine < ::Rails::Engine
     initializer :turbolinks_xhr_headers do |config|
       ActionController::Base.class_eval do
-        include XHRHeaders, Cookies, XDomainBlocker
+        include XHRHeaders, Cookies, XDomainBlocker, Redirection
         before_filter :set_xhr_redirected_to, :set_request_method_cookie
         after_filter :abort_xdomain_redirect
       end

data/test/index.html

@@ -8,6 +8,14 @@
     document.addEventListener("page:change", function() {
       console.log("page changed");
     });
+
+    document.addEventListener("page:update", function() {
+      console.log("page updated");
+    });
+
+    document.addEventListener("page:restore", function() {
+      console.log("page restored");
+    });
   </script>
 </head>
 <body class="page-index">

data/test/other.html

@@ -8,6 +8,14 @@
     document.addEventListener("page:change", function() {
       console.log("page changed");
     });
+
+    document.addEventListener("page:update", function() {
+      console.log("page updated");
+    });
+
+    document.addEventListener("page:restore", function() {
+      console.log("page restored");
+    });
   </script>
 </head>
 <body class="page-other">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbolinks
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Turbolinks makes following links in your web application faster (use with