turbolinks_render 0.9.1 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45620397713bf0e33c196b245c7e37c9afd54aca8f9eee9a7fd3bbf36dee141
-  data.tar.gz: d6272756f224fa2ebe50364886eff3832613f12d6848e628c9c4bf50e76538ca
+  metadata.gz: e280f90e434bbda7fac2a73678441b6d1549bcd26a34b36a02e7bc430268a323
+  data.tar.gz: 2f234433939c2dee28c31d6aacc3a4c178dfcd048d1af868ae4e32c7dae21df7
 SHA512:
-  metadata.gz: b7f5293cf867a102c07d7de67853edc8441248b96b48bb0e667350a7d2e5b89903a48ae6aee1e3de7c2e452affc86187775102061fae69ccd0e5d795d52cba83
-  data.tar.gz: 6f0204ce2d3995f80a5591d1de1be57a20050fdbb703c9df1e0eece0e193c80113e5a4888ecf0672e2bac2b534efdd1631822ea6b4ef6a450e40672db44b59bc
+  metadata.gz: a1660d462adac9c80204cb3d34fa832ded9c3ab6c29c3e28269cb5d1f9a17513595033b15045aa0be07c10e52e30e62a43dbad745e4d43f546ab651dca0e5a96
+  data.tar.gz: 80d496e2d359a3230388e31c39bdb17bc2e2da1dc9646959ae531d8d90e0cf914b8bc9dee99ade1ebb85c00927c1dda763a292054971d491205150a1f339d03f

data/README.md

@@ -1,14 +1,18 @@
 # turbolinks_render
 
+[![Build Status](https://travis-ci.org/jorgemanrubia/turbolinks_render.svg?branch=master)](https://travis-ci.org/jorgemanrubia/turbolinks_render)
+
 Use `render` in your Rails controllers and handle the response with Turbolinks. 
 
 Turbolinks supports [`redirect_to`](https://github.com/turbolinks/turbolinks/blob/master/README.md#redirecting-after-a-form-submission) out of the box. But `render` is not supported and you have to use [workarounds for common things like dealing with forms](https://github.com/turbolinks/turbolinks/issues/85). This gem aims to fix that. 
 
+I think Turbolinks/Rails should handle this officially. If you agree [you can vote for this idea](https://github.com/turbolinks/turbolinks-rails/issues/40).
+
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'turboilnks_render'
+gem 'turbolinks_render'
 ```
 
 And then execute:
@@ -24,6 +28,11 @@ By default, `render` will be handled by Turbolinks if these conditions are met:
 - It's not a `get` request
 - It's not rendering json
 
+When these conditions are met and `render` is used:
+
+- The body of the page is replaced with the rendered content with Javascript
+- An event `turbolinks:load` is dispatched
+
 You can disable turbolinks on a given request with: 
 
 ```ruby
@@ -44,6 +53,10 @@ In this case, to use turbolinks you should write:
 render turbolinks: true
 ```
 
+## Example 
+
+An [example](https://github.com/jorgemanrubia/rails-form-validations-example) and an [explanatory blog post](https://www.jorgemanrubia.com/2019/02/16/form-validations-with-html5-and-modern-rails/) are also available.
+
 ## Credits
 
 - [Implementation based on this idea by @nerdcave](https://github.com/turbolinks/turbolinks/issues/85#issuecomment-298347900).  

data/lib/turbolinks_render.rb

@@ -1,15 +1,33 @@
 require 'turbolinks_render/version'
 require 'turbolinks_render/rendering'
+require 'turbolinks_render/middleware'
+require 'turbolinks_render/debug_exceptions_patch'
 
 module TurbolinksRender
+  class TurbolinksRenderMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @status, @headers, @response = @app.call(env)
+    end
+  end
+
   class Engine < ::Rails::Railtie
     config.turbolinks_render = ActiveSupport::OrderedOptions.new
     config.turbolinks_render.render_with_turbolinks_by_default = true
 
     initializer :turbolinks_render do |app|
+      app.config.app_middleware.insert_before ActionDispatch::ShowExceptions, TurbolinksRender::Middleware
+
       ActiveSupport.on_load(:action_controller) do
         include Rendering
       end
+
+      class ActionDispatch::DebugExceptions
+        prepend DebugExceptionsPatch
+      end
     end
   end
 end

data/lib/turbolinks_render/debug_exceptions_patch.rb

@@ -0,0 +1,18 @@
+module TurbolinksRender
+  # Patch for ActionDispatch::DebugExceptions middleware
+  module DebugExceptionsPatch
+    def render_for_browser_request(request, wrapper)
+      template = create_template(request, wrapper)
+      file = "rescues/#{wrapper.rescue_template}"
+
+      if request.xhr? && !request.get_header('X-Turbolinks-Render-Candidate')
+        body = template.render(template: file, layout: false, formats: [:text])
+        format = "text/plain"
+      else
+        body = template.render(template: file, layout: "rescues/layout")
+        format = "text/html"
+      end
+      render(wrapper.status_code, body, format)
+    end
+  end
+end

data/lib/turbolinks_render/middleware.rb

@@ -0,0 +1,70 @@
+module TurbolinksRender
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+      @request.set_header('X-Turbolinks-Render-Candidate', turbolinks_response_candidate?)
+
+      @status, @headers, @response = @app.call(env)
+
+      return [@status, @headers, @response] if file? || (!@response.respond_to?(:body) && !@response.respond_to?(:[]))
+
+      body = @response.respond_to?(:body) ? @response.body : @response[0]
+      body = render_body_with_turbolinks(body) if render_with_turbolinks?
+      [@status, @headers, [body]]
+    end
+
+    private
+
+    def render_body_with_turbolinks(body)
+      @headers["Content-Type"] = 'text/javascript'
+      build_turbolinks_response_to_render(body).tap do |turbolinks_body|
+        @headers["Content-Length"] = turbolinks_body.length
+      end
+    end
+
+    def file?
+      @headers["Content-Transfer-Encoding"] == "binary"
+    end
+
+    def render_with_turbolinks?
+      turbolinks_response_candidate? && html_response? && (turbolinks_render_option ||
+          (render_with_turbolinks_by_default? && turbolinks_render_option != false))
+    end
+
+    def turbolinks_render_option
+      @request.get_header('X-Turbolinks-Render-Option')
+    end
+
+    def turbolinks_response_candidate?
+      @request.xhr? && !@request.get?
+    end
+
+    def html_response?
+      @headers['Content-Type'] =~ /text\/html/
+    end
+
+    def build_turbolinks_response_to_render(html)
+      escaped_html = ActionController::Base.helpers.j(html)
+
+      <<-JS
+    (function(){
+      Turbolinks.clearCache();
+      document.open();
+      document.write("#{escaped_html}");
+      document.close();
+      Turbolinks.dispatch('turbolinks:load');
+      window.scroll(0, 0);
+    })();
+      JS
+    end
+
+    def render_with_turbolinks_by_default?
+      Rails.application.config.turbolinks_render.render_with_turbolinks_by_default
+    end
+
+  end
+end

data/lib/turbolinks_render/rendering.rb

@@ -4,53 +4,14 @@ module TurbolinksRender
 
     def render(*args, &block)
       options = args.dup.extract_options!
-      if render_with_turbolinks?(options)
-        render_with_turbolinks(*args, &block)
-      else
-        super
-      end
+      capture_turbolinks_option_to_make_it_accessible_by_middleware(options)
+      super
     end
 
     private
 
-    def render_with_turbolinks?(options)
-      request_candidate_for_turbolinks? && !json_response?(options) &&
-          (options[:turbolinks] || (render_with_turbolinks_by_default? && options[:turbolinks] != false))
-    end
-
-    def request_candidate_for_turbolinks?
-      request.xhr? && !request.get?
-    end
-
-    def render_with_turbolinks_by_default?
-      Rails.application.config.turbolinks_render.render_with_turbolinks_by_default
-    end
-
-    def json_response?(options)
-      options[:json]
-    end
-
-    def render_with_turbolinks(*args, &block)
-      html = render_to_string(*args, &block)
-      self.response_body = build_turbolinks_response_to_render(html)
-      self.status = 200
-      response.content_type = 'text/javascript'
-    end
-
-    def build_turbolinks_response_to_render(html)
-      escaped_html = ActionController::Base.helpers.j(html)
-
-      <<-JS
-    (function(){
-      Turbolinks.clearCache();
-      var parser = new DOMParser();
-      var newDocument = parser.parseFromString("#{escaped_html}", "text/html");
-
-      document.documentElement.replaceChild(newDocument.body, document.body);
-      Turbolinks.dispatch('turbolinks:load');
-      window.scroll(0, 0);
-    })();
-      JS
+    def capture_turbolinks_option_to_make_it_accessible_by_middleware(options)
+      request.set_header('X-Turbolinks-Render-Option', options[:turbolinks])
     end
   end
 end

data/lib/turbolinks_render/version.rb

@@ -1,3 +1,3 @@
 module TurbolinksRender
-  VERSION = '0.9.1'
+  VERSION = '0.9.9'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: turbolinks_render
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.9
 platform: ruby
 authors:
 - Jorge Manrubia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
 - !ruby/object:Gem::Dependency
@@ -133,6 +133,8 @@ files:
 - README.md
 - Rakefile
 - lib/turbolinks_render.rb
+- lib/turbolinks_render/debug_exceptions_patch.rb
+- lib/turbolinks_render/middleware.rb
 - lib/turbolinks_render/rendering.rb
 - lib/turbolinks_render/version.rb
 homepage: https://github.com/jorgemanrubia/turbolinks_render
@@ -155,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Use Rails render with Turbolinks