simple_form 2.0.0.rc → 2.0.0

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 2.0.0.rc
+## 2.0.0
 
 ### enhancements
   * Add `button_class` configuration to change the class of buttons. ([@sryche](https://github.com/sryche))
@@ -9,9 +9,6 @@
   * `simple_form_for` allows default options for its inputs `:defaults => {}`.
   * Add `readonly` as option of input method. ([@Untainted123](https://github.com/Untainted123))
   * `simple_fields_for` for inherits wrapper option form the form builder. ([@nashby](https://github.com/nashby))
-  * Deprecated part of the old configuration API in favor of the wrapper API which allows you to customize your inputs
-    in a more flexible way. See [this guide](https://github.com/plataformatec/simple_form/wiki/Upgrading-to-Simple-Form-2.0)
-    to know how upgrade.
   * Use action prefix in the form css class. Closes [#360](https://github.com/plataformatec/simple_form/issues/360).
     This is not backward compatible with the previous versions of SimpleForm.
     For more informations see [this comment](https://github.com/plataformatec/simple_form/issues/360#issuecomment-3000780).
@@ -25,20 +22,30 @@
   * Add `:boolean_style` config to change how check boxes and radios will be displayed.
     Options are `:inline = input + label` (default) and `:nested = label > input`.
   * Add possibility to give a block to `collection_radio` and `collection_check_boxes`,
-    to generate custom label and input structure. It is used internally with the :nested
-    option for `:boolean_style`, and is useful to allow some more customization if required.
+    yielding a custom builder to generate custom label and input structure. It
+    is used internally with the :nested option for `:boolean_style`, and is useful
+    to allow some more customization if required.
   * Do not generate hidden check box field when using nested boolean style, as it is considered
     invalid markup in HTML5. This will work by default in Rails > 3.2.1 (not released at this time),
     and is backported inside SimpleForm builder extensions.
     More info in [#215](https://github.com/plataformatec/simple_form/issues/215)
   * Add `item_wrapper_class` configuration option for collection radio buttons / check boxes inputs.
+  * Change default generator templates to use .form-inputs and .form-actions classes in wrapper divs.
+    (the latter is the default in bootstrap, so this makes it easier to integrate).
+  * Field error now accepts HTML tags ([@edison](https://github.com/edison))
+  * Add `generate_additional_classes_for` config option to selectively disable extra
+    css classes for components - wrapper, label and input. ([krzyzak](https://github.com/krzyzak))
 
 ### deprecation
+  * Deprecate part of the old configuration API in favor of the wrapper API which allows you to customize your inputs
+    in a more flexible way. See [this guide](https://github.com/plataformatec/simple_form/wiki/Upgrading-to-Simple-Form-2.0)
+    to know how upgrade.
   * Deprecate the `translate` configuration in favor of `translate_labels`
   * Deprecate the `html5` configuration in favor of a new `html5` component
   * Deprecate `:radio` input type in favor of `:radio_buttons`
   * Deprecate `collection_radio` form helper in favor of `collection_radio_buttons`
     (the label class has changed as well)
+  * Remove `error_notification_id` configuration
 
 ### bug fix
   * Fix i18n lookup with attributes with same name of models.
@@ -54,6 +61,9 @@
     Closes [#341](https://github.com/plataformatec/simple_form/issues/341). ([@nashby](https://github.com/nashby))
   * Move default attribute translations out of root - use "defaults" key instead
     Closes [#384](https://github.com/plataformatec/simple_form/issues/384). ([@fringd](https://github.com/fringd))
+  * Fix label to datetime inputs to point to first select. ([@georgehemmings](https://github.com/georgehemmings))
+  * Fix usage of f.button :button with Rails 3.2.
+    Closes [#449](https://github.com/plataformatec/simple_form/issues/449).
 
 ## 1.5.2
 

data/README.md

@@ -2,11 +2,15 @@
 [![Build Status](https://secure.travis-ci.org/plataformatec/simple_form.png)](http://travis-ci.org/plataformatec/simple_form)
 
 **SimpleForm** aims to be as flexible as possible while helping you with powerful components to create
-your forms. The basic goal of simple form is to not touch your way of defining the layout, letting
+your forms. The basic goal of SimpleForm is to not touch your way of defining the layout, letting
 you find the better design for your eyes. Most of the DSL was inherited from Formtastic,
 which we are thankful for and should make you feel right at home.
 
-INFO: This README is [also available in a friendly navigable format](http://simple-form.plataformatec.com.br/).
+INFO: This README is [also available in a friendly navigable format](http://simple-form.plataformatec.com.br/)
+and refers to **SimpleForm** 2.0. If you are using **SimpleForm** in the versions 1.x, you should
+check this branch:
+
+https://github.com/plataformatec/simple_form/tree/v1.5
 
 ## Installation
 
@@ -27,11 +31,6 @@ Also, if you want to use the country select, you will need the
 
 `gem 'country_select'`
 
-And you are ready to go. Since this branch aims Rails 3 support, if you want to use it with
-Rails 2.3 you should check this branch:
-
-`http://github.com/plataformatec/simple_form/tree/v1.0`
-
 ## Configuration
 
 **SimpleForm** has several configuration options. You can read and change them in the initializer
@@ -73,8 +72,8 @@ config.wrappers :tag => :div, :class => :input,
 
   # Form components
   b.use :label_input
-  b.use :hint,  :tag => :span, :class => :hint
-  b.use :error, :tag => :span, :class => :error
+  b.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
+  b.use :error, :wrap_with => { :tag => :span, :class => :error }
 end
 ```
 
@@ -89,9 +88,9 @@ You can create new _Form components_ using the wrappers API as in the following
 config.wrappers do |b|
   b.use :placeholder
   b.use :label_input
-  b.use :tag => :div, :class => 'separator' do |component|
-    component.use :hint,  :tag => :span, :class => :hint
-    component.use :error, :tag => :span, :class => :error
+  b.wrapper :tag => :div, :class => 'separator' do |component|
+    component.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
+    component.use :error, :wrap_with => { :tag => :span, :class => :error }
   end
 end
 ```
@@ -104,9 +103,9 @@ If you want to customize the custom _Form components_ on demand you can give it
 config.wrappers do |b|
   b.use :placeholder
   b.use :label_input
-  b.use :my_wrapper, :tag => :div, :class => 'separator' do |component|
-    component.use :hint,  :tag => :span, :class => :hint
-    component.use :error, :tag => :span, :class => :error
+  b.wrapper :my_wrapper, :tag => :div, :class => 'separator' do |component|
+    component.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
+    component.use :error, :wrap_with => { :tag => :span, :class => :error }
   end
 end
 ```
@@ -156,9 +155,9 @@ default values to `false` or use the `optional` method. Is preferible to use the
 config.wrappers :placeholder => false do |b|
   b.use :placeholder
   b.use :label_input
-  b.use :tag => :div, :class => 'separator' do |component|
-    component.optional :hint, :tag => :span, :class => :hint
-    component.use :error, :tag => :span, :class => :error
+  b.wrapper :tag => :div, :class => 'separator' do |component|
+    component.optional :hint, :wrap_with => { :tag => :span, :class => :hint }
+    component.use :error, :wrap_with => { :tag => :span, :class => :error }
   end
 end
 ```
@@ -486,7 +485,7 @@ on `simple_form_for` helper. They are listed below.
 
 ### Simple Fields For
 
-Wrapper to use simple form inside a default rails form
+Wrapper to use SimpleForm inside a default rails form
 
 ```ruby
 form_for @user do |f|

data/lib/generators/simple_form/install_generator.rb

@@ -8,7 +8,7 @@ module SimpleForm
 
       def info_bootstrap
         return if options.bootstrap?
-        puts "Simple Form 2 supports Twitter bootstrap. In case you want to " \
+        puts "SimpleForm 2 supports Twitter bootstrap. In case you want to " \
           "generate bootstrap configuration, please re-run this " \
           "generator passing --bootstrap as option."
       end

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

@@ -41,41 +41,41 @@ SimpleForm.setup do |config|
 
     ## Inputs
     b.use :label_input
-    b.use :hint,  :tag => :span, :class => :hint
-    b.use :error, :tag => :span, :class => :error
+    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, :class => 'control-label'
-    b.use :tag => 'div', :class => 'controls' do |ba|
+    b.use :label
+    b.wrapper :tag => 'div', :class => 'controls' do |ba|
       ba.use :input
-      ba.use :error, :tag => 'span', :class => 'help-inline'
-      ba.use :hint,  :tag => 'p', :class => 'help-block'
+      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, :class => 'control-label'
-    b.use :hint,  :tag => 'span', :class => 'help-block'
-    b.use :tag => 'div', :class => 'controls' do |input|
-      input.use :tag => 'div', :class => 'input-prepend' do |prepend|
+    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 :error, :tag => 'span', :class => 'help-inline'
+      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, :class => 'control-label'
-    b.use :hint,  :tag => 'span', :class => 'help-block'
-    b.use :tag => 'div', :class => 'controls' do |input|
-      input.use :tag => 'div', :class => 'input-append' do |append|
+    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 :error, :tag => 'span', :class => 'help-inline'
+      input.use :hint,  :wrap_with => { :tag => 'span', :class => 'help-block' }
+      input.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
     end
   end
 
@@ -101,10 +101,10 @@ SimpleForm.setup do |config|
   # config.error_method = :first
 
   # Default tag used for error notification helper.
-  # config.error_notification_tag = :p
+  config.error_notification_tag = :div
 
   # CSS class to add for error notification helper.
-  # config.error_notification_class = :error_notification
+  config.error_notification_class = 'alert alert-error'
 
   # ID to add for error notification helper.
   # config.error_notification_id = nil
@@ -133,11 +133,14 @@ SimpleForm.setup do |config|
   # config.label_text = lambda { |label, required| "#{required} #{label}" }
 
   # You can define the class to use on all labels. Default is nil.
-  # config.label_class = 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
 
@@ -168,6 +171,6 @@ SimpleForm.setup do |config|
   # Automatically discover new inputs in Rails' autoload path.
   # config.inputs_discovery = true
 
-  # Cache simple form inputs discovery
+  # Cache SimpleForm inputs discovery
   # config.cache_discovery = !Rails.env.development?
 end

data/lib/simple_form.rb

@@ -29,10 +29,6 @@ module SimpleForm
   mattr_accessor :error_notification_class
   @@error_notification_class = :error_notification
 
-  # ID to add for error notification helper.
-  mattr_accessor :error_notification_id
-  @@error_notification_id = nil
-
   # Series of attemps to detect a default label method for collection.
   mattr_accessor :collection_label_methods
   @@collection_label_methods = [ :to_label, :name, :title, :to_s ]
@@ -77,6 +73,10 @@ module SimpleForm
   mattr_accessor :form_class
   @@form_class = :simple_form
 
+  # You can define which elements should obtain additional classes
+  mattr_accessor :generate_additional_classes_for
+  @@generate_additional_classes_for = [:wrapper, :label, :input]
+
   # Whether attributes are required by default (or not).
   mattr_accessor :required_by_default
   @@required_by_default = true
@@ -116,7 +116,7 @@ module SimpleForm
   mattr_accessor :inputs_discovery
   @@inputs_discovery = true
 
-  # Cache simple form inputs discovery
+  # Cache SimpleForm inputs discovery
   mattr_accessor :cache_discovery
   @@cache_discovery = defined?(Rails) && !Rails.env.development?
 
@@ -169,13 +169,13 @@ module SimpleForm
     b.optional :readonly
 
     b.use :label_input
-    b.use :hint,  :tag => :span, :class => :hint
-    b.use :error, :tag => :span, :class => :error
+    b.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
+    b.use :error, :wrap_with => { :tag => :span, :class => :error }
   end
 
   ## SETUP
 
-  DEPRECATED = %w(hint_tag hint_class error_tag error_class wrapper_tag wrapper_class wrapper_error_class components html5)
+  DEPRECATED = %w(hint_tag hint_class error_tag error_class error_notification_id wrapper_tag wrapper_class wrapper_error_class components html5)
   @@deprecated = []
 
   DEPRECATED.each do |method|
@@ -197,13 +197,17 @@ module SimpleForm
     ActiveSupport::Deprecation.warn "[SIMPLE_FORM] #{message}", caller
   end
 
+  def self.additional_classes_for(component)
+    generate_additional_classes_for.include?(component) ? yield : []
+  end
+
   # Default way to setup SimpleForm. Run rails generate simple_form:install
   # to create a fresh initializer with all configuration values.
   def self.setup
     yield self
 
     unless @@deprecated.empty?
-      raise "[SIMPLE FORM] Your simple form initializer file is using the following methods: #{@@deprecated.to_sentence}. " <<
+      raise "[SIMPLE FORM] Your SimpleForm initializer file is using the following methods: #{@@deprecated.to_sentence}. " <<
         "Those methods are part of the outdated configuration API. Updating to the new API is easy and fast. " <<
         "Check for more info here: https://github.com/plataformatec/simple_form/wiki/Upgrading-to-Simple-Form-2.0"
     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
@@ -28,8 +65,8 @@ module SimpleForm
       #   form_for @user do |f|
       #     f.collection_radio_buttons(
       #       :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
-      #     ) do |label_for, text, value, html_options|
-      #       f.label(label_for) { f.radio_button(attribute, value, html_options) + text }
+      #     ) do |b|
+      #       b.label { b.radio_button + b.text }
       #     end
       #   end
       #
@@ -55,12 +92,13 @@ module SimpleForm
       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 |value, text, default_html_options|
+        ) do |item, value, text, default_html_options|
+          builder = instantiate_builder(RadioButtonBuilder, attribute, item, value, text, default_html_options)
+
           if block_given?
-            yield sanitize_attribute_name(attribute, value), text, value, default_html_options
+            yield builder
           else
-            radio_button(attribute, value, default_html_options) +
-              label(sanitize_attribute_name(attribute, value), text, :class => "collection_radio_buttons")
+            builder.radio_button + builder.label(:class => "collection_radio_buttons")
           end
         end
 
@@ -99,8 +137,8 @@ module SimpleForm
       #   form_for @user do |f|
       #     f.collection_check_boxes(
       #       :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
-      #     ) do |label_for, text, value, html_options|
-      #       f.label(label_for) { f.check_box(attribute, html_options, value, '') + text }
+      #     ) do |b|
+      #       b.label { b.check_box + b.text }
       #     end
       #   end
       #
@@ -127,14 +165,14 @@ module SimpleForm
       def collection_check_boxes(attribute, collection, value_method, text_method, options={}, html_options={})
         rendered_collection = render_collection(
           collection, value_method, text_method, options, html_options
-        ) do |value, text, default_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)
 
           if block_given?
-            yield sanitize_attribute_name(attribute, value), text, value, default_html_options
+            yield builder
           else
-            check_box(attribute, default_html_options, value, nil) +
-              label(sanitize_attribute_name(attribute, value), text, :class => "collection_check_boxes")
+            builder.check_box + builder.label(:class => "collection_check_boxes")
           end
         end
 
@@ -145,7 +183,7 @@ module SimpleForm
         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|
@@ -168,19 +206,23 @@ module SimpleForm
 
       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.
       def default_html_options_for_collection(item, value, options, html_options) #:nodoc:
         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
 
           if accept
@@ -206,7 +248,7 @@ module SimpleForm
           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, :class => item_wrapper_class) : rendered_item
         end.join.html_safe
@@ -288,9 +330,9 @@ module ActionView::Helpers
       else
         add_default_name_and_id(options)
       end
-      hidden = unchecked_value ? tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value, "disabled" => options["disabled"]) : ""
+      hidden = unchecked_value ? tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value, "disabled" => options["disabled"]) : "".html_safe
       checkbox = tag("input", options)
-      (hidden + checkbox).html_safe
+      hidden + checkbox
     end
   end
 end