turbograft 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff1c8c57bee7bd53d6ce6466aca2f56a4bb7141b
-  data.tar.gz: c935fccb4ec7075510e6e0b8d6aa23a284b1cd08
+  metadata.gz: b5a814c49eaff1fbe7cf0bb02f67ef8d96fe8ff9
+  data.tar.gz: dd94aabbd02817b9ce92f99f87651daa94975176
 SHA512:
-  metadata.gz: a8e1fe39216d6d6f67724497546dd9ddd946fa6745408c3f4e8c4f60ffa2b29a1447446f86847675af890c500e8ffd12d0853007c70b46b62316a16223696dc7
-  data.tar.gz: ef845801b2eacdb8a32d9790eb525b64025a08eca8105a538484001bccc61d69d3027d2ec71645110665238bf4d33c799ec35a7b2e612925701fd6037875a0cb
+  metadata.gz: 3cfa4e748a8278ab568aac8b985eaa46df40fbf6ca063785fd66be1408ad55221d146683d0edeeba1f047a1ede182dc45f000353639886d1ffc27df958320168
+  data.tar.gz: 262fa76bf7948cd31f889e881c3b63d8a88a41d697a8d1fc37ac06d5db306905fa3508512791b0435b2e95eb18eda1662ec6f1d7b278c61d3ef2132723992c16

data/README.md

@@ -188,5 +188,6 @@ document.addEventListener 'page:after-node-removed', (event) ->
 
 ## Testing
 
-- `./server` and visit http://localhost:3000/teaspoon to run the JS test suite
+- `./server` and visit http://localhost:3000/teaspoon to run the JS test suite in the browser
+- `bundle exec teaspoon` will run the JS test suite from the command line. Uses Selenium by default, but can be configured using the TEASPOON_DRIVER environment variable
 - `bundle exec rake test` to run the browser test suite

data/lib/assets/javascripts/turbograft/turbohead.coffee

@@ -0,0 +1,215 @@
+class window.TurboHead
+  constructor: (@activeDocument, @upstreamDocument) ->
+
+  update: (successCallback, failureCallback) ->
+    activeAssets = extractTrackedAssets(@activeDocument)
+    upstreamAssets = extractTrackedAssets(@upstreamDocument)
+    {activeScripts, newScripts} = processScripts(activeAssets, upstreamAssets)
+
+    if hasScriptConflict(activeScripts, newScripts)
+      return failureCallback()
+
+    updateLinkTags(activeAssets, upstreamAssets)
+    updateScriptTags(@activeDocument, newScripts, successCallback)
+
+updateLinkTags = (activeAssets, upstreamAssets) ->
+  activeLinks = activeAssets.filter(filterForNodeType('LINK'))
+  upstreamLinks = upstreamAssets.filter(filterForNodeType('LINK'))
+  remainingActiveLinks = removeStaleLinks(activeLinks, upstreamLinks)
+  reorderedActiveLinks = reorderActiveLinks(remainingActiveLinks, upstreamLinks)
+  insertNewLinks(reorderedActiveLinks, upstreamLinks)
+
+updateScriptTags = (activeDocument, newScripts, callback) ->
+  asyncSeries(
+    newScripts.map((scriptNode) -> insertScriptTask(activeDocument, scriptNode)),
+    callback
+  )
+
+extractTrackedAssets = (doc) ->
+  for node in doc.head.children when node.dataset.turbolinksTrack?
+    node
+
+filterForNodeType = (nodeType) ->
+  (node) -> node.nodeName == nodeType
+
+hasScriptConflict = (activeScripts, newScripts) ->
+  hasExistingScriptAssetName = (upstreamNode) ->
+    activeScripts.some (activeNode) ->
+      upstreamNode.dataset.turbolinksTrackScriptAs == activeNode.dataset.turbolinksTrackScriptAs
+
+  newScripts.some(hasExistingScriptAssetName)
+
+asyncSeries = (tasks, callback) ->
+  return callback() if tasks.length == 0
+  task = tasks.shift()
+  task(-> asyncSeries(tasks, callback))
+
+insertScriptTask = (activeDocument, scriptNode) ->
+  # We need to clone script tags in order to ensure that the browser executes them.
+  newNode = activeDocument.createElement('SCRIPT')
+  newNode.setAttribute(attr.name, attr.value) for attr in scriptNode.attributes
+  newNode.appendChild(activeDocument.createTextNode(scriptNode.innerHTML))
+
+  return (done) ->
+    onScriptEvent = (event) ->
+      triggerEvent('page:script-error', event) if event.type == 'error'
+      newNode.removeEventListener('load', onScriptEvent)
+      newNode.removeEventListener('error', onScriptEvent)
+      done()
+    newNode.addEventListener('load', onScriptEvent)
+    newNode.addEventListener('error', onScriptEvent)
+    activeDocument.head.appendChild(newNode)
+    triggerEvent('page:after-script-inserted', newNode)
+
+processScripts = (activeAssets, upstreamAssets) ->
+  activeScripts = activeAssets.filter(filterForNodeType('SCRIPT'))
+  upstreamScripts = upstreamAssets.filter(filterForNodeType('SCRIPT'))
+  hasNewSrc = (upstreamNode) ->
+    activeScripts.every (activeNode) ->
+      upstreamNode.src != activeNode.src
+
+  newScripts = upstreamScripts.filter(hasNewSrc)
+
+  {activeScripts, newScripts}
+
+removeStaleLinks = (activeLinks, upstreamLinks) ->
+  isStaleLink = (link) ->
+    upstreamLinks.every (upstreamLink) ->
+      upstreamLink.href != link.href
+
+  staleLinks = activeLinks.filter(isStaleLink)
+
+  for staleLink in staleLinks
+    removedLink = document.head.removeChild(staleLink)
+    triggerEvent('page:after-link-removed', removedLink)
+
+  activeLinks.filter((link) -> !isStaleLink(link))
+
+reorderAlreadyExists = (link1, link2, reorders) ->
+  reorders.some (reorderPair) ->
+    link1 in reorderPair && link2 in reorderPair
+
+generateReorderGraph = (activeLinks, upstreamLinks) ->
+  reorders = []
+  for activeLink1 in activeLinks
+    for activeLink2 in activeLinks
+      continue if activeLink1.href == activeLink2.href
+      continue if reorderAlreadyExists(activeLink1, activeLink2, reorders)
+
+      upstreamLink1 = upstreamLinks.filter((link) -> link.href == activeLink1.href)[0]
+      upstreamLink2 = upstreamLinks.filter((link) -> link.href == activeLink2.href)[0]
+
+      orderHasChanged =
+        (activeLinks.indexOf(activeLink1) < activeLinks.indexOf(activeLink2)) !=
+        (upstreamLinks.indexOf(upstreamLink1) < upstreamLinks.indexOf(upstreamLink2))
+
+      reorders.push([activeLink1, activeLink2]) if orderHasChanged
+  reorders
+
+nextMove = (activeLinks, reorders) ->
+  changesAssociatedTo = (link) ->
+    reorders.filter (reorderPair) ->
+      link in reorderPair
+
+  linksSortedByMovePriority = activeLinks
+    .slice()
+    .sort (link1, link2) ->
+      changesAssociatedTo(link2).length - changesAssociatedTo(link1).length
+
+  linkToMove = linksSortedByMovePriority[0]
+
+  linksToPassBy = changesAssociatedTo(linkToMove).map (reorderPair) ->
+    (reorderPair.filter (link) -> link.href != linkToMove.href)[0]
+
+  {linkToMove, linksToPassBy}
+
+reorderActiveLinks = (activeLinks, upstreamLinks) ->
+  activeLinksCopy = activeLinks.slice()
+  pendingReorders = generateReorderGraph(activeLinksCopy, upstreamLinks)
+
+  removeReorder = (link1, link2) ->
+    reorderToRemove = (pendingReorders.filter (reorderPair) ->
+      link1 in reorderPair && link2 in reorderPair)[0]
+    indexToRemove = pendingReorders.indexOf(reorderToRemove)
+    pendingReorders.splice(indexToRemove, 1)
+
+  addNewReorder = (link1, link2) ->
+    pendingReorders.push [link1, link2]
+
+  markReorderAsFinished = (linkToMove, linkToPass, remainingLinksToPass) ->
+    removeReorder(linkToMove, linkToPass)
+    removalIndex = remainingLinksToPass.indexOf(linkToPass)
+    remainingLinksToPass.splice(removalIndex, 1)
+
+  removeLink = (linkToRemove, indexOfLink) ->
+    removedLink = document.head.removeChild(linkToRemove)
+    triggerEvent('page:after-link-removed', removedLink)
+    activeLinksCopy.splice(indexOfLink, 1)
+
+  performMove = (linkToMove, linksToPassBy) ->
+    moveDirection = if activeLinksCopy.indexOf(linkToMove) > activeLinksCopy.indexOf(linksToPassBy[0]) then 'UP' else 'DOWN'
+    startIndex = activeLinksCopy.indexOf(linkToMove)
+
+    switch moveDirection
+      when 'UP'
+        for i in [(startIndex - 1)..0]
+          currentLink = activeLinksCopy[i]
+          if currentLink in linksToPassBy
+            markReorderAsFinished(linkToMove, currentLink, linksToPassBy)
+
+            if linksToPassBy.length == 0
+              removeLink(linkToMove, startIndex)
+
+              document.head.insertBefore(linkToMove, activeLinksCopy[i])
+              activeLinksCopy.splice(i, 0, linkToMove)
+              triggerEvent('page:after-link-inserted', linkToMove)
+              return
+          else
+            addNewReorder(linkToMove, currentLink, pendingReorders)
+      when 'DOWN'
+        for i in [(startIndex + 1)...activeLinksCopy.length]
+          currentLink = activeLinksCopy[i]
+          if currentLink in linksToPassBy
+            markReorderAsFinished(linkToMove, currentLink, linksToPassBy)
+
+            if linksToPassBy.length == 0
+              removeLink(linkToMove, startIndex)
+
+              targetIndex = i - 1
+              if targetIndex == activeLinksCopy.length - 1
+                document.head.appendChild(linkToMove)
+                activeLinksCopy.push(linkToMove)
+              else
+                document.head.insertBefore(linkToMove, activeLinksCopy[targetIndex + 1])
+                activeLinksCopy.splice(targetIndex + 1, 0, linkToMove)
+              triggerEvent('page:after-link-inserted', linkToMove)
+              return
+          else
+            addNewReorder(linkToMove, currentLink, pendingReorders)
+
+  while pendingReorders.length > 0
+    {linkToMove, linksToPassBy} = nextMove(activeLinksCopy, pendingReorders)
+    performMove(linkToMove, linksToPassBy)
+
+  activeLinksCopy
+
+insertNewLinks = (activeLinks, upstreamLinks) ->
+  isNewLink = (link) ->
+    activeLinks.every (activeLink) ->
+      activeLink.href != link.href
+
+  upstreamLinks
+    .filter(isNewLink)
+    .reverse() # This is because we can't insert before a sibling that hasn't been inserted yet.
+    .forEach (newUpstreamLink) ->
+      index = upstreamLinks.indexOf(newUpstreamLink)
+      newActiveLink = newUpstreamLink.cloneNode()
+      if index == upstreamLinks.length - 1
+        document.head.appendChild(newActiveLink)
+        activeLinks.push(newActiveLink)
+      else
+        targetIndex = activeLinks.indexOf((activeLinks.filter (link) ->
+          link.href == upstreamLinks[index + 1].href)[0])
+        document.head.insertBefore(newActiveLink, activeLinks[targetIndex])
+        activeLinks.splice(targetIndex, 0, newActiveLink)
+      triggerEvent('page:after-link-inserted', newActiveLink)

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

@@ -63,7 +63,6 @@ removeNode = (node) ->
 class window.Turbolinks
   createDocument = null
   currentState = null
-  loadedAssets = null
   referer = null
 
   fetch = (url, options = {}) ->
@@ -80,6 +79,10 @@ class window.Turbolinks
 
     fetchReplacement url, options
 
+  @fullPageNavigate: (url) ->
+    triggerEvent('page:before-full-refresh', url: url)
+    document.location.href = url
+
   @pushState: (state, title, url) ->
     window.history.pushState(state, title, url)
 
@@ -89,12 +92,18 @@ class window.Turbolinks
   fetchReplacement = (url, options) ->
     triggerEvent 'page:fetch', url: url.absolute
 
-    xhr?.abort()
+    if xhr?
+      # Workaround for sinon xhr.abort()
+      # https://github.com/sinonjs/sinon/issues/432#issuecomment-216917023
+      xhr.readyState = 0
+      xhr.statusText = "abort"
+      xhr.abort()
+
     xhr = new XMLHttpRequest
+
     xhr.open 'GET', url.withoutHashForIE10compatibility(), true
     xhr.setRequestHeader 'Accept', 'text/html, application/xhtml+xml, application/xml'
     xhr.setRequestHeader 'X-XHR-Referer', referer
-
     options.headers ?= {}
 
     for k,v of options.headers
@@ -102,13 +111,17 @@ class window.Turbolinks
 
     xhr.onload = ->
       if xhr.status >= 500
-        document.location.href = url.absolute
+        Turbolinks.fullPageNavigate(url.absolute)
       else
         Turbolinks.loadPage(url, xhr, options)
+      xhr = null
 
-    xhr.onloadend = -> xhr = null
-    xhr.onerror   = ->
-      document.location.href = url.absolute
+    xhr.onerror = ->
+      # Workaround for sinon xhr.abort()
+      if xhr.statusText == "abort"
+        xhr = null
+        return
+      Turbolinks.fullPageNavigate(url.absolute)
 
     xhr.send()
 
@@ -117,17 +130,27 @@ class window.Turbolinks
   @loadPage: (url, xhr, options = {}) ->
     triggerEvent 'page:receive'
     options.updatePushState ?= true
-
-    if doc = processResponse(xhr, options.partialReplace)
+    if upstreamDocument = processResponse(xhr, options.partialReplace)
       reflectNewUrl url if options.updatePushState
-      nodes = changePage(extractTitleAndBody(doc)..., options)
-      reflectRedirectedUrl(xhr) if options.updatePushState
-      triggerEvent 'page:load', nodes
-      options.onLoadFunction?()
-    else
-      document.location.href = url.absolute
 
-    return
+      new TurboHead(document, upstreamDocument).update(
+        onHeadUpdateSuccess = ->
+          nodes = changePage(
+            upstreamDocument.querySelector('title')?.textContent,
+            removeNoscriptTags(upstreamDocument.querySelector('body')),
+            CSRFToken.get(upstreamDocument).token,
+            'runScripts',
+            options
+          )
+          reflectRedirectedUrl(xhr) if options.updatePushState
+          options.onLoadFunction?()
+          triggerEvent 'page:load', nodes
+        ,
+        onHeadUpdateError = ->
+          Turbolinks.fullPageNavigate(url.absolute)
+      )
+    else
+      Turbolinks.fullPageNavigate(url.absolute)
 
   changePage = (title, body, csrfToken, runScripts, options = {}) ->
     document.title = title if title
@@ -210,7 +233,7 @@ class window.Turbolinks
         newNode = newNode.cloneNode(true)
         replaceNode(newNode, existingNode)
 
-        if newNode.nodeName == 'SCRIPT' && newNode.getAttribute("data-turbolinks-eval") != "false"
+        if newNode.nodeName == 'SCRIPT' && newNode.dataset.turbolinksEval != "false"
           executeScriptTag(newNode)
         else
           refreshedNodes.push(newNode)
@@ -307,29 +330,9 @@ class window.Turbolinks
     validContent = ->
       xhr.getResponseHeader('Content-Type').match /^(?:text\/html|application\/xhtml\+xml|application\/xml)(?:;|$)/
 
-    extractTrackAssets = (doc) ->
-      for node in doc.querySelector('head').childNodes when node.getAttribute?('data-turbolinks-track')?
-        node.getAttribute('src') or node.getAttribute('href')
-
-    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
-
     if !clientOrServerError() && validContent()
-      doc = createDocument xhr.responseText
-      changed = assetsChanged(doc)
-
-      if doc && (!changed || partial)
-        return doc
-
-  extractTitleAndBody = (doc) ->
-    title = doc.querySelector 'title'
-    [ title?.textContent, removeNoscriptTags(doc.querySelector('body')), CSRFToken.get(doc).token, 'runScripts' ]
+      upstreamDocument = createDocument(xhr.responseText)
+      return upstreamDocument
 
   installHistoryChangeHandler = (event) ->
     if event.state?.turbolinks

data/lib/turbograft/version.rb

@@ -1,3 +1,3 @@
 module TurboGraft
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/lib/turbograft/xhr_url_for.rb

@@ -3,13 +3,9 @@ module TurboGraft
   # option by using the X-XHR-Referer request header instead of the standard Referer
   # request header.
   module XHRUrlFor
-    def self.included(base)
-      base.alias_method_chain :url_for, :xhr_referer
-    end
-
-    def url_for_with_xhr_referer(options = {})
+    def url_for(options = {})
       options = (controller.request.headers["X-XHR-Referer"] || options) if options == :back
-      url_for_without_xhr_referer options
+      super(options)
     end
   end
 end

data/lib/turbograft.rb

@@ -21,8 +21,8 @@ module TurboGraft
         Config.controllers.each do |klass|
           klass.constantize.class_eval do
             include XHRHeaders, Cookies, XDomainBlocker, Redirection
-            before_filter :set_xhr_redirected_to, :set_request_method_cookie
-            after_filter :abort_xdomain_redirect
+            before_action :set_xhr_redirected_to, :set_request_method_cookie
+            after_action :abort_xdomain_redirect
           end
         end
 
@@ -36,7 +36,7 @@ module TurboGraft
 
       ActiveSupport.on_load(:action_view) do
         (ActionView::RoutingUrlFor rescue ActionView::Helpers::UrlHelper).module_eval do
-          include XHRUrlFor
+          prepend XHRUrlFor
         end
       end unless RUBY_VERSION =~ /^1\.8/
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbograft
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Kristian Plettenberg-Dussault
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -228,8 +228,8 @@ files:
 - lib/assets/javascripts/turbograft/link.coffee
 - lib/assets/javascripts/turbograft/page.coffee
 - lib/assets/javascripts/turbograft/remote.coffee
+- lib/assets/javascripts/turbograft/turbohead.coffee
 - lib/assets/javascripts/turbograft/turbolinks.coffee
-- lib/turbograft.js
 - lib/turbograft.rb
 - lib/turbograft/cookies.rb
 - lib/turbograft/redirection.rb
@@ -257,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: turbolinks with partial page replacement