turbolinks-form 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d2cb57298ae2a5a1b8ba4558194588bfa194bf0
+  data.tar.gz: 960d1a4935b7e671397cd4dd07922510c3db4385
+SHA512:
+  metadata.gz: 0f25b167126b16ae244ab711966c662c78c7bd35de3c135a82116f939cf893bb72e38956f29633a84776556d96601ee47ead36e46bde2cea1c496b69c8cc3173
+  data.tar.gz: 9bd4e1678e718437ee761b446879ce02c242bdb69aa232a3e61b362a3fa5fbd10da582ef75cd20ca9bb0a660ce48e8c262345e8451f31867ba98b67cbf81f51e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/fixtures/shards.yml
+/spec/fixtures/schemas
+/tmp/
+.byebug_history
+turbolinks-form-*.*.*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+turbolinks-form

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in turbolinks-form.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Henrique Gubert
+
+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,104 @@
+# turbolinks-form
+Turbolinks 5 extension to render form errors after a submit.
+
+## Installation
+
+Add the gem to your `Gemfile`
+
+``` ruby
+gem 'turbolinks-form'
+```
+
+Then `bundle install`.
+
+Add the javascript to your `application.js` or to your `vendor.js`
+
+``` javascript
+//= require turbolinks-form
+```
+
+This will automatically include jQuery and Turbolinks if not included already.
+
+
+## Basic Usage
+
+Add `turbolinks_form: true` to your `form_for` or `form_tag`
+
+``` erb
+<%= form_for :resource, turbolinks_form: true do |f| ... %>
+
+<%= form_tag users_path, turbolinks_form: true do ... %>
+```
+
+In your controller, just render the desired view with status `:unprocessable_entity`
+ when validation fails:
+``` ruby
+def create
+  @user = User.build(params[:user])
+  if @user.save
+    redirect_to users_path  # This redirect_to is handled by turbolinks alone
+  else
+    render :new, status: :unprocessable_entity  # This render is handled by turbolinks-form
+  end
+end
+```
+
+The body of the rendered page will replace the current body, just like turbolinks would do for a regular visit.
+
+If you prefer, you can use a convenience method `render_form_with_errors` that will automatically render the `new` page on `create` actions and the `edit` page on `update` actions
+``` ruby
+def create
+  @user = User.build(params[:user])
+  if @user.save
+    redirect_to users_path  # This redirect_to is handled by turbolinks alone
+  else
+    render_form_with_errors  # This render is handled by turbolinks-form
+  end
+end
+```
+
+## Advanced Usage
+
+#### Rendering custom view
+You can pass the template name as the parameter to `render_form_with_errors` to choose any view you would like to render:
+``` ruby
+render_form_with_errors template: 'custom_view'
+```
+
+#### Rendering form with errors inside dialog
+Sometimes we do not wish to replace the whole page body with the form with error, but rather just replace the content of a dialog or page fragment. You can pass the dialog CSS selector to choose where your form will be rendered:
+``` ruby
+render_form_with_errors target: 'div.dialog'
+```
+The command above will replace the whole content of `div.dialog` with the body of your rendered page. When using this option your page is rendered without layout.
+
+## More Details
+
+#### Script tags
+Turbolinks-form will execute any `<script>` tags that the body of the response contains.
+
+#### Cache
+Turbolinks-form ignores Turbolinks caches. It does not populate or uses cache.
+
+#### Events
+Turbolinks-form will trigger only a subset of the (Turbolink events)[https://github.com/turbolinks/turbolinks#full-list-of-events]. Namely:
+
+* `turbolinks:request-start` fires before Turbolinks-form submits the form. Access the XMLHttpRequest object with `event.data.xhr`.
+
+* `turbolinks:request-end` fires after the network request completes. Access the XMLHttpRequest object with `event.data.xhr`.
+
+* `turbolinks:before-render` fires before rendering the page. Access the new `<body>` element with `event.data.newBody`.
+
+* `turbolinks:render` fires after Turbolinks renders the page. This event fires twice during an application visit to a cached location: once after rendering the cached version, and again after rendering the fresh version.
+
+* `turbolinks:load` fires after the page has finished loading (after rendering and after running inline script tags).
+
+#### Graceful Degradation
+When the request is not `xhr`, `turbolinks-form` degrades gracefully to regular rendering (with full page load).
+
+#### Browser history
+Turbolinks-form ignores browser history. It does not push any new state nor replaces the last state.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/assets/javascripts/turbolinks-form-core.js

@@ -0,0 +1,106 @@
+
+
+$(function() {
+
+  // As documented on the reference below, turbolinks 5 does not treat a render
+  // after a form submit by default, leaving the users to implement their own
+  // solutions.
+  //
+  // https://github.com/turbolinks/turbolinks/issues/85#issuecomment-323446272
+  //
+  // The code below imitates the behavior of turbolinks when treating regular GET
+  // responses. Namely, it:
+  //   - Replaces only the body of the page
+  //   - It runs all script tags on the body of the new page
+  //   - It fires the turbolinks:load event
+  //
+  // This doesn't mean it does ALL what turbolinks does. For example, we don't
+  // merge script tags from old and new page <head> elements.
+  // This also doesn't change the browser history or does any change to the URL.
+  // The reason we don't do such things is simply that this is a solution to
+  // render errors in forms, and usually we render the same page/form rendered
+  // before the submit.
+  var handleResponse = function(response) {
+    // parses response
+    var newDom = new DOMParser().parseFromString(response.responseText, "text/html");
+
+    // dispatches turbolinks event
+    Turbolinks.dispatch('turbolinks:before-render', {data: {newBody: newDom.body}});
+
+    // if there is no target, replaces whole body
+    var target;
+    if (!response.getResponseHeader('turbolinks-form-render-target')) {
+      document.body = newDom.body;
+      target = document.body;
+    } else {
+      target = $(response.getResponseHeader('turbolinks-form-render-target'), document.body)[0];
+      while (target.firstChild) {
+        target.removeChild(target.firstChild);
+      }
+      while (newDom.body.firstChild) {
+        target.appendChild(newDom.body.removeChild(newDom.body.firstChild));
+      }
+    }
+
+    // dispatches turbolinks event
+    Turbolinks.dispatch('turbolinks:render');
+
+    // get all script tags, and replace them by a new version with the same
+    // content. This makes them run.
+    var bodyScriptTags = target.getElementsByTagName('script');
+    for (var i=0; i<bodyScriptTags.length; i++) {
+      var newScript = document.createElement("script");
+      var oldScript = bodyScriptTags[i];
+      newScript.text = oldScript.text;
+      oldScript.parentNode.replaceChild(newScript, oldScript);
+    }
+
+    Turbolinks.dispatch("turbolinks:load");
+    scrollTo(0, 0);
+  }
+
+
+  // This code is only activated if:
+  //  1) HTTP status code is 422 unprocessable_entity
+  //  2) Response has the 'turbolinks-form-render' header
+  //
+  // PS: it is also activated on errors with code 500, so that we can know the
+  //     error is happening and not that the site is unresponsive
+  $(document).on("ajax:error", function(e, response) {
+    // dispatches turbolinks event
+    Turbolinks.dispatch('turbolinks:request-end', {data: {xhr: response}});
+
+    var isError500 = (response.status == 500)
+    var isFormErrorResponse = (response.status == 422 && response.getResponseHeader('turbolinks-form-render'));
+    if (isError500 || isFormErrorResponse) {
+      handleResponse(response);
+    }
+  });
+
+  // This code is only activated if:
+  //  1) HTTP status code is 200
+  //  2) Response has 'turbolinks-form-render' header and 'turbolinks-form-render-when-success' header
+  $(document).on("ajax:success", function(e, data, status, response) {
+    // dispatches turbolinks event
+    Turbolinks.dispatch('turbolinks:request-end', {data: {xhr: response}});
+
+    var isFormSuccessResponse = (response.status == 200 && response.getResponseHeader('turbolinks-form-render') && response.getResponseHeader('turbolinks-form-render-when-success'));
+    if (isFormSuccessResponse) {
+      handleResponse(response);
+    }
+  });
+
+  // Sets up event delegation to forms with data-turbolinks-form attribute
+  $(document).on("ajax:beforeSend", "[data-turbolinks-form]", function(e, xhr, settings) {
+    // adds the turbolinks-form-submit header for forms with data-turbolinks-form attribute being submitted,
+    // so the controller knows it has to put the turbolinks-form-render header on the response
+    xhr.setRequestHeader('turbolinks-form-submit', '1');
+
+    // changes default Accept header to say we preferably want an HTML content as a response
+    xhr.setRequestHeader('Accept', '*/*;q=0.5, text/javascript;q=0.9, application/javascript;q=0.9, application/ecmascript;q=0.9, application/x-ecmascript;q=0.9, text/html')
+
+    // dispatches turbolinks event
+    Turbolinks.dispatch('turbolinks:request-start', {data: {xhr: xhr}});
+  });
+
+});

data/app/assets/javascripts/turbolinks-form.js

@@ -0,0 +1,4 @@
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require turbolinks-form-core

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "turbolinks/form"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/turbolinks/form.rb

@@ -0,0 +1,15 @@
+require 'turbolinks/form/version'
+require 'turbolinks/form/view_helper'
+require 'turbolinks/form/controller'
+
+# includes the Rails engine, that automatically includes the assets on the app
+require "turbolinks/form/engine"
+
+# includes the Railtie, that loads the ViewHelper and controller methods
+require 'turbolinks/form/railtie' if defined?(Rails::Railtie)
+
+module Turbolinks
+  module Form
+
+  end
+end

data/lib/turbolinks/form/controller.rb

@@ -0,0 +1,84 @@
+module Turbolinks::Form
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :set_turbolinks_form_header
+    end
+
+    # convenience method
+    def render_errors(view_name=nil)
+      render_form_with_errors template: view_name
+    end
+
+    # Method used to render form with errors after a submit. It will automatically
+    # render the 'new' template for the 'create' action and the 'edit' template
+    # for the 'update' action.
+    #
+    # Options:
+    #   :template => specify a template other than 'new'/'edit'
+    #   :target => specify a css selector where the body of the rendered page should
+    #              be subtituted to. When this option is used the rendering occurs
+    #              without layout.
+    #
+    def render_form_with_errors(options={})
+      render_options = prepare_render_options(options)
+      render_options[:status] = :unprocessable_entity
+      render render_options
+    end
+
+    # Render some view after a form submit success (to be used instead of a
+    # redirect).
+    #
+    # Options:
+    #   :template => specify a template other than 'new'/'edit'
+    #   :target => specify a css selector where the body of the rendered page should
+    #              be subtituted to. When this option is used the rendering occurs
+    #              without layout.
+    #
+    def render_view_with_success(options={})
+      render_options = prepare_render_options(options)
+      render_options[:status] = 200
+
+      # this header is required to prevent turbolinks-form to render any response
+      # received when successfull (we don't want to render the content of a redirect,
+      # for example)
+      response.headers['turbolinks-form-render-when-success'] = '1'
+
+      render render_options
+    end
+
+  private
+
+    def set_turbolinks_form_header
+      if turbolinks_form_request?
+        # response.set_header("turbolinks-form-render", '1')
+        response.headers['turbolinks-form-render'] = '1'
+      end
+    end
+
+    def turbolinks_form_request?
+      (request.post? || request.put? || request.patch?) && request.xhr? && request.headers['turbolinks-form-submit']
+    end
+
+    def prepare_render_options(options)
+      render_options = {}
+
+      if !options[:template]
+        case action_name
+        when 'create' then render_options[:action] = 'new'
+        when 'update' then render_options[:action] = 'edit'
+        end
+      else
+        render_options[:action] = options[:template]
+      end
+
+      if options[:target] && request.xhr?
+        render_options[:layout] = false
+        response.headers['turbolinks-form-render-target'] = options[:target]
+      end
+
+      render_options
+    end
+  end
+end

data/lib/turbolinks/form/engine.rb

@@ -0,0 +1,5 @@
+# Defining the engine automatically includes the assets on the apps
+module Turbolinks::Form
+  class Engine < Rails::Engine
+  end
+end

data/lib/turbolinks/form/railtie.rb

@@ -0,0 +1,15 @@
+module Turbolinks::Form
+
+  class Railtie < Rails::Railtie
+    initializer 'turbolinks-form' do
+      ActiveSupport.on_load :action_view do
+        include Turbolinks::Form::ViewHelper
+      end
+
+      ActiveSupport.on_load :action_controller do
+        include Turbolinks::Form::Controller
+      end
+    end
+  end
+
+end

data/lib/turbolinks/form/version.rb

@@ -0,0 +1,5 @@
+module Turbolinks
+  module Form
+    VERSION = "0.0.1"
+  end
+end

data/lib/turbolinks/form/view_helper.rb

@@ -0,0 +1,32 @@
+module Turbolinks::Form
+  module ViewHelper
+    extend ActiveSupport::Concern
+
+    def form_for(record_or_name_or_array, *args, &proc)
+      options = args.extract_options!
+
+      # makes submit a xhr request that accepts html as response
+      if options.keys.include?(:turbolinks_form) && options[:turbolinks_form]
+        options[:remote] = true
+        options[:data] ||= {}
+        options[:data][:turbolinks_form] = true
+      end
+
+      super(record_or_name_or_array, *(args << options), &proc)
+    end
+
+    def form_tag(record_or_name_or_array, *args, &proc)
+      options = args.extract_options!
+
+      # makes submit a xhr request that accepts html as response
+      if options.keys.include?(:turbolinks_form) && options[:turbolinks_form]
+        options[:remote] = true
+        options[:data] ||= {}
+        options[:data][:turbolinks_form] = true
+      end
+
+      super(record_or_name_or_array, *(args << options), &proc)
+    end
+
+  end
+end

data/turbolinks-form.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'turbolinks/form/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "turbolinks-form"
+  spec.version       = Turbolinks::Form::VERSION
+  spec.authors       = ["Henrique Gubert"]
+  spec.email         = ["guberthenrique@hotmail.com"]
+
+  spec.description   = %q{Turbolinks 5 extension to render form errors after a submit}
+  spec.summary       = %q{Turbolinks-form extends Turbolinks 5 to allow a controller
+    to render any view after a form submit, and this view's body will replace the
+    current body, just like a regular Turbolinks visit. This makes it easy to render
+    form errors or to highlight invalid fields.}
+  spec.homepage      = "https://github.com/hsgubert/turbolinks-form"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails', '~> 4.2', '~> 5.0', '~> 5.1'
+  spec.add_runtime_dependency 'turbolinks', '~> 5.0', '>= 5.0.0'
+  spec.add_runtime_dependency 'jquery-rails', '~> 4.3', '>= 4.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", '~> 9'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: turbolinks-form
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henrique Gubert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: Turbolinks 5 extension to render form errors after a submit
+email:
+- guberthenrique@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- app/assets/javascripts/turbolinks-form-core.js
+- app/assets/javascripts/turbolinks-form.js
+- bin/console
+- bin/setup
+- lib/turbolinks/form.rb
+- lib/turbolinks/form/controller.rb
+- lib/turbolinks/form/engine.rb
+- lib/turbolinks/form/railtie.rb
+- lib/turbolinks/form/version.rb
+- lib/turbolinks/form/view_helper.rb
+- turbolinks-form.gemspec
+homepage: https://github.com/hsgubert/turbolinks-form
+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.11
+signing_key: 
+specification_version: 4
+summary: Turbolinks-form extends Turbolinks 5 to allow a controller to render any
+  view after a form submit, and this view's body will replace the current body, just
+  like a regular Turbolinks visit. This makes it easy to render form errors or to
+  highlight invalid fields.
+test_files: []