turbograft 0.4.3 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9334d30bbf9e86dd7baae353ac711bc9688f70ff
-  data.tar.gz: 92bc6bf6eb003c707d82b1b28d7b71bd67e59ada
+SHA256:
+  metadata.gz: fba255993ff4ba3b193a70109a4635ebe5c672b2baa82e788f9e94f8d1d79fe5
+  data.tar.gz: 024e4089a512cfcaf3f3c1233eb58a44535f67be2a99257f7575c7880861fac5
 SHA512:
-  metadata.gz: 6625a059b2940513077f90ab4e11645e807cd57a62074815ed36f89710d28c3702a0277a90c62f243a079a0cc042011f8845cacd077f7881db43e576d478e5dd
-  data.tar.gz: 02850cbe00f2c90a16a34fd2932fb458fe542f578b766e7b1709ff9c938a75d706c5b439639a6338d93be44c6e86a0d4d3a80af20ce0e9a8760b2b7544fc9f24
+  metadata.gz: e638743501bff1821d16afca2ee426081e85ff70d69b15647568c6fe2a766b089ee85f43d7138a60afe1cad2a235cdfeb25afb04c7d6dac92a42767bc125eb35
+  data.tar.gz: f6a539ce14d10aefb28f500a2e9834a8a888851762ffa143667a6c1bc54a22948609c6498a7f611ab3208065e3e7680370de41f9ad79e038177f4a54de1a0c8b

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

@@ -16,18 +16,18 @@ Page.refresh = (options = {}, callback) ->
   else
     location.href
 
-  if options.response
-    options.partialReplace = true
-    options.onLoadFunction = callback
+  turboOptions = {
+    partialReplace: true,
+    exceptKeys: options.exceptKeys,
+    onlyKeys: options.onlyKeys,
+    updatePushState: options.updatePushState,
+    callback: callback
+  }
 
-    xhr = options.response
-    delete options.response
-    Turbolinks.loadPage null, xhr, options
+  if xhr = options.response
+    Turbolinks.loadPage null, xhr, turboOptions
   else
-    options.partialReplace = true
-    options.callback = callback if callback
-
-    Turbolinks.visit newUrl, options
+    Turbolinks.visit newUrl, turboOptions
 
 Page.open = ->
   window.open(arguments...)

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

@@ -134,16 +134,19 @@ class TurboGraft.Remote
       else if @opts.fullRefresh
         Page.refresh()
       else if @refreshOnSuccess
-        Page.refresh
+        Page.refresh(
           response: xhr
           onlyKeys: @refreshOnSuccess
+        )
       else if @refreshOnSuccessExcept
-        Page.refresh
+        Page.refresh(
           response: xhr
           exceptKeys: @refreshOnSuccessExcept
+        )
       else
-        Page.refresh
+        Page.refresh(
           response: xhr
+        )
 
   onError: (ev) =>
     @opts.fail?()
@@ -162,13 +165,15 @@ class TurboGraft.Remote
       else if @opts.fullRefresh
         Page.refresh()
       else if @refreshOnError
-        Page.refresh
+        Page.refresh(
           response: xhr
           onlyKeys: @refreshOnError
+        )
       else if @refreshOnErrorExcept
-        Page.refresh
+        Page.refresh(
           response: xhr
           exceptKeys: @refreshOnErrorExcept
+        )
       else
         triggerEventFor 'turbograft:remote:fail:unhandled', @initiator,
           xhr: xhr

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

@@ -1,5 +1,11 @@
 class TurboGraft.Response
-  constructor: (@xhr) ->
+  constructor: (@xhr, intendedURL) ->
+    if intendedURL && intendedURL.withoutHash() != @xhr.responseURL
+      redirectedTo = @xhr.responseURL
+    else
+      redirectedTo = @xhr.getResponseHeader('X-XHR-Redirected-To')
+
+    @finalURL = redirectedTo || intendedURL
 
   valid: -> @hasRenderableHttpStatus() && @hasValidContent()
 
@@ -21,3 +27,5 @@ class TurboGraft.Response
     "URL: #{@xhr.responseURL}, " +
     "ReadyState: #{@xhr.readyState}, " +
     "Headers: #{@xhr.getAllResponseHeaders()}"
+
+TurboGraft.location = () -> location.href

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

@@ -44,6 +44,9 @@ class TurboGraft.TurboHead
       noMatchingSrc(node) || noMatchingHref(node)
     )
 
+  movingFromTrackedToUntracked: () ->
+    @upstreamAssets.length == 0 && @activeAssets.length > 0
+
   hasNamedAssetConflicts: () ->
     @newScripts
       .concat(@newLinks)
@@ -51,7 +54,9 @@ class TurboGraft.TurboHead
       .some(datasetMatchesIn(TRACKED_ATTRIBUTE_NAME, @activeAssets))
 
   hasAssetConflicts: () ->
-    @hasNamedAssetConflicts() || @hasChangedAnonymousAssets()
+    @movingFromTrackedToUntracked() ||
+      @hasNamedAssetConflicts() ||
+      @hasChangedAnonymousAssets()
 
   waitForAssets: () ->
     resolvePreviousRequest?(isCanceled: true)

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

@@ -1,3 +1,7 @@
+Response = TurboGraft.Response
+TurboHead = TurboGraft.TurboHead
+jQuery = window.jQuery
+
 xhr = null
 activeDocument = document
 
@@ -67,17 +71,18 @@ class window.Turbolinks
 
   fetch = (url, options = {}) ->
     return if pageChangePrevented(url)
-    url = new ComponentUrl url
+    url = new ComponentUrl(url)
 
     rememberReferer()
 
-    options.partialReplace ?= false
-    options.onlyKeys ?= []
-    options.onLoadFunction = ->
-      resetScrollPosition() unless options.onlyKeys.length
-      options.callback?()
+    fetchReplacement(url, options)
 
-    fetchReplacement url, options
+  isPartialReplace = (response, options) ->
+    Boolean(
+      options.partialReplace ||
+      options.onlyKeys?.length ||
+      options.exceptKeys?.length
+    )
 
   @fullPageNavigate: (url) ->
     if url?
@@ -136,24 +141,28 @@ class window.Turbolinks
 
   @loadPage: (url, xhr, options = {}) ->
     triggerEvent 'page:receive'
+    response = new Response(xhr, url)
     options.updatePushState ?= true
-    if upstreamDocument = new TurboGraft.Response(xhr).document()
-      if options.partialReplace
-        reflectNewUrl url if options.updatePushState
-        updateBody(upstreamDocument, xhr, options)
-      else
-        turbohead = new TurboGraft.TurboHead(activeDocument, upstreamDocument)
-        if turbohead.hasAssetConflicts()
-          return Turbolinks.fullPageNavigate(url)
-        reflectNewUrl url if options.updatePushState
-        turbohead.waitForAssets().then((result) ->
-          updateBody(upstreamDocument, xhr, options) unless result?.isCanceled
-        )
-    else
+    options.partialReplace = isPartialReplace(response, options)
+
+    unless upstreamDocument = response.document()
       triggerEvent 'page:error', xhr
-      Turbolinks.fullPageNavigate(url)
+      Turbolinks.fullPageNavigate(response.finalURL)
+      return
+
+    if options.partialReplace
+      updateBody(upstreamDocument, response, options)
+      return
+
+    turbohead = new TurboHead(activeDocument, upstreamDocument)
+    if turbohead.hasAssetConflicts()
+      return Turbolinks.fullPageNavigate(response.finalURL)
 
-  updateBody = (upstreamDocument, xhr, options) ->
+    turbohead.waitForAssets().then((result) ->
+      updateBody(upstreamDocument, response, options) unless result?.isCanceled
+    )
+
+  updateBody = (upstreamDocument, response, options) ->
     nodes = changePage(
       upstreamDocument.querySelector('title')?.textContent,
       removeNoscriptTags(upstreamDocument.querySelector('body')),
@@ -161,16 +170,17 @@ class window.Turbolinks
       'runScripts',
       options
     )
-    reflectRedirectedUrl(xhr) if options.updatePushState
-    options.onLoadFunction?()
+    reflectNewUrl(response.finalURL) if options.updatePushState
+
+    Turbolinks.resetScrollPosition() unless options.partialReplace
+
+    options.callback?()
     triggerEvent 'page:load', nodes
 
   changePage = (title, body, csrfToken, runScripts, options = {}) ->
     activeDocument.title = title if title
-    options.onlyKeys ?= []
-    options.exceptKeys ?= []
 
-    if options.onlyKeys.length
+    if options.onlyKeys?.length
       nodesToRefresh = [].concat(getNodesWithRefreshAlways(), getNodesMatchingRefreshKeys(options.onlyKeys))
       nodes = refreshNodes(nodesToRefresh, body)
       setAutofocusElement() if anyAutofocusElement(nodes)
@@ -178,7 +188,7 @@ class window.Turbolinks
     else
       refreshNodes(getNodesWithRefreshAlways(), body)
       persistStaticElements(body)
-      if options.exceptKeys.length
+      if options.exceptKeys?.length
         refreshAllExceptWithKeys(options.exceptKeys, body)
       else
         deleteRefreshNeverNodes(body)
@@ -307,14 +317,6 @@ class window.Turbolinks
       Turbolinks.pushState { turbolinks: true, url: url.absolute }, '', url.absolute
     return
 
-  reflectRedirectedUrl = (xhr) ->
-    if location = xhr.getResponseHeader 'X-XHR-Redirected-To'
-      location = new ComponentUrl location
-      preservedHash = if location.hasNoHash() then activeDocument.location.hash else ''
-      Turbolinks.replaceState currentState, '', location.href + preservedHash
-
-    return
-
   rememberReferer = ->
     referer = activeDocument.location.href
 
@@ -327,7 +329,7 @@ class window.Turbolinks
   recallScrollPosition = (page) ->
     window.scrollTo page.positionX, page.positionY
 
-  resetScrollPosition = ->
+  @resetScrollPosition: ->
     if activeDocument.location.hash
       activeDocument.location.href = activeDocument.location.href
     else

data/lib/turbograft.rb

@@ -14,16 +14,20 @@ module TurboGraft
     self.controllers = ["ActionController::Base"]
   end
 
+  def self.included(controller)
+    controller.class_eval do
+      include XHRHeaders, Cookies, XDomainBlocker, Redirection
+      before_action :set_xhr_redirected_to, :set_request_method_cookie
+      after_action :abort_xdomain_redirect
+    end
+  end
+
   class Engine < ::Rails::Engine
 
     initializer :turbograft do |config|
       ActiveSupport.on_load(:action_controller) do
-        Config.controllers.each do |klass|
-          klass.constantize.class_eval do
-            include XHRHeaders, Cookies, XDomainBlocker, Redirection
-            before_action :set_xhr_redirected_to, :set_request_method_cookie
-            after_action :abort_xdomain_redirect
-          end
+        Config.controllers.each do |class_name|
+          class_name.constantize.include(::TurboGraft)
         end
 
         ActionDispatch::Request.class_eval do

data/lib/turbograft/redirection.rb

@@ -7,10 +7,9 @@ module TurboGraft
     private
     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
+      response.content_type = Mime[:js]
     end
   end
 end

data/lib/turbograft/version.rb

@@ -1,3 +1,3 @@
 module TurboGraft
-  VERSION = '0.4.3'
+  VERSION = '0.4.8'
 end

data/lib/turbograft/x_domain_blocker.rb

@@ -5,8 +5,8 @@ module TurboGraft
   module XDomainBlocker
     private
       def same_origin?(a, b)
-        a = URI.parse URI.escape(a)
-        b = URI.parse URI.escape(b)
+        a = URI.parse URI::DEFAULT_PARSER.escape(a)
+        b = URI.parse URI::DEFAULT_PARSER.escape(b)
         [a.scheme, a.host, a.port] == [b.scheme, b.host, b.port]
       end
 

data/lib/turbograft/xhr_headers.rb

@@ -25,23 +25,32 @@ module TurboGraft
     end
 
     private
-      def store_for_turbolinks(url)
-        session[:_turbolinks_redirect_to] = url if session && request.headers["X-XHR-Referer"]
-        url
-      end
 
-      def set_xhr_redirected_to
-        if session && session[:_turbolinks_redirect_to]
-          response.headers['X-XHR-Redirected-To'] = session.delete :_turbolinks_redirect_to
-        end
-      end
+    # Ensure backwards compatibility
+    # Rails < 4.2:  _compute_redirect_to_location(options)
+    # Rails >= 4.2: _compute_redirect_to_location(request, options)
+    def _normalize_redirect_params(args)
+      options, req = args.reverse
+      [options, req || request]
+    end
+
+    def store_for_turbolinks(url)
+      session[:_turbolinks_redirect_to] = url if session && request.headers["X-XHR-Referer"]
+      url
+    end
 
-      # Ensure backwards compatibility
-      # Rails < 4.2:  _compute_redirect_to_location(options)
-      # Rails >= 4.2: _compute_redirect_to_location(request, options)
-      def _normalize_redirect_params(args)
-        options, req = args.reverse
-        [options, req || request]
+    def set_xhr_redirected_to
+      if turbolinks_redirected? && request_matches_redirect?
+        response.headers['X-XHR-Redirected-To'] = session.delete(:_turbolinks_redirect_to)
       end
+    end
+
+    def turbolinks_redirected?
+      session && session[:_turbolinks_redirect_to]
+    end
+
+    def request_matches_redirect?
+      session[:_turbolinks_redirect_to] == request.original_url
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbograft
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.8
 platform: ruby
 authors:
 - Kristian Plettenberg-Dussault
@@ -10,10 +10,12 @@ authors:
 - Tyler Mercier
 - Anthony Cameron
 - Patrick Donovan
+- Mathew Allen
+- Gord Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -211,9 +213,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: It's like turbolinks, but with partial page replacement and tests
+description: Turbograft is a hard fork of Turbolinks, allowing you to perform partial
+  page refreshes and offering ajax form utilities.
 email:
 - tylermercier@gmail.com
+- mathew.allen@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -242,24 +246,24 @@ files:
 homepage: https://github.com/Shopify/turbograft
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: turbolinks with partial page replacement