button_to_form 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98adc411f0fb0e2dfc0db591e3bafa70ca12e7a33ba230c63b25036b4430350c
-  data.tar.gz: c91c4b77327bec023a76a11b4ab4e2f3c39e1d99894b4e303fde214933a76fda
+  metadata.gz: fc4b4ecc124a1394c6a8f02525a0d88790f83f032393818ff15a4f9488adb7ad
+  data.tar.gz: cb7fca9a94e3285e539c4c35df78e1919dce9e6cc54be85129fc6bbf7c5c7cd5
 SHA512:
-  metadata.gz: db2c812e441ffc139591f40fb0fffdac22a6c9700fd130fa4f3ec5c51f95a33429e11293f50275178e0b4f6259cd093dda34b7ca69184a55f43c57fa4e617126
-  data.tar.gz: df6e59e461b0a57c731db35c5fce1c97eec4a896f83e4d6637f8d922e1f955c09416b8350476200b98d9f757870cab52d1e92d9fa1ae3eeb62fb992322a28afd
+  metadata.gz: 1bb3ed8a7d0dda063f6871d1ef36dcea0e00c1922b8be3cf83f09eb857f3954c8cc82e2653f3fb31fa0534d5f9b6c0a6c82a2cdecac12b8fce23175ea6fba379
+  data.tar.gz: adbbf8e3c6f2ff3031d40528d5353023937863d74e3c26c15ffe756782a5db85acb38bbf14f24adc613d52761ab3be827ad4d7b4366fb36493848ddb9c9f155f

data/Changelog.md

@@ -0,0 +1,13 @@
+# Changelog
+
+This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the
+recommendations of [keepachangelog.com](http://keepachangelog.com/).
+
+## 0.2.0 (2019-12-12)
+
+- Make `button_options` optional
+- Don't output another (duplicate) `form` with same id if called again with the same form id
+
+## 0.1.0 (2019-12-11)
+
+Initial release

data/Readme.md

@@ -1,16 +1,17 @@
 # `button_to_form`
 
 [![Gem Version](https://badge.fury.io/rb/button_to_form.svg)](https://badge.fury.io/rb/button_to_form)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rdoc.info/github/TylerRick/button_to_form/master)
 
 ## 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.
+provided by rails _doesn't work_ when used inside of a `<form>` tag, because it adds a new `<form>`
+(at your current nesting level) and HTML doesn't allow a `form` to be nested within another `form`.
 
 ## How does it work?
 
-The HTML spec does, however, allow a button/input/etc. to be
+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):
@@ -19,9 +20,39 @@ The [HTML spec says](https://html.spec.whatwg.org/#association-of-controls-and-f
 > (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.
+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 to *that* `form`'s action _rather_ than to the
+action of the `form` it is a descendant of.
+
+So — assuming you have added `<%= content_for(:footer) %>` somewhere in your layout — this source:
+
+```ruby
+= form_tag '/main_form' do
+  = hidden_field_tag :main_form_param_1, 'main_form'
+  = text_field_tag   :main_form_param_2, ''
+
+  = button_to_form 'Make happy', '/make_happy' do
+    = hidden_field_tag :how_happy, 'ecstatic!'
+```
+
+will get rendered to HTML that looks something like this:
+```html
+  <form action="/main_form" accept-charset="UTF-8" method="post">
+    <input type="hidden" name="main_form_param_1" id="main_form_param_1" value="main_form">
+    <input type="text" name="main_form_param_2" id="main_form_param_2" value="">
+    <button name="button" type="submit" form="form-1e7dc01b-46d0-4a44-908e-77fbe2a7ec98">Make happy</button>
+  </form>
+  …
+  <div id="footer">
+    <form id="form-1e7dc01b-46d0-4a44-908e-77fbe2a7ec98" action="/make_happy" accept-charset="UTF-8" method="post">
+      <input type="hidden" name="how_happy" id="how_happy" value="ecstatic!">
+    </form>
+  </div>
+```
+
+As you can see, there are 2 `<form>` tags that get rendered, but neither of them is nested within
+the other, so it is allowed — and works well! Now you can include `button_to` calls inside of
+other forms as much as your heart desires.
 
 
 ## Installation
@@ -37,37 +68,53 @@ For this helper to work, you *must* also include this somewhere in your layout:
   <%= content_for(:footer) %>
 ```
 
+If you want these forms to be added to a different `content_for` key, say `:forms`, you can
+configure it like so:
+```ruby
 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:
 
+```ruby
   = button_to_form 'Make happy', [:make_happy, user]
+```
+(These examples use HAML, but you could just as easily use ERB.)
+
+Unless you have a use case where the default generated id doesn't work, it is recommended to use
+that approach, as it ensures that each `button_to_form` call has its own corresponding unique
+`<form>`.
 
-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`.
+If, however, you need to reference this form in other places, you can specify a well-known id as the
+form's id. You can also pass other `form_options`, such as `method`.
 
+```ruby
   = 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.
+You may pass along additional data to the endpoint via `hidden_field_tag`s by passing them inside a
+block. You don't need to specify the `form` in this case because, as descendants, they are already
+associated with this new form.
 
+```ruby
   = button_to_form 'Delete', thing,
     {data: {confirm: 'Are you sure?'}},
-    {method: 'delete'}
+    {method: 'delete'} do
     = 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 start up a development web server with the same internal Rails app that is used for tests, run `rackup`.
+
 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

data/app/helpers/button_to_form_helper.rb

@@ -41,19 +41,25 @@ module ButtonToFormHelper
   #     {method: 'delete'}
   #     = hidden_field_tag :some_id, some_id
   #
-  def button_to_form(button_text, url, button_options, form_options = {}, &block)
+  # If you call button_to_form with the same form id, it will render the button but will _not_
+  # render another form with the same id since it doesn't make sense to have multiple forms with the
+  # same id. Instead it will assume you want another form that reuses (gets associated with) the
+  # *existing* form with that 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
+    @button_to_form_ids ||= []
+    @button_to_form_id = form_options[:id]
+    unless @button_to_form_ids.include?(@button_to_form_id)
+      content_for(ButtonToFormHelper.content_for_name) do
+        form_tag(url, **form_options) do
+          block.call if block
+        end
       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_to_form_ids << @button_to_form_id
 
-    button_tag(button_text, **button_options, type: 'submit', form: form_options[:id])
+    button_tag(button_text, **button_options, type: 'submit', form: @button_to_form_id)
   end
 
 end

data/config.ru

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "rubygems"
-require "bundler"
+require_relative './config/rails_environment'
 
-Bundler.require :default, :development
-
-Combustion.initialize! :action_controller, :action_view
 run Combustion::Application

data/config/rails_environment.rb

@@ -0,0 +1,11 @@
+# This common code has been extracted to ensure that both config.ru and spec/spec_helper.rb
+# configure Combustion/Rails in exactly the same way.
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller, :action_view
+
+ButtonToFormHelper.content_for_name = :forms

data/lib/button_to_form/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: button_to_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Rick
@@ -59,6 +59,7 @@ files:
 - bin/setup
 - button_to_form.gemspec
 - config.ru
+- config/rails_environment.rb
 - lib/button_to_form.rb
 - lib/button_to_form/engine.rb
 - lib/button_to_form/version.rb