simple_form 3.0.4 → 5.0.3

data/test/form_builder/wrapper_test.rb

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class WrapperTest < ActionView::TestCase
-  test 'wrapper should not have error class for attribute without errors' do
+  test 'wrapper does not have error class for attribute without errors' do
     with_form_for @user, :active
     assert_no_select 'div.field_with_errors'
   end
 
-  test 'wrapper should not have error class when object is not present' do
+  test 'wrapper does not have error class when object is not present' do
     with_form_for :project, :name
     assert_no_select 'div.field_with_errors'
   end
 
-  test 'wrapper should add the attribute name class' do
+  test 'wrapper adds the attribute name class' do
     with_form_for @user, :name
     assert_select 'div.user_name'
   end
 
-  test 'wrapper should add the attribute name class for nested forms' do
+  test 'wrapper adds the attribute name class for nested forms' do
     @user.company = Company.new(1, 'Empresa')
     with_concat_form_for @user do |f|
       concat(f.simple_fields_for(:company) do |company_form|
@@ -27,44 +28,72 @@ class WrapperTest < ActionView::TestCase
     assert_select 'div.user_company_name'
   end
 
-  test 'wrapper should add the association name class' do
+  test 'wrapper adds the association name class' do
     with_form_for @user, :company
     assert_select 'div.user_company'
   end
 
-  test 'wrapper should add error class for attribute with errors' do
+  test 'wrapper adds error class for attribute with errors' do
     with_form_for @user, :name
     assert_select 'div.field_with_errors'
   end
 
-  test 'wrapper should add hint class for attribute with a hint' do
+  test 'wrapper adds error class to input for attribute with errors' do
+    with_form_for @user, :name, wrapper: custom_wrapper_with_input_error_class
+    assert_select 'div.field_with_errors'
+    assert_select 'input.is-invalid'
+  end
+
+  test 'wrapper does not add error class to input when the attribute is valid' do
+    with_form_for @user, :phone_number, wrapper: custom_wrapper_with_input_error_class
+    assert_no_select 'div.field_with_errors'
+    assert_no_select 'input.is-invalid'
+  end
+
+  test 'wrapper adds valid class for present attribute without errors' do
+    @user.instance_eval { undef errors }
+    with_form_for @user, :name, wrapper: custom_wrapper_with_input_valid_class
+    assert_select 'div.field_without_errors'
+    assert_select 'input.is-valid'
+    assert_no_select 'div.field_with_errors'
+    assert_no_select 'input.is-invalid'
+  end
+
+  test 'wrapper does not determine if valid class is needed when it is set to nil' do
+    @user.instance_eval { undef errors }
+    with_form_for @user, :name, wrapper: custom_wrapper_with_input_valid_class(valid_class: nil)
+
+    assert_no_select 'div.field_without_errors'
+  end
+
+  test 'wrapper adds hint class for attribute with a hint' do
     with_form_for @user, :name, hint: 'hint'
     assert_select 'div.field_with_hint'
   end
 
-  test 'wrapper should not have disabled class by default' do
+  test 'wrapper does not have disabled class by default' do
     with_form_for @user, :active
     assert_no_select 'div.disabled'
   end
 
-  test 'wrapper should have disabled class when input is disabled' do
+  test 'wrapper has disabled class when input is disabled' do
     with_form_for @user, :active, disabled: true
     assert_select 'div.disabled'
   end
 
-  test 'wrapper should support no wrapping when wrapper is false' do
+  test 'wrapper supports no wrapping when wrapper is false' do
     with_form_for @user, :name, wrapper: false
     assert_select 'form > label[for=user_name]'
     assert_select 'form > input#user_name.string'
   end
 
-  test 'wrapper should support no wrapping when wrapper tag is false' do
+  test 'wrapper supports no wrapping when wrapper tag is false' do
     with_form_for @user, :name, wrapper: custom_wrapper_without_top_level
     assert_select 'form > label[for=user_name]'
     assert_select 'form > input#user_name.string'
   end
 
-  test 'wrapper should wrapping tag adds required/optional css classes' do
+  test 'wrapper wraps tag adds required/optional css classes' do
     with_form_for @user, :name
     assert_select 'form div.input.required.string'
 
@@ -72,23 +101,23 @@ class WrapperTest < ActionView::TestCase
     assert_select 'form div.input.optional.integer'
   end
 
-  test 'wrapper should allow custom options to be given' do
+  test 'wrapper allows custom options to be given' do
     with_form_for @user, :name, wrapper_html: { id: "super_cool", class: 'yay' }
     assert_select 'form #super_cool.required.string.yay'
   end
 
-  test 'wrapper should allow tag to be given on demand' do
+  test 'wrapper allows tag to be given on demand' do
     with_form_for @user, :name, wrapper_tag: :b
     assert_select 'form b.required.string'
   end
 
-  test 'wrapper should allow wrapper class to be given on demand' do
+  test 'wrapper allows wrapper class to be given on demand' do
     with_form_for @user, :name, wrapper_class: :wrapper
     assert_select 'form div.wrapper.required.string'
   end
 
-  test 'wrapper should skip additional classes when configured' do
-    swap SimpleForm, generate_additional_classes_for: [:input, :label] do
+  test 'wrapper skips additional classes when configured' do
+    swap SimpleForm, generate_additional_classes_for: %i[input label] do
       with_form_for @user, :name, wrapper_class: :wrapper
       assert_select 'form div.wrapper'
       assert_no_select 'div.required'
@@ -97,8 +126,8 @@ class WrapperTest < ActionView::TestCase
     end
   end
 
-  test 'wrapper should not generate empty css class' do
-    swap SimpleForm, generate_additional_classes_for: [:input, :label] do
+  test 'wrapper does not generate empty css class' do
+    swap SimpleForm, generate_additional_classes_for: %i[input label] do
       swap_wrapper :default, custom_wrapper_without_class do
         with_form_for @user, :name
         assert_no_select 'div#custom_wrapper_without_class[class]'
@@ -128,6 +157,21 @@ class WrapperTest < ActionView::TestCase
     end
   end
 
+  test 'custom wrappers can have additional attributes' do
+    swap_wrapper :default, custom_wrapper_with_additional_attributes do
+      with_form_for @user, :name
+
+      assert_select "div.custom_wrapper[title='some title'][data-wrapper='test']"
+    end
+  end
+
+  test 'custom wrappers can have full error message on attributes' do
+    swap_wrapper :default, custom_wrapper_with_full_error do
+      with_form_for @user, :name
+      assert_select 'span.error', "Super User Name! cannot be blank"
+    end
+  end
+
   test 'custom wrappers on a form basis' do
     swap_wrapper :another do
       with_concat_form_for(@user) do |f|
@@ -172,8 +216,8 @@ class WrapperTest < ActionView::TestCase
     end
   end
 
-  test 'do not duplicate label classes for different inputs' do
-    swap_wrapper :default, self.custom_wrapper_with_label_html_option do
+  test 'does not duplicate label classes for different inputs' do
+    swap_wrapper :default, custom_wrapper_with_label_html_option do
       with_concat_form_for(@user) do |f|
         concat f.input :name, required: false
         concat f.input :email, as: :email, required: true
@@ -191,7 +235,7 @@ class WrapperTest < ActionView::TestCase
     end
   end
 
-  test 'use wrapper for specified in config mapping' do
+  test 'uses wrapper for specified in config mapping' do
     swap_wrapper :another do
       swap SimpleForm, wrapper_mappings: { string: :another } do
         with_form_for @user, :name
@@ -200,4 +244,135 @@ class WrapperTest < ActionView::TestCase
       end
     end
   end
+
+  test 'uses custom wrapper mapping per form basis' do
+    swap_wrapper :another do
+      with_concat_form_for @user, wrapper_mappings: { string: :another } do |f|
+        concat f.input :name
+      end
+    end
+
+    assert_select "section.custom_wrapper div.another_wrapper label"
+    assert_select "section.custom_wrapper div.another_wrapper input.string"
+  end
+
+  test 'simple_fields_form reuses custom wrapper mapping per form basis' do
+    @user.company = Company.new(1, 'Empresa')
+
+    swap_wrapper :another do
+      with_concat_form_for @user, wrapper_mappings: { string: :another } do |f|
+        concat(f.simple_fields_for(:company) do |company_form|
+          concat(company_form.input(:name))
+        end)
+      end
+    end
+
+    assert_select "section.custom_wrapper div.another_wrapper label"
+    assert_select "section.custom_wrapper div.another_wrapper input.string"
+  end
+
+  test "input attributes class will merge with wrapper_options' classes" do
+    swap_wrapper :default, custom_wrapper_with_input_class do
+      with_concat_form_for @user do |f|
+        concat f.input :name, input_html: { class: 'another-class' }
+      end
+    end
+
+    assert_select "div.custom_wrapper input.string.inline-class.another-class"
+  end
+
+  test "input with data attributes will merge with wrapper_options' data" do
+    swap_wrapper :default, custom_wrapper_with_input_data_modal do
+      with_concat_form_for @user do |f|
+        concat f.input :name, input_html: { data: { modal: 'another-data', target: 'merge-data' } }
+      end
+    end
+
+    assert_select "input[data-wrapper='data-wrapper'][data-modal='another-data'][data-target='merge-data']"
+  end
+
+  test "input with aria attributes will merge with wrapper_options' aria" do
+    swap_wrapper :default, custom_wrapper_with_input_aria_modal do
+      with_concat_form_for @user do |f|
+        concat f.input :name, input_html: { aria: { modal: 'another-aria', target: 'merge-aria' } }
+      end
+    end
+
+    assert_select "input[aria-wrapper='aria-wrapper'][aria-modal='another-aria'][aria-target='merge-aria']"
+  end
+
+  test 'input accepts attributes in the DSL' do
+    swap_wrapper :default, custom_wrapper_with_input_class do
+      with_concat_form_for @user do |f|
+        concat f.input :name
+      end
+    end
+
+    assert_select "div.custom_wrapper input.string.inline-class"
+  end
+
+  test 'label accepts attributes in the DSL' do
+    swap_wrapper :default, custom_wrapper_with_label_class do
+      with_concat_form_for @user do |f|
+        concat f.input :name
+      end
+    end
+
+    assert_select "div.custom_wrapper label.string.inline-class"
+  end
+
+  test 'label_input accepts attributes in the DSL' do
+    swap_wrapper :default, custom_wrapper_with_label_input_class do
+      with_concat_form_for @user do |f|
+        concat f.input :name
+      end
+    end
+
+    assert_select "div.custom_wrapper label.string.inline-class"
+    assert_select "div.custom_wrapper input.string.inline-class"
+  end
+
+  test 'input accepts data attributes in the DSL' do
+    swap_wrapper :default, custom_wrapper_with_input_attributes do
+      with_concat_form_for @user do |f|
+        concat f.input :name
+      end
+    end
+
+    assert_select "div.custom_wrapper input.string[data-modal=true]"
+  end
+
+  test 'inline wrapper displays when there is content' do
+    swap_wrapper :default, custom_wrapper_with_wrapped_optional_component do
+      with_form_for @user, :name, hint: "cannot be blank"
+      assert_select 'section.custom_wrapper div.no_output_wrapper p.omg_hint', "cannot be blank"
+      assert_select 'p.omg_hint'
+    end
+  end
+
+  test 'inline wrapper does not display when there is no content' do
+    swap_wrapper :default, custom_wrapper_with_wrapped_optional_component do
+      with_form_for @user, :name
+      assert_select 'section.custom_wrapper div.no_output_wrapper'
+      assert_no_select 'p.omg_hint'
+    end
+  end
+
+  test 'optional wrapper does not display when there is content' do
+    swap_wrapper :default, custom_wrapper_with_unless_blank do
+      with_form_for @user, :name, hint: "can't be blank"
+      assert_select 'section.custom_wrapper div.no_output_wrapper'
+      assert_select 'div.no_output_wrapper'
+      assert_select 'p.omg_hint'
+    end
+  end
+
+  test 'optional wrapper does not display when there is no content' do
+    swap_wrapper :default, custom_wrapper_with_unless_blank do
+      with_form_for @user, :name
+      assert_no_select 'section.custom_wrapper div.no_output_wrapper'
+      assert_no_select 'div.no_output_wrapper'
+      assert_no_select 'p.omg_hint'
+    end
+  end
 end

data/test/generators/simple_form_generator_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class SimpleFormGeneratorTest < Rails::Generators::TestCase
@@ -18,22 +19,22 @@ class SimpleFormGeneratorTest < Rails::Generators::TestCase
   end
 
   test 'generates the simple_form initializer with the bootstrap wrappers' do
-    run_generator %w(--bootstrap)
+    run_generator %w[--bootstrap]
     assert_file 'config/initializers/simple_form.rb',
       /config\.default_wrapper = :default/, /config\.boolean_style = :nested/
-    assert_file 'config/initializers/simple_form_bootstrap.rb', /config\.wrappers :bootstrap/,
-      /config\.default_wrapper = :bootstrap/
+    assert_file 'config/initializers/simple_form_bootstrap.rb', /config\.wrappers :vertical_form/,
+      /config\.wrappers :horizontal_form/, /config\.default_wrapper = :vertical_form/
   end
 
   test 'generates the simple_form initializer with the foundation wrappers' do
-    run_generator %w(--foundation)
+    run_generator %w[--foundation]
     assert_file 'config/initializers/simple_form.rb',
       /config\.default_wrapper = :default/, /config\.boolean_style = :nested/
-    assert_file 'config/initializers/simple_form_foundation.rb', /config\.wrappers :foundation/,
-      /config\.default_wrapper = :foundation/
+    assert_file 'config/initializers/simple_form_foundation.rb', /config\.wrappers :vertical_form/,
+      /config\.default_wrapper = :vertical_form/, /config\.item_wrapper_tag = :div/
   end
 
-  %W(erb haml slim).each do |engine|
+  %w[erb haml slim].each do |engine|
     test "generates the scaffold template when using #{engine}" do
       run_generator ['-e', engine]
       assert_file "lib/templates/#{engine}/scaffold/_form.html.#{engine}"

data/test/inputs/boolean_input_test.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 # encoding: UTF-8
 require 'test_helper'
 
 class BooleanInputTest < ActionView::TestCase
-  test 'input should generate a checkbox by default for boolean attributes' do
+  test 'input generates a checkbox by default for boolean attributes' do
     with_input_for @user, :active, :boolean
     assert_select 'input[type=checkbox].boolean#user_active'
     assert_select 'label.boolean.optional', 'Active'
@@ -49,15 +50,43 @@ class BooleanInputTest < ActionView::TestCase
 
   test 'input boolean with nested allows :inline_label' do
     swap SimpleForm, boolean_style: :nested do
-      with_input_for @user, :active, :boolean, label: false, inline_label: 'I am so inline.'
-      assert_select 'label.checkbox', text: 'I am so inline.'
+      with_input_for @user, :active, :boolean, inline_label: 'I am so inline.'
+      assert_select 'label.checkbox', text: ' I am so inline.'
+    end
+  end
+
+  test 'input boolean with nested escapes :inline_label with HTML' do
+    swap SimpleForm, boolean_style: :nested do
+      with_input_for @user, :active, :boolean, inline_label: '<b>I am so inline.</b>'
+      assert_no_select 'label.checkbox b'
+    end
+  end
+
+  test 'input boolean with nested allows :inline_label with HTML when safe' do
+    swap SimpleForm, boolean_style: :nested do
+      with_input_for @user, :active, :boolean, inline_label: '<b>I am so inline.</b>'.html_safe
+      assert_select 'label.checkbox b', text: 'I am so inline.'
     end
   end
 
   test 'input boolean with nested style creates an inline label using the default label text when inline_label option set to true' do
     swap SimpleForm, boolean_style: :nested do
-      with_input_for @user, :active, :boolean, label: false, inline_label: true
-      assert_select 'label.checkbox', text: 'Active'
+      with_input_for @user, :active, :boolean, inline_label: true
+      assert_select 'label.checkbox', text: ' Active'
+    end
+  end
+
+  test 'input boolean with nested style creates an inline label using the label text when inline_label option set to true' do
+    swap SimpleForm, boolean_style: :nested do
+      with_input_for @user, :active, :boolean, inline_label: true, label_text: proc { 'New Active' }
+      assert_select 'label.checkbox', text: ' New Active'
+    end
+  end
+
+  test 'input boolean with nested style creates an inline label using the label html when inline_label option set to true' do
+    swap SimpleForm, boolean_style: :nested do
+      with_input_for @user, :active, :boolean, inline_label: true, label_text: proc { '<b>New Active</b>' }
+      assert_select 'label.checkbox', text: ' New Active'
     end
   end
 
@@ -78,6 +107,14 @@ class BooleanInputTest < ActionView::TestCase
     end
   end
 
+  test 'input boolean with nested generates a disabled hidden field with the form attribute when it is given' do
+    swap SimpleForm, boolean_style: :nested do
+      with_input_for @user, :active, :boolean, input_html: { form: 'form_id' }
+
+      assert_select "input[type=hidden][form=form_id]+ label.boolean > input.boolean"
+    end
+  end
+
   test 'input accepts changing boolean style to nested through given options' do
     with_input_for @user, :active, :boolean, boolean_style: :nested
     assert_select 'label[for=user_active]', 'Active'
@@ -109,6 +146,22 @@ class BooleanInputTest < ActionView::TestCase
     end
   end
 
+  test 'input with nested style allows disabling hidden field' do
+    swap SimpleForm, boolean_style: :nested do
+      with_input_for @user, :active, :boolean, include_hidden: false
+      assert_select "label.boolean > input.boolean"
+      assert_no_select "input[type=hidden] + label.boolean"
+    end
+  end
+
+  test 'input with nested style does not include hidden field when unchecked_value is false' do
+    swap SimpleForm, boolean_style: :nested do
+      with_input_for @user, :active, :boolean, unchecked_value: false
+      assert_select "label.boolean > input.boolean"
+      assert_no_select "input[type=hidden] + label.boolean"
+    end
+  end
+
   test 'input boolean works using :input only in wrapper config (no label_input)' do
     swap_wrapper do
       with_input_for @user, :active, :boolean
@@ -128,6 +181,26 @@ class BooleanInputTest < ActionView::TestCase
     end
   end
 
+  test 'input boolean allows specifying boolean_label_class on a per-input basis' do
+    swap_wrapper do
+      swap SimpleForm, boolean_style: :nested, boolean_label_class: 'foo' do
+        with_input_for @user, :active, :boolean, boolean_label_class: 'baz'
+
+        assert_select 'label.boolean + input[type=hidden] + label.baz > input.boolean'
+      end
+    end
+  end
+
+  test 'input boolean with nested style works using :input only in wrapper config (no label_input), adding the extra label wrapper with custom class' do
+    swap_wrapper do
+      swap SimpleForm, boolean_style: :nested, boolean_label_class: 'foo' do
+        with_input_for @user, :active, :boolean
+
+        assert_select 'label.boolean + input[type=hidden] + label.foo > input.boolean'
+      end
+    end
+  end
+
   test 'input boolean with nested style works using :label_input in wrapper config, adding "checkbox" class to label' do
     swap_wrapper :default, self.custom_wrapper_without_top_level do
       swap SimpleForm, boolean_style: :nested do
@@ -138,7 +211,17 @@ class BooleanInputTest < ActionView::TestCase
     end
   end
 
-  test 'input boolean without additional classes should add "checkbox" class to label' do
+  test 'input boolean with nested style works using :label_input in wrapper config, adding custom class to label' do
+    swap_wrapper :default, self.custom_wrapper_without_top_level do
+      swap SimpleForm, boolean_style: :nested, boolean_label_class: 'foo' do
+        with_input_for @user, :active, :boolean
+
+        assert_select 'input[type=hidden] + label.boolean.foo > input.boolean'
+      end
+    end
+  end
+
+  test 'input boolean without additional classes adds "checkbox" class to label' do
     swap_wrapper :default, self.custom_wrapper_without_top_level do
       swap SimpleForm, boolean_style: :nested, generate_additional_classes_for: [:input] do
         with_input_for @user, :active, :boolean
@@ -149,4 +232,12 @@ class BooleanInputTest < ActionView::TestCase
       end
     end
   end
+
+  test 'input boolean works with wrapper config defining a class for the input' do
+    swap_wrapper :default, self.custom_wrapper_with_input_class do
+      with_input_for @user, :active, :boolean
+
+      assert_select 'input.boolean.inline-class'
+    end
+  end
 end