turbolinks_render 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3771ad622437e3a92f8529d069c82ac3fc6ea4c9
+  data.tar.gz: 5fd8bddd612bf72fde74e239c68fcbc1a2db10d1
+SHA512:
+  metadata.gz: 88712b8d615cc039a63cc10386fca0d72e73ffb3977d2099c5c6a18cc72bfcfdf5fc80b323a687d17accc9ebc8e003e7ab3e5f6a2dd3ce5dffe98c5b6c22baf6
+  data.tar.gz: 43bd9209a484567f487e10d82de77be8d3aa2e50f583867881132542a6aa3a390c992f13210c16e398cda1221f0ba9808fadd3f093b9eb116f4babf5fb048b5a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Jorge Manrubia
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# 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. 
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'turboilnks_render'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+By default, when using `render`, the response is going to be handled by Turbolinks if these conditions are met:
+
+- It's an ajax request
+- It's not a `get` request
+- It's not rendering json
+
+You can disable turbolinks for a given response: 
+
+```ruby
+render turbolinks: false
+```
+
+### Configuration
+
+You can invert the default behavior: never use turbolinks for rendering unless explicitly indicated. Create a file `config/initializers/turbolinks_render.rb` and toggle `turbolinks_render.render_with_turbolinks_by_default`:
+
+```ruby
+Rails.application.config.turbolinks_render.render_with_turbolinks_by_default = false
+```
+
+In this case, to use turbolinks in a given response you should write:
+
+```ruby
+render turbolinks: true
+```
+
+## Credits
+
+- [Implementation based on this idea by @nerdcave](https://github.com/turbolinks/turbolinks/issues/85#issuecomment-298347900).  
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Turbolinks::Rails::Render'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/turbolinks_render.rb

@@ -0,0 +1,16 @@
+require 'turbolinks_render/version'
+require 'turbolinks_render/rendering'
+
+module TurbolinksRender
+  class Engine < ::Rails::Railtie
+    config.turbolinks_render = ActiveSupport::OrderedOptions.new
+    config.turbolinks_render.render_with_turbolinks_by_default = true
+
+    initializer :turbolinks_render do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include Rendering
+      end
+    end
+  end
+end
+

data/lib/turbolinks_render/rendering.rb

@@ -0,0 +1,56 @@
+module TurbolinksRender
+  module Rendering
+    extend ActiveSupport::Concern
+
+    def render(*args, &block)
+      options = args.dup.extract_options!
+      if render_with_turbolinks?(options)
+        render_with_turbolinks(*args, &block)
+      else
+        super
+      end
+    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
+    end
+  end
+end

data/lib/turbolinks_render/version.rb

@@ -0,0 +1,3 @@
+module TurbolinksRender
+  VERSION = '0.9.0'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: turbolinks_render
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Jorge Manrubia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-18 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
+  name: turbolinks-source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Rails render with Turbolinks
+email:
+- jorge.manrubia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/turbolinks_render.rb
+- lib/turbolinks_render/rendering.rb
+- lib/turbolinks_render/version.rb
+homepage: https://github.com/jorgemanrubia/turboilnks_render
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Use Rails render with Turbolinks
+test_files: []