turbolinks 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b7c786dc5fe799560978873952c05876224aa42
-  data.tar.gz: f79c665b9dadef0b27cb3d252c9773f90b57e6c7
+  metadata.gz: a29652f5af8636c6c8e56062fcaee11ec2997453
+  data.tar.gz: c90a5773bee34e8d043876e5a3b4f4520bda207c
 SHA512:
-  metadata.gz: 652de423718540abd5069b448a58c6dde9c7c2e92e2ef01c1e48b3356ecee0e2cd706db3084a42489ac88415e3861b72304bc939f7d775891fe3be0e356664c7
-  data.tar.gz: 39eb0d8d11d6e73b69da4a191dbf99143f4b2b3c4ff0f730684536982808010899fe0cd1e22599e015c28d14899a446b54d8d5cf16420645870040104a552163
+  metadata.gz: 6d2be7089afe4cc2c492090bd411cc325900df7515875f9917ab76ce29316eb2f8a358e39381d04aa73fdc3a4eb542ea261dd2126cab16bcd66d844b02ac4207
+  data.tar.gz: 2dff851cfb527fdc0e6b3bb262dfb0baaea02f602b0f170da6cd020d9c45412c9346e877230d42af72b2754d11125034c61ba8721faa5a7127a10163d2ed12a4

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 David Heinemeier Hansson
+Copyright 2012-2014 David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -197,6 +197,7 @@ Language Ports
 * [Flask Turbolinks](https://github.com/lepture/flask-turbolinks) (Python Flask)
 * [ASP.NET MVC Turbolinks](https://github.com/kazimanzurrashid/aspnetmvcturbolinks)
 * [PHP Turbolinks Component](https://github.com/helthe/Turbolinks) (Symfony Component)
+* [PHP Turbolinks Package](https://github.com/frenzyapp/turbolinks) (Laravel Package)
 
 Credits
 -------

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

@@ -4,7 +4,6 @@ transitionCacheEnabled  = false
 
 currentState            = null
 loadedAssets            = null
-htmlExtensions          = ['html']
 
 referer                 = null
 
@@ -13,11 +12,13 @@ xhr                     = null
 
 
 fetch = (url) ->
+  url = new ComponentUrl url
+
   rememberReferer()
   cacheCurrentPage()
   reflectNewUrl url
 
-  if transitionCacheEnabled and cachedPage = transitionCacheFor(url)
+  if transitionCacheEnabled and cachedPage = transitionCacheFor(url.absolute)
     fetchHistory cachedPage
     fetchReplacement url
   else
@@ -31,11 +32,11 @@ enableTransitionCache = (enable = true) ->
   transitionCacheEnabled = enable
 
 fetchReplacement = (url, onLoadFunction = =>) ->  
-  triggerEvent 'page:fetch', url: url
+  triggerEvent 'page:fetch', url: url.absolute
 
   xhr?.abort()
   xhr = new XMLHttpRequest
-  xhr.open 'GET', removeHashForIE10compatiblity(url), true
+  xhr.open 'GET', url.withoutHashForIE10compatibility(), true
   xhr.setRequestHeader 'Accept', 'text/html, application/xhtml+xml, application/xml'
   xhr.setRequestHeader 'X-XHR-Referer', referer
 
@@ -48,10 +49,10 @@ fetchReplacement = (url, onLoadFunction = =>) ->
       onLoadFunction()
       triggerEvent 'page:load'
     else
-      document.location.href = url
+      document.location.href = url.absolute
 
   xhr.onloadend = -> xhr = null
-  xhr.onerror   = -> document.location.href = url
+  xhr.onerror   = -> document.location.href = url.absolute
 
   xhr.send()
 
@@ -63,8 +64,10 @@ fetchHistory = (cachedPage) ->
 
 
 cacheCurrentPage = ->
-  pageCache[currentState.url] =
-    url:                      document.location.href,
+  currentStateUrl = new ComponentUrl currentState.url
+
+  pageCache[currentStateUrl.absolute] =
+    url:                      currentStateUrl.relative,
     body:                     document.body,
     title:                    document.title,
     positionY:                window.pageYOffset,
@@ -113,13 +116,14 @@ removeNoscriptTags = (node) ->
   node
 
 reflectNewUrl = (url) ->
-  if url isnt referer
-    window.history.pushState { turbolinks: true, url: url }, '', url
+  if (url = new ComponentUrl url).absolute isnt referer
+    window.history.pushState { turbolinks: true, url: url.absolute }, '', url.absolute
 
 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
+    location = new ComponentUrl location
+    preservedHash = if location.hasNoHash() then document.location.hash else ''
+    window.history.replaceState currentState, '', location.href + preservedHash
 
 rememberReferer = ->
   referer = document.location.href
@@ -140,17 +144,6 @@ resetScrollPosition = ->
     window.scrollTo 0, 0
 
 
-# Intention revealing function alias
-removeHashForIE10compatiblity = (url) ->
-  removeHash url
-
-removeHash = (url) ->
-  link = url
-  unless url.href?
-    link = document.createElement 'A'
-    link.href = url
-  link.href.replace link.hash, ''
-
 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=/'
@@ -242,53 +235,108 @@ browserCompatibleDocumentParser = ->
       return createDocumentUsingWrite
 
 
-installClickHandlerLast = (event) ->
-  unless event.defaultPrevented
-    document.removeEventListener 'click', handleClick, false
-    document.addEventListener 'click', handleClick, false
-
-handleClick = (event) ->
-  unless event.defaultPrevented
-    link = extractLink event
-    if link.nodeName is 'A' and !ignoreClick(event, link)
-      visit link.href unless pageChangePrevented()
-      event.preventDefault()
-
-
-extractLink = (event) ->
-  link = event.target
-  link = link.parentNode until !link.parentNode or link.nodeName is 'A'
-  link
-
-crossOriginLink = (link) ->
-  location.protocol isnt link.protocol or location.host isnt link.host
-
-anchoredLink = (link) ->
-  ((link.hash and removeHash(link)) is removeHash(location)) or
-    (link.href is location.href + '#')
-
-nonHtmlLink = (link) ->
-  url = removeHash link
-  url.match(/\.[a-z]+(\?.*)?$/g) and not url.match(new RegExp("\\.(?:#{htmlExtensions.join('|')})?(\\?.*)?$", 'g'))
-
-noTurbolink = (link) ->
-  until ignore or link is document
-    ignore = link.getAttribute('data-no-turbolink')?
-    link = link.parentNode
-  ignore
-
-targetLink = (link) ->
-  link.target.length isnt 0
-
-nonStandardClick = (event) ->
-  event.which > 1 or event.metaKey or event.ctrlKey or event.shiftKey or event.altKey
-
-ignoreClick = (event, link) ->
-  crossOriginLink(link) or anchoredLink(link) or nonHtmlLink(link) or noTurbolink(link) or targetLink(link) or nonStandardClick(event)
-
-allowLinkExtensions = (extensions...) ->
-  htmlExtensions.push extension for extension in extensions
-  htmlExtensions
+# The ComponentUrl class converts a basic URL string into an object
+# that behaves similarly to document.location.  
+#
+# If an instance is created from a relative URL, the current document 
+# is used to fill in the missing attributes (protocol, host, port).  
+class ComponentUrl
+  constructor: (@original = document.location.href) ->
+    return @original if @original.constructor is ComponentUrl
+    @_parse()
+
+  withoutHash: -> @href.replace @hash, ''
+
+  # Intention revealing function alias
+  withoutHashForIE10compatibility: -> @withoutHash()
+
+  hasNoHash: -> @hash.length is 0
+
+  _parse: ->
+    (@link ?= document.createElement 'a').href = @original
+    { @href, @protocol, @host, @hostname, @port, @pathname, @search, @hash } = @link
+    @origin = [@protocol, '//', @hostname].join ''
+    @origin += ":#{@port}" unless @port.length is 0
+    @relative = [@pathname, @search, @hash].join ''
+    @absolute = @href
+
+# The Link class derives from the ComponentUrl class, but is built from an
+# existing link element.  Provides verification functionality for Turbolinks
+# to use in determining whether it should process the link when clicked.
+class Link extends ComponentUrl
+  @HTML_EXTENSIONS: ['html']
+
+  @allowExtensions: (extensions...) ->
+    Link.HTML_EXTENSIONS.push extension for extension in extensions
+    Link.HTML_EXTENSIONS
+
+  constructor: (@link) ->
+    return @link if @link.constructor is Link
+    @original = @link.href
+    super
+
+  shouldIgnore: ->
+    @_crossOrigin() or 
+      @_anchored() or 
+      @_nonHtml() or 
+      @_optOut() or 
+      @_target()
+
+  _crossOrigin: ->
+    @origin isnt (new ComponentUrl).origin
+    
+  _anchored: ->
+    ((@hash and @withoutHash()) is (current = new ComponentUrl).withoutHash()) or 
+      (@href is current.href + '#') 
+
+  _nonHtml: ->
+    @pathname.match(/\.[a-z]+$/g) and not @pathname.match(new RegExp("\\.(?:#{Link.HTML_EXTENSIONS.join('|')})?$", 'g'))
+
+  _optOut: ->
+    link = @link
+    until ignore or link is document
+      ignore = link.getAttribute('data-no-turbolink')?
+      link = link.parentNode
+    ignore
+
+  _target: ->
+    @link.target.length isnt 0
+
+
+# The Click class handles clicked links, verifying if Turbolinks should
+# take control by inspecting both the event and the link. If it should, 
+# the page change process is initiated. If not, control is passed back 
+# to the browser for default functionality. 
+class Click
+  @installHandlerLast: (event) ->
+    unless event.defaultPrevented
+      document.removeEventListener 'click', Click.handle, false
+      document.addEventListener 'click', Click.handle, false
+
+  @handle: (event) ->
+    new Click event
+
+  constructor: (@event) ->
+    return if @event.defaultPrevented
+    @_extractLink()
+    if @_validForTurbolinks()
+      visit @link.href unless pageChangePrevented()
+      @event.preventDefault() 
+
+  _extractLink: ->
+    link = @event.target
+    link = link.parentNode until !link.parentNode or link.nodeName is 'A'
+    @link = new Link(link) if link.nodeName is 'A' and link.href.length isnt 0
+
+  _validForTurbolinks: ->
+    @link? and not (@link.shouldIgnore() or @_nonStandardClick())
+
+  _nonStandardClick: ->
+    @event.which > 1 or 
+      @event.metaKey or 
+      @event.ctrlKey or 
+      @event.shiftKey or 
+      @event.altKey
 
 
 # Delay execution of function long enough to miss the popstate event
@@ -310,7 +358,7 @@ installJqueryAjaxSuccessPageUpdateTrigger = ->
 
 installHistoryChangeHandler = (event) ->
   if event.state?.turbolinks
-    if cachedPage = pageCache[event.state.url]
+    if cachedPage = pageCache[(new ComponentUrl(event.state.url)).absolute]
       cacheCurrentPage()
       fetchHistory cachedPage
     else
@@ -321,7 +369,7 @@ initializeTurbolinks = ->
   rememberCurrentState()
   createDocument = browserCompatibleDocumentParser()
 
-  document.addEventListener 'click', installClickHandlerLast, true
+  document.addEventListener 'click', Click.installHandlerLast, true
 
   bypassOnLoadPopstate ->
     window.addEventListener 'popstate', installHistoryChangeHandler, false
@@ -361,4 +409,4 @@ else
 #   Turbolinks.enableTransitionCache()
 #   Turbolinks.allowLinkExtensions('md')
 #   Turbolinks.supported
-@Turbolinks = { visit, pagesCached, enableTransitionCache, allowLinkExtensions, supported: browserSupportsTurbolinks }
+@Turbolinks = { visit, pagesCached, enableTransitionCache, allowLinkExtensions: Link.allowExtensions, supported: browserSupportsTurbolinks }

data/lib/turbolinks.rb

@@ -8,21 +8,25 @@ require 'turbolinks/redirection'
 module Turbolinks
   class Engine < ::Rails::Engine
     initializer :turbolinks do |config|
-      ActionController::Base.class_eval do
-        include XHRHeaders, Cookies, XDomainBlocker, Redirection
-        before_filter :set_xhr_redirected_to, :set_request_method_cookie
-        after_filter :abort_xdomain_redirect
-      end
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.class_eval do
+          include XHRHeaders, Cookies, XDomainBlocker, Redirection
+          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
+        ActionDispatch::Request.class_eval do
+          def referer
+            self.headers['X-XHR-Referer'] || super
+          end
+          alias referrer referer
         end
-        alias referrer referer
       end
 
-      (ActionView::RoutingUrlFor rescue ActionView::Helpers::UrlHelper).module_eval do
-        include XHRUrlFor
+      ActiveSupport.on_load(:action_view) do
+        (ActionView::RoutingUrlFor rescue ActionView::Helpers::UrlHelper).module_eval do
+          include XHRUrlFor
+        end
       end
     end
   end

data/lib/turbolinks/version.rb

@@ -1,3 +1,3 @@
 module Turbolinks
-  VERSION = '2.2.1'
+  VERSION = '2.2.2'
 end

data/lib/turbolinks/xhr_url_for.rb

@@ -7,14 +7,9 @@ module Turbolinks
       base.alias_method_chain :url_for, :xhr_referer
     end
  
-    def url_for_with_xhr_referer(options)
-      options = (xhr_referer || options) if options == :back
+    def url_for_with_xhr_referer(options = {})
+      options = (controller.request.headers["X-XHR-Referer"] || options) if options == :back
       url_for_without_xhr_referer options
     end
-
-    private
-      def xhr_referer
-        controller.request.headers["X-XHR-Referer"]
-      end
   end
-end
+end

data/test/config.ru

@@ -15,6 +15,10 @@ map "/500" do
   # throw Internal Server Error (500)
 end
 
+map "/withoutextension" do
+  run Rack::File.new(File.join(Root, "test", "withoutextension"), "Content-Type" => "text/html")
+end
+
 map "/" do
   run Rack::Directory.new(File.join(Root, "test"))
 end

data/test/index.html

@@ -22,6 +22,8 @@
   <ul style="margin-top:200px;">
     <li><a href="/other.html">Other page</a></li>
     <li><a href="/other.html"><span>Wrapped link</span></a></li>
+    <li><a href="/withoutextension">Without extension</a></li>
+    <li><a href="/withoutextension?sort=user.name">Without extension with query params</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="/reload.html"><span>New assets track </span></a></li>

data/test/withoutextension

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<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");
+    });
+
+    document.addEventListener("page:update", function() {
+      console.log("page updated");
+    });
+
+    document.addEventListener("page:restore", function() {
+      console.log("page restored");
+    });
+  </script>
+</head>
+<body class="page-other">
+  <ul>
+    <li><a href="/index.html">Home</a></li>
+  </ul>
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbolinks
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -47,6 +47,7 @@ files:
 - test/offline.html
 - test/other.html
 - test/reload.html
+- test/withoutextension
 homepage: https://github.com/rails/turbolinks/
 licenses:
 - MIT