Rename text_area to textarea

Follow-up to [rails#52432][]
Related to [rails#52430][]

Helpers like `text_area_tag` construct [textarea][] elements. This
commit renames all view helper and form builder methods to replace
occurrences of `text_area` with `textarea`.

In the same style, this commit also renames the `rich_text`-prefixed
helpers to utilize a `textarea` suffix instead of the existing
`text_area` suffix.

To preserve backwards compatibility, this commit defines aliases for the
existing `text_area` format.

[rails#52432]: rails#52432
[rails#52430]: rails#52430
[textarea]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea

Author: seanpdoyle

actionmailbox/app/views/rails/conductor/action_mailbox/inbound_emails/new.html.erb

@@ -40,7 +40,7 @@
 
   <div>
     <%= form.label :body, "Body" %><br>
-    <%= form.text_area :body, size: "40x20", value: params[:body] %>
+    <%= form.textarea :body, size: "40x20", value: params[:body] %>
   </div>
 
   <div>

actionmailbox/app/views/rails/conductor/action_mailbox/inbound_emails/sources/new.html.erb

@@ -5,7 +5,7 @@
 <%= form_with(url: main_app.rails_conductor_inbound_email_sources_path, local: true) do |form| %>
   <div>
     <%= form.label :source, "Source" %><br>
-    <%= form.text_area :source, size: "80x60" %>
+    <%= form.textarea :source, size: "80x60" %>
   </div>
 
   <%= form.submit "Deliver inbound email" %>

actiontext/CHANGELOG.md

@@ -1,3 +1,10 @@
+*   Rename `rich_text_area` methods into `rich_textarea`
+
+    Old names are still available as aliases.
+
+    *Sean Doyle*
+
+
 *   Only sanitize `content` attribute when present in attachments.
 
     *Petrik de Heus*

actiontext/app/helpers/action_text/tag_helper.rb

@@ -24,10 +24,10 @@ module TagHelper
     #
     # #### Example
     #
-    #     rich_text_area_tag "content", message.content
+    #     rich_textarea_tag "content", message.content
     #     # <input type="hidden" name="content" id="trix_input_post_1">
     #     # <trix-editor id="content" input="trix_input_post_1" class="trix-content" ...></trix-editor>
-    def rich_text_area_tag(name, value = nil, options = {})
+    def rich_textarea_tag(name, value = nil, options = {})
       options = options.symbolize_keys
       form = options.delete(:form)
 
@@ -43,6 +43,7 @@ def rich_text_area_tag(name, value = nil, options = {})
 
       input_tag + editor_tag
     end
+    alias_method :rich_text_area_tag, :rich_textarea_tag
   end
 end
 
@@ -56,7 +57,7 @@ def render
       options = @options.stringify_keys
       add_default_name_and_id(options)
       options["input"] ||= dom_id(object, [options["id"], :trix_input].compact.join("_")) if object
-      html_tag = @template_object.rich_text_area_tag(options.delete("name"), options.fetch("value") { value }, options.except("value"))
+      html_tag = @template_object.rich_textarea_tag(options.delete("name"), options.fetch("value") { value }, options.except("value"))
       error_wrapping(html_tag)
     end
   end
@@ -76,28 +77,30 @@ module FormHelper
     #
     #
     # #### Example
-    #     rich_text_area :message, :content
+    #     rich_textarea :message, :content
     #     # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1">
     #     # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
     #
-    #     rich_text_area :message, :content, value: "<h1>Default message</h1>"
+    #     rich_textarea :message, :content, value: "<h1>Default message</h1>"
     #     # <input type="hidden" name="message[content]" id="message_content_trix_input_message_1" value="<h1>Default message</h1>">
     #     # <trix-editor id="content" input="message_content_trix_input_message_1" class="trix-content" ...></trix-editor>
-    def rich_text_area(object_name, method, options = {})
+    def rich_textarea(object_name, method, options = {})
       Tags::ActionText.new(object_name, method, self, options).render
     end
+    alias_method :rich_text_area, :rich_textarea
   end
 
   class FormBuilder
-    # Wraps ActionView::Helpers::FormHelper#rich_text_area for form builders:
+    # Wraps ActionView::Helpers::FormHelper#rich_textarea for form builders:
     #
     #     <%= form_with model: @message do |f| %>
-    #       <%= f.rich_text_area :content %>
+    #       <%= f.rich_textarea :content %>
     #     <% end %>
     #
     # Please refer to the documentation of the base helper for details.
-    def rich_text_area(method, options = {})
-      @template.rich_text_area(@object_name, method, objectify_options(options))
+    def rich_textarea(method, options = {})
+      @template.rich_textarea(@object_name, method, objectify_options(options))
     end
+    alias_method :rich_text_area, :rich_textarea
   end
 end

actiontext/lib/action_text/system_test_helper.rb

@@ -17,42 +17,45 @@ module SystemTestHelper
     # Examples:
     #
     #     # <trix-editor id="message_content" ...></trix-editor>
-    #     fill_in_rich_text_area "message_content", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "message_content", with: "Hello <em>world!</em>"
     #
     #     # <trix-editor placeholder="Your message here" ...></trix-editor>
-    #     fill_in_rich_text_area "Your message here", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "Your message here", with: "Hello <em>world!</em>"
     #
     #     # <label for="message_content">Message content</label>
     #     # <trix-editor id="message_content" ...></trix-editor>
-    #     fill_in_rich_text_area "Message content", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "Message content", with: "Hello <em>world!</em>"
     #
     #     # <trix-editor aria-label="Message content" ...></trix-editor>
-    #     fill_in_rich_text_area "Message content", with: "Hello <em>world!</em>"
+    #     fill_in_rich_textarea "Message content", with: "Hello <em>world!</em>"
     #
     #     # <input id="trix_input_1" name="message[content]" type="hidden">
     #     # <trix-editor input="trix_input_1"></trix-editor>
-    #     fill_in_rich_text_area "message[content]", with: "Hello <em>world!</em>"
-    def fill_in_rich_text_area(locator = nil, with:)
-      find(:rich_text_area, locator).execute_script("this.editor.loadHTML(arguments[0])", with.to_s)
+    #     fill_in_rich_textarea "message[content]", with: "Hello <em>world!</em>"
+    def fill_in_rich_textarea(locator = nil, with:)
+      find(:rich_textarea, locator).execute_script("this.editor.loadHTML(arguments[0])", with.to_s)
     end
+    alias_method :fill_in_rich_text_area, :fill_in_rich_textarea
   end
 end
 
-Capybara.add_selector :rich_text_area do
-  label "rich-text area"
-  xpath do |locator|
-    if locator.nil?
-      XPath.descendant(:"trix-editor")
-    else
-      input_located_by_name = XPath.anywhere(:input).where(XPath.attr(:name) == locator).attr(:id)
-      input_located_by_label = XPath.anywhere(:label).where(XPath.string.n.is(locator)).attr(:for)
+%i[rich_textarea rich_text_area].each do |rich_textarea|
+  Capybara.add_selector rich_textarea do
+    label "rich-text area"
+    xpath do |locator|
+      if locator.nil?
+        XPath.descendant(:"trix-editor")
+      else
+        input_located_by_name = XPath.anywhere(:input).where(XPath.attr(:name) == locator).attr(:id)
+        input_located_by_label = XPath.anywhere(:label).where(XPath.string.n.is(locator)).attr(:for)
 
-      XPath.descendant(:"trix-editor").where \
-        XPath.attr(:id).equals(locator) |
-        XPath.attr(:placeholder).equals(locator) |
-        XPath.attr(:"aria-label").equals(locator) |
-        XPath.attr(:input).equals(input_located_by_name) |
-        XPath.attr(:id).equals(input_located_by_label)
+        XPath.descendant(:"trix-editor").where \
+          XPath.attr(:id).equals(locator) |
+          XPath.attr(:placeholder).equals(locator) |
+          XPath.attr(:"aria-label").equals(locator) |
+          XPath.attr(:input).equals(input_located_by_name) |
+          XPath.attr(:id).equals(input_located_by_label)
+      end
     end
   end
 end

actiontext/test/dummy/app/views/messages/_form.html.erb

@@ -18,7 +18,7 @@
 
   <div class="field">
     <%= form.label :content, "Message content label" %>
-    <%= form.rich_text_area :content, class: "trix-content",
+    <%= form.rich_textarea :content, class: "trix-content",
           placeholder: "Your message here", aria: { label: "Message content aria-label" } %>
   </div>
 

actiontext/test/system/system_test_helper_test.rb

@@ -9,36 +9,36 @@ def setup
 
   test "filling in a rich-text area by ID" do
     assert_selector "trix-editor#message_content"
-    fill_in_rich_text_area "message_content", with: "Hello world!"
+    fill_in_rich_textarea "message_content", with: "Hello world!"
     assert_selector :field, "message[content]", with: /Hello world!/, type: "hidden"
   end
 
   test "filling in a rich-text area by placeholder" do
     assert_selector "trix-editor[placeholder='Your message here']"
-    fill_in_rich_text_area "Your message here", with: "Hello world!"
+    fill_in_rich_textarea "Your message here", with: "Hello world!"
     assert_selector :field, "message[content]", with: /Hello world!/, type: "hidden"
   end
 
   test "filling in a rich-text area by aria-label" do
     assert_selector "trix-editor[aria-label='Message content aria-label']"
-    fill_in_rich_text_area "Message content aria-label", with: "Hello world!"
+    fill_in_rich_textarea "Message content aria-label", with: "Hello world!"
     assert_selector :field, "message[content]", with: /Hello world!/, type: "hidden"
   end
 
   test "filling in a rich-text area by label" do
     assert_selector "label", text: "Message content label"
-    fill_in_rich_text_area "Message content label", with: "Hello world!"
+    fill_in_rich_textarea "Message content label", with: "Hello world!"
     assert_selector :field, "message[content]", with: /Hello world!/, type: "hidden"
   end
 
   test "filling in a rich-text area by input name" do
     assert_selector "trix-editor[input]"
-    fill_in_rich_text_area "message[content]", with: "Hello world!"
+    fill_in_rich_textarea "message[content]", with: "Hello world!"
     assert_selector :field, "message[content]", with: /Hello world!/, type: "hidden"
   end
 
   test "filling in the only rich-text area" do
-    fill_in_rich_text_area with: "Hello world!"
+    fill_in_rich_textarea with: "Hello world!"
     assert_selector :field, "message[content]", with: /Hello world!/, type: "hidden"
   end
 end

actiontext/test/template/form_helper_test.rb

@@ -25,10 +25,10 @@ def form_with(*, **)
     )
   end
 
-  test "#rich_text_area_tag helper" do
+  test "#rich_textarea_tag helper" do
     message = Message.new
 
-    concat rich_text_area_tag :content, message.content, { input: "trix_input_1" }
+    concat rich_textarea_tag :content, message.content, { input: "trix_input_1" }
 
     assert_dom_equal \
       '<input type="hidden" name="content" id="trix_input_1" autocomplete="off" />' \
@@ -37,8 +37,8 @@ def form_with(*, **)
       output_buffer
   end
 
-  test "#rich_text_area helper" do
-    concat rich_text_area :message, :content, input: "trix_input_1"
+  test "#rich_textarea helper" do
+    concat rich_textarea :message, :content, input: "trix_input_1"
 
     assert_dom_equal \
       '<input type="hidden" name="message[content]" id="trix_input_1" autocomplete="off" />' \
@@ -47,10 +47,10 @@ def form_with(*, **)
       output_buffer
   end
 
-  test "#rich_text_area helper renders the :value argument into the hidden field" do
+  test "#rich_textarea helper renders the :value argument into the hidden field" do
     message = Message.new content: "<h1>hello world</h1>"
 
-    concat rich_text_area :message, :title, value: message.content, input: "trix_input_1"
+    concat rich_textarea :message, :title, value: message.content, input: "trix_input_1"
 
     assert_dom_equal \
       '<input type="hidden" name="message[title]" id="trix_input_1" value="&lt;h1&gt;hello world&lt;/h1&gt;" autocomplete="off" />' \
@@ -61,7 +61,7 @@ def form_with(*, **)
 
   test "form with rich text area" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :content
+      form.rich_textarea :content
     end
 
     assert_dom_equal \
@@ -75,7 +75,7 @@ def form_with(*, **)
 
   test "form with rich text area having class" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :content, class: "custom-class"
+      form.rich_textarea :content, class: "custom-class"
     end
 
     assert_dom_equal \
@@ -92,7 +92,7 @@ def form_with(*, **)
     message.errors.add(:content, :blank)
 
     form_with model: message, scope: :message do |form|
-      form.rich_text_area :content
+      form.rich_textarea :content
     end
 
     assert_dom_equal \
@@ -108,7 +108,7 @@ def form_with(*, **)
 
   test "form with rich text area for non-attribute" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :not_an_attribute
+      form.rich_textarea :not_an_attribute
     end
 
     assert_dom_equal \
@@ -122,7 +122,7 @@ def form_with(*, **)
 
   test "modelless form with rich text area" do
     form_with url: "/messages", scope: :message do |form|
-      form.rich_text_area :content, { input: "trix_input_2" }
+      form.rich_textarea :content, { input: "trix_input_2" }
     end
 
     assert_dom_equal \
@@ -136,7 +136,7 @@ def form_with(*, **)
 
   test "form with rich text area having placeholder without locale" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :content, placeholder: true
+      form.rich_textarea :content, placeholder: true
     end
 
     assert_dom_equal \
@@ -151,7 +151,7 @@ def form_with(*, **)
   test "form with rich text area having placeholder with locale" do
     I18n.with_locale :placeholder do
       form_with model: Message.new, scope: :message do |form|
-        form.rich_text_area :title, placeholder: true
+        form.rich_textarea :title, placeholder: true
       end
     end
 
@@ -166,7 +166,7 @@ def form_with(*, **)
 
   test "form with rich text area with value" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :title, value: "<h1>hello world</h1>"
+      form.rich_textarea :title, value: "<h1>hello world</h1>"
     end
 
     assert_dom_equal \
@@ -180,7 +180,7 @@ def form_with(*, **)
 
   test "form with rich text area with form attribute" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :title, form: "other_form"
+      form.rich_textarea :title, form: "other_form"
     end
 
     assert_dom_equal \
@@ -194,7 +194,7 @@ def form_with(*, **)
 
   test "form with rich text area with data[direct_upload_url]" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :content, data: { direct_upload_url: "http://test.host/direct_uploads" }
+      form.rich_textarea :content, data: { direct_upload_url: "http://test.host/direct_uploads" }
     end
 
     assert_dom_equal \
@@ -208,7 +208,7 @@ def form_with(*, **)
 
   test "form with rich text area with data[blob_url_template]" do
     form_with model: Message.new, scope: :message do |form|
-      form.rich_text_area :content, data: { blob_url_template: "http://test.host/blobs/:signed_id/:filename" }
+      form.rich_textarea :content, data: { blob_url_template: "http://test.host/blobs/:signed_id/:filename" }
     end
 
     assert_dom_equal \

actionview/CHANGELOG.md

@@ -1,3 +1,9 @@
+*   Rename `text_area` methods into `textarea`
+
+    Old names are still available as aliases.
+
+    *Sean Doyle*
+
 *   Rename `check_box*` methods into `checkbox*`.
 
     Old names are still available as aliases.