simple_form 1.5.2 → 2.0.0

data/lib/simple_form/inputs/collection_input.rb

@@ -13,9 +13,8 @@ module SimpleForm
       end
 
       def input
-        label_method, value_method = detect_collection_methods
-        @builder.send(:"collection_#{input_type}", attribute_name, collection,
-                      value_method, label_method, input_options, input_html_options)
+        raise NotImplementedError,
+          "input should be implemented by classes inheriting from CollectionInput"
       end
 
       def input_options
@@ -27,18 +26,23 @@ module SimpleForm
       private
 
       def collection
-        @collection ||= (options.delete(:collection) || self.class.boolean_collection).to_a
+        @collection ||= begin
+          collection = options.delete(:collection) || self.class.boolean_collection
+          collection.respond_to?(:call) ? collection.call : collection.to_a
+        end
       end
 
-      # Select components does not allow the required html tag.
       def has_required?
-        super && input_type != :select
+        super && (input_options[:include_blank] || multiple?)
       end
 
       # Check if :include_blank must be included by default.
       def skip_include_blank?
-        (options.keys & [:prompt, :include_blank, :default, :selected]).any? ||
-          options[:input_html].try(:[], :multiple)
+        (options.keys & [:prompt, :include_blank, :default, :selected]).any? || multiple?
+      end
+
+      def multiple?
+        !!options[:input_html].try(:[], :multiple)
       end
 
       # Detect the right method to find the label and value for a collection.
@@ -58,10 +62,10 @@ module SimpleForm
         [label, value]
       end
 
-      def detect_common_display_methods
-        collection_classes = detect_collection_classes
+      def detect_common_display_methods(collection_classes = detect_collection_classes)
+        collection_translated = translate_collection if collection_classes == [Symbol]
 
-        if collection_classes.include?(Array)
+        if collection_translated || collection_classes.include?(Array)
           { :label => :first, :value => :last }
         elsif collection_includes_basic_objects?(collection_classes)
           { :label => :to_s, :value => :to_s }
@@ -73,8 +77,8 @@ module SimpleForm
         end
       end
 
-      def detect_collection_classes
-        collection.map { |e| e.class }.uniq
+      def detect_collection_classes(some_collection = collection)
+        some_collection.map { |e| e.class }.uniq
       end
 
       def collection_includes_basic_objects?(collection_classes)
@@ -82,6 +86,16 @@ module SimpleForm
           String, Integer, Fixnum, Bignum, Float, NilClass, Symbol, TrueClass, FalseClass
         ]).any?
       end
+
+      def translate_collection
+        if translated_collection = translate(:options)
+          @collection = collection.map do |key|
+            [translated_collection[key] || key, key]
+          end
+          true
+        end
+      end
     end
   end
 end
+

data/lib/simple_form/inputs/collection_radio_buttons_input.rb

@@ -0,0 +1,67 @@
+module SimpleForm
+  module Inputs
+    class CollectionRadioButtonsInput < CollectionInput
+      def input
+        label_method, value_method = detect_collection_methods
+
+        @builder.send("collection_#{input_type}",
+          attribute_name, collection, value_method, label_method,
+          input_options, input_html_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
+
+      protected
+
+      def apply_default_collection_options!(options)
+        unless options.key?(:item_wrapper_tag)
+          options[:item_wrapper_tag] = SimpleForm.item_wrapper_tag
+        end
+        options[:item_wrapper_class] = [
+          item_wrapper_class, options[:item_wrapper_class], SimpleForm.item_wrapper_class
+        ].compact.presence
+
+        unless options.key?(:collection_wrapper_tag)
+          options[:collection_wrapper_tag] = SimpleForm.collection_wrapper_tag
+        end
+        options[:collection_wrapper_class] = [
+          options[:collection_wrapper_class], SimpleForm.collection_wrapper_class
+        ].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?
+
+        proc { |builder| build_nested_boolean_style_item_tag(builder) }
+      end
+
+      def build_nested_boolean_style_item_tag(collection_builder)
+        collection_builder.radio_button + collection_builder.text
+      end
+
+      def item_wrapper_class
+        "radio"
+      end
+
+      # Do not attempt to generate label[for] attributes by default, unless an
+      # explicit html option is given. This avoids generating labels pointing to
+      # non existent fields.
+      def generate_label_for_attribute?
+        false
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/collection_select_input.rb

@@ -0,0 +1,14 @@
+module SimpleForm
+  module Inputs
+    class CollectionSelectInput < CollectionInput
+      def input
+        label_method, value_method = detect_collection_methods
+
+        @builder.collection_select(
+          attribute_name, collection, value_method, label_method,
+          input_options, input_html_options
+        )
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/date_time_input.rb

@@ -5,19 +5,23 @@ module SimpleForm
         @builder.send(:"#{input_type}_select", attribute_name, input_options, input_html_options)
       end
 
-      private
-
       def has_required?
         false
       end
 
+      private
+
       def label_target
-        case input_type
+        position = case input_type
         when :date, :datetime
-          "#{attribute_name}_1i"
-        when :time
-          "#{attribute_name}_4i"
+          date_order = input_options[:order] || I18n.t('date.order')
+          date_order.first
+        else
+          :hour
         end
+
+        position = ActionView::Helpers::DateTimeSelector::POSITION[position]
+        "#{attribute_name}_#{position}i"
       end
     end
   end

data/lib/simple_form/inputs/grouped_collection_select_input.rb

@@ -0,0 +1,41 @@
+module SimpleForm
+  module Inputs
+    class GroupedCollectionSelectInput < CollectionInput
+      def input
+        label_method, value_method = detect_collection_methods
+        @builder.grouped_collection_select(attribute_name, grouped_collection,
+                      group_method, group_label_method, value_method, label_method,
+                      input_options, input_html_options)
+      end
+
+      private
+
+      def grouped_collection
+        @grouped_collection ||= begin
+          grouped_collection = options.delete(:collection)
+          grouped_collection.respond_to?(:call) ? grouped_collection.call : grouped_collection.to_a
+        end
+      end
+
+      # Sample collection
+      def collection
+        @collection ||= grouped_collection.first.try(:send, group_method) || []
+      end
+
+      def group_method
+        @group_method ||= options.delete(:group_method)
+      end
+
+      def group_label_method
+        label = options.delete(:group_label_method)
+
+        unless label
+          common_method_for = detect_common_display_methods(detect_collection_classes(grouped_collection))
+          label = common_method_for[:label]
+        end
+
+        label
+      end
+    end
+  end
+end

data/lib/simple_form/inputs/hidden_input.rb

@@ -1,17 +1,14 @@
 module SimpleForm
   module Inputs
     class HiddenInput < Base
-      def render
+      disable :label, :errors, :hint, :required
+
+      def input
         @builder.hidden_field(attribute_name, input_html_options)
       end
-      alias :input :render
 
       private
 
-      def attribute_required?
-        false
-      end
-
       def required_class
         nil
       end

data/lib/simple_form/inputs/numeric_input.rb

@@ -1,72 +1,24 @@
 module SimpleForm
   module Inputs
     class NumericInput < Base
-      enable :placeholder
+      enable :placeholder, :min_max
 
       def input
         add_size!
-        if SimpleForm.html5
+        input_html_classes.unshift("numeric")
+        if html5?
           input_html_options[:type] ||= "number"
           input_html_options[:step] ||= integer? ? 1 : "any"
-          infer_attributes_from_validations!
         end
         @builder.text_field(attribute_name, input_html_options)
       end
 
-      def input_html_classes
-        super.unshift("numeric")
-      end
-
       private
 
       # Rails adds the size attr by default, if the :size key does not exist.
       def add_size!
         input_html_options[:size] ||= nil
       end
-
-      def infer_attributes_from_validations!
-        return unless has_validators?
-
-        numeric_validator = find_numericality_validator or return
-        validator_options = numeric_validator.options
-
-        input_html_options[:min] ||= minimum_value(validator_options)
-        input_html_options[:max] ||= maximum_value(validator_options)
-      end
-
-      def integer?
-        input_type == :integer
-      end
-
-      def minimum_value(validator_options)
-        if integer? && validator_options.key?(:greater_than)
-          evaluate_validator_option(validator_options[:greater_than]) + 1
-        else
-          evaluate_validator_option(validator_options[:greater_than_or_equal_to])
-        end
-      end
-
-      def maximum_value(validator_options)
-        if integer? && validator_options.key?(:less_than)
-          evaluate_validator_option(validator_options[:less_than]) - 1
-        else
-          evaluate_validator_option(validator_options[:less_than_or_equal_to])
-        end
-      end
-
-      def find_numericality_validator
-        find_validator(ActiveModel::Validations::NumericalityValidator)
-      end
-
-      def evaluate_validator_option(option)
-        if option.is_a?(Numeric)
-          option
-        elsif option.is_a?(Symbol)
-          object.send(option)
-        elsif option.respond_to?(:call)
-          option.call(object)
-        end
-      end
     end
   end
 end

data/lib/simple_form/inputs/password_input.rb

@@ -1,11 +1,10 @@
 module SimpleForm
   module Inputs
     class PasswordInput < Base
-      enable :placeholder
+      enable :placeholder, :maxlength
 
       def input
         add_size!
-        add_maxlength!
         @builder.password_field(attribute_name, input_html_options)
       end
     end

data/lib/simple_form/inputs/priority_input.rb

@@ -1,6 +1,6 @@
 module SimpleForm
   module Inputs
-    class PriorityInput < CollectionInput
+    class PriorityInput < CollectionSelectInput
       def input
         @builder.send(:"#{input_type}_select", attribute_name, input_priority,
                       input_options, input_html_options)
@@ -10,7 +10,7 @@ module SimpleForm
         options[:priority] || SimpleForm.send(:"#{input_type}_priority")
       end
 
-    protected
+      protected
 
       def has_required?
         false

data/lib/simple_form/inputs/range_input.rb

@@ -1,10 +1,8 @@
 module SimpleForm
   module Inputs
     class RangeInput < NumericInput
-      disable :placeholder
-
       def input
-        if SimpleForm.html5
+        if html5?
           input_html_options[:type] ||= "range"
           input_html_options[:step] ||= 1
         end

data/lib/simple_form/inputs/string_input.rb

@@ -1,20 +1,18 @@
 module SimpleForm
   module Inputs
     class StringInput < Base
-      enable :placeholder
+      enable :placeholder, :maxlength, :pattern
 
       def input
-        input_html_options[:type] ||= input_type if SimpleForm.html5 && !string?
-        add_maxlength!
-        add_pattern!
+        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)
       end
 
-      def input_html_classes
-        string? ? super : super.unshift("string")
-      end
-
       private
 
       def string?

data/lib/simple_form/inputs/text_input.rb

@@ -1,10 +1,9 @@
 module SimpleForm
   module Inputs
     class TextInput < Base
-      enable :placeholder
+      enable :placeholder, :maxlength
 
       def input
-        add_maxlength!
         @builder.text_area(attribute_name, input_html_options)
       end
     end

data/lib/simple_form/inputs.rb

@@ -1,17 +1,21 @@
 module SimpleForm
   module Inputs
-    autoload :Base,            'simple_form/inputs/base'
-    autoload :BlockInput,      'simple_form/inputs/block_input'
-    autoload :BooleanInput,    'simple_form/inputs/boolean_input'
-    autoload :CollectionInput, 'simple_form/inputs/collection_input'
-    autoload :DateTimeInput,   'simple_form/inputs/date_time_input'
-    autoload :FileInput,       'simple_form/inputs/file_input'
-    autoload :HiddenInput,     'simple_form/inputs/hidden_input'
-    autoload :NumericInput,    'simple_form/inputs/numeric_input'
-    autoload :PasswordInput,   'simple_form/inputs/password_input'
-    autoload :PriorityInput,   'simple_form/inputs/priority_input'
-    autoload :RangeInput,      'simple_form/inputs/range_input'
-    autoload :StringInput,     'simple_form/inputs/string_input'
-    autoload :TextInput,       'simple_form/inputs/text_input'
+    autoload :Base,                         'simple_form/inputs/base'
+    autoload :BlockInput,                   'simple_form/inputs/block_input'
+    autoload :BooleanInput,                 'simple_form/inputs/boolean_input'
+    autoload :CollectionCheckBoxesInput,    'simple_form/inputs/collection_check_boxes_input'
+    autoload :CollectionInput,              'simple_form/inputs/collection_input'
+    autoload :CollectionRadioButtonsInput,  'simple_form/inputs/collection_radio_buttons_input'
+    autoload :CollectionSelectInput,        'simple_form/inputs/collection_select_input'
+    autoload :DateTimeInput,                'simple_form/inputs/date_time_input'
+    autoload :FileInput,                    'simple_form/inputs/file_input'
+    autoload :GroupedCollectionSelectInput, 'simple_form/inputs/grouped_collection_select_input'
+    autoload :HiddenInput,                  'simple_form/inputs/hidden_input'
+    autoload :NumericInput,                 'simple_form/inputs/numeric_input'
+    autoload :PasswordInput,                'simple_form/inputs/password_input'
+    autoload :PriorityInput,                'simple_form/inputs/priority_input'
+    autoload :RangeInput,                   'simple_form/inputs/range_input'
+    autoload :StringInput,                  'simple_form/inputs/string_input'
+    autoload :TextInput,                    'simple_form/inputs/text_input'
   end
 end

data/lib/simple_form/version.rb

@@ -1,3 +1,3 @@
 module SimpleForm
-  VERSION = "1.5.2".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/simple_form/wrappers/builder.rb

@@ -0,0 +1,103 @@
+module SimpleForm
+  module Wrappers
+    # Provides the builder syntax for components. The builder provides
+    # three methods `use`, `optional` and `wrapper` and they allow the following invocations:
+    #
+    #     config.wrappers do |b|
+    #       # Use a single component
+    #       b.use :html5
+    #
+    #       # Use the component, but do not automatically lookup. It will only be triggered when
+    #       # :placeholder is explicitly set.
+    #       b.optional :placeholder
+    #
+    #       # Use a component with specific wrapper options
+    #       b.use :error, :wrap_with => { :tag => "span", :class => "error" }
+    #
+    #       # Use a set of components by wrapping them in a tag+class.
+    #       b.wrapper :tag => "div", :class => "another" do |ba|
+    #         ba.use :label
+    #         ba.use :input
+    #       end
+    #
+    #       # Use a set of components by wrapping them in a tag+class.
+    #       # This wrapper is identified by :label_input, which means it can
+    #       # be turned off on demand with `f.input :name, :label_input => false`
+    #       b.wrapper :label_input, :tag => "div", :class => "another" do |ba|
+    #         ba.use :label
+    #         ba.use :input
+    #       end
+    #     end
+    #
+    # The builder also accepts default options at the root level. This is usually
+    # used if you want a component to be disabled by default:
+    #
+    #     config.wrappers :hint => false do |b|
+    #       b.use :hint
+    #       b.use :label_input
+    #     end
+    #
+    # In the example above, hint defaults to false, which means it won't automatically
+    # do the lookup anymore. It will only be triggered when :hint is explicitly set.
+    class Builder
+      def initialize(options)
+        @options    = options
+        @components = []
+      end
+
+      def use(name, options=nil, &block)
+        if block_given?
+          ActiveSupport::Deprecation.warn "Passing a block to use is deprecated. " \
+            "Please use wrapper instead of use."
+          return wrapper(name, options, &block)
+        end
+
+        if options && options.keys != [:wrap_with]
+          ActiveSupport::Deprecation.warn "Passing :tag, :class and others to use is deprecated. " \
+            "Please invoke b.use #{name.inspect}, :wrap_with => #{options.inspect} instead."
+          options = { :wrap_with => options }
+        end
+
+        if options && wrapper = options[:wrap_with]
+          @components << Single.new(name, wrapper)
+        else
+          @components << name
+        end
+      end
+
+      def optional(name, options=nil, &block)
+        if block_given?
+          ActiveSupport::Deprecation.warn "Passing a block to optional is deprecated. " \
+            "Please use wrapper instead of optional."
+          return wrapper(name, options, &block)
+        end
+
+        if options && options.keys != [:wrap_with]
+          ActiveSupport::Deprecation.warn "Passing :tag, :class and others to optional is deprecated. " \
+            "Please invoke b.optional #{name.inspect}, :wrap_with => #{options.inspect} instead."
+          options = { :wrap_with => options }
+        end
+
+        @options[name] = false
+        use(name, options, &block)
+      end
+
+      def wrapper(name, options=nil)
+        if block_given?
+          name, options = nil, name if name.is_a?(Hash)
+          builder = self.class.new(@options)
+          options ||= {}
+          options[:tag] = :div if options[:tag].nil?
+          yield builder
+          @components << Many.new(name, builder.to_a, options)
+        else
+          raise ArgumentError, "A block is required as argument to wrapper"
+        end
+      end
+
+      def to_a
+        @components
+      end
+    end
+  end
+end

data/lib/simple_form/wrappers/many.rb

@@ -0,0 +1,69 @@
+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`.
+    # This API allows inputs/components to be easily wrapped, removing the
+    # need to modify the code only to wrap input in an extra tag.
+    #
+    # `Many` represents a wrapper around several components at the same time.
+    # It may optionally receive a namespace, allowing it to be configured
+    # on demand on input generation.
+    class Many
+      attr_reader :namespace, :defaults, :components
+      alias :to_sym :namespace
+
+      def initialize(namespace, components, defaults={})
+        @namespace  = namespace
+        @components = components
+        @defaults   = defaults
+        @defaults[:tag]   = :div unless @defaults.key?(:tag)
+        @defaults[:class] = Array.wrap(@defaults[:class])
+      end
+
+      def render(input)
+        content = "".html_safe
+        options = input.options
+
+        components.each do |component|
+          next if options[component] == false
+          rendered = component.respond_to?(:render) ? component.render(input) : input.send(component)
+          content.safe_concat rendered.to_s if rendered
+        end
+
+        wrap(input, options, content)
+      end
+
+      def find(name)
+        return self if namespace == name
+
+        @components.each do |c|
+          if c.is_a?(Symbol)
+            return nil if c == namespace
+          elsif value = c.find(name)
+            return value
+          end
+        end
+
+        nil
+      end
+
+      private
+
+      def wrap(input, options, content)
+        return content if options[namespace] == false
+
+        tag = (namespace && options[:"#{namespace}_tag"]) || @defaults[:tag]
+        return content unless tag
+
+        klass = html_classes(input, options)
+        opts  = options[:"#{namespace}_html"] || {}
+        opts[:class] = (klass << opts[:class]).join(' ').strip unless klass.empty?
+        input.template.content_tag(tag, content, opts)
+      end
+
+      def html_classes(input, options)
+        @defaults[:class].dup
+      end
+    end
+  end
+end

data/lib/simple_form/wrappers/root.rb

@@ -0,0 +1,34 @@
+module SimpleForm
+  module Wrappers
+    # `Root` is the root wrapper for all components. It is special cased to
+    # always have a namespace and to add special html classes.
+    class Root < Many
+      attr_reader :options
+
+      def initialize(*args)
+        super(:wrapper, *args)
+        @options = @defaults.except(:tag, :class, :error_class, :hint_class)
+      end
+
+      def render(input)
+        input.options.reverse_merge!(@options)
+        super
+      end
+
+      # Provide a fallback if name cannot be found.
+      def find(name)
+        super || SimpleForm::Wrappers::Many.new(name, [name])
+      end
+
+      private
+
+      def html_classes(input, options)
+        css = options[:wrapper_class] ? Array.wrap(options[:wrapper_class]) : @defaults[:class]
+        css += SimpleForm.additional_classes_for(:wrapper) { input.html_classes }
+        css << (options[:wrapper_error_class] || @defaults[:error_class]) if input.has_errors?
+        css << (options[:wrapper_hint_class] || @defaults[:hint_class]) if input.has_hint?
+        css
+      end
+    end
+  end
+end