button_to_form 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98adc411f0fb0e2dfc0db591e3bafa70ca12e7a33ba230c63b25036b4430350c
+  data.tar.gz: c91c4b77327bec023a76a11b4ab4e2f3c39e1d99894b4e303fde214933a76fda
+SHA512:
+  metadata.gz: db2c812e441ffc139591f40fb0fffdac22a6c9700fd130fa4f3ec5c51f95a33429e11293f50275178e0b4f6259cd093dda34b7ca69184a55f43c57fa4e617126
+  data.tar.gz: df6e59e461b0a57c731db35c5fce1c97eec4a896f83e4d6637f8d922e1f955c09416b8350476200b98d9f757870cab52d1e92d9fa1ae3eeb62fb992322a28afd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in button_to_form.gemspec
+gemspec
+
+gem "bundler", "~> 1.17"
+gem "byebug"
+gem "capybara", '3.23.0'
+gem "combustion", "~> 1.0"
+gem "haml-rails"
+gem "pry"
+gem "rails", ">= 4.2"
+gem "rake", "~> 10.0"
+gem "rspec-rails", "~> 3.0"
+gem 'selenium-webdriver'

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2019 Tyler Rick
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,75 @@
+# `button_to_form`
+
+[![Gem Version](https://badge.fury.io/rb/button_to_form.svg)](https://badge.fury.io/rb/button_to_form)
+
+## Motivation
+
+The [button_to](https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-button_to)
+provided by rails doesn't work when used inside of a form tag, because it adds a new <form> and
+HTML doesn't allow a form within a form.
+
+## How does it work?
+
+The HTML spec does, however, allow a button/input/etc. to be
+associated with a different form than the one it is nested within.
+
+The [HTML spec says](https://html.spec.whatwg.org/#association-of-controls-and-forms):
+
+> A form-associated element is, by default, associated with its nearest ancestor form element
+> (as described below), but, if it is listed, may have a form attribute specified to override
+> this.
+
+This helper takes advantage of that, rendering a separate, empty form in the footer, and then
+associating this button with it, so that it submits with *that* form's action rather than the
+action of the form it is a descendant of.
+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'button_to_form'
+```
+
+For this helper to work, you *must* also include this somewhere in your layout:
+```ruby
+  <%= content_for(:footer) %>
+```
+
+ButtonToFormHelper.content_for_name = :forms
+
+## Usage
+
+By default, it will generate a unique id for the form. In its simplest form, it can be used as a
+drop-in replacement for Rails's `button_to`. Example:
+
+  = button_to_form 'Make happy', [:make_happy, user]
+
+If you need to reference this form in other places, you should specify the form's id. You can
+also pass other `form_options`, such as `method`.
+
+  = button_to_form 'Delete', thing,
+    {data: {confirm: 'Are you sure?'}},
+    {method: 'delete', id: 'delete_thing_form'}
+  = hidden_field_tag :some_id, some_id, {form: 'delete_thing_form'}
+
+You may pass along additional data to the endpoint via hidden_field_tags by passing them as a
+block. You don't need to specify the form in this case because, as descendants, they are already
+associated with this form.
+
+  = button_to_form 'Delete', thing,
+    {data: {confirm: 'Are you sure?'}},
+    {method: 'delete'}
+    = hidden_field_tag :some_id, some_id
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/button_to_form.

data/app/helpers/button_to_form_helper.rb

@@ -0,0 +1,59 @@
+module ButtonToFormHelper
+  class << self
+    attr_accessor :content_for_name
+  end
+  self.content_for_name = :footer
+
+  # The [button_to](https://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-button_to)
+  # provided by rails doesn't work when used inside of a form tag, because it adds a new <form> and
+  # HTML doesn't allow a form within a form. It does, however, allow a button/input/etc. to be
+  # associated with a different form than the one it is nested within.
+  #
+  # The [HTML spec says](https://html.spec.whatwg.org/#association-of-controls-and-forms):
+  #
+  # > A form-associated element is, by default, associated with its nearest ancestor form element
+  # > (as described below), but, if it is listed, may have a form attribute specified to override
+  # > this.
+  #
+  # This helper takes advantage of that, rendering a separate, empty form in the footer, and then
+  # associating this button with it, so that it submits with *that* form's action rather than the
+  # action of the form it is a descendant of.
+  #
+  # By default, it will generate a unique id for the form. In its simplest form, it can be used as a
+  # drop-in replacement for Rails's `button_to`. Example:
+  #
+  #   = button_to_form 'Make happy', [:make_happy, user]
+  #
+  # If you need to reference this form in other places, you should specify the form's id. You can
+  # also pass other `form_options`, such as `method`.
+  #
+  #   = button_to_form 'Delete', thing,
+  #     {data: {confirm: 'Are you sure?'}},
+  #     {method: 'delete', id: 'delete_thing_form'}
+  #   = hidden_field_tag :some_id, some_id, {form: 'delete_thing_form'}
+  #
+  # You may pass along additional data to the endpoint via hidden_field_tags by passing them as a
+  # block. You don't need to specify the form in this case because, as descendants, they are already
+  # associated with this form.
+  #
+  #   = button_to_form 'Delete', thing,
+  #     {data: {confirm: 'Are you sure?'}},
+  #     {method: 'delete'}
+  #     = hidden_field_tag :some_id, some_id
+  #
+  def button_to_form(button_text, url, button_options, form_options = {}, &block)
+    form_options[:id] ||= "form-#{SecureRandom.uuid}"
+    content_for(ButtonToFormHelper.content_for_name) do
+      # @button_to_form_rendered_content_for_name = true
+      # controller.instance_variable_set '@button_to_form_rendered_content_for_name', true
+      form_tag(url, **form_options) do
+        block.call if block
+      end
+    end
+    # @button_to_form_needs_to_render_content_for_name = true
+    # controller.instance_variable_set '@button_to_form_needs_to_render_content_for_name', true
+
+    button_tag(button_text, **button_options, type: 'submit', form: form_options[:id])
+  end
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "button_to_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(__FILE__)

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/button_to_form.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "button_to_form/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "button_to_form"
+  spec.version       = ButtonToForm::Version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+
+  spec.summary       = %q{A button_to helper that can be used inside a form tag (unlike Rails's own button_to)}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/TylerRick/button_to_form"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+  spec.add_dependency "actionpack", ">= 4.2"
+  spec.add_dependency "railties", ">= 4.2"
+end

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller, :action_view
+run Combustion::Application

data/lib/button_to_form.rb

@@ -0,0 +1,2 @@
+require "button_to_form/version"
+require "button_to_form/engine"

data/lib/button_to_form/engine.rb

@@ -0,0 +1,28 @@
+require 'rails/engine'
+require 'active_support'
+
+module ButtonToForm
+  class Engine < ::Rails::Engine
+    ActiveSupport.on_load(:action_controller) do
+      include ButtonToForm::ControllerMethods
+    end
+  end
+
+  module ControllerMethods
+    extend ActiveSupport::Concern
+    # TODO: Raise error if content_for :footer was never called in layout. But how do we even detect
+    # that?
+=begin disabled
+    included do
+      after_action \
+        def ensure_button_to_form_rendered
+          puts %(@button_to_form_needs_to_render_layout_section=#{(@button_to_form_needs_to_render_layout_section).inspect})
+          puts %(=>@button_to_form_rendered_layout_section=#{(@button_to_form_rendered_layout_section).inspect})
+          if @button_to_form_needs_to_render_layout_section && !@button_to_form_rendered_layout_section
+            raise "button_to_form requires that you include content_for(:footer) somewhere in your layout"
+          end
+        end
+    end
+=end
+  end
+end

data/lib/button_to_form/version.rb

@@ -0,0 +1,3 @@
+module ButtonToForm
+  Version = "0.1.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: button_to_form
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: A button_to helper that can be used inside a form tag (unlike Rails's
+  own button_to)
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- app/helpers/button_to_form_helper.rb
+- bin/console
+- bin/setup
+- button_to_form.gemspec
+- config.ru
+- lib/button_to_form.rb
+- lib/button_to_form/engine.rb
+- lib/button_to_form/version.rb
+homepage: https://github.com/TylerRick/button_to_form
+licenses: []
+metadata:
+  homepage_uri: https://github.com/TylerRick/button_to_form
+  source_code_uri: https://github.com/TylerRick/button_to_form
+  changelog_uri: https://github.com/TylerRick/button_to_form/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A button_to helper that can be used inside a form tag (unlike Rails's own
+  button_to)
+test_files: []