simple_form 3.0.4 → 5.0.3

data/test/action_view_extensions/builder_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class BuilderTest < ActionView::TestCase
@@ -8,13 +9,13 @@ class BuilderTest < ActionView::TestCase
     end
   end
 
-  def with_collection_radio_buttons(object, attribute, collection, value_method, text_method, options={}, html_options={}, &block)
+  def with_collection_radio_buttons(object, attribute, collection, value_method, text_method, options = {}, html_options = {}, &block)
     with_concat_form_for(object) do |f|
       f.collection_radio_buttons attribute, collection, value_method, text_method, options, html_options, &block
     end
   end
 
-  def with_collection_check_boxes(object, attribute, collection, value_method, text_method, options={}, html_options={}, &block)
+  def with_collection_check_boxes(object, attribute, collection, value_method, text_method, options = {}, html_options = {}, &block)
     with_concat_form_for(object) do |f|
       f.collection_check_boxes attribute, collection, value_method, text_method, options, html_options, &block
     end
@@ -36,16 +37,25 @@ class BuilderTest < ActionView::TestCase
   end
 
   test "collection radio handles camelized collection values for labels correctly" do
-    with_collection_radio_buttons @user, :active, ['Yes', 'No'], :to_s, :to_s
+    with_collection_radio_buttons @user, :active, %w[Yes No], :to_s, :to_s
 
     assert_select 'form label.collection_radio_buttons[for=user_active_yes]', 'Yes'
     assert_select 'form label.collection_radio_buttons[for=user_active_no]', 'No'
   end
 
-  test "collection radio should sanitize collection values for labels correctly" do
+  test "collection radio sanitizes collection values for labels correctly" do
     with_collection_radio_buttons @user, :name, ['$0.99', '$1.99'], :to_s, :to_s
-    assert_select 'label.collection_radio_buttons[for=user_name_099]', '$0.99'
-    assert_select 'label.collection_radio_buttons[for=user_name_199]', '$1.99'
+
+    # Rails 6 changed the way it sanitizes the values
+    # https://github.com/rails/rails/blob/6-0-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    # https://github.com/rails/rails/blob/5-2-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    if ActionView::VERSION::MAJOR == 5
+      assert_select 'label.collection_radio_buttons[for=user_name_099]', '$0.99'
+      assert_select 'label.collection_radio_buttons[for=user_name_199]', '$1.99'
+    else
+      assert_select 'label.collection_radio_buttons[for=user_name_0_99]', '$0.99'
+      assert_select 'label.collection_radio_buttons[for=user_name_1_99]', '$1.99'
+    end
   end
 
   test "collection radio checks the correct value to local variables" do
@@ -243,7 +253,7 @@ class BuilderTest < ActionView::TestCase
 
   test "collection radio with block helpers does not leak the template" do
     with_concat_form_for(@user) do |f|
-      collection_input =  f.collection_radio_buttons :active, [true, false], :to_s, :to_s do |b|
+      collection_input = f.collection_radio_buttons :active, [true, false], :to_s, :to_s do |b|
         b.label(class: b.object) { b.radio_button + b.text }
       end
       concat collection_input
@@ -263,15 +273,15 @@ class BuilderTest < ActionView::TestCase
     collection = [Tag.new(1, 'Tag 1'), Tag.new(2, 'Tag 2')]
     with_collection_check_boxes @user, :tag_ids, collection, :id, :name
 
-    assert_select 'form input#user_tag_ids_1[type=checkbox][value=1]'
-    assert_select 'form input#user_tag_ids_2[type=checkbox][value=2]'
+    assert_select 'form input#user_tag_ids_1[type=checkbox][value="1"]'
+    assert_select 'form input#user_tag_ids_2[type=checkbox][value="2"]'
   end
 
   test "collection check box generates only one hidden field for the entire collection, to ensure something will be sent back to the server when posting an empty collection" do
     collection = [Tag.new(1, 'Tag 1'), Tag.new(2, 'Tag 2')]
     with_collection_check_boxes @user, :tag_ids, collection, :id, :name
 
-    assert_select "form input[type=hidden][name='user[tag_ids][]'][value=]", count: 1
+    assert_select "form input[type=hidden][name='user[tag_ids][]'][value='']", count: 1
   end
 
   test "collection check box accepts a collection and generate a serie of checkboxes with labels for label method" do
@@ -283,16 +293,25 @@ class BuilderTest < ActionView::TestCase
   end
 
   test "collection check box handles camelized collection values for labels correctly" do
-    with_collection_check_boxes @user, :active, ['Yes', 'No'], :to_s, :to_s
+    with_collection_check_boxes @user, :active, %w[Yes No], :to_s, :to_s
 
     assert_select 'form label.collection_check_boxes[for=user_active_yes]', 'Yes'
     assert_select 'form label.collection_check_boxes[for=user_active_no]', 'No'
   end
 
-  test "collection check box should sanitize collection values for labels correctly" do
+  test "collection check box sanitizes collection values for labels correctly" do
     with_collection_check_boxes @user, :name, ['$0.99', '$1.99'], :to_s, :to_s
-    assert_select 'label.collection_check_boxes[for=user_name_099]', '$0.99'
-    assert_select 'label.collection_check_boxes[for=user_name_199]', '$1.99'
+
+    # Rails 6 changed the way it sanitizes the values
+    # https://github.com/rails/rails/blob/6-0-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    # https://github.com/rails/rails/blob/5-2-stable/actionview/lib/action_view/helpers/tags/base.rb#L141
+    if ActionView::VERSION::MAJOR == 5
+      assert_select 'label.collection_check_boxes[for=user_name_099]', '$0.99'
+      assert_select 'label.collection_check_boxes[for=user_name_199]', '$1.99'
+    else
+      assert_select 'label.collection_check_boxes[for=user_name_0_99]', '$0.99'
+      assert_select 'label.collection_check_boxes[for=user_name_1_99]', '$1.99'
+    end
   end
 
   test "collection check box checks the correct value to local variables" do
@@ -301,36 +320,36 @@ class BuilderTest < ActionView::TestCase
 
     with_collection_check_boxes user, :tag_ids, collection, :first, :last
 
-    assert_select 'form input[type=checkbox][value=1][checked=checked]'
-    assert_select 'form input[type=checkbox][value=3][checked=checked]'
-    assert_no_select 'form input[type=checkbox][value=2][checked=checked]'
+    assert_select 'form input[type=checkbox][value="1"][checked=checked]'
+    assert_select 'form input[type=checkbox][value="3"][checked=checked]'
+    assert_no_select 'form input[type=checkbox][value="2"][checked=checked]'
   end
 
   test "collection check box accepts selected values as :checked option" do
     collection = (1..3).map { |i| [i, "Tag #{i}"] }
     with_collection_check_boxes @user, :tag_ids, collection, :first, :last, checked: [1, 3]
 
-    assert_select 'form input[type=checkbox][value=1][checked=checked]'
-    assert_select 'form input[type=checkbox][value=3][checked=checked]'
-    assert_no_select 'form input[type=checkbox][value=2][checked=checked]'
+    assert_select 'form input[type=checkbox][value="1"][checked=checked]'
+    assert_select 'form input[type=checkbox][value="3"][checked=checked]'
+    assert_no_select 'form input[type=checkbox][value="2"][checked=checked]'
   end
 
   test "collection check boxes accepts selected string values as :checked option" do
     collection = (1..3).map { |i| [i, "Category #{i}"] }
-    with_collection_check_boxes :user, :category_ids, collection, :first, :last, checked: ['1', '3']
+    with_collection_check_boxes :user, :category_ids, collection, :first, :last, checked: %w[1 3]
 
-    assert_select 'input[type=checkbox][value=1][checked=checked]'
-    assert_select 'input[type=checkbox][value=3][checked=checked]'
-    assert_no_select 'input[type=checkbox][value=2][checked=checked]'
+    assert_select 'input[type=checkbox][value="1"][checked=checked]'
+    assert_select 'input[type=checkbox][value="3"][checked=checked]'
+    assert_no_select 'input[type=checkbox][value="2"][checked=checked]'
   end
 
   test "collection check box accepts a single checked value" do
     collection = (1..3).map { |i| [i, "Tag #{i}"] }
     with_collection_check_boxes @user, :tag_ids, collection, :first, :last, checked: 3
 
-    assert_select 'form input[type=checkbox][value=3][checked=checked]'
-    assert_no_select 'form input[type=checkbox][value=1][checked=checked]'
-    assert_no_select 'form input[type=checkbox][value=2][checked=checked]'
+    assert_select 'form input[type=checkbox][value="3"][checked=checked]'
+    assert_no_select 'form input[type=checkbox][value="1"][checked=checked]'
+    assert_no_select 'form input[type=checkbox][value="2"][checked=checked]'
   end
 
   test "collection check box accepts selected values as :checked option and override the model values" do
@@ -338,44 +357,44 @@ class BuilderTest < ActionView::TestCase
     @user.tag_ids = [2]
     with_collection_check_boxes @user, :tag_ids, collection, :first, :last, checked: [1, 3]
 
-    assert_select 'form input[type=checkbox][value=1][checked=checked]'
-    assert_select 'form input[type=checkbox][value=3][checked=checked]'
-    assert_no_select 'form input[type=checkbox][value=2][checked=checked]'
+    assert_select 'form input[type=checkbox][value="1"][checked=checked]'
+    assert_select 'form input[type=checkbox][value="3"][checked=checked]'
+    assert_no_select 'form input[type=checkbox][value="2"][checked=checked]'
   end
 
   test "collection check box accepts multiple disabled items" do
     collection = (1..3).map { |i| [i, "Tag #{i}"] }
     with_collection_check_boxes @user, :tag_ids, collection, :first, :last, disabled: [1, 3]
 
-    assert_select 'form input[type=checkbox][value=1][disabled=disabled]'
-    assert_select 'form input[type=checkbox][value=3][disabled=disabled]'
-    assert_no_select 'form input[type=checkbox][value=2][disabled=disabled]'
+    assert_select 'form input[type=checkbox][value="1"][disabled=disabled]'
+    assert_select 'form input[type=checkbox][value="3"][disabled=disabled]'
+    assert_no_select 'form input[type=checkbox][value="2"][disabled=disabled]'
   end
 
   test "collection check box accepts single disable item" do
     collection = (1..3).map { |i| [i, "Tag #{i}"] }
     with_collection_check_boxes @user, :tag_ids, collection, :first, :last, disabled: 1
 
-    assert_select 'form input[type=checkbox][value=1][disabled=disabled]'
-    assert_no_select 'form input[type=checkbox][value=3][disabled=disabled]'
-    assert_no_select 'form input[type=checkbox][value=2][disabled=disabled]'
+    assert_select 'form input[type=checkbox][value="1"][disabled=disabled]'
+    assert_no_select 'form input[type=checkbox][value="3"][disabled=disabled]'
+    assert_no_select 'form input[type=checkbox][value="2"][disabled=disabled]'
   end
 
   test "collection check box accepts a proc to disabled items" do
     collection = (1..3).map { |i| [i, "Tag #{i}"] }
     with_collection_check_boxes @user, :tag_ids, collection, :first, :last, disabled: proc { |i| i.first == 1 }
 
-    assert_select 'form input[type=checkbox][value=1][disabled=disabled]'
-    assert_no_select 'form input[type=checkbox][value=3][disabled=disabled]'
-    assert_no_select 'form input[type=checkbox][value=2][disabled=disabled]'
+    assert_select 'form input[type=checkbox][value="1"][disabled=disabled]'
+    assert_no_select 'form input[type=checkbox][value="3"][disabled=disabled]'
+    assert_no_select 'form input[type=checkbox][value="2"][disabled=disabled]'
   end
 
   test "collection check box accepts html options" do
     collection = [[1, 'Tag 1'], [2, 'Tag 2']]
     with_collection_check_boxes @user, :tag_ids, collection, :first, :last, {}, class: 'check'
 
-    assert_select 'form input.check[type=checkbox][value=1]'
-    assert_select 'form input.check[type=checkbox][value=2]'
+    assert_select 'form input.check[type=checkbox][value="1"]'
+    assert_select 'form input.check[type=checkbox][value="2"]'
   end
 
   test "collection check box with fields for" do
@@ -386,8 +405,8 @@ class BuilderTest < ActionView::TestCase
       end
     end
 
-    assert_select 'form input#user_post_tag_ids_1[type=checkbox][value=1]'
-    assert_select 'form input#user_post_tag_ids_2[type=checkbox][value=2]'
+    assert_select 'form input#user_post_tag_ids_1[type=checkbox][value="1"]'
+    assert_select 'form input#user_post_tag_ids_2[type=checkbox][value="2"]'
 
     assert_select 'form label.collection_check_boxes[for=user_post_tag_ids_1]', 'Tag 1'
     assert_select 'form label.collection_check_boxes[for=user_post_tag_ids_2]', 'Tag 2'
@@ -541,7 +560,7 @@ class BuilderTest < ActionView::TestCase
 
   test "collection check boxes with block helpers does not leak the template" do
     with_concat_form_for(@user) do |f|
-      collection_input =  f.collection_check_boxes :active, [true, false], :to_s, :to_s do |b|
+      collection_input = f.collection_check_boxes :active, [true, false], :to_s, :to_s do |b|
         b.label(class: b.object) { b.check_box + b.text }
       end
       concat collection_input
@@ -593,7 +612,7 @@ class BuilderTest < ActionView::TestCase
     end
   end
 
-  test "fields inherites wrapper option from the parent form" do
+  test "fields inherits wrapper option from the parent form" do
     swap_wrapper :another do
       simple_form_for(:user, wrapper: :another) do |f|
         f.simple_fields_for(:company) do |company|

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