turbograft 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de6aed257f2451693856924987ff6238f3b86f6f
-  data.tar.gz: 020bf3757da79669cca06b78dc237f7f0f423bd2
+  metadata.gz: 1adee05ec0b9f2e394fd907aa38f75574715bcd1
+  data.tar.gz: 4d7a8bcaf0016e552e684b38dd0323a7f455b71f
 SHA512:
-  metadata.gz: 950bfd3d8f0f12ccc9089a66383c6197f9288e4ea8f3fdd5122168102fdcfa9a4e3627077f4bbc31fb7a48293378195f91afc4135a192c72e3c53f3ed21bdf7f
-  data.tar.gz: 19a95050d2a3d94fdb4ba20a804b94e1edba12f1afa83a0ba1b1d36df0ef37797fd8769899aeefac92d81afc2cf0c6b727da776cc8eba6b80d2a4bc4966881fc
+  metadata.gz: 41bfd3ae74adb0c3f62c7cefb2ee566ea1193cb2398a37b11186fd9a57289a6772b16b58de58c6237989e1196f65544a6ee931aacebabebfd663648b4075e744
+  data.tar.gz: 1cd3bc34fd7021780ae31120991cd16bba9cafc8e6f10ea0812f272ebb0816fb0e6a200001810bd16b82f909af901755af953ae42f2843b7a5dd7e21e0579452

data/README.md

@@ -12,17 +12,9 @@ In botony, one can take parts of a tree and splice it onto another tree.  The DO
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'turbograft'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install turbograft
+* Add `gem "turbograft"` to your Gemfile
+* Run `bundle install`
+* Add `#= require turbograft` to _app/assets/javascripts/application.js_
 
 ## Usage
 

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

@@ -15,12 +15,9 @@ class window.Click
     return if @event.defaultPrevented
     @_extractLink()
     if @_validForTurbolinks()
-      Turbolinks.visit @link.href unless @_pageChangePrevented()
+      Turbolinks.visit @link.href
       @event.preventDefault()
 
-  _pageChangePrevented: ->
-    !triggerEvent 'page:before-change' # TODO: fix this global
-
   _extractLink: ->
     link = @event.target
     link = link.parentNode until !link.parentNode or link.nodeName is 'A'

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

@@ -38,8 +38,9 @@ TurboGraft.handlers.remoteMethodHandler = (ev) ->
     fullRefresh: target.getAttribute('full-refresh')?
     refreshOnSuccess: target.getAttribute('refresh-on-success')
     refreshOnError: target.getAttribute('refresh-on-error')
+    refreshOnErrorExcept: target.getAttribute('full-refresh-on-error-except')
 
-  if !options.refreshOnSuccess && !options.refreshOnError
+  if !options.refreshOnSuccess && !options.refreshOnError && !options.refreshOnErrorExcept
     options.fullRefresh = true
 
   remote = new TurboGraft.Remote(options, null, target)
@@ -60,8 +61,9 @@ TurboGraft.handlers.remoteFormHandler = (ev) ->
     fullRefresh: target.getAttribute('full-refresh')?
     refreshOnSuccess: target.getAttribute('refresh-on-success')
     refreshOnError: target.getAttribute('refresh-on-error')
+    refreshOnErrorExcept: target.getAttribute('full-refresh-on-error-except')
 
-  if !options.refreshOnSuccess && !options.refreshOnError
+  if !options.refreshOnSuccess && !options.refreshOnError && !options.refreshOnErrorExcept
     options.fullRefresh = true
 
   remote = new TurboGraft.Remote(options, target, target)

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

@@ -17,7 +17,9 @@ Page.refresh = (options = {}, callback) ->
     location.href
 
   if options.response
-    Turbolinks.loadPage null, options.response, true, callback, options.onlyKeys || []
+    onlyKeys   = options.onlyKeys   || []
+    exceptKeys = options.exceptKeys || []
+    Turbolinks.loadPage null, options.response, true, callback, onlyKeys, exceptKeys
   else
     Turbolinks.visit newUrl, true, options.onlyKeys || [], -> callback?()
 

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

@@ -1,24 +1,24 @@
 class TurboGraft.Remote
   constructor: (@opts, form, target) ->
-    formData = if form then new FormData(form) else new FormData()
-
-    @initiator = target
+    formData   = if form then new FormData(form) else new FormData()
+    @initiator = target || form
 
     actualRequestType = if @opts.httpRequestType.toLowerCase() == 'get' then 'GET' else 'POST'
 
     formData.append("_method", @opts.httpRequestType)
 
-    @refreshOnSuccess = @opts.refreshOnSuccess.split(" ") if @opts.refreshOnSuccess
-    @refreshOnError = @opts.refreshOnError.split(" ") if @opts.refreshOnError
+    @refreshOnSuccess       = @opts.refreshOnSuccess.split(" ")       if @opts.refreshOnSuccess
+    @refreshOnError         = @opts.refreshOnError.split(" ")         if @opts.refreshOnError
+    @refreshOnErrorExcept   = @opts.refreshOnErrorExcept.split(" ")   if @opts.refreshOnErrorExcept
 
     xhr = new XMLHttpRequest
     xhr.open(actualRequestType, @opts.httpUrl, true)
     xhr.setRequestHeader('Accept', 'text/html, application/xhtml+xml, application/xml')
+    triggerEventFor('turbograft:remote:init', @initiator, xhr: xhr)
 
     xhr.addEventListener 'loadstart', =>
-      triggerEvent 'turbograft:remote:start',
-        xhr: xhr,
-        initiator: @initiator
+      triggerEventFor 'turbograft:remote:start', @initiator,
+        xhr: xhr
 
     xhr.addEventListener 'error', @onError
     xhr.addEventListener 'load', (event) =>
@@ -28,18 +28,16 @@ class TurboGraft.Remote
         @onError(event)
 
     xhr.addEventListener 'loadend', =>
-      triggerEvent 'turbograft:remote:always',
-        xhr: xhr,
-        initiator: @initiator
+      triggerEventFor 'turbograft:remote:always', @initiator,
+        xhr: xhr
 
     xhr.send(formData)
     xhr
 
   onSuccess: (ev) ->
     xhr = ev.target
-    triggerEvent 'turbograft:remote:success',
-      xhr: xhr,
-      initiator: @initiator
+    triggerEventFor 'turbograft:remote:success', @initiator,
+      xhr: xhr
 
     if redirect = xhr.getResponseHeader('X-Next-Redirect')
       Page.visit(redirect, reload: true)
@@ -56,15 +54,14 @@ class TurboGraft.Remote
 
   onError: (ev) ->
     xhr = ev.target
-    triggerEvent 'turbograft:remote:fail',
-      xhr: xhr,
-      initiator: @initiator
+    triggerEventFor 'turbograft:remote:fail', @initiator,
+      xhr: xhr
 
-    if @refreshOnError
+    if @refreshOnError || @refreshOnErrorExcept
       Page.refresh
         response: xhr
         onlyKeys: @refreshOnError
+        exceptKeys: @refreshOnErrorExcept
     else
-      triggerEvent 'turbograft:remote:fail:unhandled',
-        xhr: xhr,
-        initiator: @initiator
+      triggerEventFor 'turbograft:remote:fail:unhandled', @initiator,
+        xhr: xhr

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

@@ -1,4 +1,4 @@
-xhr                     = null
+xhr = null
 
 installDocumentReadyPageEventTriggers = ->
   document.addEventListener 'DOMContentLoaded', ( ->
@@ -28,6 +28,12 @@ window.triggerEvent = (name, data) ->
   event.initEvent name, true, true
   document.dispatchEvent event
 
+window.triggerEventFor = (name, node, data) ->
+  event = document.createEvent 'Events'
+  event.data = data if data
+  event.initEvent name, true, true
+  node.dispatchEvent event
+
 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=/'
@@ -54,33 +60,17 @@ class window.Turbolinks
   currentState = null
   loadedAssets = null
   referer = null
-  usePageCache = false
-  @pageCache = pageCache = new PageCache()
 
   fetch = (url, partialReplace = false, replaceContents = [], callback) ->
+    return if pageChangePrevented(url)
     url = new ComponentUrl url
 
     rememberReferer()
-    Turbolinks.cacheCurrentPage() if usePageCache
-
-    if usePageCache and cachedPage = transitionCacheFor(url.absolute)
-      fetchHistory cachedPage
-      fetchReplacement url, partialReplace, null, replaceContents
-    else
-      fetchReplacement url, partialReplace, ->
-        resetScrollPosition() unless replaceContents.length
-        callback?()
-      , replaceContents
-
-  @pageCacheEnabled = ->
-    usePageCache
 
-  @usePageCache = (status) ->
-    usePageCache = status
-
-  transitionCacheFor = (url) ->
-    cachedPage = pageCache.get(url)
-    cachedPage if cachedPage and !cachedPage.transitionCacheDisabled
+    fetchReplacement url, partialReplace, ->
+      resetScrollPosition() unless replaceContents.length
+      callback?()
+    , replaceContents
 
   @pushState: (state, title, url) ->
     window.history.pushState(state, title, url)
@@ -111,12 +101,12 @@ class window.Turbolinks
 
     return
 
-  @loadPage: (url, xhr, partialReplace = false, onLoadFunction = (->), replaceContents = []) ->
+  @loadPage: (url, xhr, partialReplace = false, onLoadFunction = (->), replaceContents = [], replaceAllExcept = []) ->
     triggerEvent 'page:receive'
 
     if doc = processResponse(xhr, partialReplace)
       reflectNewUrl url
-      nodes = changePage(extractTitleAndBody(doc)..., partialReplace, replaceContents)
+      nodes = changePage(extractTitleAndBody(doc)..., partialReplace, replaceContents, replaceAllExcept)
       reflectRedirectedUrl(xhr)
       triggerEvent 'page:load', nodes
       onLoadFunction?()
@@ -125,32 +115,15 @@ class window.Turbolinks
 
     return
 
-  fetchHistory = (cachedPage) ->
-    xhr?.abort()
-    changePage cachedPage.title, cachedPage.body, false
-    recallScrollPosition cachedPage
-    triggerEvent 'page:restore'
-
-
-  @cacheCurrentPage: ->
-    currentStateUrl = new ComponentUrl currentState.url
-
-    pageCache.set currentStateUrl.absolute,
-      url:                      currentStateUrl.relative,
-      body:                     document.body,
-      title:                    document.title,
-      positionY:                window.pageYOffset,
-      positionX:                window.pageXOffset,
-      transitionCacheDisabled:  document.querySelector('[data-no-transition-cache]')?
-
-    return
-
-  changePage = (title, body, csrfToken, runScripts, partialReplace, replaceContents = []) ->
+  changePage = (title, body, csrfToken, runScripts, partialReplace, replaceContents = [], replaceAllExcept = []) ->
     document.title = title if title
     if replaceContents.length
       return refreshNodesWithKeys(replaceContents, body)
     else
-      deleteRefreshNeverNodes(body)
+      if replaceAllExcept.length
+        refreshAllExceptWithKeys(replaceAllExcept, body)
+      else
+        deleteRefreshNeverNodes(body)
 
       triggerEvent 'page:before-replace'
       document.documentElement.replaceChild body, document.body
@@ -204,6 +177,20 @@ class window.Turbolinks
 
     refreshedNodes
 
+  refreshAllExceptWithKeys = (keys, body) ->
+    allNodesToKeep = []
+
+    for key in keys
+      for node in document.querySelectorAll("[refresh=#{key}]")
+        allNodesToKeep.push(node)
+
+    for existingNode in allNodesToKeep
+      unless nodeId = existingNode.getAttribute('id')
+        throw new Error "Turbolinks refresh: Refresh key elements must have an id."
+
+      remoteNode = body.querySelector("##{ nodeId }")
+      remoteNode.parentNode.replaceChild(existingNode, remoteNode)
+
   executeScriptTags = ->
     scripts = Array::slice.call document.body.querySelectorAll 'script:not([data-turbolinks-eval="false"])'
     for script in scripts when script.type in ['', 'text/javascript']
@@ -253,8 +240,8 @@ class window.Turbolinks
     else
       window.scrollTo 0, 0
 
-  pageChangePrevented = ->
-    !triggerEvent 'page:before-change'
+  pageChangePrevented = (url) ->
+    !triggerEvent('page:before-change', url)
 
   processResponse = (xhr, partial = false) ->
     clientOrServerError = ->
@@ -290,11 +277,7 @@ class window.Turbolinks
 
   installHistoryChangeHandler = (event) ->
     if event.state?.turbolinks
-      if cachedPage = pageCache.get((new ComponentUrl(event.state.url)).absolute)
-        Turbolinks.cacheCurrentPage()
-        fetchHistory cachedPage
-      else
-        Turbolinks.visit event.target.location.href
+      Turbolinks.visit event.target.location.href
 
   # Delay execution of function long enough to miss the popstate event
   # some browsers fire on the initial page load.

data/lib/turbograft/version.rb

@@ -1,3 +1,3 @@
 module TurboGraft
-  VERSION = '0.0.8'
+  VERSION = '0.0.10'
 end

data/lib/turbograft/xhr_headers.rb

@@ -16,6 +16,17 @@ module TurboGraft
     end
 
     private
+
+    if Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR > 1
+      def _compute_redirect_to_location_with_xhr_referer(request, options)
+        session[:_turbolinks_redirect_to] =
+          if options == :back && request.headers["X-XHR-Referer"]
+            _compute_redirect_to_location_without_xhr_referer(request, request.headers["X-XHR-Referer"])
+          else
+            _compute_redirect_to_location_without_xhr_referer(request, options)
+          end
+      end
+    else
       def _compute_redirect_to_location_with_xhr_referer(options)
         session[:_turbolinks_redirect_to] =
           if options == :back && request.headers["X-XHR-Referer"]
@@ -24,12 +35,12 @@ module TurboGraft
             _compute_redirect_to_location_without_xhr_referer(options)
           end
       end
+    end
 
-      def set_xhr_redirected_to
-        if session[:_turbolinks_redirect_to]
-          response.headers['X-XHR-Redirected-To'] = session.delete :_turbolinks_redirect_to
-        end
+    def set_xhr_redirected_to
+      if session[:_turbolinks_redirect_to]
+        response.headers['X-XHR-Redirected-To'] = session.delete :_turbolinks_redirect_to
       end
+    end
   end
-
 end