Consistently render `button_to` as `<button>` #40747

seanpdoyle · 2020-12-04T02:17:27Z

Consistently render `button_to` as `<button>`

Prior to this commit, the
ActionView::Helpers::UrlHelper#button_to helper rendered
<input type="submit"> elements when passed its contents as a String
argument, and rendered <button type="submit"> elements when passed its
contents as a block.

This difference is subtle, and might lead to surprises.

Additionally, a <form> element's submitter can encode a name/value
pairing, which will be submitted as part of the request. When
button_to renders an <input type="submit"> element, the "button"
content is rendered as a [value] attribute, which prevents any
meaningful data from being encoded.

Since it's a single <button> or <input type="submit"> within a
<form>, missing out on that opportunity to encode information might
not be a show stopper, but ensuring that a <button> element is
rendered without a default [value] attribute enables applications to
encode additional information that can be accessed JavaScript as
element.value, instead of a workaround like
element.getAttribute("data-value").

Support rendering `input` elements with button_to

To support the original behavior of button_to rendering <input type="submit"> elements when invoked without a block, expose the
app.config.button_to_generates_button_tag configuration flag.

By default, it's set to true and ensures that all button_to calls
render <button> elements. To revert to the original behavior, set it
to false.

Co-authored-by: Dusan Orlovic duleorlovic@gmail.com

seanpdoyle · 2020-12-04T02:26:20Z

I now realize this is a re-imagining of #35143 (authored by @duleorlovic).

My changeset doesn't include any of the configurations from that branch. Is re-enabling <input type="submit"> still a concern?

kaspth · 2020-12-14T14:49:51Z

Yeah, we still want that configuration. Don't like the false that's used to indicate the new config, let's flip it so it's button_to_generates_button_tag = true. This'll also read better in new_framework_defaults_6_2.rb

Let's add @duleorlovic as a co-author for good measure as well.

kaspth · 2020-12-14T14:51:22Z

Yeah, we still want that configuration.

I mean unless you can find a suitable reason to not use a configuration point for this. I haven't looked into this so I'm repeating from @rafaelfranca.

actionview/lib/action_view/helpers/url_helper.rb

...ib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults_6_2.rb.tt

actionview/lib/action_view/railtie.rb

...ib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults_6_2.rb.tt

actionview/lib/action_view/helpers/url_helper.rb

seanpdoyle · 2020-12-15T15:11:21Z

actionview/test/template/url_helper_test.rb

@@ -50,6 +50,8 @@ class UrlHelperTest < ActiveSupport::TestCase
  include RenderERBUtils

  setup :_prepare_context
+  setup    { ActionView::Helpers::UrlHelper.button_to_generates_button_tag = true }
+  teardown { ActionView::Helpers::UrlHelper.button_to_generates_button_tag = false }


@kaspth since the default is false, these lines were necessary to enable the new behavior.

Does this feel idiomatic and compatible with the new_framework_defaults pattern to you?

Currently, this commit only includes a single test to cover button_to without a block with button_to_generates_button_tag = false. Is that sufficient? Would it be better to double the collection of def test_button_to_* tests to ensure we have coverage for both variations of the configuration flag?

actionview/lib/action_view/helpers/url_helper.rb

actionview/test/template/url_helper_test.rb

...ib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults_6_2.rb.tt

rafaelfranca

👍 Can you squash the last commit?

Prior to this commit, the [ActionView::Helpers::UrlHelper#button_to][button_to] helper rendered `<input type="submit">` elements when passed its contents as a String argument, and rendered `<button type="submit">` elements when passed its contents as a block. This difference is subtle, and might lead to surprises. Additionally, a `<form>` element's submitter can encode a `name`/`value` pairing, which will be submitted as part of the request. When `button_to` renders an `<input type="submit">` element, the "button" content is rendered as a `[value]` attribute, which prevents any meaningful data from being encoded. Since it's a single `<button>` or `<input type="submit">` within a `<form>`, missing out on that opportunity to encode information might not be a show stopper, but ensuring that a `<button>` element is rendered _without_ a default `[value]` attribute enables applications to encode additional information that can be accessed JavaScript as `element.value`, instead of a workaround like `element.getAttribute("data-value")`. Support rendering `input` elements with button_to --- To support the original behavior of `button_to` rendering `<input type="submit">` elements when invoked _without_ a block, expose the `app.config.button_to_generates_button_tag` configuration flag. By default, it's set to `true` and ensures that all `button_to` calls render `<button>` elements. To revert to the original behavior, set it to `false`. [button_to]: https://api.rubyonrails.org/v6.0/classes/ActionView/Helpers/UrlHelper.html#method-i-button_to Co-authored-by: Dusan Orlovic <duleorlovic@gmail.com>

seanpdoyle · 2020-12-29T00:34:13Z

@rafaelfranca I've squashed the commits. Thank you for the review!

@kaspth

In rails#40747 we added `ActionView::Helpers::UrlHelper.button_to_generates_button_tag`. - `config.action_view.button_to_generates_button_tag` should configure `ActionView::Helpers::UrlHelper.button_to_generates_button_tag` - Added test cases - Fixed new_framework_defaults_6_2.rb.tt (See rails#40747 (comment), rails#40747 (comment), cc @kaspth) - Added the option to the configuring guide - Documented - Added to "6.2 defaults section - Added to "Baseline defaults" section (see ff88113)

Rails 7 made `#button_to` consistent [1], so that now it always render a `<button>` HTML tag. Before that, its output was an `<input>` tag in some circumstances. Our tests were relying on the output to be an `<input>` tag, but we can be generic and catch both the old and new behaviors. See [2] for the line of code in solidus were the tag is generated. [1] - rails/rails#40747 [2] - https://github.com/solidusio/solidus/blob/350ed34e54fe27ff4e7ef8ea7478dbd5372796b9/backend/app/helpers/spree/admin/orders_helper.rb#L12

ref: rails#40747 The global config is great for new projects, but for large existing projects, auditing every `button_to` call could be overwhelming enough to not bother. This PR allows you to set if a button should always be returned per-invocation. This way you can gradually opt in to the config, or you can use it only in parts of your codebase. ```ruby button_to("Save", "http://www.example.com") # renders <input> button_to("Save", "http://www.example.com", button_tag: true) # renders <button> button_to("Save", "http://www.example.com", button_tag: false) # renders <input> button_to("Save", "http://www.example.com") # renders <button> button_to("Save", "http://www.example.com", button_tag: true) # renders <button> button_to("Save", "http://www.example.com", button_tag: false) # renders <input> ```

ghiculescu · 2023-09-05T01:50:02Z

Would love feedback on #49142

rails-bot bot added the actionview label Dec 4, 2020

seanpdoyle force-pushed the consistent-button-to branch from e518b92 to 5f2cf30 Compare December 14, 2020 22:16

kaspth reviewed Dec 14, 2020

View reviewed changes

actionview/lib/action_view/helpers/url_helper.rb Outdated Show resolved Hide resolved

actionview/lib/action_view/helpers/url_helper.rb Outdated Show resolved Hide resolved

seanpdoyle force-pushed the consistent-button-to branch from 9e216ef to 6324fd5 Compare December 14, 2020 23:56

rails-bot bot added the railties label Dec 14, 2020

seanpdoyle commented Dec 14, 2020

View reviewed changes

...ib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults_6_2.rb.tt Show resolved Hide resolved

kaspth reviewed Dec 15, 2020

View reviewed changes

actionview/lib/action_view/railtie.rb Outdated Show resolved Hide resolved

...ib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults_6_2.rb.tt Show resolved Hide resolved

seanpdoyle commented Dec 15, 2020

View reviewed changes

actionview/lib/action_view/helpers/url_helper.rb Outdated Show resolved Hide resolved

seanpdoyle force-pushed the consistent-button-to branch 3 times, most recently from b736b7b to ca7f4bd Compare December 15, 2020 15:08

seanpdoyle commented Dec 15, 2020

View reviewed changes

seanpdoyle force-pushed the consistent-button-to branch from ca7f4bd to d7b2dc7 Compare December 28, 2020 19:16

rafaelfranca reviewed Dec 28, 2020

View reviewed changes

rafaelfranca approved these changes Dec 28, 2020

View reviewed changes

seanpdoyle force-pushed the consistent-button-to branch from 53a747b to 9af9458 Compare December 29, 2020 00:33

rafaelfranca merged commit cd019cd into rails:master Dec 29, 2020

seanpdoyle deleted the consistent-button-to branch December 29, 2020 01:08

seanpdoyle mentioned this pull request Dec 29, 2020

Enable button_to to use button without block #35143

Closed

bogdanvlviv mentioned this pull request Jan 8, 2021

Make config.action_view.button_to_generates_button_tag work #41055

Merged

This was referenced Sep 1, 2021

Rails 7 alpha button_to now not work with hash options for url #43146

Closed

fix #43146 button_to now not works with hash params for url #43157

Closed

ghiculescu mentioned this pull request Sep 5, 2023

Allow overriding button_to_generates_button_tag per-invocation #49142

Closed

Consistently render `button_to` as `<button>` #40747

Consistently render `button_to` as `<button>` #40747

seanpdoyle commented Dec 4, 2020 •

edited

seanpdoyle commented Dec 4, 2020

kaspth commented Dec 14, 2020

kaspth commented Dec 14, 2020

seanpdoyle Dec 15, 2020

rafaelfranca left a comment

seanpdoyle commented Dec 29, 2020

ghiculescu commented Sep 5, 2023

Consistently render button_to as <button> #40747

Consistently render button_to as <button> #40747

Conversation

seanpdoyle commented Dec 4, 2020 • edited

Consistently render button_to as <button>

Support rendering input elements with button_to

seanpdoyle commented Dec 4, 2020

kaspth commented Dec 14, 2020

kaspth commented Dec 14, 2020

seanpdoyle Dec 15, 2020

Choose a reason for hiding this comment

rafaelfranca left a comment

Choose a reason for hiding this comment

seanpdoyle commented Dec 29, 2020

ghiculescu commented Sep 5, 2023

Consistently render `button_to` as `<button>` #40747

Consistently render `button_to` as `<button>` #40747

seanpdoyle commented Dec 4, 2020 •

edited

Consistently render `button_to` as `<button>`

Support rendering `input` elements with button_to