simple_form 2.1.0 → 3.2.0

data/lib/simple_form/inputs/base.rb

@@ -1,8 +1,13 @@
 require 'simple_form/i18n_cache'
+require 'active_support/core_ext/string/output_safety'
+require 'action_view/helpers'
 
 module SimpleForm
   module Inputs
     class Base
+      include ERB::Util
+      include ActionView::Helpers::TranslationHelper
+
       extend I18nCache
 
       include SimpleForm::Helpers::Autofocus
@@ -24,7 +29,7 @@ module SimpleForm
       attr_reader :attribute_name, :column, :input_type, :reflection,
                   :options, :input_html_options, :input_html_classes, :html_classes
 
-      delegate :template, :object, :object_name, :lookup_model_names, :lookup_action, :to => :@builder
+      delegate :template, :object, :object_name, :lookup_model_names, :lookup_action, to: :@builder
 
       class_attribute :default_options
       self.default_options = {}
@@ -50,14 +55,14 @@ module SimpleForm
       def initialize(builder, attribute_name, column, input_type, options = {})
         super
 
-        options             = options.dup
-        @builder            = builder
-        @attribute_name     = attribute_name
-        @column             = column
-        @input_type         = input_type
-        @reflection         = options.delete(:reflection)
-        @options            = options.reverse_merge!(self.class.default_options)
-        @required           = calculate_required
+        options         = options.dup
+        @builder        = builder
+        @attribute_name = attribute_name
+        @column         = column
+        @input_type     = input_type
+        @reflection     = options.delete(:reflection)
+        @options        = options.reverse_merge!(self.class.default_options)
+        @required       = calculate_required
 
         # Notice that html_options_for receives a reference to input_html_classes.
         # This means that classes added dynamically to input_html_classes will
@@ -65,6 +70,10 @@ module SimpleForm
         @html_classes = SimpleForm.additional_classes_for(:input) { additional_classes }
 
         @input_html_classes = @html_classes.dup
+        if SimpleForm.input_class && !input_html_classes.empty?
+          input_html_classes << SimpleForm.input_class
+        end
+
         @input_html_options = html_options_for(:input, input_html_classes).tap do |o|
           o[:readonly]  = true if has_readonly?
           o[:disabled]  = true if has_disabled?
@@ -72,7 +81,7 @@ module SimpleForm
         end
       end
 
-      def input
+      def input(wrapper_options = nil)
         raise NotImplementedError
       end
 
@@ -90,10 +99,6 @@ module SimpleForm
 
       private
 
-      def add_size!
-        input_html_options[:size] ||= [limit, SimpleForm.default_input_size].compact.min
-      end
-
       def limit
         if column
           decimal_or_float? ? decimal_limit : column_limit
@@ -164,7 +169,7 @@ module SimpleForm
       #            email: 'E-mail.'
       #
       #  Take a look at our locale example file.
-      def translate(namespace, default='')
+      def translate_from_namespace(namespace, default = '')
         model_names = lookup_model_names.dup
         lookups     = []
 
@@ -179,7 +184,23 @@ module SimpleForm
         lookups << :"defaults.#{reflection_or_attribute_name}"
         lookups << default
 
-        I18n.t(lookups.shift, :scope => :"simple_form.#{namespace}", :default => lookups).presence
+        I18n.t(lookups.shift, scope: :"#{i18n_scope}.#{namespace}", default: lookups).presence
+      end
+
+      def merge_wrapper_options(options, wrapper_options)
+        if wrapper_options
+          options.merge(wrapper_options) do |_, oldval, newval|
+            if Array === oldval
+              oldval + Array(newval)
+            end
+          end
+        else
+          options
+        end
+      end
+
+      def i18n_scope
+        SimpleForm.i18n_scope
       end
     end
   end

data/lib/simple_form/inputs/block_input.rb

@@ -6,9 +6,9 @@ module SimpleForm
         @block = block
       end
 
-      def input
+      def input(wrapper_options = nil)
         template.capture(&@block)
       end
     end
   end
-end
+end

data/lib/simple_form/inputs/boolean_input.rb

@@ -1,30 +1,36 @@
 module SimpleForm
   module Inputs
     class BooleanInput < Base
-      def input
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
         if nested_boolean_style?
           build_hidden_field_for_checkbox +
-            template.label_tag(nil, :class => "checkbox") {
-              build_check_box_without_hidden_field + inline_label
+            template.label_tag(nil, class: SimpleForm.boolean_label_class) {
+              build_check_box_without_hidden_field(merged_input_options) +
+                inline_label
             }
         else
-          build_check_box
+          build_check_box(unchecked_value, merged_input_options)
         end
       end
 
-      def label_input
-        if options[:label] == false
-          input
+      def label_input(wrapper_options = nil)
+        if options[:label] == false || inline_label?
+          input(wrapper_options)
         elsif nested_boolean_style?
           html_options = label_html_options.dup
-          html_options[:class].push(:checkbox)
+          html_options[:class] ||= []
+          html_options[:class].push(SimpleForm.boolean_label_class) if SimpleForm.boolean_label_class
+
+          merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
 
           build_hidden_field_for_checkbox +
             @builder.label(label_target, html_options) {
-              build_check_box_without_hidden_field + label_text
+              build_check_box_without_hidden_field(merged_input_options) + label_text
             }
         else
-          input + label
+          input(wrapper_options) + label(wrapper_options)
         end
       end
 
@@ -34,14 +40,14 @@ module SimpleForm
       # reuse the method for nested boolean style, but with no unchecked value,
       # which won't generate the hidden checkbox. This is the default functionality
       # in Rails > 3.2.1, and is backported in SimpleForm AV helpers.
-      def build_check_box(unchecked_value = unchecked_value)
-        @builder.check_box(attribute_name, input_html_options, checked_value, unchecked_value)
+      def build_check_box(unchecked_value, options)
+        @builder.check_box(attribute_name, options, checked_value, unchecked_value)
       end
 
       # Build a checkbox without generating the hidden field. See
       # #build_hidden_field_for_checkbox for more info.
-      def build_check_box_without_hidden_field
-        build_check_box(nil)
+      def build_check_box_without_hidden_field(options)
+        build_check_box(nil, options)
       end
 
       # Create a hidden field for the current checkbox, so we can simulate Rails
@@ -49,14 +55,23 @@ module SimpleForm
       # we need the hidden field to be *outside* the label (otherwise it
       # generates invalid html - html5 only).
       def build_hidden_field_for_checkbox
-        @builder.hidden_field(attribute_name, :value => unchecked_value, :id => nil,
-                              :disabled => input_html_options[:disabled],
-                              :name => input_html_options[:name])
+        options = { value: unchecked_value, id: nil, disabled: input_html_options[:disabled] }
+        options[:name] = input_html_options[:name] if input_html_options.has_key?(:name)
+
+        @builder.hidden_field(attribute_name, options)
+      end
+
+      def inline_label?
+        nested_boolean_style? && options[:inline_label]
       end
 
       def inline_label
         inline_option = options[:inline_label]
-        inline_option == true ? label_text : inline_option
+
+        if inline_option
+          label = inline_option == true ? label_text : html_escape(inline_option)
+          " #{label}".html_safe
+        end
       end
 
       # Booleans are not required by default because in most of the cases

data/lib/simple_form/inputs/collection_input.rb

@@ -7,19 +7,23 @@ module SimpleForm
       # "simple_form.no" keys. See the example locale file.
       def self.boolean_collection
         i18n_cache :boolean_collection do
-          [ [I18n.t(:"simple_form.yes", :default => 'Yes'), true],
-            [I18n.t(:"simple_form.no", :default => 'No'), false] ]
+          [ [I18n.t(:"simple_form.yes", default: 'Yes'), true],
+            [I18n.t(:"simple_form.no", default: 'No'), false] ]
         end
       end
 
-      def input
+      def input(wrapper_options = nil)
         raise NotImplementedError,
           "input should be implemented by classes inheriting from CollectionInput"
       end
 
       def input_options
         options = super
+
         options[:include_blank] = true unless skip_include_blank?
+        translate_option options, :prompt
+        translate_option options, :include_blank
+
         options
       end
 
@@ -33,7 +37,7 @@ module SimpleForm
       end
 
       def has_required?
-        super && (input_options[:include_blank] || multiple?)
+        super && (input_options[:include_blank] || input_options[:prompt] || multiple?)
       end
 
       # Check if :include_blank must be included by default.
@@ -66,17 +70,21 @@ module SimpleForm
         collection_translated = translate_collection if collection_classes == [Symbol]
 
         if collection_translated || collection_classes.include?(Array)
-          { :label => :first, :value => :last }
+          { label: :first, value: :second }
         elsif collection_includes_basic_objects?(collection_classes)
-          { :label => :to_s, :value => :to_s }
+          { label: :to_s, value: :to_s }
         else
-          sample = collection.first || collection.last
-
-          { :label => SimpleForm.collection_label_methods.find { |m| sample.respond_to?(m) },
-            :value => SimpleForm.collection_value_methods.find { |m| sample.respond_to?(m) } }
+          detect_method_from_class(collection_classes)
         end
       end
 
+      def detect_method_from_class(collection_classes)
+        sample = collection.first || collection.last
+
+        { label: SimpleForm.collection_label_methods.find { |m| sample.respond_to?(m) },
+          value: SimpleForm.collection_value_methods.find { |m| sample.respond_to?(m) } }
+      end
+
       def detect_collection_classes(some_collection = collection)
         some_collection.map { |e| e.class }.uniq
       end
@@ -88,14 +96,27 @@ module SimpleForm
       end
 
       def translate_collection
-        if translated_collection = translate(:options)
+        if translated_collection = translate_from_namespace(:options)
           @collection = collection.map do |key|
-            [translated_collection[key] || key, key]
+            html_key = "#{key}_html".to_sym
+
+            if translated_collection[html_key]
+              [translated_collection[html_key].html_safe || key, key.to_s]
+            else
+              [translated_collection[key] || key, key.to_s]
+            end
           end
           true
         end
       end
+
+      def translate_option(options, key)
+        if options[key] == :translate
+          namespace = key.to_s.pluralize
+
+          options[key] = translate_from_namespace(namespace, true)
+        end
+      end
     end
   end
 end
-

data/lib/simple_form/inputs/collection_radio_buttons_input.rb

@@ -1,19 +1,21 @@
 module SimpleForm
   module Inputs
     class CollectionRadioButtonsInput < CollectionInput
-      def input
+      def input(wrapper_options = nil)
         label_method, value_method = detect_collection_methods
 
-        @builder.send("collection_#{input_type}",
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.send(:"collection_#{input_type}",
           attribute_name, collection, value_method, label_method,
-          input_options, input_html_options, &collection_block_for_nested_boolean_style
+          input_options, merged_input_options,
+          &collection_block_for_nested_boolean_style
         )
       end
 
       def input_options
         options = super
         apply_default_collection_options!(options)
-        apply_nested_boolean_collection_options!(options) if nested_boolean_style?
         options
       end
 
@@ -23,7 +25,7 @@ module SimpleForm
         options[:item_wrapper_tag] ||= options.fetch(:item_wrapper_tag, SimpleForm.item_wrapper_tag)
         options[:item_wrapper_class] = [
           item_wrapper_class, options[:item_wrapper_class], SimpleForm.item_wrapper_class
-        ].compact.presence
+        ].compact.presence if SimpleForm.include_default_input_wrapper_class
 
         options[:collection_wrapper_tag] ||= options.fetch(:collection_wrapper_tag, SimpleForm.collection_wrapper_tag)
         options[:collection_wrapper_class] = [
@@ -31,13 +33,6 @@ module SimpleForm
         ].compact.presence
       end
 
-      # Force item wrapper to be a label when using nested boolean, to support
-      # configuring classes through :item_wrapper_class, and to maintain
-      # compatibility with :inline style and default :item_wrapper_tag.
-      def apply_nested_boolean_collection_options!(options)
-        options[:item_wrapper_tag] = :label
-      end
-
       def collection_block_for_nested_boolean_style
         return unless nested_boolean_style?
 

data/lib/simple_form/inputs/collection_select_input.rb

@@ -1,12 +1,14 @@
 module SimpleForm
   module Inputs
     class CollectionSelectInput < 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.collection_select(
           attribute_name, collection, value_method, label_method,
-          input_options, input_html_options
+          input_options, merged_input_options
         )
       end
     end

data/lib/simple_form/inputs/date_time_input.rb

@@ -1,23 +1,37 @@
 module SimpleForm
   module Inputs
     class DateTimeInput < Base
-      def input
-        @builder.send(:"#{input_type}_select", attribute_name, input_options, input_html_options)
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        if use_html5_inputs?
+          @builder.send(:"#{input_type}_field", attribute_name, merged_input_options)
+        else
+          @builder.send(:"#{input_type}_select", attribute_name, input_options, merged_input_options)
+        end
       end
 
       private
 
       def label_target
-        position = case input_type
-        when :date, :datetime
-          date_order = input_options[:order] || I18n.t('date.order')
-          date_order.first
+        if use_html5_inputs?
+          attribute_name
         else
-          :hour
+          position = case input_type
+          when :date, :datetime
+            date_order = input_options[:order] || I18n.t('date.order')
+            date_order.first.to_sym
+          else
+            :hour
+          end
+
+          position = ActionView::Helpers::DateTimeSelector::POSITION[position]
+          "#{attribute_name}_#{position}i"
         end
+      end
 
-        position = ActionView::Helpers::DateTimeSelector::POSITION[position]
-        "#{attribute_name}_#{position}i"
+      def use_html5_inputs?
+        input_options[:html5]
       end
     end
   end

data/lib/simple_form/inputs/file_input.rb

@@ -1,8 +1,10 @@
 module SimpleForm
   module Inputs
     class FileInput < Base
-      def input
-        @builder.file_field(attribute_name, input_html_options)
+      def input(wrapper_options = nil)
+        merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+        @builder.file_field(attribute_name, merged_input_options)
       end
     end
   end

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,21 +3,16 @@ module SimpleForm
     class NumericInput < Base
       enable :placeholder, :min_max
 
-      def input
-        add_size!
+      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)
 
-      # Rails adds the size attr by default, if the :size key does not exist.
-      def add_size!
-        input_html_options[:size] ||= nil
+        @builder.text_field(attribute_name, merged_input_options)
       end
     end
   end

data/lib/simple_form/inputs/password_input.rb

@@ -3,9 +3,10 @@ module SimpleForm
     class PasswordInput < Base
       enable :placeholder, :maxlength
 
-      def input
-        add_size!
-        @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,14 +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
 
-        add_size!
-        @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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,68 @@
+module SimpleForm
+  module Tags
+    module CollectionExtensions
+      private
+
+      def render_collection
+        item_wrapper_tag   = @options.fetch(:item_wrapper_tag, :span)
+        item_wrapper_class = @options[:item_wrapper_class]
+
+        @collection.map do |item|
+          value = value_for_collection(item, @value_method)
+          text  = value_for_collection(item, @text_method)
+          default_html_options = default_html_options_for_collection(item, value)
+          additional_html_options = option_html_attributes(item)
+
+          rendered_item = yield item, value, text, default_html_options.merge(additional_html_options)
+
+          if @options.fetch(:boolean_style, SimpleForm.boolean_style) == :nested
+            label_options = default_html_options.slice(:index, :namespace)
+            label_options['class'] = @options[:item_label_class]
+            rendered_item = @template_object.label(@object_name, sanitize_attribute_name(value), 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
+
+      def wrap_rendered_collection(collection)
+        wrapper_tag = @options[:collection_wrapper_tag]
+
+        if wrapper_tag
+          wrapper_class = @options[:collection_wrapper_class]
+          @template_object.content_tag(wrapper_tag, collection, class: wrapper_class)
+        else
+          collection
+        end
+      end
+    end
+
+    class CollectionRadioButtons < ActionView::Helpers::Tags::CollectionRadioButtons
+      include CollectionExtensions
+
+      def render
+        wrap_rendered_collection(super)
+      end
+
+      private
+
+      def render_component(builder)
+        builder.radio_button + builder.label(class: "collection_radio_buttons")
+      end
+    end
+
+    class CollectionCheckBoxes < ActionView::Helpers::Tags::CollectionCheckBoxes
+      include CollectionExtensions
+
+      def render
+        wrap_rendered_collection(super)
+      end
+
+      private
+
+      def render_component(builder)
+        builder.check_box + builder.label(class: "collection_check_boxes")
+      end
+    end
+  end
+end