Merge pull request rails#42051 from seanpdoyle/form-empty-action

Support `<form>` elements without `[action]`

Author: guilleiguaran

actionview/CHANGELOG.md

@@ -1,3 +1,12 @@
+*   Support rendering `<form>` elements _without_ `[action]` attributes by:
+
+    * `form_with url: false` or `form_with ..., html: { action: false }`
+    * `form_for ..., url: false` or `form_for ..., html: { action: false }`
+    * `form_tag false` or `form_tag ..., action: false`
+    * `button_to "...", false` or `button_to(false) { ... }`
+
+    *Sean Doyle*
+
 *   Add `:day_format` option to `date_select`
 
         date_select("article", "written_on", day_format: ->(day) { day.ordinalize })

actionview/lib/action_view/helpers/form_helper.rb

@@ -282,6 +282,12 @@ module FormHelper
       #     ...
       #   <% end %>
       #
+      # You can omit the <tt>action</tt> attribute by passing <tt>url: false</tt>:
+      #
+      #   <%= form_for(@post, url: false) do |f| %>
+      #     ...
+      #   <% end %>
+      #
       # You can also set the answer format, like this:
       #
       #   <%= form_for(@post, format: :json) do |f| %>
@@ -449,7 +455,7 @@ def form_for(record, options = {}, &block)
         output  = capture(builder, &block)
         html_options[:multipart] ||= builder.multipart?
 
-        html_options = html_options_for_form(options[:url] || {}, html_options)
+        html_options = html_options_for_form(options.fetch(:url, {}), html_options)
         form_tag_with_body(html_options, output)
       end
 
@@ -465,10 +471,12 @@ def apply_form_for_options!(record, object, options) # :nodoc:
           method: method
         )
 
-        options[:url] ||= if options.key?(:format)
-          polymorphic_path(record, format: options.delete(:format))
-        else
-          polymorphic_path(record, {})
+        if options[:url] != false
+          options[:url] ||= if options.key?(:format)
+            polymorphic_path(record, format: options.delete(:format))
+          else
+            polymorphic_path(record, {})
+          end
         end
       end
       private :apply_form_for_options!
@@ -487,6 +495,15 @@ def apply_form_for_options!(record, object, options) # :nodoc:
       #   <form action="/posts" method="post">
       #     <input type="text" name="title">
       #   </form>
+
+      #   # With an intentionally empty URL:
+      #   <%= form_with url: false do |form| %>
+      #     <%= form.text_field :title %>
+      #   <% end %>
+      #   # =>
+      #   <form method="post" data-remote="true">
+      #     <input type="text" name="title">
+      #   </form>
       #
       #   # Adding a scope prefixes the input field names:
       #   <%= form_with scope: :post, url: posts_path do |form| %>
@@ -744,7 +761,9 @@ def form_with(model: nil, scope: nil, url: nil, format: nil, **options, &block)
         options[:skip_default_ids] = !form_with_generates_ids
 
         if model
-          url ||= polymorphic_path(model, format: format)
+          if url != false
+            url ||= polymorphic_path(model, format: format)
+          end
 
           model   = model.last if model.is_a?(Array)
           scope ||= model_name_from_record_or_class(model).param_key
@@ -1559,7 +1578,11 @@ def html_options_for_form_with(url_for_options = nil, model = nil, html: {}, loc
 
           # The following URL is unescaped, this is just a hash of options, and it is the
           # responsibility of the caller to escape all the values.
-          html_options[:action] = url_for(url_for_options || {})
+          if url_for_options == false || html_options[:action] == false
+            html_options.delete(:action)
+          else
+            html_options[:action] = url_for(url_for_options || {})
+          end
           html_options[:"accept-charset"] = "UTF-8"
           html_options[:"data-remote"] = true unless local
 

actionview/lib/action_view/helpers/form_tag_helper.rb

@@ -62,6 +62,9 @@ module FormTagHelper
       #
       #   <%= form_tag('/posts', remote: true) %>
       #   # => <form action="/posts" method="post" data-remote="true">
+
+      #   form_tag(false, method: :get)
+      #   # => <form method="get">
       #
       #   form_tag('http://far.away.com/form', authenticity_token: false)
       #   # form without authenticity token
@@ -875,7 +878,11 @@ def html_options_for_form(url_for_options, options)
             html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart")
             # The following URL is unescaped, this is just a hash of options, and it is the
             # responsibility of the caller to escape all the values.
-            html_options["action"]  = url_for(url_for_options)
+            if url_for_options == false || html_options["action"] == false
+              html_options.delete("action")
+            else
+              html_options["action"] = url_for(url_for_options)
+            end
             html_options["accept-charset"] = "UTF-8"
 
             html_options["data-remote"] = true if html_options.delete("remote")

actionview/lib/action_view/helpers/url_helper.rb

@@ -238,7 +238,15 @@ def link_to(name = nil, options = nil, html_options = nil, &block)
       # HTTP verb via the +:method+ option within +html_options+.
       #
       # ==== Options
-      # The +options+ hash accepts the same options as +url_for+.
+      # The +options+ hash accepts the same options as +url_for+. To generate a
+      # <tt><form></tt> element without an <tt>[action]</tt> attribute, pass
+      # <tt>false</tt>:
+      #
+      #   <%= button_to "New", false %>
+      #   # => "<form method="post" class="button_to">
+      #   #      <button type="submit">New</button>
+      #   #      <input name="authenticity_token" type="hidden" value="10f2163b45388899ad4d5ae948988266befcb6c3d1b2451cf657a0c293d605a6"/>
+      #   #    </form>"
       #
       # Most values in +html_options+ are passed through to the button element,
       # but there are a few special options:
@@ -324,11 +332,15 @@ def link_to(name = nil, options = nil, html_options = nil, &block)
       #   #
       def button_to(name = nil, options = nil, html_options = nil, &block)
         html_options, options = options, name if block_given?
-        options      ||= {}
         html_options ||= {}
         html_options = html_options.stringify_keys
 
-        url    = options.is_a?(String) ? options : url_for(options)
+        url =
+          case options
+          when FalseClass then nil
+          else url_for(options)
+          end
+
         remote = html_options.delete("remote")
         params = html_options.delete("params")
 

actionview/test/template/form_helper/form_with_test.rb

@@ -53,7 +53,7 @@ def form_text(action = "http://www.example.com", local: false, **options)
 
     method = method.to_s == "get" ? "get" : "post"
 
-    txt =  +%{<form accept-charset="UTF-8" action="#{action}"}
+    txt =  +%{<form accept-charset="UTF-8"} + (action ? %{ action="#{action}"} : "")
     txt << %{ enctype="multipart/form-data"} if enctype
     txt << %{ data-remote="true"} unless local
     txt << %{ class="#{html_class}"} if html_class
@@ -107,6 +107,22 @@ def test_form_with_with_method_delete
     assert_dom_equal expected, actual
   end
 
+  def test_form_with_false_url
+    actual = form_with(url: false)
+
+    expected = whole_form(false)
+
+    assert_dom_equal expected, actual
+  end
+
+  def test_form_with_false_action
+    actual = form_with(html: { action: false })
+
+    expected = whole_form(false)
+
+    assert_dom_equal expected, actual
+  end
+
   def test_form_with_with_local_true
     actual = form_with(local: true)
 
@@ -445,6 +461,22 @@ def test_form_with_general_attributes
     assert_dom_equal expected, output_buffer
   end
 
+  def test_form_with_false_url
+    form_with(url: false)
+
+    expected = whole_form(false)
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  def test_form_with_model_and_false_url
+    form_with(model: Post.new, url: false)
+
+    expected = whole_form(false)
+
+    assert_dom_equal expected, output_buffer
+  end
+
   def test_form_with_attribute_not_on_model
     form_with(model: @post) do |f|
       concat f.text_field :this_dont_exist_on_post
@@ -2398,7 +2430,7 @@ def hidden_fields(options = {})
     end
 
     def form_text(action = "/", id = nil, html_class = nil, local = nil, multipart = nil, method = nil)
-      txt =  +%{<form accept-charset="UTF-8" action="#{action}"}
+      txt =  +%{<form accept-charset="UTF-8"} + (action ? %{ action="#{action}"} : "")
       txt << %{ enctype="multipart/form-data"} if multipart
       txt << %{ data-remote="true"} unless local
       txt << %{ class="#{html_class}"} if html_class

actionview/test/template/form_helper_test.rb

@@ -1617,6 +1617,24 @@ def test_form_for_id
     assert_dom_equal expected, output_buffer
   end
 
+  def test_form_for_false_url
+    form_for(Post.new, url: false) do |form|
+    end
+
+    expected = whole_form(false, "new_post", "new_post")
+
+    assert_dom_equal expected, output_buffer
+  end
+
+  def test_form_for_false_action
+    form_for(Post.new, html: { action: false }) do |form|
+    end
+
+    expected = whole_form(false, "new_post", "new_post")
+
+    assert_dom_equal expected, output_buffer
+  end
+
   def test_field_id_with_model
     value = field_id(Post.new, :title)
 
@@ -3738,7 +3756,7 @@ def hidden_fields(options = {})
     end
 
     def form_text(action = "/", id = nil, html_class = nil, remote = nil, multipart = nil, method = nil)
-      txt =  +%{<form accept-charset="UTF-8" action="#{action}"}
+      txt =  +%{<form accept-charset="UTF-8"} + (action ? %{ action="#{action}"} : "")
       txt << %{ enctype="multipart/form-data"} if multipart
       txt << %{ data-remote="true"} if remote
       txt << %{ class="#{html_class}"} if html_class

actionview/test/template/form_tag_helper_test.rb

@@ -42,7 +42,7 @@ def form_text(action = "http://www.example.com", options = {})
 
     method = method.to_s == "get" ? "get" : "post"
 
-    txt =  +%{<form accept-charset="UTF-8" action="#{action}"}
+    txt =  +%{<form accept-charset="UTF-8"} + (action ? %{ action="#{action}"} : "")
     txt << %{ enctype="multipart/form-data"} if enctype
     txt << %{ data-remote="true"} if remote
     txt << %{ class="#{html_class}"} if html_class
@@ -138,6 +138,20 @@ def test_form_tag_with_remote_false
     assert_dom_equal expected, actual
   end
 
+  def test_form_tag_with_false_url_for_options
+    actual = form_tag(false)
+
+    expected = whole_form(false)
+    assert_dom_equal expected, actual
+  end
+
+  def test_form_tag_with_false_action
+    actual = form_tag({}, action: false)
+
+    expected = whole_form(false)
+    assert_dom_equal expected, actual
+  end
+
   def test_form_tag_enforce_utf8_true
     actual = form_tag({}, { enforce_utf8: true })
     expected = whole_form("http://www.example.com", enforce_utf8: true)

actionview/test/template/url_helper_test.rb

@@ -161,6 +161,20 @@ def test_button_to_with_path
     )
   end
 
+  def test_button_to_with_false_url
+    assert_dom_equal(
+      %{<form method="post" class="button_to"><button type="submit">Hello</button></form>},
+      button_to("Hello", false)
+    )
+  end
+
+  def test_button_to_with_false_url_and_block
+    assert_dom_equal(
+      %{<form method="post" class="button_to"><button type="submit">Hello</button></form>},
+      button_to(false) { "Hello" }
+    )
+  end
+
   def test_button_to_with_straight_url_and_request_forgery
     self.request_forgery = true