turbolinks 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81b3f537e66ca790fc7d3582de6eb2eab6d1b9b9
-  data.tar.gz: b9f0c3ed62c42062e678b92676012d08ad8decfc
+  metadata.gz: 1263ec55bfcb3699eb35184773029a0f1366b9af
+  data.tar.gz: 25bd7c81bfc177362c28bef759e0da5c98ddb354
 SHA512:
-  metadata.gz: 34ec20469fdcfa96705c4b3b1639c963196568cf78c46f9d24083849d93c4193acb5cca47b28e2caf7edcc2907586e1793394aa04a80304afe607fd3d8f91429
-  data.tar.gz: faf3469bb52dc2adba9e96634946c5b5cc775c5be9a77ead70cde60a80a29b3737f3634b68d7e1d31a5bb6ab1bed3891bbd40219d99cdc26b89387fc08757892
+  metadata.gz: 401359f94e306dbb1314e2dc1335b892124ce215b7e80289cfda10ba84c4ec09e064a6c1c0bc0f176bf9368db5bc3f36ede90549d7bd2a9d6d4094bfd0977bee
+  data.tar.gz: fab798e6aeeea6c25bb0a522c632ae1813c1e10459c7a626a2db568590104e10ba017eb58add3261c7b1255dbd9326ebd8ee74f48765c87ced3e39761333f639

data/README.md

@@ -27,21 +27,34 @@ Turbolinks is designed to be as light-weight as possible (so you won't think twi
 Events
 ------
 
-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:
+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.
 
-*Load* a fresh version of a page from the server:
+***Load* a fresh version of a page from the server:**
+* `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: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:
+Handlers bound to the `page:before-change` event may return `false`, which will cancel the Turbolinks process. 
 
-*Restore* a cached page from the client-side cache:
+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:
+
+***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.
+The number of pages Turbolinks caches can be configured to suit your application's needs:
+
+```javascript
+// View the current cache size
+Turbolinks.pagesCached();
+
+// Set the cache size
+Turbolinks.pagesCached(20);
+```
+
+To implement 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);
@@ -98,7 +111,10 @@ Asset change detection
 
 You can track certain assets, like application.js and application.css, that you want to ensure are always of the latest version inside a Turbolinks session. This is done by marking those asset links with data-turbolinks-track, like so:
 
-```<link href="/assets/application-9bd64a86adb3cd9ab3b16e9dca67a33a.css" rel="stylesheet" type="text/css" data-turbolinks-track>```
+```html
+<link href="/assets/application-9bd64a86adb3cd9ab3b16e9dca67a33a.css" rel="stylesheet"
+      type="text/css" data-turbolinks-track>
+```
 
 If those assets change URLs (embed an md5 stamp to ensure this), the page will do a full reload instead of going through Turbolinks. This ensures that all Turbolinks sessions will always be running off your latest JavaScript and CSS.
 
@@ -108,7 +124,7 @@ When this happens, you'll technically be requesting the same page twice. Once th
 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.
+Turbolinks will evaluate any script tags in pages it visits, 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. 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`:
 
@@ -146,6 +162,10 @@ Installation
 1. Add `//= require turbolinks` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
 1. Restart your server and you're now using turbolinks!
 
+Language Ports
+--------------
+
+* [Flask Turbolinks](https://github.com/lepture/flask-turbolinks) (Python Flask)
 
 Credits
 -------

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

@@ -1,20 +1,12 @@
-initialized    = false
+cacheSize      = 10
 currentState   = null
-referer        = document.location.href
+referer        = null
 loadedAssets   = null
 pageCache      = {}
 createDocument = null
 requestMethod  = document.cookie.match(/request_method=(\w+)/)?[1].toUpperCase() or ''
 xhr            = null
 
-visit = (url) ->
-  if browserSupportsPushState && browserIsntBuggy
-    cacheCurrentPage()
-    reflectNewUrl url
-    fetchReplacement url
-  else
-    document.location.href = url
-
 
 fetchReplacement = (url) ->
   triggerEvent 'page:fetch'
@@ -31,7 +23,8 @@ fetchReplacement = (url) ->
   xhr.onload = ->
     triggerEvent 'page:receive'
 
-    if doc = validateResponse()
+    if doc = processResponse()
+      reflectNewUrl url
       changePage extractTitleAndBody(doc)...
       reflectRedirectedUrl()
       if document.location.hash
@@ -39,6 +32,8 @@ fetchReplacement = (url) ->
       else
         resetScrollPosition()
       triggerEvent 'page:load'
+    else
+      document.location.href = url
 
   xhr.onloadend = -> xhr = null
   xhr.onabort   = -> rememberCurrentUrl()
@@ -46,21 +41,16 @@ fetchReplacement = (url) ->
 
   xhr.send()
 
-fetchHistory = (state) ->
+fetchHistory = (position) ->
   cacheCurrentPage()
-
-  if page = pageCache[state.position]
-    xhr?.abort()
-    changePage page.title, page.body
-    recallScrollPosition page
-    triggerEvent 'page:restore'
-  else
-    fetchReplacement document.location.href
+  page = pageCache[position]
+  xhr?.abort()
+  changePage page.title, page.body
+  recallScrollPosition page
+  triggerEvent 'page:restore'
 
 
 cacheCurrentPage = ->
-  rememberInitialPage()
-
   pageCache[currentState.position] =
     url:       document.location.href,
     body:      document.body,
@@ -68,7 +58,10 @@ cacheCurrentPage = ->
     positionY: window.pageYOffset,
     positionX: window.pageXOffset
 
-  constrainPageCacheTo(10)
+  constrainPageCacheTo cacheSize
+
+pagesCached = (size = cacheSize) ->
+  cacheSize = parseInt(size) if /^[\d]+$/.test size
 
 constrainPageCacheTo = (limit) ->
   for own key, value of pageCache
@@ -101,8 +94,7 @@ removeNoscriptTags = ->
   return
 
 reflectNewUrl = (url) ->
-  if url isnt document.location.href
-    referer = document.location.href
+  if url isnt referer
     window.history.pushState { turbolinks: true, position: currentState.position + 1 }, '', url
 
 reflectRedirectedUrl = ->
@@ -116,13 +108,6 @@ rememberCurrentUrl = ->
 rememberCurrentState = ->
   currentState = window.history.state
 
-rememberInitialPage = ->
-  unless initialized
-    rememberCurrentUrl()
-    rememberCurrentState()
-    createDocument = browserCompatibleDocumentParser()
-    initialized = true
-
 recallScrollPosition = (page) ->
   window.scrollTo page.positionX, page.positionY
 
@@ -141,13 +126,15 @@ triggerEvent = (name) ->
   event.initEvent name, true, true
   document.dispatchEvent event
 
+pageChangePrevented = ->
+  !triggerEvent 'page:before-change'
 
-validateResponse = ->
+processResponse = ->
   clientOrServerError = ->
     400 <= xhr.status < 600
 
-  invalidContent = ->
-    !xhr.getResponseHeader('Content-Type').match /^(?:text\/html|application\/xhtml\+xml|application\/xml)(?:;|$)/
+  validContent = ->
+    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')?
@@ -161,17 +148,10 @@ validateResponse = ->
     [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
+  if not clientOrServerError() and validContent()
+    doc = createDocument xhr.responseText
+    if doc and !assetsChanged doc
+      return doc
 
 extractTitleAndBody = (doc) ->
   title = doc.querySelector 'title'
@@ -234,7 +214,7 @@ handleClick = (event) ->
   unless event.defaultPrevented
     link = extractLink event
     if link.nodeName is 'A' and !ignoreClick(event, link)
-      visit link.href
+      visit link.href unless pageChangePrevented()
       event.preventDefault()
 
 
@@ -269,11 +249,19 @@ nonStandardClick = (event) ->
 ignoreClick = (event, link) ->
   crossOriginLink(link) or anchoredLink(link) or nonHtmlLink(link) or noTurbolink(link) or targetLink(link) or nonStandardClick(event)
 
-
 initializeTurbolinks = ->
+  rememberCurrentUrl()
+  rememberCurrentState()
+  createDocument = browserCompatibleDocumentParser()
   document.addEventListener 'click', installClickHandlerLast, true
   window.addEventListener 'popstate', (event) ->
-    fetchHistory event.state if event.state?.turbolinks
+    state = event.state
+
+    if state?.turbolinks
+      if pageCache[state.position]
+        fetchHistory state.position
+      else
+        visit event.target.location.href
   , false
 
 browserSupportsPushState =
@@ -285,7 +273,19 @@ browserIsntBuggy =
 requestMethodIsSafe =
   requestMethod in ['GET','']
 
-initializeTurbolinks() if browserSupportsPushState and browserIsntBuggy and requestMethodIsSafe
+if browserSupportsPushState and browserIsntBuggy and requestMethodIsSafe
+  visit = (url) ->
+    referer = document.location.href
+    cacheCurrentPage()
+    fetchReplacement url
+
+  initializeTurbolinks()
+else
+  visit = (url) ->
+    document.location.href = url
 
-# Call Turbolinks.visit(url) from client code
-@Turbolinks = { visit }
+# Public API
+#   Turbolinks.visit(url)
+#   Turbolinks.pagesCached() 
+#   Turbolinks.pagesCached(20)
+@Turbolinks = { visit, pagesCached }

metadata

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