simple_form 3.0.1 → 4.0.0

data/test/action_view_extensions/form_helper_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class FormHelperTest < ActionView::TestCase
@@ -8,17 +9,36 @@ class FormHelperTest < ActionView::TestCase
     end
   end
 
-  test 'SimpleForm should add default class to form' do
+  test 'SimpleForm adds default class to form' do
     with_concat_form_for(:user)
     assert_select 'form.simple_form'
   end
 
-  test 'SimpleForm should use default browser validations by default' do
+  test 'SimpleForm allows overriding default form class' do
+    swap SimpleForm, default_form_class: "my_custom_class" do
+      with_concat_form_for :user, html: { class: "override_class" }
+      assert_no_select 'form.my_custom_class'
+      assert_select 'form.override_class'
+    end
+  end
+
+  # Remove this test when SimpleForm.form_class is removed in 4.x
+  test 'SimpleForm allows overriding default form class, but not form class' do
+    ActiveSupport::Deprecation.silence do
+      swap SimpleForm, form_class: "fixed_class", default_form_class: "my_custom_class" do
+        with_concat_form_for :user, html: { class: "override_class" }
+        assert_no_select 'form.my_custom_class'
+        assert_select 'form.fixed_class.override_class'
+      end
+    end
+  end
+
+  test 'SimpleForm uses default browser validations by default' do
     with_concat_form_for(:user)
     assert_no_select 'form[novalidate]'
   end
 
-  test 'SimpleForm should not use default browser validations if specified in the configuration options' do
+  test 'SimpleForm does not use default browser validations if specified in the configuration options' do
     swap SimpleForm, browser_validations: false do
       with_concat_form_for(:user)
       assert_select 'form[novalidate="novalidate"]'
@@ -37,57 +57,57 @@ class FormHelperTest < ActionView::TestCase
     end
   end
 
-  test 'SimpleForm should add object name as css class to form when object is not present' do
+  test 'SimpleForm adds object name as css class to form when object is not present' do
     with_concat_form_for(:user, html: { novalidate: true })
     assert_select 'form.simple_form.user'
   end
 
-  test 'SimpleForm should add :as option as css class to form when object is not present' do
+  test 'SimpleForm adds :as option as css class to form when object is not present' do
     with_concat_form_for(:user, as: 'superuser')
     assert_select 'form.simple_form.superuser'
   end
 
-  test 'SimpleForm should add object class name with new prefix as css class to form if record is not persisted' do
+  test 'SimpleForm adds object class name with new prefix as css class to form if record is not persisted' do
     @user.new_record!
     with_concat_form_for(@user)
     assert_select 'form.simple_form.new_user'
   end
 
-  test 'SimpleForm should add :as option with new prefix as css class to form if record is not persisted' do
+  test 'SimpleForm adds :as option with new prefix as css class to form if record is not persisted' do
     @user.new_record!
     with_concat_form_for(@user, as: 'superuser')
     assert_select 'form.simple_form.new_superuser'
   end
 
-  test 'SimpleForm should add edit class prefix as css class to form if record is persisted' do
+  test 'SimpleForm adds edit class prefix as css class to form if record is persisted' do
     with_concat_form_for(@user)
     assert_select 'form.simple_form.edit_user'
   end
 
-  test 'SimpleForm should add :as options with edit prefix as css class to form if record is persisted' do
+  test 'SimpleForm adds :as options with edit prefix as css class to form if record is persisted' do
     with_concat_form_for(@user, as: 'superuser')
     assert_select 'form.simple_form.edit_superuser'
   end
 
-  test 'SimpleForm should add last object name as css class to form when there is array of objects' do
+  test 'SimpleForm adds last object name as css class to form when there is array of objects' do
     with_concat_form_for([Company.new, @user])
     assert_select 'form.simple_form.edit_user'
   end
 
-  test 'SimpleForm should not add object class to form if css_class is specified' do
+  test 'SimpleForm does not add object class to form if css_class is specified' do
     with_concat_form_for(:user, html: { class: nil })
     assert_no_select 'form.user'
   end
 
-  test 'SimpleForm should add custom class to form if css_class is specified' do
+  test 'SimpleForm adds custom class to form if css_class is specified' do
     with_concat_form_for(:user, html: { class: 'my_class' })
     assert_select 'form.my_class'
   end
 
-  test 'pass options to SimpleForm' do
+  test 'passes options to SimpleForm' do
     with_concat_form_for(:user, url: '/account', html: { id: 'my_form' })
     assert_select 'form#my_form'
-    assert_select 'form[action=/account]'
+    assert_select 'form[action="/account"]'
   end
 
   test 'form_for yields an instance of FormBuilder' do
@@ -132,7 +152,7 @@ class FormHelperTest < ActionView::TestCase
   end
 
   test 'SimpleForm for swaps default action view field_error_proc' do
-    expected_error_proc = lambda {}
+    expected_error_proc = -> {}
     swap SimpleForm, field_error_proc: expected_error_proc do
       simple_form_for :user do |f|
         assert_equal expected_error_proc, ::ActionView::Base.field_error_proc
@@ -142,7 +162,7 @@ class FormHelperTest < ActionView::TestCase
 
   private
 
-  def swap_field_error_proc(expected_error_proc = lambda {})
+  def swap_field_error_proc(expected_error_proc = -> {})
     swap ActionView::Base, field_error_proc: expected_error_proc do
       yield
 

data/test/components/custom_components_test.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+# Module that represents a custom component.
+module Numbers
+  def number(wrapper_options = nil)
+    @number ||= options[:number].to_s.html_safe
+  end
+end
+
+# Module that represents a custom component.
+module InputGroup
+  def prepend(wrapper_options = nil)
+    span_tag = content_tag(:span, options[:prepend], class: 'input-group-text')
+    template.content_tag(:div, span_tag, class: 'input-group-prepend')
+  end
+
+  def append(wrapper_options = nil)
+    span_tag = content_tag(:span, options[:append], class: 'input-group-text')
+    template.content_tag(:div, span_tag, class: 'input-group-append')
+  end
+end
+
+class CustomComponentsTest < ActionView::TestCase
+  test 'includes the custom components' do
+    SimpleForm.include_component Numbers
+
+    custom_wrapper = SimpleForm.build tag: :div, class: "custom_wrapper" do |b|
+      b.use :number, wrap_with: { tag: 'div', class: 'number' }
+    end
+
+    with_form_for @user, :name, number: 1, wrapper: custom_wrapper
+
+    assert_select 'div.number', text: '1'
+  end
+
+  test 'includes custom components and use it as optional in the wrapper' do
+    SimpleForm.include_component InputGroup
+
+    custom_wrapper = SimpleForm.build tag: :div, class: 'custom_wrapper' do |b|
+      b.use :label
+      b.optional :prepend
+      b.use :input
+      b.use :append
+    end
+
+    with_form_for @user, :name, prepend: true, wrapper: custom_wrapper
+
+    assert_select 'div.input-group-prepend > span.input-group-text'
+    assert_select 'div.input-group-append > span.input-group-text'
+  end
+
+  test 'raises a TypeError when the component is not a Module' do
+    component = 'MyComponent'
+
+    exception = assert_raises TypeError do 
+      SimpleForm.include_component(component)
+    end
+    assert_equal exception.message, "SimpleForm.include_component expects a module but got: String"
+  end
+end

data/test/components/label_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: UTF-8
 require 'test_helper'
 
@@ -7,34 +8,34 @@ class IsolatedLabelTest < ActionView::TestCase
     SimpleForm::Inputs::Base.reset_i18n_cache :translate_required_html
   end
 
-  def with_label_for(object, attribute_name, type, options={})
+  def with_label_for(object, attribute_name, type, options = {})
     with_concat_form_for(object) do |f|
       options[:reflection] = Association.new(Company, :company, {}) if options.delete(:setup_association)
       SimpleForm::Inputs::Base.new(f, attribute_name, nil, type, options).label
     end
   end
 
-  test 'label should generate a default humanized description' do
+  test 'label generates a default humanized description' do
     with_label_for @user, :name, :string
     assert_select 'label[for=user_name]', /Name/
   end
 
-  test 'label should allow a customized description' do
+  test 'label allows a customized description' do
     with_label_for @user, :name, :string, label: 'My label!'
     assert_select 'label[for=user_name]', /My label!/
   end
 
-  test 'label should use human attribute name from object when available' do
+  test 'label uses human attribute name from object when available' do
     with_label_for @user, :description, :text
     assert_select 'label[for=user_description]', /User Description!/
   end
 
-  test 'label should use human attribute name based on association name' do
+  test 'label uses human attribute name based on association name' do
     with_label_for @user, :company_id, :string, setup_association: true
     assert_select 'label', /Company Human Name!/
   end
 
-  test 'label should use i18n based on model, action, and attribute to lookup translation' do
+  test 'label uses i18n based on model, action, and attribute to lookup translation' do
     @controller.action_name = "new"
     store_translations(:en, simple_form: { labels: { user: {
       new: { description: 'Nova descrição' }
@@ -44,7 +45,7 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should fallback to new when action is create' do
+  test 'label fallbacks to new when action is create' do
     @controller.action_name = "create"
     store_translations(:en, simple_form: { labels: { user: {
       new: { description: 'Nova descrição' }
@@ -54,7 +55,7 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should not explode while looking for i18n translation when action is not set' do
+  test 'label does not explode while looking for i18n translation when action is not set' do
     def @controller.action_name; nil; end
 
     assert_nothing_raised do
@@ -63,7 +64,7 @@ class IsolatedLabelTest < ActionView::TestCase
     assert_select 'label[for=user_description]'
   end
 
-  test 'label should use i18n based on model and attribute to lookup translation' do
+  test 'label uses i18n based on model and attribute to lookup translation' do
     store_translations(:en, simple_form: { labels: { user: {
       description: 'Descrição'
     } } }) do
@@ -72,14 +73,14 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should use i18n under defaults to lookup translation' do
+  test 'label uses i18n under defaults to lookup translation' do
     store_translations(:en, simple_form: { labels: { defaults: { age: 'Idade' } } }) do
       with_label_for @user, :age, :integer
       assert_select 'label[for=user_age]', /Idade/
     end
   end
 
-  test 'label should not use i18n label if translate is false' do
+  test 'label does not use i18n label if translate is false' do
     swap SimpleForm, translate_labels: false do
       store_translations(:en, simple_form: { labels: { defaults: { age: 'Idade' } } }) do
         with_label_for @user, :age, :integer
@@ -107,7 +108,7 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should do correct i18n lookup for nested models with nested translation' do
+  test 'label does correct i18n lookup for nested models with nested translation' do
     @user.company = Company.new(1, 'Empresa')
 
     store_translations(:en, simple_form: { labels: {
@@ -125,7 +126,7 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should do correct i18n lookup for nested models with no nested translation' do
+  test 'label does correct i18n lookup for nested models with no nested translation' do
     @user.company = Company.new(1, 'Empresa')
 
     store_translations(:en, simple_form: { labels: {
@@ -144,7 +145,7 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should do correct i18n lookup for nested has_many models with no nested translation' do
+  test 'label does correct i18n lookup for nested has_many models with no nested translation' do
     @user.tags = [Tag.new(1, 'Empresa')]
 
     store_translations(:en, simple_form: { labels: {
@@ -163,7 +164,7 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should have css class from type' do
+  test 'label has css class from type' do
     with_label_for @user, :name, :string
     assert_select 'label.string'
     with_label_for @user, :description, :text
@@ -176,8 +177,8 @@ class IsolatedLabelTest < ActionView::TestCase
     assert_select 'label.datetime'
   end
 
-  test 'label should not have css class from type when generate_additional_classes_for does not include :label' do
-    swap SimpleForm, generate_additional_classes_for: [:wrapper, :input] do
+  test 'label does not have css class from type when generate_additional_classes_for does not include :label' do
+    swap SimpleForm, generate_additional_classes_for: %i[wrapper input] do
       with_label_for @user, :name, :string
       assert_no_select 'label.string'
       with_label_for @user, :description, :text
@@ -191,22 +192,22 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should not generate empty css class' do
-    swap SimpleForm, generate_additional_classes_for: [:wrapper, :input] do
+  test 'label does not generate empty css class' do
+    swap SimpleForm, generate_additional_classes_for: %i[wrapper input] do
       with_label_for @user, :name, :string
       assert_no_select 'label[class]'
     end
   end
 
-  test 'label should obtain required from ActiveModel::Validations when it is included' do
+  test 'label obtains required from ActiveModel::Validations when it is included' do
     with_label_for @validating_user, :name, :string
     assert_select 'label.required'
     with_label_for @validating_user, :status, :string
     assert_select 'label.optional'
   end
 
-  test 'label should not obtain required from ActiveModel::Validations when generate_additional_classes_for does not include :label' do
-    swap SimpleForm, generate_additional_classes_for: [:wrapper, :input] do
+  test 'label does not obtain required from ActiveModel::Validations when generate_additional_classes_for does not include :label' do
+    swap SimpleForm, generate_additional_classes_for: %i[wrapper input] do
       with_label_for @validating_user, :name, :string
       assert_no_select 'label.required'
       with_label_for @validating_user, :status, :string
@@ -214,48 +215,66 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should allow overriding required when ActiveModel::Validations is included' do
+  test 'label allows overriding required when ActiveModel::Validations is included' do
     with_label_for @validating_user, :name, :string, required: false
     assert_select 'label.optional'
     with_label_for @validating_user, :status, :string, required: true
     assert_select 'label.required'
   end
 
-  test 'label should be required by default when ActiveModel::Validations is not included' do
+  test 'label is required by default when ActiveModel::Validations is not included' do
     with_label_for @user, :name, :string
     assert_select 'label.required'
   end
 
-  test 'label should be able to disable required when ActiveModel::Validations is not included' do
+  test 'label is able to disable required when ActiveModel::Validations is not included' do
     with_label_for @user, :name, :string, required: false
     assert_no_select 'label.required'
   end
 
-  test 'label should add required text when required' do
+  test 'label adds required text when required' do
     with_label_for @user, :name, :string
     assert_select 'label.required abbr[title=required]', '*'
   end
 
-  test 'label should not have required text in no required inputs' do
+  test 'label does not have required text in no required inputs' do
     with_label_for @user, :name, :string, required: false
     assert_no_select 'form label abbr'
   end
 
-  test 'label should use i18n to find required text' do
+  test 'label uses i18n to find required text' do
     store_translations(:en, simple_form: { required: { text: 'campo requerido' } }) do
       with_label_for @user, :name, :string
-      assert_select 'form label abbr[title=campo requerido]', '*'
+      assert_select 'form label abbr[title="campo requerido"]', '*'
     end
   end
 
-  test 'label should use i18n to find required mark' do
+  test 'label uses custom i18n scope to find required text' do
+    store_translations(:en, my_scope: { required: { text: 'Pflichtfeld' } }) do
+      swap SimpleForm, i18n_scope: :my_scope do
+        with_label_for @user, :name, :string
+        assert_select 'form label abbr[title="Pflichtfeld"]', '*'
+      end
+    end
+  end
+
+  test 'label uses i18n to find required mark' do
     store_translations(:en, simple_form: { required: { mark: '*-*' } }) do
       with_label_for @user, :name, :string
       assert_select 'form label abbr', '*-*'
     end
   end
 
-  test 'label should use i18n to find required string tag' do
+  test 'label uses custom i18n scope to find required mark' do
+    store_translations(:en, my_scope: { required: { mark: '!!' } }) do
+      swap SimpleForm, i18n_scope: :my_scope do
+        with_label_for @user, :name, :string
+        assert_select 'form label abbr', '!!'
+      end
+    end
+  end
+
+  test 'label uses i18n to find required string tag' do
     store_translations(:en, simple_form: { required: { html: '<span class="required" title="requerido">*</span>' } }) do
       with_label_for @user, :name, :string
       assert_no_select 'form label abbr'
@@ -263,37 +282,47 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should allow overwriting input id' do
+  test 'label uses custom i18n scope to find required string tag' do
+    store_translations(:en, my_scope: { required: { html: '<span class="mandatory" title="Pflichtfeld">!!</span>' } }) do
+      swap SimpleForm, i18n_scope: :my_scope do
+        with_label_for @user, :name, :string
+        assert_no_select 'form label abbr'
+        assert_select 'form label span.mandatory[title=Pflichtfeld]', '!!'
+      end
+    end
+  end
+
+  test 'label allows overwriting input id' do
     with_label_for @user, :name, :string, input_html: { id: 'my_new_id' }
     assert_select 'label[for=my_new_id]'
   end
 
-  test 'label should allow overwriting of for attribute' do
+  test 'label allows overwriting of for attribute' do
     with_label_for @user, :name, :string, label_html: { for: 'my_new_id' }
     assert_select 'label[for=my_new_id]'
   end
 
-  test 'label should allow overwriting of for attribute with input_html not containing id' do
+  test 'label allows overwriting of for attribute with input_html not containing id' do
     with_label_for @user, :name, :string, label_html: { for: 'my_new_id' }, input_html: { class: 'foo' }
     assert_select 'label[for=my_new_id]'
   end
 
-  test 'label should use default input id when it was not overridden' do
+  test 'label uses default input id when it was not overridden' do
     with_label_for @user, :name, :string, input_html: { class: 'my_new_id' }
     assert_select 'label[for=user_name]'
   end
 
-  test 'label should be generated properly when object is not present' do
+  test 'label is generated properly when object is not present' do
     with_label_for :project, :name, :string
     assert_select 'label[for=project_name]', /Name/
   end
 
-  test 'label should include for attribute for select collection' do
-    with_label_for @user, :sex, :select, collection: [:male, :female]
+  test 'label includes for attribute for select collection' do
+    with_label_for @user, :sex, :select, collection: %i[male female]
     assert_select 'label[for=user_sex]'
   end
 
-  test 'label should use i18n properly when object is not present' do
+  test 'label uses i18n properly when object is not present' do
     store_translations(:en, simple_form: { labels: {
       project: { name: 'Nome' }
     } }) do
@@ -302,14 +331,14 @@ class IsolatedLabelTest < ActionView::TestCase
     end
   end
 
-  test 'label should add required by default when object is not present' do
+  test 'label adds required by default when object is not present' do
     with_label_for :project, :name, :string
     assert_select 'label.required[for=project_name]'
     with_label_for :project, :description, :string, required: false
     assert_no_select 'label.required[for=project_description]'
   end
 
-  test 'label should add chosen label class' do
+  test 'label adds chosen label class' do
     swap SimpleForm, label_class: :my_custom_class do
       with_label_for @user, :name, :string
       assert_select 'label.my_custom_class'