simple_form 1.5.2 → 2.0.0.rc

data/lib/simple_form/core_ext/hash.rb

@@ -0,0 +1,16 @@
+# TODO: Delete this file when we drop support for Rails 3.0
+#   This method is already implemented in active_support 3.1
+
+unless Hash.new.respond_to?(:deep_dup)
+  class Hash
+    # Returns a deep copy of hash.
+    def deep_dup
+      duplicate = self.dup
+      duplicate.each_pair do |k,v|
+        tv = duplicate[k]
+        duplicate[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_dup : v
+      end
+      duplicate
+    end
+  end
+end

data/lib/simple_form/error_notification.rb

@@ -1,7 +1,6 @@
 module SimpleForm
   class ErrorNotification
     delegate :object, :object_name, :template, :to => :@builder
-    include SimpleForm::Helpers::HasErrors
 
     def initialize(builder, options)
       @builder = builder
@@ -17,6 +16,14 @@ module SimpleForm
 
     protected
 
+    def errors
+      object.errors
+    end
+
+    def has_errors?
+      object && object.respond_to?(:errors) && errors.present?
+    end
+
     def error_message
       @message || translate_error_notification
     end

data/lib/simple_form/form_builder.rb

@@ -1,6 +1,14 @@
+require 'simple_form/core_ext/hash'
+
 module SimpleForm
   class FormBuilder < ActionView::Helpers::FormBuilder
-    attr_reader :template, :object_name, :object
+    attr_reader :template, :object_name, :object, :wrapper
+
+    # When action is create or update, we still should use new and edit
+    ACTIONS = {
+      :create => :new,
+      :update => :edit
+    }
 
     extend MapType
     include SimpleForm::Inputs
@@ -11,7 +19,10 @@ module SimpleForm
     map_type :password,                            :to => SimpleForm::Inputs::PasswordInput
     map_type :integer, :decimal, :float,           :to => SimpleForm::Inputs::NumericInput
     map_type :range,                               :to => SimpleForm::Inputs::RangeInput
-    map_type :select, :radio, :check_boxes,        :to => SimpleForm::Inputs::CollectionInput
+    map_type :check_boxes,                         :to => SimpleForm::Inputs::CollectionCheckBoxesInput
+    map_type :radio_buttons,                       :to => SimpleForm::Inputs::CollectionRadioButtonsInput
+    map_type :select,                              :to => SimpleForm::Inputs::CollectionSelectInput
+    map_type :grouped_select,                      :to => SimpleForm::Inputs::GroupedCollectionSelectInput
     map_type :date, :time, :datetime,              :to => SimpleForm::Inputs::DateTimeInput
     map_type :country, :time_zone,                 :to => SimpleForm::Inputs::PriorityInput
     map_type :boolean,                             :to => SimpleForm::Inputs::BooleanInput
@@ -20,6 +31,12 @@ module SimpleForm
       @discovery_cache ||= {}
     end
 
+    def initialize(*) #:nodoc:
+      super
+      @defaults = options[:defaults]
+      @wrapper  = SimpleForm.wrapper(options[:wrapper] || SimpleForm.default_wrapper)
+    end
+
     # Basic input helper, combines all components in the stack to generate
     # input html based on options the user define and some guesses through
     # database column information. By default a call to input will generate
@@ -71,8 +88,8 @@ module SimpleForm
     #
     # == Collection
     #
-    # When playing with collections (:radio and :select inputs), you have three extra
-    # options:
+    # When playing with collections (:radio_buttons, :check_boxes and :select
+    # inputs), you have three extra options:
     #
     #   :collection => use to determine the collection to generate the radio or select
     #
@@ -86,14 +103,16 @@ module SimpleForm
     # given SimpleForm.time_zone_priority and SimpleForm.country_priority are used respectivelly.
     #
     def input(attribute_name, options={}, &block)
-      column     = find_attribute_column(attribute_name)
-      input_type = default_input_type(attribute_name, column, options)
+      options = @defaults.deep_dup.deep_merge(options) if @defaults
 
-      if block_given?
-        SimpleForm::Inputs::BlockInput.new(self, attribute_name, column, input_type, options, &block).render
-      else
-        find_mapping(input_type).new(self, attribute_name, column, input_type, options).render
-      end
+      chosen =
+        if name = options[:wrapper]
+          name.respond_to?(:render) ? name : SimpleForm.wrapper(name)
+        else
+          wrapper
+        end
+
+      chosen.render find_input(attribute_name, options, &block)
     end
     alias :attribute :input
 
@@ -112,12 +131,8 @@ module SimpleForm
     #        name="user[name]" size="100" type="text" value="Carlos" />
     #
     def input_field(attribute_name, options={})
-      column     = find_attribute_column(attribute_name)
-      input_type = default_input_type(attribute_name, column, options)
-
       options[:input_html] = options.except(:as, :collection, :label_method, :value_method)
-
-      find_mapping(input_type).new(self, attribute_name, column, input_type, options).input
+      SimpleForm::Wrappers::Root.new([:input], :wrapper => false).render find_input(attribute_name, options)
     end
 
     # Helper for dealing with association selects/radios, generating the
@@ -160,7 +175,7 @@ module SimpleForm
 
       attribute = case reflection.macro
         when :belongs_to
-          reflection.options[:foreign_key] || :"#{reflection.name}_id"
+          (reflection.respond_to?(:options) && reflection.options[:foreign_key]) || :"#{reflection.name}_id"
         when :has_one
           raise ":has_one associations are not supported by f.association"
         else
@@ -192,7 +207,7 @@ module SimpleForm
     #
     def button(type, *args, &block)
       options = args.extract_options!
-      options[:class] = "button #{options[:class]}".strip
+      options[:class] = [SimpleForm.button_class, options[:class]].compact
       args << options
       if respond_to?("#{type}_button")
         send("#{type}_button", *args, &block)
@@ -213,7 +228,8 @@ module SimpleForm
       options[:error_html] = options.except(:error_tag, :error_prefix, :error_method)
       column      = find_attribute_column(attribute_name)
       input_type  = default_input_type(attribute_name, column, options)
-      SimpleForm::Inputs::Base.new(self, attribute_name, column, input_type, options).error
+      wrapper.find(:error).
+        render(SimpleForm::Inputs::Base.new(self, attribute_name, column, input_type, options))
     end
 
     # Return the error but also considering its name. This is used
@@ -244,7 +260,7 @@ module SimpleForm
     #    f.hint "Don't forget to accept this"
     #
     def hint(attribute_name, options={})
-      options[:hint_html] = options.except(:hint_tag)
+      options[:hint_html] = options.except(:hint_tag, :hint)
       if attribute_name.is_a?(String)
         options[:hint] = attribute_name
         attribute_name, column, input_type = nil, nil, nil
@@ -252,7 +268,9 @@ module SimpleForm
         column      = find_attribute_column(attribute_name)
         input_type  = default_input_type(attribute_name, column, options)
       end
-      SimpleForm::Inputs::Base.new(self, attribute_name, column, input_type, options).hint
+
+      wrapper.find(:hint).
+        render(SimpleForm::Inputs::Base.new(self, attribute_name, column, input_type, options))
     end
 
     # Creates a default label tag for the given attribute. You can give a label
@@ -294,7 +312,53 @@ module SimpleForm
       SimpleForm::ErrorNotification.new(self, options).render
     end
 
-  private
+    # Extract the model names from the object_name mess, ignoring numeric and
+    # explicit child indexes.
+    #
+    # Example:
+    #
+    # route[blocks_attributes][0][blocks_learning_object_attributes][1][foo_attributes]
+    # ["route", "blocks", "blocks_learning_object", "foo"]
+    #
+    def lookup_model_names
+      @lookup_model_names ||= begin
+        child_index = options[:child_index]
+        names = object_name.to_s.scan(/([a-zA-Z_]+)/).flatten
+        names.delete(child_index) if child_index
+        names.each { |name| name.gsub!('_attributes', '') }
+        names.freeze
+      end
+    end
+
+    # The action to be used in lookup.
+    def lookup_action
+      @lookup_action ||= begin
+        action = template.controller.action_name
+        return unless action
+        action = action.to_sym
+        ACTIONS[action] || action
+      end
+    end
+
+    private
+
+    # Find an input based on the attribute name.
+    def find_input(attribute_name, options={}, &block) #:nodoc:
+      column     = find_attribute_column(attribute_name)
+      input_type = default_input_type(attribute_name, column, options)
+
+      if input_type == :radio
+        SimpleForm.deprecation_warn "Using `:as => :radio` as input type is " \
+          "deprecated, please change it to `:as => :radio_buttons`."
+        input_type = :radio_buttons
+      end
+
+      if block_given?
+        SimpleForm::Inputs::BlockInput.new(self, attribute_name, column, input_type, options, &block)
+      else
+        find_mapping(input_type).new(self, attribute_name, column, input_type, options)
+      end
+    end
 
     # Attempt to guess the better input type given the defined options. By
     # default alwayls fallback to the user :as option, or to a :select when a

data/lib/simple_form/helpers.rb

@@ -1,9 +1,12 @@
 module SimpleForm
+  # Helpers are made of several helpers that cannot be turned on automatically.
+  # For instance, disabled cannot be turned on automatically, it requires the
+  # user to explicitly pass the option :disabled => true so it may work.
   module Helpers
-    autoload :HasErrors,    'simple_form/helpers/has_errors'
-    autoload :Maxlength,    'simple_form/helpers/maxlength'
-    autoload :Pattern,      'simple_form/helpers/pattern'
-    autoload :Validators,   'simple_form/helpers/validators'
+    autoload :Autofocus,    'simple_form/helpers/autofocus'
+    autoload :Disabled,     'simple_form/helpers/disabled'
+    autoload :Readonly,     'simple_form/helpers/readonly'
     autoload :Required,     'simple_form/helpers/required'
+    autoload :Validators,   'simple_form/helpers/validators'
   end
 end

data/lib/simple_form/helpers/autofocus.rb

@@ -0,0 +1,11 @@
+module SimpleForm
+  module Helpers
+    module Autofocus
+      private
+
+      def has_autofocus?
+        options[:autofocus] == true
+      end
+    end
+  end
+end

data/lib/simple_form/helpers/disabled.rb

@@ -0,0 +1,15 @@
+module SimpleForm
+  module Helpers
+    module Disabled
+      private
+
+      def has_disabled?
+        options[:disabled] == true
+      end
+
+      def disabled_class
+        :disabled if has_disabled?
+      end
+    end
+  end
+end

data/lib/simple_form/helpers/readonly.rb

@@ -0,0 +1,15 @@
+module SimpleForm
+  module Helpers
+    module Readonly
+      private
+
+      def readonly_class
+        :readonly if has_readonly?
+      end
+
+      def has_readonly?
+        options[:readonly] == true
+      end
+    end
+  end
+end

data/lib/simple_form/helpers/required.rb

@@ -3,7 +3,7 @@ module SimpleForm
     module Required
       private
 
-      def attribute_required?
+      def required_field?
         @required
       end
 
@@ -15,22 +15,19 @@ module SimpleForm
             v.kind == :presence && valid_validator?(v)
           end
         else
-          attribute_required_by_default?
+          required_by_default?
         end
       end
 
-      # Whether this input is valid for HTML 5 required attribute.
-      def has_required?
-        attribute_required? && SimpleForm.html5 && SimpleForm.browser_validations
-      end
-
-      def attribute_required_by_default?
+      def required_by_default?
         SimpleForm.required_by_default
       end
 
+      # Do not use has_required? because we want to add the class
+      # regardless of the required option.
       def required_class
-        attribute_required? ? :required : :optional
+        required_field? ? :required : :optional
       end
     end
   end
-end
+end

data/lib/simple_form/helpers/validators.rb

@@ -1,12 +1,12 @@
 module SimpleForm
   module Helpers
     module Validators
-      private
-
       def has_validators?
-        attribute_name && object.class.respond_to?(:validators_on)
+        @has_validators ||= attribute_name && object.class.respond_to?(:validators_on)
       end
 
+      private
+
       def attribute_validators
         object.class.validators_on(attribute_name)
       end
@@ -37,7 +37,7 @@ module SimpleForm
       end
 
       def find_validator(validator)
-        attribute_validators.find { |v| validator === v }
+        attribute_validators.find { |v| validator === v } if has_validators?
       end
     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/inputs/base.rb

@@ -3,49 +3,68 @@ module SimpleForm
     class Base
       extend I18nCache
 
-      # When action is create or update, we still should use new and edit
-      ACTIONS = {
-        :create => :new,
-        :update => :edit
-      }
-
+      include SimpleForm::Helpers::Autofocus
+      include SimpleForm::Helpers::Disabled
+      include SimpleForm::Helpers::Readonly
       include SimpleForm::Helpers::Required
       include SimpleForm::Helpers::Validators
-      include SimpleForm::Helpers::Maxlength
-      include SimpleForm::Helpers::Pattern
 
       include SimpleForm::Components::Errors
       include SimpleForm::Components::Hints
+      include SimpleForm::Components::HTML5
       include SimpleForm::Components::LabelInput
+      include SimpleForm::Components::Maxlength
+      include SimpleForm::Components::MinMax
+      include SimpleForm::Components::Pattern
       include SimpleForm::Components::Placeholders
-      include SimpleForm::Components::Wrapper
+      include SimpleForm::Components::Readonly
+
+      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
 
-      # Enables certain components support to the given input.
-      def self.enable(*args)
-        args.each { |m| alias_method m, :"enabled_#{m}" }
+      class_attribute :default_options
+      self.default_options = {}
+
+      def self.enable(*keys)
+        options = self.default_options.dup
+        keys.each { |key| options.delete(key) }
+        self.default_options = options
       end
 
-      def self.disable(*args)
-        args.each { |m| alias_method m, :"disabled_#{m}" }
+      def self.disable(*keys)
+        options = self.default_options.dup
+        keys.each { |key| options[key] = false }
+        self.default_options = options
       end
 
-      attr_reader :attribute_name, :column, :input_type, :reflection,
-                  :options, :input_html_options
+      # Always enabled.
+      enable :hint
 
-      delegate :template, :object, :object_name, :to => :@builder
+      # Usually disabled, needs to be enabled explicitly passing true as option.
+      disable :maxlength, :placeholder, :pattern, :min_max
 
       def initialize(builder, attribute_name, column, input_type, options = {})
+        super
+
         @builder            = builder
         @attribute_name     = attribute_name
         @column             = column
         @input_type         = input_type
         @reflection         = options.delete(:reflection)
-        @options            = options
+        @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
+        # still propagate to input_html_options.
+        @html_classes       = [input_type, required_class, readonly_class, disabled_class].compact
+        @input_html_classes = @html_classes.dup
         @input_html_options = html_options_for(:input, input_html_classes).tap do |o|
-          o[:required]  = true if has_required?
-          o[:disabled]  = true if disabled?
-          o[:autofocus] = true if has_autofocus? && SimpleForm.html5
+          o[:readonly]  = true if has_readonly?
+          o[:disabled]  = true if has_disabled?
+          o[:autofocus] = true if has_autofocus?
         end
       end
 
@@ -57,20 +76,6 @@ module SimpleForm
         options
       end
 
-      def input_html_classes
-        [input_type, required_class]
-      end
-
-      def render
-        content = "".html_safe
-        components_list.each do |component|
-          next if options[component] == false
-          rendered = send(component)
-          content.safe_concat rendered.to_s if rendered
-        end
-        wrap(content)
-      end
-
       private
 
       def add_size!
@@ -81,17 +86,8 @@ module SimpleForm
         column && column.limit
       end
 
-      def components_list
-        if components = options[:components]
-          ActiveSupport::Deprecation.warn "The option :components of f.input is deprecated. Please turn off each component individually instead."
-          components
-        else
-          SimpleForm.components
-        end
-      end
-
-      def has_autofocus?
-        options[:autofocus]
+      def nested_boolean_style?
+        options.fetch(:boolean_style, SimpleForm.boolean_style) == :nested
       end
 
       # Find reflection name when available, otherwise use attribute
@@ -100,22 +96,19 @@ module SimpleForm
       end
 
       # Retrieve options for the given namespace from the options hash
-      def html_options_for(namespace, extra)
+      def html_options_for(namespace, css_classes)
         html_options = options[:"#{namespace}_html"] || {}
-        html_options[:class] = (extra << html_options[:class]).join(' ').strip if extra.present?
+        css_classes << html_options[:class] if html_options.key?(:class)
+        html_options[:class] = css_classes
         html_options
       end
 
-      def disabled?
-        options[:disabled] == true
-      end
-
       # Lookup translations for the given namespace using I18n, based on object name,
       # actual action and attribute name. Lookup priority as follows:
       #
       #   simple_form.{namespace}.{model}.{action}.{attribute}
       #   simple_form.{namespace}.{model}.{attribute}
-      #   simple_form.{namespace}.{attribute}
+      #   simple_form.{namespace}.defaults.{attribute}
       #
       #  Namespace is used for :labels and :hints.
       #
@@ -130,7 +123,7 @@ module SimpleForm
       #   simple_form.{namespace}.{model}.{nested}.{attribute}
       #   simple_form.{namespace}.{nested}.{action}.{attribute}
       #   simple_form.{namespace}.{nested}.{attribute}
-      #   simple_form.{namespace}.{attribute}
+      #   simple_form.{namespace}.defaults.{attribute}
       #
       #  Example:
       #
@@ -144,9 +137,7 @@ module SimpleForm
       #
       #  Take a look at our locale example file.
       def translate(namespace, default='')
-        return nil unless SimpleForm.translate
-
-        model_names = lookup_model_names
+        model_names = lookup_model_names.dup
         lookups     = []
 
         while !model_names.empty?
@@ -156,34 +147,12 @@ module SimpleForm
           lookups << :"#{joined_model_names}.#{lookup_action}.#{reflection_or_attribute_name}"
           lookups << :"#{joined_model_names}.#{reflection_or_attribute_name}"
         end
-        lookups << :"#{reflection_or_attribute_name}"
+        lookups << :"defaults.#{lookup_action}.#{reflection_or_attribute_name}"
+        lookups << :"defaults.#{attribute_name}"
         lookups << default
 
         I18n.t(lookups.shift, :scope => :"simple_form.#{namespace}", :default => lookups).presence
       end
-
-      # Extract the model names from the object_name mess, ignoring numeric and
-      # explicit child indexes.
-      #
-      # Example:
-      #
-      # route[blocks_attributes][0][blocks_learning_object_attributes][1][foo_attributes]
-      # ["route", "blocks", "blocks_learning_object", "foo"]
-      #
-      def lookup_model_names
-        child_index = @builder.options[:child_index]
-        names = object_name.to_s.scan(/([a-zA-Z_]+)/).flatten
-        names.delete(child_index) if child_index
-        names.each { |name| name.gsub!('_attributes', '') }
-      end
-
-      # The action to be used in lookup.
-      def lookup_action
-        action = template.controller.action_name
-        return unless action
-        action = action.to_sym
-        ACTIONS[action] || action
-      end
     end
   end
 end