simple_form 1.5.2 → 2.0.0

data/lib/generators/simple_form/install_generator.rb

@@ -3,7 +3,15 @@ module SimpleForm
     class InstallGenerator < Rails::Generators::Base
       desc "Copy SimpleForm default files"
       source_root File.expand_path('../templates', __FILE__)
-      class_option :template_engine
+      class_option :template_engine, :desc => 'Template engine to be invoked (erb, haml or slim).'
+      class_option :bootstrap, :type => :boolean, :desc => 'Add the Twitter Bootstrap wrappers to the SimpleForm initializer.'
+
+      def info_bootstrap
+        return if options.bootstrap?
+        puts "SimpleForm 2 supports Twitter bootstrap. In case you want to " \
+          "generate bootstrap configuration, please re-run this " \
+          "generator passing --bootstrap as option."
+      end
 
       def copy_config
         directory 'config'
@@ -13,6 +21,12 @@ module SimpleForm
         engine = options[:template_engine]
         copy_file "_form.html.#{engine}", "lib/templates/#{engine}/scaffold/_form.html.#{engine}"
       end
+
+      def show_readme
+        if behavior == :invoke && options.bootstrap?
+          readme "README"
+        end
+      end
     end
   end
 end

data/lib/generators/simple_form/templates/README

@@ -0,0 +1,12 @@
+===============================================================================
+
+  Be sure to have a copy of the Bootstrap stylesheet available on your
+  application, you can get it on http://twitter.github.com/bootstrap.
+
+  Inside your views, use the 'simple_form_for' with one of the Bootstrap form
+  classes, '.form-horizontal', '.form-inline', '.form-search' or
+  '.form-vertical', as the following:
+
+    = simple_form_for(@user, :html => {:class => 'form-horizontal' }) do |form|
+
+===============================================================================

data/lib/generators/simple_form/templates/_form.html.erb

@@ -1,13 +1,13 @@
 <%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
   <%%= f.error_notification %>
 
-  <div class="inputs">
+  <div class="form-inputs">
   <%- attributes.each do |attribute| -%>
     <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
   <%- end -%>
   </div>
 
-  <div class="actions">
+  <div class="form-actions">
     <%%= f.button :submit %>
   </div>
 <%% end %>

data/lib/generators/simple_form/templates/_form.html.haml

@@ -1,10 +1,10 @@
 = simple_form_for(@<%= singular_table_name %>) do |f|
   = f.error_notification
 
-  .inputs
+  .form-inputs
   <%- attributes.each do |attribute| -%>
     = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
   <%- end -%>
 
-  .actions
+  .form-actions
     = f.button :submit

data/lib/generators/simple_form/templates/_form.html.slim

@@ -1,10 +1,10 @@
 = simple_form_for(@<%= singular_table_name %>) do |f|
   = f.error_notification
 
-  .inputs
-  | <%- attributes.each do |attribute| -%>
+  .form-inputs
+<%- attributes.each do |attribute| -%>
     = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
-  | <%- end -%>
+<%- end -%>
 
-  .actions
+  .form-actions
     = f.button :submit

data/lib/generators/simple_form/templates/config/initializers/simple_form.rb.tt

@@ -0,0 +1,176 @@
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, :class => :input,
+    :hint_class => :field_with_hint, :error_class => :field_with_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input :placeholder => "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => :lookup`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable the lookup for any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    b.optional :maxlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    b.use :label_input
+    b.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
+    b.use :error, :wrap_with => { :tag => :span, :class => :error }
+  end
+<% if options.bootstrap? %>
+  config.wrappers :bootstrap, :tag => 'div', :class => 'control-group', :error_class => 'error' do |b|
+    b.use :placeholder
+    b.use :label
+    b.wrapper :tag => 'div', :class => 'controls' do |ba|
+      ba.use :input
+      ba.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
+      ba.use :hint,  :wrap_with => { :tag => 'p', :class => 'help-block' }
+    end
+  end
+
+  config.wrappers :prepend, :tag => 'div', :class => "control-group", :error_class => 'error' do |b|
+    b.use :placeholder
+    b.use :label
+    b.wrapper :tag => 'div', :class => 'controls' do |input|
+      input.wrapper :tag => 'div', :class => 'input-prepend' do |prepend|
+        prepend.use :input
+      end
+      input.use :hint,  :wrap_with => { :tag => 'span', :class => 'help-block' }
+      input.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
+    end
+  end
+
+  config.wrappers :append, :tag => 'div', :class => "control-group", :error_class => 'error' do |b|
+    b.use :placeholder
+    b.use :label
+    b.wrapper :tag => 'div', :class => 'controls' do |input|
+      input.wrapper :tag => 'div', :class => 'input-append' do |append|
+        append.use :input
+      end
+      input.use :hint,  :wrap_with => { :tag => 'span', :class => 'help-block' }
+      input.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
+    end
+  end
+
+  # Wrappers for forms and inputs using the Twitter Bootstrap toolkit.
+  # Check the Bootstrap docs (http://twitter.github.com/bootstrap)
+  # to learn about the different styles for forms and inputs,
+  # buttons and other elements.
+  config.default_wrapper = :bootstrap
+<% else %>
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+<% end %>
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   :inline => input + label
+  #   :nested => label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'alert alert-error'
+
+  # ID to add for error notification helper.
+  # config.error_notification_id = nil
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span. Please note that when using :boolean_style = :nested,
+  # SimpleForm will force this option to be a label.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  config.label_class = 'control-label'
+
+  # You can define the class to use on all forms. Default is simple_form.
+  # config.form_class = :simple_form
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use default HTML5 validations (novalidate option).
+  # Default is enabled.
+  config.browser_validations = false
+
+  # Collection of methods to detect if a file type was given.
+  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # Default size for text inputs.
+  # config.default_input_size = 50
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+end

data/lib/simple_form/action_view_extensions/builder.rb

@@ -1,9 +1,46 @@
 module SimpleForm
   module ActionViewExtensions
+    # Base builder to handle each instance of a collection of radio buttons / check boxes.
+    # Based on (at this time upcoming) Rails 4 collection builders.
+    class BuilderBase #:nodoc:
+      attr_reader :object, :text, :value
+
+      def initialize(template_object, object_name, method_name, object,
+                     sanitized_attribute_name, text, value, input_html_options)
+        @template_object = template_object
+        @object_name = object_name
+        @method_name = method_name
+        @object = object
+        @sanitized_attribute_name = sanitized_attribute_name
+        @text = text
+        @value = value
+        @input_html_options = input_html_options
+      end
+
+      def label(label_html_options={}, &block)
+        @template_object.label(@object_name, @sanitized_attribute_name, @text, label_html_options, &block)
+      end
+    end
+
+    # Handles generating an instance of radio + label for collection_radio_buttons.
+    class RadioButtonBuilder < BuilderBase #:nodoc:
+      def radio_button(extra_html_options={})
+        html_options = extra_html_options.merge(@input_html_options)
+        @template_object.radio_button(@object_name, @method_name, @value, html_options)
+      end
+    end
+
+    # Handles generating an instance of check box + label for collection_check_boxes.
+    class CheckBoxBuilder < BuilderBase #:nodoc:
+      def check_box(extra_html_options={})
+        html_options = extra_html_options.merge(@input_html_options)
+        @template_object.check_box(@object_name, @method_name, html_options, @value, nil)
+      end
+    end
+
     # A collection of methods required by simple_form but added to rails default form.
     # This means that you can use such methods outside simple_form context.
     module Builder
-
       # Create a collection of radio inputs for the attribute. Basically this
       # helper will create a radio input associated with a label for each
       # text/value option in the collection, using value_method and text_method
@@ -14,13 +51,24 @@ module SimpleForm
       # == Examples
       #
       #   form_for @user do |f|
-      #     f.collection_radio :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
+      #     f.collection_radio_buttons :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
       #   end
       #
       #   <input id="user_options_true" name="user[options]" type="radio" value="true" />
-      #   <label class="collection_radio" for="user_options_true">Yes</label>
+      #   <label class="collection_radio_buttons" for="user_options_true">Yes</label>
       #   <input id="user_options_false" name="user[options]" type="radio" value="false" />
-      #   <label class="collection_radio" for="user_options_false">No</label>
+      #   <label class="collection_radio_buttons" for="user_options_false">No</label>
+      #
+      # It is also possible to give a block that should generate the radio +
+      # label. To wrap the radio with the label, for instance:
+      #
+      #   form_for @user do |f|
+      #     f.collection_radio_buttons(
+      #       :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
+      #     ) do |b|
+      #       b.label { b.radio_button + b.text }
+      #     end
+      #   end
       #
       # == Options
       #
@@ -31,17 +79,37 @@ module SimpleForm
       #   * disabled => the value or values that should be disabled. Accepts a single
       #                 item or an array of items.
       #
-      #   * collection_wrapper_tag => the tag to wrap the entire collection.
+      #   * collection_wrapper_tag   => the tag to wrap the entire collection.
+      #
+      #   * collection_wrapper_class => the CSS class to use for collection_wrapper_tag
       #
-      #   * item_wrapper_tag       => the tag to wrap each item in the collection.
+      #   * item_wrapper_tag         => the tag to wrap each item in the collection.
       #
-      def collection_radio(attribute, collection, value_method, text_method, options={}, html_options={})
-        render_collection(
-          attribute, collection, value_method, text_method, options, html_options
-        ) do |value, text, default_html_options|
-          radio_button(attribute, value, default_html_options) +
-            label(sanitize_attribute_name(attribute, value), text, :class => "collection_radio")
+      #   * item_wrapper_class       => the CSS class to use for item_wrapper_tag
+      #
+      #   * a block                  => to generate the label + radio or any other component.
+      #
+      def collection_radio_buttons(attribute, collection, value_method, text_method, options={}, html_options={})
+        rendered_collection = render_collection(
+          collection, value_method, text_method, options, html_options
+        ) do |item, value, text, default_html_options|
+          builder = instantiate_builder(RadioButtonBuilder, attribute, item, value, text, default_html_options)
+
+          if block_given?
+            yield builder
+          else
+            builder.radio_button + builder.label(:class => "collection_radio_buttons")
+          end
         end
+
+        wrap_rendered_collection(rendered_collection, options)
+      end
+
+      # deprecated
+      def collection_radio(*args, &block)
+        SimpleForm.deprecation_warn "The `collection_radio` helper is deprecated, " \
+          "please use `collection_radio_buttons` instead."
+        collection_radio_buttons(*args, &block)
       end
 
       # Creates a collection of check boxes for each item in the collection,
@@ -63,32 +131,59 @@ module SimpleForm
       #   <input id="user_options_false" name="user[options][]" type="checkbox" value="false" />
       #   <label class="collection_check_boxes" for="user_options_false">No</label>
       #
+      # It is also possible to give a block that should generate the check box +
+      # label. To wrap the check box with the label, for instance:
+      #
+      #   form_for @user do |f|
+      #     f.collection_check_boxes(
+      #       :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
+      #     ) do |b|
+      #       b.label { b.check_box + b.text }
+      #     end
+      #   end
+      #
       # == Options
       #
       # Collection check box accepts some extra options:
       #
       #   * checked  => the value or values that should be checked initially. Accepts
-      #                 a single item or an array of items.
+      #                 a single item or an array of items. It overrides existing associations.
       #
       #   * disabled => the value or values that should be disabled. Accepts a single
       #                 item or an array of items.
       #
-      #   * collection_wrapper_tag => the tag to wrap the entire collection.
+      #   * collection_wrapper_tag   => the tag to wrap the entire collection.
+      #
+      #   * collection_wrapper_class => the CSS class to use for collection_wrapper_tag
+      #
+      #   * item_wrapper_tag         => the tag to wrap each item in the collection.
       #
-      #   * item_wrapper_tag       => the tag to wrap each item in the collection.
+      #   * item_wrapper_class       => the CSS class to use for item_wrapper_tag
+      #
+      #   * a block                  => to generate the label + check box or any other component.
       #
       def collection_check_boxes(attribute, collection, value_method, text_method, options={}, html_options={})
-        render_collection(
-          attribute, collection, value_method, text_method, options, html_options
-        ) do |value, text, default_html_options|
+        rendered_collection = render_collection(
+          collection, value_method, text_method, options, html_options
+        ) do |item, value, text, default_html_options|
           default_html_options[:multiple] = true
+          builder = instantiate_builder(CheckBoxBuilder, attribute, item, value, text, default_html_options)
 
-          check_box(attribute, default_html_options, value, '') +
-            label(sanitize_attribute_name(attribute, value), text, :class => "collection_check_boxes")
+          if block_given?
+            yield builder
+          else
+            builder.check_box + builder.label(:class => "collection_check_boxes")
+          end
         end
+
+        # Append a hidden field to make sure something will be sent back to the
+        # server if all checkboxes are unchecked.
+        hidden = template.hidden_field_tag("#{object_name}[#{attribute}][]", "", :id => nil)
+
+        wrap_rendered_collection(rendered_collection + hidden, options)
       end
 
-      # Wrapper for using simple form inside a default rails form.
+      # Wrapper for using SimpleForm inside a default rails form.
       # Example:
       #
       #   form_for @user do |f|
@@ -99,6 +194,8 @@ module SimpleForm
       #   end
       def simple_fields_for(*args, &block)
         options = args.extract_options!
+        options[:wrapper] ||= self.options[:wrapper]
+
         if self.class < ActionView::Helpers::FormBuilder
           options[:builder] ||= self.class
         else
@@ -107,7 +204,12 @@ module SimpleForm
         fields_for(*(args << options), &block)
       end
 
-    private
+      private
+
+      def instantiate_builder(builder_class, attribute, item, value, text, html_options)
+        builder_class.new(@template, object_name, attribute, item,
+                          sanitize_attribute_name(attribute, value), text, value, html_options)
+      end
 
       # Generate default options for collection helpers, such as :checked and
       # :disabled.
@@ -115,77 +217,122 @@ module SimpleForm
         html_options = html_options.dup
 
         [:checked, :selected, :disabled].each do |option|
-          next unless options[option]
+          next unless current_option = options[option]
 
-          accept = if options[option].respond_to?(:call)
-            options[option].call(item)
+          accept = if current_option.respond_to?(:call)
+            current_option.call(item)
           else
-            Array(options[option]).include?(value)
+            Array(current_option).include?(value)
           end
 
-          html_options[option] = true if accept
+          if accept
+            html_options[option] = true
+          elsif option == :checked
+            html_options[option] = false
+          end
         end
 
         html_options
       end
 
-      def sanitize_attribute_name(attribute, value)
+      def sanitize_attribute_name(attribute, value) #:nodoc:
         "#{attribute}_#{value.to_s.gsub(/\s/, "_").gsub(/[^-\w]/, "").downcase}"
       end
 
-      def render_collection(attribute, collection, value_method, text_method, options={}, html_options={}) #:nodoc:
-        collection_wrapper_tag = options.has_key?(:collection_wrapper_tag) ? options[:collection_wrapper_tag] : SimpleForm.collection_wrapper_tag
-        item_wrapper_tag = options.has_key?(:item_wrapper_tag) ? options[:item_wrapper_tag] : SimpleForm.item_wrapper_tag
+      def render_collection(collection, value_method, text_method, options={}, html_options={}) #:nodoc:
+        item_wrapper_tag   = options.fetch(:item_wrapper_tag, :span)
+        item_wrapper_class = options[:item_wrapper_class]
 
-        rendered_collection = collection.map do |item|
+        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, options, html_options)
 
-          rendered_item = yield value, text, default_html_options
+          rendered_item = yield item, value, text, default_html_options
 
-          item_wrapper_tag ? @template.content_tag(item_wrapper_tag, rendered_item) : rendered_item
+          item_wrapper_tag ? @template.content_tag(item_wrapper_tag, rendered_item, :class => item_wrapper_class) : rendered_item
         end.join.html_safe
-
-        collection_wrapper_tag ? @template.content_tag(collection_wrapper_tag, rendered_collection) : rendered_collection
       end
 
       def value_for_collection(item, value) #:nodoc:
         value.respond_to?(:call) ? value.call(item) : item.send(value)
       end
+
+      def wrap_rendered_collection(collection, options)
+        wrapper_tag = options[:collection_wrapper_tag]
+
+        if wrapper_tag
+          wrapper_class = options[:collection_wrapper_class]
+          @template.content_tag(wrapper_tag, collection, :class => wrapper_class)
+        else
+          collection
+        end
+      end
     end
   end
 end
 
-class ActionView::Helpers::FormBuilder
-  include SimpleForm::ActionViewExtensions::Builder
+module ActionView::Helpers
+  class FormBuilder
+    include SimpleForm::ActionViewExtensions::Builder
 
-  # Override default Rails collection_select helper to handle lambdas/procs in
-  # text and value methods, so it works the same way as collection_radio and
-  # collection_check_boxes in SimpleForm. If none of text/value methods is a
-  # callable object, then it just delegates back to original collection select.
-  #
-  alias :original_collection_select :collection_select
-  def collection_select(attribute, collection, value_method, text_method, options={}, html_options={})
-    if value_method.respond_to?(:call) || text_method.respond_to?(:call)
-      collection = collection.map do |item|
-        value = value_for_collection(item, value_method)
-        text  = value_for_collection(item, text_method)
+    # Override default Rails collection_select helper to handle lambdas/procs in
+    # text and value methods, so it works the same way as collection_radio_buttons
+    # and collection_check_boxes in SimpleForm. If none of text/value methods is a
+    # callable object, then it just delegates back to original collection select.
+    #
+    alias :original_collection_select :collection_select
+    def collection_select(attribute, collection, value_method, text_method, options={}, html_options={})
+      if value_method.respond_to?(:call) || text_method.respond_to?(:call)
+        collection = 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, options, html_options)
-        disabled = value if default_html_options[:disabled]
-        selected = value if default_html_options[:selected]
+          default_html_options = default_html_options_for_collection(item, value, options, html_options)
+          disabled = value if default_html_options[:disabled]
+          selected = value if default_html_options[:selected]
 
-        [value, text, selected, disabled]
-      end
+          [value, text, selected, disabled]
+        end
 
-      [:disabled, :selected].each do |option|
-        option_value    = collection.map(&:pop).compact
-        options[option] = option_value if option_value.present?
+        [:disabled, :selected].each do |option|
+          option_value    = collection.map(&:pop).compact
+          options[option] = option_value if option_value.present?
+        end
+        value_method, text_method = :first, :last
       end
-      value_method, text_method = :first, :last
+
+      original_collection_select(attribute, collection, value_method, text_method, options, html_options)
     end
+  end
 
-    original_collection_select(attribute, collection, value_method, text_method, options, html_options)
+  # Backport Rails fix to checkbox tag element, which does not generate the
+  # hidden input when given nil as unchecked value. This is to make SimpleForm
+  # collection check boxes helper to work fine with nested boolean style, when
+  # they are wrapped in labels. Without that, clicking in the label would
+  # actually change the hidden input, instead of the checkbox.
+  # FIXME: remove when support only Rails >= 3.2.2.
+  class InstanceTag
+    def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
+      options = options.stringify_keys
+      options["type"]     = "checkbox"
+      options["value"]    = checked_value
+      if options.has_key?("checked")
+        cv = options.delete "checked"
+        checked = cv == true || cv == "checked"
+      else
+        checked = self.class.check_box_checked?(value(object), checked_value)
+      end
+      options["checked"] = "checked" if checked
+      if options["multiple"]
+        add_default_name_and_id_for_value(checked_value, options)
+        options.delete("multiple")
+      else
+        add_default_name_and_id(options)
+      end
+      hidden = unchecked_value ? tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value, "disabled" => options["disabled"]) : "".html_safe
+      checkbox = tag("input", options)
+      hidden + checkbox
+    end
   end
 end