simple_form 3.0.0 → 3.1.0.rc1

data/lib/simple_form/inputs/grouped_collection_select_input.rb

@@ -1,11 +1,14 @@
 module SimpleForm
   module Inputs
     class GroupedCollectionSelectInput < CollectionInput
-      def input
+      def input(wrapper_options = nil)
         label_method, value_method = detect_collection_methods
+
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
         @builder.grouped_collection_select(attribute_name, grouped_collection,
                       group_method, group_label_method, value_method, label_method,
-                      input_options, input_html_options)
+                      input_options, merged_input_options)
       end
 
       private
@@ -19,7 +22,7 @@ module SimpleForm
 
       # Sample collection
       def collection
-        @collection ||= grouped_collection.first.try(:send, group_method) || []
+        @collection ||= grouped_collection.map { |collection| collection.try(:send, group_method) }.detect(&:present?) || []
       end
 
       def group_method
@@ -36,6 +39,15 @@ module SimpleForm
 
         label
       end
+
+      def detect_method_from_class(collection_classes)
+        return {} if collection_classes.empty?
+
+        sample = collection_classes.first
+
+        { label: SimpleForm.collection_label_methods.find { |m| sample.instance_methods.include?(m) },
+          value: SimpleForm.collection_value_methods.find { |m| sample.instance_methods.include?(m) } }
+      end
     end
   end
 end

data/lib/simple_form/inputs/hidden_input.rb

@@ -3,8 +3,10 @@ module SimpleForm
     class HiddenInput < Base
       disable :label, :errors, :hint, :required
 
-      def input
-        @builder.hidden_field(attribute_name, input_html_options)
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.hidden_field(attribute_name, merged_input_options)
       end
 
       private

data/lib/simple_form/inputs/numeric_input.rb

@@ -3,16 +3,17 @@ module SimpleForm
     class NumericInput < Base
       enable :placeholder, :min_max
 
-      def input
+      def input(wrapper_options = nil)
         input_html_classes.unshift("numeric")
         if html5?
           input_html_options[:type] ||= "number"
           input_html_options[:step] ||= integer? ? 1 : "any"
         end
-        @builder.text_field(attribute_name, input_html_options)
-      end
 
-      private
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.text_field(attribute_name, merged_input_options)
+      end
     end
   end
 end

data/lib/simple_form/inputs/password_input.rb

@@ -3,8 +3,10 @@ module SimpleForm
     class PasswordInput < Base
       enable :placeholder, :maxlength
 
-      def input
-        @builder.password_field(attribute_name, input_html_options)
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.password_field(attribute_name, merged_input_options)
       end
     end
   end

data/lib/simple_form/inputs/priority_input.rb

@@ -1,9 +1,11 @@
 module SimpleForm
   module Inputs
     class PriorityInput < CollectionSelectInput
-      def input
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
         @builder.send(:"#{input_type}_select", attribute_name, input_priority,
-                      input_options, input_html_options)
+                      input_options, merged_input_options)
       end
 
       def input_priority

data/lib/simple_form/inputs/range_input.rb

@@ -1,7 +1,7 @@
 module SimpleForm
   module Inputs
     class RangeInput < NumericInput
-      def input
+      def input(wrapper_options = nil)
         if html5?
           input_html_options[:type] ||= "range"
           input_html_options[:step] ||= 1

data/lib/simple_form/inputs/string_input.rb

@@ -3,13 +3,15 @@ module SimpleForm
     class StringInput < Base
       enable :placeholder, :maxlength, :pattern
 
-      def input
+      def input(wrapper_options = nil)
         unless string?
           input_html_classes.unshift("string")
           input_html_options[:type] ||= input_type if html5?
         end
 
-        @builder.text_field(attribute_name, input_html_options)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.text_field(attribute_name, merged_input_options)
       end
 
       private

data/lib/simple_form/inputs/text_input.rb

@@ -3,8 +3,10 @@ module SimpleForm
     class TextInput < Base
       enable :placeholder, :maxlength
 
-      def input
-        @builder.text_area(attribute_name, input_html_options)
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.text_area(attribute_name, merged_input_options)
       end
     end
   end

data/lib/simple_form/railtie.rb

@@ -3,5 +3,12 @@ require 'rails/railtie'
 module SimpleForm
   class Railtie < Rails::Railtie
     config.eager_load_namespaces << SimpleForm
+
+    config.after_initialize do
+      unless SimpleForm.configured?
+        warn '[Simple Form] Simple Form is not configured in the application and will use the default values.' +
+          ' Use `rails generate simple_form:install` to generate the Simple Form configuration.'
+      end
+    end
   end
 end

data/lib/simple_form/tags.rb

@@ -15,6 +15,13 @@ module SimpleForm
 
           rendered_item = yield item, value, text, default_html_options.merge(additional_html_options)
 
+          if @options.fetch(:boolean_style, SimpleForm.boolean_style) == :nested
+            label_options = {}
+            add_default_name_and_id_for_value(value, label_options)
+            label_options['for'] = label_options.delete('id')
+            rendered_item = content_tag(:label, rendered_item, label_options)
+          end
+
           item_wrapper_tag ? @template_object.content_tag(item_wrapper_tag, rendered_item, class: item_wrapper_class) : rendered_item
         end.join.html_safe
       end

data/lib/simple_form/version.rb

@@ -1,3 +1,3 @@
 module SimpleForm
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.0.rc1".freeze
 end

data/lib/simple_form/wrappers/builder.rb

@@ -45,20 +45,20 @@ module SimpleForm
         @components = []
       end
 
-      def use(name, options=nil, &block)
+      def use(name, options = {}, &block)
         if options && wrapper = options[:wrap_with]
-          @components << Single.new(name, wrapper)
+          @components << Single.new(name, wrapper, options.except(:wrap_with))
         else
-          @components << name
+          @components << Leaf.new(name, options)
         end
       end
 
-      def optional(name, options=nil, &block)
+      def optional(name, options = {}, &block)
         @options[name] = false
         use(name, options, &block)
       end
 
-      def wrapper(name, options=nil)
+      def wrapper(name, options = nil)
         if block_given?
           name, options = nil, name if name.is_a?(Hash)
           builder = self.class.new(@options)

data/lib/simple_form/wrappers/leaf.rb

@@ -0,0 +1,28 @@
+module SimpleForm
+  module Wrappers
+    class Leaf
+      attr_reader :namespace
+
+      def initialize(namespace, options = {})
+        @namespace = namespace
+        @options = options
+      end
+
+      def render(input)
+        method = input.method(@namespace)
+
+        if method.arity == 0
+          ActiveSupport::Deprecation.warn(SimpleForm::CUSTOM_INPUT_DEPRECATION_WARN % { name: @namespace })
+
+          method.call
+        else
+          method.call(@options)
+        end
+      end
+
+      def find(name)
+        self if @namespace == name
+      end
+    end
+  end
+end

data/lib/simple_form/wrappers/many.rb

@@ -1,7 +1,7 @@
 module SimpleForm
   module Wrappers
     # A wrapper is an object that holds several components and render them.
-    # A component may either be a symbol or any object that responds to `render`.
+    # A component may be any object that responds to `render`.
     # This API allows inputs/components to be easily wrapped, removing the
     # need to modify the code only to wrap input in an extra tag.
     #
@@ -10,9 +10,8 @@ module SimpleForm
     # on demand on input generation.
     class Many
       attr_reader :namespace, :defaults, :components
-      alias :to_sym :namespace
 
-      def initialize(namespace, components, defaults={})
+      def initialize(namespace, components, defaults = {})
         @namespace  = namespace
         @components = components
         @defaults   = defaults
@@ -25,8 +24,8 @@ module SimpleForm
         options = input.options
 
         components.each do |component|
-          next if options[component] == false
-          rendered = component.respond_to?(:render) ? component.render(input) : input.send(component)
+          next if options[component.namespace] == false
+          rendered = component.render(input)
           content.safe_concat rendered.to_s if rendered
         end
 
@@ -62,7 +61,7 @@ module SimpleForm
       end
 
       def html_options(options)
-        options[:"#{namespace}_html"] || {}
+        (@defaults[:html] || {}).merge(options[:"#{namespace}_html"] || {})
       end
 
       def html_classes(input, options)

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

@@ -80,8 +80,13 @@ class ErrorTest < ActionView::TestCase
     assert_no_select 'p.error[error_method]'
   end
 
-  test 'error should generate an error message with raw HTML tags' do
+  test 'error should escape error prefix text' do
     with_error_for @user, :name, error_prefix: '<b>Name</b>'
+    assert_select 'span.error', "&lt;b&gt;Name&lt;/b&gt; can't be blank"
+  end
+
+  test 'error should generate an error message with raw HTML tags' do
+    with_error_for @user, :name, error_prefix: '<b>Name</b>'.html_safe
     assert_select 'span.error', "Name can't be blank"
     assert_select 'span.error b', "Name"
   end
@@ -118,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/hint_test.rb

@@ -43,8 +43,14 @@ class HintTest < ActionView::TestCase
   end
 
   test 'hint should be output as html_safe' do
-    with_hint_for @user, :name, hint: '<b>Bold</b> and not...'
+    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
+    with_hint_for @user, :name, hint: '<script>alert(1337)</script>'
+    assert_select 'span.hint', "&lt;script&gt;alert(1337)&lt;/script&gt;"
   end
 
   # Without attribute name
@@ -132,7 +138,7 @@ 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't be blank"
+      assert_select 'div.omg_hint', "can&#39;t be blank"
     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