simple_form 3.0.1 → 4.0.0

data/test/form_builder/hint_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 # Tests for f.hint
@@ -8,24 +9,29 @@ class HintTest < ActionView::TestCase
     end
   end
 
-  test 'hint should not be generated by default' do
+  test 'hint does not be generated by default' do
     with_hint_for @user, :name
     assert_no_select 'span.hint'
   end
 
-  test 'hint should be generated with optional text' do
+  test 'hint is generated with optional text' do
     with_hint_for @user, :name, hint: 'Use with care...'
     assert_select 'span.hint', 'Use with care...'
   end
 
-  test 'hint should not modify the options hash' do
+  test 'hint is generated with decorated object responsive to #to_model' do
+    with_hint_for @decorated_user, :name, hint: 'Use with care...'
+    assert_select 'span.hint', 'Use with care...'
+  end
+
+  test 'hint does not modify the options hash' do
     options = { hint: 'Use with care...' }
     with_hint_for @user, :name, options
     assert_select 'span.hint', 'Use with care...'
     assert_equal({ hint: 'Use with care...' }, options)
   end
 
-  test 'hint should be generated cleanly with optional text' do
+  test 'hint is generated cleanly with optional text' do
     with_hint_for @user, :name, hint: 'Use with care...', hint_tag: :span
     assert_no_select 'span.hint[hint]'
     assert_no_select 'span.hint[hint_tag]'
@@ -37,20 +43,20 @@ class HintTest < ActionView::TestCase
     assert_select 'p.hint', 'Use with care...'
   end
 
-  test 'hint should be able to pass html options' do
+  test 'hint is able to pass html options' do
     with_hint_for @user, :name, hint: 'Yay!', id: 'hint', class: 'yay'
     assert_select 'span#hint.hint.yay'
   end
 
-  test 'hint should be output as html_safe' do
+  test 'hint is output as html_safe' do
     with_hint_for @user, :name, hint: '<b>Bold</b> and not...'.html_safe
     assert_select 'span.hint', 'Bold and not...'
     assert_select 'span.hint b', 'Bold'
   end
 
-  test 'builder should escape hint text' do
+  test 'builder escapes hint text' do
     with_hint_for @user, :name, hint: '<script>alert(1337)</script>'
-    assert_select 'span.hint', "&lt;script&gt;alert(1337)&lt;/script&gt;"
+    assert_no_select 'span.hint script'
   end
 
   # Without attribute name
@@ -60,7 +66,7 @@ class HintTest < ActionView::TestCase
     assert_select 'span.hint', 'Hello World!'
   end
 
-  test 'hint without attribute name should generate component tag with a clean HTML' do
+  test 'hint without attribute name generates component tag with a clean HTML' do
     with_hint_for @validating_user, 'Hello World!'
     assert_no_select 'span.hint[hint]'
     assert_no_select 'span.hint[hint_html]'
@@ -73,14 +79,14 @@ class HintTest < ActionView::TestCase
     assert_no_select 'p.hint[hint_tag]'
   end
 
-  test 'hint without attribute name should be able to pass html options' do
+  test 'hint without attribute name is able to pass html options' do
     with_hint_for @user, 'Yay', id: 'hint', class: 'yay'
     assert_select 'span#hint.hint.yay', 'Yay'
   end
 
   # I18n
 
-  test 'hint should use i18n based on model, action, and attribute to lookup translation' do
+  test 'hint uses i18n based on model, action, and attribute to lookup translation' do
     store_translations(:en, simple_form: { hints: { user: {
       edit: { name: 'Content of this input will be truncated...' }
     } } }) do
@@ -89,7 +95,7 @@ class HintTest < ActionView::TestCase
     end
   end
 
-  test 'hint should use i18n with model and attribute to lookup translation' do
+  test 'hint uses i18n with model and attribute to lookup translation' do
     store_translations(:en, simple_form: { hints: { user: {
       name: 'Content of this input will be capitalized...'
     } } }) do
@@ -98,7 +104,7 @@ class HintTest < ActionView::TestCase
     end
   end
 
-  test 'hint should use i18n under defaults namespace to lookup translation' do
+  test 'hint uses i18n under defaults namespace to lookup translation' do
     store_translations(:en, simple_form: {
       hints: { defaults: { name: 'Content of this input will be downcased...' } }
     }) do
@@ -107,7 +113,7 @@ class HintTest < ActionView::TestCase
     end
   end
 
-  test 'hint should use i18n with lookup for association name' do
+  test 'hint uses i18n with lookup for association name' do
     store_translations(:en, simple_form: { hints: {
       user: { company: 'My company!' }
     } } ) do
@@ -116,7 +122,7 @@ class HintTest < ActionView::TestCase
     end
   end
 
-  test 'hint should output translations as html_safe' do
+  test 'hint outputs translations as html_safe' do
     store_translations(:en, simple_form: { hints: { user: {
       edit: { name: '<b>This is bold</b> and this is not...' }
     } } }) do
@@ -128,7 +134,7 @@ class HintTest < ActionView::TestCase
 
   # No object
 
-  test 'hint should generate properly when object is not present' do
+  test 'hint generates properly when object is not present' do
     with_hint_for :project, :name, hint: 'Test without object'
     assert_select 'span.hint', 'Test without object'
   end
@@ -137,8 +143,8 @@ class HintTest < ActionView::TestCase
 
   test 'hint with custom wrappers works' do
     swap_wrapper do
-      with_hint_for @user, :name, hint: "can't be blank"
-      assert_select 'div.omg_hint', "can&#39;t be blank"
+      with_hint_for @user, :name, hint: "cannot be blank"
+      assert_select 'div.omg_hint', "cannot be blank"
     end
   end
 end

data/test/form_builder/input_field_test.rb

@@ -1,125 +1,201 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 # Tests for f.input_field
 class InputFieldTest < ActionView::TestCase
-  test "builder input_field should only render the input tag, nothing else" do
-    with_concat_form_for(@user) do |f|
-      f.input_field :name
+  def with_input_field_for(object, *args)
+    with_concat_form_for(object) do |f|
+      f.input_field(*args)
     end
+  end
+
+  test "builder input_field only renders the input tag, nothing else" do
+    with_input_field_for @user, :name
+
     assert_select 'form > input.required.string'
     assert_no_select 'div.string'
     assert_no_select 'label'
     assert_no_select '.hint'
   end
 
-  test 'builder input_field should allow overriding default input type' do
-    with_concat_form_for(@user) do |f|
-      f.input_field :name, as: :text
-    end
+  test 'builder input_field allows overriding default input type' do
+    with_input_field_for @user, :name, as: :text
 
     assert_no_select 'input#user_name'
     assert_select 'textarea#user_name.text'
   end
 
-  test 'builder input_field should generate input type based on column type' do
-    with_concat_form_for(@user) do |f|
-      f.input_field :age
-    end
+  test 'builder input_field generates input type based on column type' do
+    with_input_field_for @user, :age
 
     assert_select 'input[type=number].integer#user_age'
   end
 
-  test 'builder input_field should be able to disable any component' do
-    with_concat_form_for(@user) do |f|
-      f.input_field :age, html5: false
-    end
+  test 'builder input_field is able to disable any component' do
+    with_input_field_for @user, :age, html5: false
 
     assert_no_select 'input[html5=false]#user_age'
     assert_select 'input[type=text].integer#user_age'
   end
 
-  test 'builder input_field should allow passing options to input tag' do
-    with_concat_form_for(@user) do |f|
-      f.input_field :name, id: 'name_input', class: 'name'
-    end
+  test 'builder input_field allows passing options to input tag' do
+    with_input_field_for @user, :name, id: 'name_input', class: 'name'
 
     assert_select 'input.string.name#name_input'
   end
 
-  test 'builder input_field should not modify the options hash' do
+  test 'builder input_field does not modify the options hash' do
     options = { id: 'name_input', class: 'name' }
-
-    with_concat_form_for(@user) do |f|
-      f.input_field :name, options
-    end
+    with_input_field_for @user, :name, options
 
     assert_select 'input.string.name#name_input'
     assert_equal({ id: 'name_input', class: 'name' }, options)
   end
 
 
-  test 'builder input_field should generate an input tag with a clean HTML' do
-    with_concat_form_for(@user) do |f|
-      f.input_field :name, as: :integer, class: 'name'
-    end
+  test 'builder input_field generates an input tag with a clean HTML' do
+    with_input_field_for @user, :name, as: :integer, class: 'name'
 
     assert_no_select 'input.integer[input_html]'
     assert_no_select 'input.integer[as]'
   end
 
-  test 'builder input_field should use i18n to translate placeholder text' do
+  test 'builder input_field uses i18n to translate placeholder text' do
     store_translations(:en, simple_form: { placeholders: { user: {
       name: 'Name goes here'
     } } }) do
+      with_input_field_for @user, :name
 
-      with_concat_form_for(@user) do |f|
-        f.input_field :name
-      end
-
-      assert_select 'input.string[placeholder=Name goes here]'
+      assert_select 'input.string[placeholder="Name goes here"]'
     end
   end
 
-  test 'builder input_field should use min_max component' do
-    with_concat_form_for(@other_validating_user) do |f|
-      f.input_field :age, as: :integer
-    end
+  test 'builder input_field uses min_max component' do
+    with_input_field_for @other_validating_user, :age, as: :integer
 
-    assert_select 'input[min=18]'
+    assert_select 'input[min="18"]'
   end
 
-  test 'builder input_field should use pattern component' do
-    with_concat_form_for(@other_validating_user) do |f|
-      f.input_field :country, as: :string
-    end
+  test 'builder input_field does not use pattern component by default' do
+    with_input_field_for @other_validating_user, :country, as: :string
+
+    assert_no_select 'input[pattern="\w+"]'
+  end
+
+  test 'builder input_field infers pattern from attributes' do
+    with_input_field_for @other_validating_user, :country, as: :string, pattern: true
 
     assert_select 'input[pattern="\w+"]'
   end
 
-  test 'builder input_field should use readonly component' do
-    with_concat_form_for(@other_validating_user) do |f|
-      f.input_field :age, as: :integer, readonly: true
-    end
+  test 'builder input_field accepts custom pattern' do
+    with_input_field_for @other_validating_user, :country, as: :string, pattern: '\d+'
+
+    assert_select 'input[pattern="\d+"]'
+  end
+
+  test 'builder input_field uses readonly component' do
+    with_input_field_for @other_validating_user, :age, as: :integer, readonly: true
 
     assert_select 'input.integer.readonly[readonly]'
   end
 
-  test 'builder input_field should use maxlength component' do
-    with_concat_form_for(@validating_user) do |f|
-      f.input_field :name, as: :string
-    end
+  test 'builder input_field uses maxlength component' do
+    with_input_field_for @validating_user, :name, as: :string
 
-    assert_select 'input.string[maxlength=25]'
+    assert_select 'input.string[maxlength="25"]'
   end
 
-  test 'builder collection input_field should generate input tag with a clean HTML' do
-    with_concat_form_for(@user) do |f|
-      f.input_field :status, collection: ['Open', 'Closed'], class: 'status', label_method: :to_s, value_method: :to_s
-    end
+  test 'builder input_field uses minlength component' do
+    with_input_field_for @validating_user, :name, as: :string
+
+    assert_select 'input.string[minlength="5"]'
+  end
+
+  test 'builder collection input_field generates input tag with a clean HTML' do
+    with_input_field_for @user, :status, collection: %w[Open Closed],
+      class: 'status', label_method: :to_s, value_method: :to_s
 
     assert_no_select 'select.status[input_html]'
     assert_no_select 'select.status[collection]'
     assert_no_select 'select.status[label_method]'
     assert_no_select 'select.status[value_method]'
   end
+
+  test 'build input_field does not treat "boolean_style" as a HTML attribute' do
+    with_input_field_for @user, :active, boolean_style: :nested
+
+    assert_no_select 'input.boolean[boolean_style]'
+  end
+
+  test 'build input_field does not treat "prompt" as a HTML attribute' do
+    with_input_field_for @user, :attempts, collection: [1,2,3,4,5], prompt: :translate
+
+    assert_no_select 'select[prompt]'
+  end
+
+  test 'build input_field without pattern component use the pattern string' do
+    swap_wrapper :default, custom_wrapper_with_html5_components do
+      with_input_field_for @user, :name, pattern: '\w+'
+
+      assert_select 'input[pattern="\w+"]'
+    end
+  end
+
+  test 'build input_field without placeholder component use the placeholder string' do
+    swap_wrapper :default, custom_wrapper_with_html5_components do
+      with_input_field_for @user, :name, placeholder: 'Placeholder'
+
+      assert_select 'input[placeholder="Placeholder"]'
+    end
+  end
+
+  test 'build input_field without maxlength component use the maxlength string' do
+    swap_wrapper :default, custom_wrapper_with_html5_components do
+      with_input_field_for @user, :name, maxlength: 5
+
+      assert_select 'input[maxlength="5"]'
+    end
+  end
+
+  test 'build input_field without minlength component use the minlength string' do
+    swap_wrapper :default, custom_wrapper_with_html5_components do
+      with_input_field_for @user, :name, minlength: 5
+
+      assert_select 'input[minlength="5"]'
+    end
+  end
+
+  test 'build input_field without readonly component use the readonly string' do
+    swap_wrapper :default, custom_wrapper_with_html5_components do
+      with_input_field_for @user, :name, readonly: true
+
+      assert_select 'input[readonly="readonly"]'
+    end
+  end
+
+  test 'adds valid class to input_field when it is configured' do
+    swap SimpleForm, input_field_valid_class: 'is-valid' do
+      @user.instance_eval { undef errors }
+      with_input_field_for @user, :name
+
+      assert_select 'input.string.required.is-valid'
+    end
+  end
+
+  test 'adds error class to input_field when it is configured' do
+    swap SimpleForm, input_field_error_class: 'is-invalid' do
+      with_input_field_for @user, :name
+
+      assert_select 'input.string.required.is-invalid'
+    end
+  end
+
+  test 'does not add validation classes to input_field when it is not configured' do
+    swap SimpleForm, input_field_error_class: nil, input_field_valid_class: nil do
+      with_input_field_for @user, :name
+
+      assert_select 'input.string.required'
+    end
+  end
 end

data/test/form_builder/label_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: UTF-8
 require 'test_helper'
 
@@ -8,63 +9,78 @@ class LabelTest < ActionView::TestCase
     end
   end
 
-  test 'builder should generate a label for the attribute' do
+  test 'builder generates a label for the attribute' do
     with_label_for @user, :name
     assert_select 'label.string[for=user_name]', /Name/
   end
 
-  test 'builder should generate a label for the boolean attrbiute' do
+  test 'builder generates a label for the attribute with decorated object responsive to #to_model' do
+    with_label_for @decorated_user, :name
+    assert_select 'label.string[for=user_name]', /Name/
+  end
+
+  test 'builder generates a label for the boolean attrbiute' do
     with_label_for @user, :name, as: :boolean
     assert_select 'label.boolean[for=user_name]', /Name/
     assert_no_select 'label[as=boolean]'
   end
 
-  test 'builder should generate a label component tag with a clean HTML' do
+  test 'builder generates a label component tag with a clean HTML' do
     with_label_for @user, :name
     assert_no_select 'label.string[label_html]'
   end
 
-  test 'builder should add a required class to label if the attribute is required' do
+  test 'builder adds a required class to label if the attribute is required' do
     with_label_for @validating_user, :name
     assert_select 'label.string.required[for=validating_user_name]', /Name/
   end
 
-  test 'builder should escape label text' do
+  test 'builder adds a disabled class to label if the attribute is disabled' do
+    with_label_for @validating_user, :name, disabled: true
+    assert_select 'label.string.disabled[for=validating_user_name]', /Name/
+  end
+
+  test 'builder does not add a disabled class to label if the attribute is not disabled' do
+    with_label_for @validating_user, :name, disabled: false
+    assert_no_select 'label.string.disabled[for=validating_user_name]', /Name/
+  end
+
+  test 'builder escapes label text' do
     with_label_for @user, :name, label: '<script>alert(1337)</script>', required: false
-    assert_select 'label.string', "&lt;script&gt;alert(1337)&lt;/script&gt;"
+    assert_no_select 'label.string script'
   end
 
-  test 'builder should not escape label text if it is safe' do
+  test 'builder does not escape label text if it is safe' do
     with_label_for @user, :name, label: '<script>alert(1337)</script>'.html_safe, required: false
     assert_select 'label.string script', "alert(1337)"
   end
 
-  test 'builder should allow passing options to label tag' do
+  test 'builder allows passing options to label tag' do
     with_label_for @user, :name, label: 'My label', id: 'name_label'
     assert_select 'label.string#name_label', /My label/
   end
 
-  test 'builder label should generate label tag with clean HTML' do
+  test 'builder label generates label tag with clean HTML' do
     with_label_for @user, :name, label: 'My label', required: true, id: 'name_label'
     assert_select 'label.string#name_label', /My label/
     assert_no_select 'label[label]'
     assert_no_select 'label[required]'
   end
 
-  test 'builder should not modify the options hash' do
+  test 'builder does not modify the options hash' do
     options = { label: 'My label', id: 'name_label' }
     with_label_for @user, :name, options
     assert_select 'label.string#name_label', /My label/
     assert_equal({ label: 'My label', id: 'name_label' }, options)
   end
 
-  test 'builder should fallback to default label when string is given' do
+  test 'builder fallbacks to default label when string is given' do
     with_label_for @user, :name, 'Nome do usuário'
     assert_select 'label', 'Nome do usuário'
     assert_no_select 'label.string'
   end
 
-  test 'builder should fallback to default label when block is given' do
+  test 'builder fallbacks to default label when block is given' do
     with_label_for @user, :name do
       'Nome do usuário'
     end
@@ -73,9 +89,48 @@ class LabelTest < ActionView::TestCase
   end
 
   test 'builder allows label order to be changed' do
-    swap SimpleForm, label_text: lambda { |l, r| "#{l}:" } do
+    swap SimpleForm, label_text: proc { |l, r| "#{l}:" } do
       with_label_for @user, :age
       assert_select 'label.integer[for=user_age]', "Age:"
     end
   end
+
+  test 'configuration allow set label text for wrappers' do
+    swap_wrapper :default, custom_wrapper_with_label_text do
+      with_concat_form_for(@user) do |f|
+        concat f.input :age
+      end
+      assert_select "label.integer[for=user_age]", "**Age**"
+    end
+  end
+
+  test 'configuration allow set rewrited label tag for wrappers' do
+    swap_wrapper :default, custom_wrapper_with_custom_label_component do
+      with_concat_form_for(@user) do |f|
+        concat f.input :age
+      end
+      assert_select "span.integer.user_age", /Age/
+    end
+  end
+
+  test 'builder allows custom formatting when label is explicitly specified' do
+    swap SimpleForm, label_text: ->(l, r, explicit_label) { explicit_label ? l : "#{l.titleize}:" } do
+      with_label_for @user, :time_zone, 'What is your home time zone?'
+      assert_select 'label[for=user_time_zone]', 'What is your home time zone?'
+    end
+  end
+
+  test 'builder allows custom formatting when label is generated' do
+    swap SimpleForm, label_text: ->(l, r, explicit_label) { explicit_label ? l : "#{l.titleize}:" } do
+      with_label_for @user, :time_zone
+      assert_select 'label[for=user_time_zone]', 'Time Zone:'
+    end
+  end
+
+  test 'builder allows label specific `label_text` option' do
+    with_label_for @user, :time_zone, label_text: ->(l, _, _) { "#{l.titleize}:" }
+
+    assert_no_select 'label[label_text]'
+    assert_select 'label[for=user_time_zone]', 'Time Zone:'
+  end
 end