simple_form 3.0.1 → 3.1.0.rc1

data/lib/simple_form/wrappers/root.rb

@@ -17,7 +17,7 @@ module SimpleForm
 
       # Provide a fallback if name cannot be found.
       def find(name)
-        super || SimpleForm::Wrappers::Many.new(name, [name])
+        super || SimpleForm::Wrappers::Many.new(name, [Leaf.new(name)])
       end
 
       private

data/lib/simple_form/wrappers/single.rb

@@ -2,14 +2,16 @@ module SimpleForm
   module Wrappers
     # `Single` is an optimization for a wrapper that has only one component.
     class Single < Many
-      def initialize(name, options={})
-        super(name, [name], options)
+      def initialize(name, wrapper_options = {}, options = {})
+        @component = Leaf.new(name, options)
+
+        super(name, [@component], wrapper_options)
       end
 
       def render(input)
         options = input.options
         if options[namespace] != false
-          content = input.send(namespace)
+          content = @component.render(input)
           wrap(input, options, content) if content
         end
       end

data/lib/simple_form/wrappers.rb

@@ -4,5 +4,6 @@ module SimpleForm
     autoload :Many,    'simple_form/wrappers/many'
     autoload :Root,    'simple_form/wrappers/root'
     autoload :Single,  'simple_form/wrappers/single'
+    autoload :Leaf,    'simple_form/wrappers/leaf'
   end
 end

data/lib/simple_form.rb

@@ -24,6 +24,24 @@ module SimpleForm
     SimpleForm::Components.eager_load!
   end
 
+  CUSTOM_INPUT_DEPRECATION_WARN = <<-WARN
+%{name} method now accepts a `wrapper_options` argument. The method definition without the argument is deprecated and will be removed in the next Simple Form version. Change your code from:
+
+    def %{name}
+
+to
+
+    def %{name}(wrapper_options)
+
+See https://github.com/plataformatec/simple_form/pull/997 for more information.
+  WARN
+
+  @@configured = false
+
+  def self.configured? #:nodoc:
+    @@configured
+  end
+
   ## CONFIGURATION OPTIONS
 
   # Method used to tidy up errors.
@@ -66,7 +84,7 @@ module SimpleForm
 
   # How the label text should be generated altogether with the required text.
   mattr_accessor :label_text
-  @@label_text = lambda { |label, required| "#{required} #{label}" }
+  @@label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
 
   # You can define the class to be used on all labels. Defaults to none.
   mattr_accessor :label_class
@@ -107,6 +125,8 @@ module SimpleForm
   # Custom wrappers for input types. This should be a hash containing an input
   # type as key and the wrapper that will be used for all inputs with specified type.
   # e.g { string: :string_wrapper, boolean: :boolean_wrapper }
+  # You can also set a wrapper mapping per form basis.
+  # e.g simple_form_for(@foo, wrapper_mappings: { check_boxes: :bootstrap_checkbox })
   mattr_accessor :wrapper_mappings
   @@wrapper_mappings = nil
 
@@ -151,15 +171,26 @@ module SimpleForm
   mattr_accessor :input_class
   @@input_class = nil
 
+  # Defines if an input wrapper class should be included or not
+  mattr_accessor :include_default_input_wrapper_class
+  @@include_default_input_wrapper_class = true
+
+  # Define the default class of the input wrapper of the boolean input.
+  mattr_accessor :boolean_label_class
+  @@boolean_label_class = 'checkbox'
+
   ## WRAPPER CONFIGURATION
   # The default wrapper to be used by the FormBuilder.
   mattr_accessor :default_wrapper
   @@default_wrapper = :default
-  @@wrappers = {}
+  @@wrappers = {} #:nodoc:
+
+  mattr_accessor :i18n_scope
+  @@i18n_scope = 'simple_form'
 
   # Retrieves a given wrapper
   def self.wrapper(name)
-    @@wrappers[name.to_sym] or raise WrapperNotFound, "Couldn't find wrapper with name #{name}"
+    @@wrappers[name.to_s] or raise WrapperNotFound, "Couldn't find wrapper with name #{name}"
   end
 
   # Raised when fails to find a given wrapper name
@@ -172,14 +203,14 @@ module SimpleForm
     if block_given?
       options                 = args.extract_options!
       name                    = args.first || :default
-      @@wrappers[name.to_sym] = build(options, &block)
+      @@wrappers[name.to_s]   = build(options, &block)
     else
       @@wrappers
     end
   end
 
   # Builds a new wrapper using SimpleForm::Wrappers::Builder.
-  def self.build(options={})
+  def self.build(options = {})
     options[:tag] = :div if options[:tag].nil?
     builder = SimpleForm::Wrappers::Builder.new(options)
     yield builder
@@ -210,9 +241,10 @@ module SimpleForm
     ActiveSupport::Deprecation.warn "[SIMPLE_FORM] SimpleForm.default_input_size= is deprecated and has no effect", caller
   end
 
-  # Default way to setup SimpleForm. Run rails generate simple_form:install
+  # Default way to setup Simple Form. Run rails generate simple_form:install
   # to create a fresh initializer with all configuration values.
   def self.setup
+    @@configured = true
     yield self
   end
 end

data/test/action_view_extensions/builder_test.rb

@@ -8,13 +8,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

data/test/components/label_test.rb

@@ -7,7 +7,7 @@ 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

data/test/form_builder/association_test.rb

@@ -113,6 +113,14 @@ class AssociationTest < ActionView::TestCase
     assert_no_select 'form select option[value=3]'
   end
 
+  test 'builder allows collection to have a scope' do
+    with_association_for @user, :special_pictures
+    assert_select 'form select.select#user_special_picture_ids'
+    assert_select 'form select option[value=3]', '3'
+    assert_no_select 'form select option[value=1]'
+    assert_no_select 'form select option[value=2]'
+  end
+
   test 'builder marks the record which already belongs to the user' do
     @user.company_id = 2
     with_association_for @user, :company, as: :radio_buttons
@@ -146,6 +154,15 @@ class AssociationTest < ActionView::TestCase
     end
   end
 
+  test 'builder does not call order if the given association does not respond to it' do
+    with_association_for @user, :pictures
+    assert_select 'form select.select#user_picture_ids'
+    assert_select 'form select[multiple=multiple]'
+    assert_select 'form select option[value=1]', 'Picture 1'
+    assert_select 'form select option[value=2]', 'Picture 2'
+    assert_select 'form select option[value=3]', 'Picture 3'
+  end
+
   test 'builder creates a select with multiple options for collection associations' do
     with_association_for @user, :tags
     assert_select 'form select.select#user_tag_ids'

data/test/form_builder/error_notification_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 
 # Tests for f.error_notification
 class ErrorNotificationTest < ActionView::TestCase
-  def with_error_notification_for(object, options={}, &block)
+  def with_error_notification_for(object, options = {}, &block)
     with_concat_form_for(object) do |f|
       f.error_notification(options)
     end

data/test/form_builder/error_test.rb

@@ -123,4 +123,65 @@ class ErrorTest < ActionView::TestCase
       assert_select 'span.omg_error', "can't be blank"
     end
   end
+
+  # FULL_ERROR_WRAPPER
+
+  test 'full error should find errors on association' do
+    swap_wrapper :default, self.custom_wrapper_with_full_error do
+      with_form_for @user, :company_id, as: :select
+      assert_select 'span.error', 'Company must be valid'
+    end
+  end
+
+  test 'full error can be disabled' do
+    swap_wrapper :default, self.custom_wrapper_with_full_error do
+      with_form_for @user, :company_id, as: :select, full_error: false
+      assert_no_select 'span.error'
+    end
+  end
+
+  test 'full error can be disabled setting error to false' do
+    swap_wrapper :default, self.custom_wrapper_with_full_error do
+      with_form_for @user, :company_id, as: :select, error: false
+      assert_no_select 'span.error'
+    end
+  end
+
+  # CUSTOM ERRORS
+
+  test 'input with custom error works' do
+    error_text = "Super User Name! can't be blank"
+    with_form_for @user, :name, error: error_text
+
+    assert_select 'span.error', error_text
+  end
+
+  test 'input with error option as true does not use custom error' do
+    with_form_for @user, :name, error: true
+
+    assert_select 'span.error', "can't be blank"
+  end
+
+  test 'input with custom error does not generate the error if there is no error on the attribute' do
+    with_form_for @user, :active, error: "Super User Active! can't be blank"
+
+    assert_no_select 'span.error'
+  end
+
+  test 'input with custom error works when using full_error component' do
+    swap_wrapper :default, self.custom_wrapper_with_full_error do
+      error_text = "Super User Name! can't be blank"
+      with_form_for @user, :name, error: error_text
+
+      assert_select 'span.error', error_text
+    end
+  end
+
+  test 'input with custom error when using full_error component does not generate the error if there is no error on the attribute' do
+    swap_wrapper :default, self.custom_wrapper_with_full_error do
+      with_form_for @user, :active, error: "Super User Active! can't be blank"
+
+      assert_no_select 'span.error'
+    end
+  end
 end

data/test/form_builder/input_field_test.rb

@@ -88,14 +88,30 @@ class InputFieldTest < ActionView::TestCase
     assert_select 'input[min=18]'
   end
 
-  test 'builder input_field should use pattern component' do
+  test 'builder input_field should not use pattern component by default' do
     with_concat_form_for(@other_validating_user) do |f|
       f.input_field :country, as: :string
     end
 
+    assert_no_select 'input[pattern="\w+"]'
+  end
+
+  test 'builder input_field should infer pattern from attributes' do
+    with_concat_form_for(@other_validating_user) do |f|
+      f.input_field :country, as: :string, pattern: true
+    end
+
     assert_select 'input[pattern="\w+"]'
   end
 
+  test 'builder input_field should accept custom patter' do
+    with_concat_form_for(@other_validating_user) do |f|
+      f.input_field :country, as: :string, pattern: '\d+'
+    end
+
+    assert_select 'input[pattern="\d+"]'
+  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
@@ -122,4 +138,12 @@ class InputFieldTest < ActionView::TestCase
     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 an HTML attribute' do
+    with_concat_form_for(@user) do |f|
+      f.input_field :active, boolean_style: :nested
+    end
+
+    assert_no_select 'input.boolean[boolean_style]'
+  end
 end

data/test/form_builder/label_test.rb

@@ -73,9 +73,32 @@ 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, self.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 'builder should allow custom formatting when label is explicitly specified' do
+    swap SimpleForm, label_text: lambda { |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 should allow custom formatting when label is generated' do
+    swap SimpleForm, label_text: lambda { |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
 end

data/test/form_builder/wrapper_test.rb

@@ -128,6 +128,21 @@ class WrapperTest < ActionView::TestCase
     end
   end
 
+  test 'custom wrappers can have additional attributes' do
+    swap_wrapper :default, self.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, self.custom_wrapper_with_full_error do
+      with_form_for @user, :name
+      assert_select 'span.error', "Name can't be blank"
+    end
+  end
+
   test 'custom wrappers on a form basis' do
     swap_wrapper :another do
       with_concat_form_for(@user) do |f|
@@ -200,4 +215,56 @@ class WrapperTest < ActionView::TestCase
       end
     end
   end
+
+  test 'use 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 'input accepts attributes in the DSL' do
+    swap_wrapper :default, self.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, self.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, self.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, self.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
 end

data/test/generators/simple_form_generator_test.rb

@@ -21,8 +21,8 @@ class SimpleFormGeneratorTest < Rails::Generators::TestCase
     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

data/test/inputs/boolean_input_test.rb

@@ -50,14 +50,42 @@ 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.'
+      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, label: false, inline_label: '<b>I am so inline.</b>'
+      assert_select 'label.checkbox', text: ' &lt;b&gt;I am so inline.&lt;/b&gt;'
+    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, label: false, 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'
+      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, label: false, 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, label: false, inline_label: true, label_text: proc { '<b>New Active</b>' }
+      assert_select 'label.checkbox', text: ' New Active'
     end
   end
 
@@ -128,6 +156,16 @@ class BooleanInputTest < ActionView::TestCase
     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,6 +176,16 @@ class BooleanInputTest < ActionView::TestCase
     end
   end
 
+  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 should add "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

data/test/inputs/collection_check_boxes_input_test.rb

@@ -53,6 +53,20 @@ class CollectionCheckBoxesInputTest < ActionView::TestCase
     end
   end
 
+  test 'input that uses automatic collection translation for check_boxes should properly set checked values' do
+    store_translations(:en, simple_form: { options: { defaults: {
+      gender: { male: 'Male', female: 'Female'}
+    } } } ) do
+      @user.gender = 'male'
+
+      with_input_for @user, :gender, :check_boxes, collection: [:male, :female]
+      assert_select 'input[type=checkbox][value=male][checked=checked]'
+      assert_select 'input[type=checkbox][value=female]'
+      assert_select 'label.collection_check_boxes', 'Male'
+      assert_select 'label.collection_check_boxes', 'Female'
+    end
+  end
+
   test 'input check boxes does not wrap the collection by default' do
     with_input_for @user, :active, :check_boxes
 
@@ -199,29 +213,27 @@ class CollectionCheckBoxesInputTest < ActionView::TestCase
     swap SimpleForm, boolean_style: :nested do
       with_input_for @user, :active, :check_boxes
 
-      assert_select 'label.checkbox > input#user_active_true[type=checkbox]'
-      assert_select 'label.checkbox', 'Yes'
-      assert_select 'label.checkbox > input#user_active_false[type=checkbox]'
-      assert_select 'label.checkbox', 'No'
+      assert_select 'span.checkbox > label > input#user_active_true[type=checkbox]'
+      assert_select 'span.checkbox > label', 'Yes'
+      assert_select 'span.checkbox > label > input#user_active_false[type=checkbox]'
+      assert_select 'span.checkbox > label', 'No'
       assert_no_select 'label.collection_radio_buttons'
     end
   end
 
-  test 'input check boxes with nested style overrides configured item wrapper tag, forcing the :label' do
+  test 'input check boxes with nested style does not overrides configured item wrapper tag' do
     swap SimpleForm, boolean_style: :nested, item_wrapper_tag: :li do
       with_input_for @user, :active, :check_boxes
 
-      assert_select 'label.checkbox > input'
-      assert_no_select 'li'
+      assert_select 'li.checkbox > label > input'
     end
   end
 
-  test 'input check boxes with nested style overrides given item wrapper tag, forcing the :label' do
+  test 'input check boxes with nested style does not overrides given item wrapper tag' do
     swap SimpleForm, boolean_style: :nested do
       with_input_for @user, :active, :check_boxes, item_wrapper_tag: :li
 
-      assert_select 'label.checkbox > input'
-      assert_no_select 'li'
+      assert_select 'li.checkbox > label > input'
     end
   end
 
@@ -229,7 +241,24 @@ class CollectionCheckBoxesInputTest < ActionView::TestCase
     swap SimpleForm, boolean_style: :nested do
       with_input_for @user, :active, :check_boxes, item_wrapper_class: "inline"
 
-      assert_select 'label.checkbox.inline > input'
+      assert_select 'span.checkbox.inline > label > input'
+    end
+  end
+
+  test 'input check boxes wrapper class are not included when set to falsey' do
+    swap SimpleForm, include_default_input_wrapper_class: false, boolean_style: :nested do
+      with_input_for @user, :gender, :check_boxes, collection: [:male, :female]
+
+      assert_no_select 'label.checkbox'
+    end
+  end
+
+  test 'input check boxes custom wrapper class is included when include input wrapper class is falsey' do
+    swap SimpleForm, include_default_input_wrapper_class: false, boolean_style: :nested do
+      with_input_for @user, :gender, :check_boxes, collection: [:male, :female], item_wrapper_class: 'custom'
+
+      assert_no_select 'label.checkbox'
+      assert_select 'span.custom'
     end
   end
 end