simple_form 2.1.0 → 3.2.0

data/README.md

@@ -1,12 +1,16 @@
-# SimpleForm - Rails forms made easy.
-[![Build Status](https://secure.travis-ci.org/plataformatec/simple_form.png?branch=master)](http://travis-ci.org/plataformatec/simple_form)
+![Simple Form Logo](https://raw.github.com/plataformatec/simple_form/master/simple_form.png)
 
-**SimpleForm** aims to be as flexible as possible while helping you with powerful components to create
-your forms. The basic goal of SimpleForm is to not touch your way of defining the layout, letting
+By [Plataformatec](http://plataformatec.com.br/).
+
+Rails forms made easy.
+
+**Simple Form** 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
 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 refers to **SimpleForm** 2.1. For older releases, check the related branch for your version.
+INFO: This README is [also available in a friendly navigable format](http://simple-form.plataformatec.com.br/)
+and refers to **Simple Form** 3.1. For older releases, check the related branch for your version.
 
 ## Installation
 
@@ -28,52 +32,62 @@ Run the generator:
 rails generate simple_form:install
 ```
 
-Also, if you want to use the country select, you will need the
-[country_select gem](https://rubygems.org/gems/country_select), add it to your Gemfile:
-
-```ruby
-gem 'country_select'
-```
-
-### Twitter Bootstrap
+### Bootstrap
 
-**SimpleForm** 2.0 can be easily integrated to the [Twitter Bootstrap](http://twitter.github.com/bootstrap).
+**Simple Form** can be easily integrated to the [Bootstrap](http://getbootstrap.com/).
 To do that you have to use the `bootstrap` option in the install generator, like this:
 
 ```console
 rails generate simple_form:install --bootstrap
 ```
 
-You have to be sure that you added a copy of the [Twitter Bootstrap](http://twitter.github.com/bootstrap)
+You have to be sure that you added a copy of the [Bootstrap](http://getbootstrap.com/)
 assets on your application.
 
 For more information see the generator output, our
 [example application code](https://github.com/rafaelfranca/simple_form-bootstrap) and
 [the live example app](http://simple-form-bootstrap.plataformatec.com.br/).
 
-**NOTE**: **SimpleForm** integration requires Twitter Bootstrap version 2.0 or higher.
+### Zurb Foundation 5
 
-### Zurb Foundation 3
-
-To generate wrappers that are compatible with [Zurb Foundation 3](http://foundation.zurb.com/), pass the `foundation` option to the generator, like this:
+To generate wrappers that are compatible with [Zurb Foundation 5](http://foundation.zurb.com/), pass
+the `foundation` option to the generator, like this:
 
 ```console
 rails generate simple_form:install --foundation
 ```
 
-Please note that the Foundation wrapper does not support the `:hint` option by default. In order to enable hints, please uncomment the appropriate line in `config/initializers/simple_form_foundation.rb`. You will need to provide your own CSS styles for hints.
+Please note that the Foundation wrapper does not support the `:hint` option by default. In order to
+enable hints, please uncomment the appropriate line in `config/initializers/simple_form_foundation.rb`.
+You will need to provide your own CSS styles for hints.
+
+Please see the [instructions on how to install Foundation in a Rails app](http://foundation.zurb.com/docs/applications.html).
 
-Please see the [instructions on how to install Foundation in a Rails app](http://foundation.zurb.com/docs/rails.php).
+### Country Select
+
+If you want to use the country select, you will need the
+[country_select gem](https://rubygems.org/gems/country_select), add it to your Gemfile:
+
+```ruby
+gem 'country_select'
+```
+
+If you don't want to use the gem you can easily override this behaviour by mapping the
+country inputs to something else, with a line like this in your `simple_form.rb` initializer:
+
+```ruby
+config.input_mappings = { /country/ => :string }
+```
 
 ## Usage
 
-**SimpleForm** was designed to be customized as you need to. Basically it's a stack of components that
+**Simple Form** was designed to be customized as you need to. Basically it's a stack of components that
 are invoked to create a complete html input for you, which by default contains label, hints, errors
 and the input itself. It does not aim to create a lot of different logic from the default Rails
-form helpers, as they do a great work by themselves. Instead, **SimpleForm** acts as a DSL and just
+form helpers, as they do a great job by themselves. Instead, **Simple Form** acts as a DSL and just
 maps your input type (retrieved from the column definition in the database) to a specific helper method.
 
-To start using **SimpleForm** you just have to use the helper it provides:
+To start using **Simple Form** you just have to use the helper it provides:
 
 ```erb
 <%= simple_form_for @user do |f| %>
@@ -86,15 +100,15 @@ To start using **SimpleForm** you just have to use the helper it provides:
 This will generate an entire form with labels for user name and password as well, and render errors
 by default when you render the form with invalid data (after submitting for example).
 
-You can overwrite the default label by passing it to the input method. You can also add a hint or
-even a placeholder. For boolean inputs, you can add an inline label as well:
+You can overwrite the default label by passing it to the input method. You can also add a hint,
+an error, or even a placeholder. For boolean inputs, you can add an inline label as well:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :username, :label => 'Your username please' %>
-  <%= f.input :password, :hint => 'No special characters.' %>
-  <%= f.input :email, :placeholder => 'user@domain.com' %>
-  <%= f.input :remember_me, :inline_label => 'Yes, remember me' %>
+  <%= f.input :username, label: 'Your username please', error: 'Username is mandatory, please specify one' %>
+  <%= f.input :password, hint: 'No special characters.' %>
+  <%= f.input :email, placeholder: 'user@domain.com' %>
+  <%= f.input :remember_me, inline_label: 'Yes, remember me' %>
   <%= f.button :submit %>
 <% end %>
 ```
@@ -104,9 +118,9 @@ of any of them:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :username, :label_html => { :class => 'my_class' } %>
-  <%= f.input :password, :hint => false, :error_html => { :id => 'password_error'} %>
-  <%= f.input :password_confirmation, :label => false %>
+  <%= f.input :username, label_html: { class: 'my_class' } %>
+  <%= f.input :password, hint: false, error_html: { id: 'password_error'} %>
+  <%= f.input :password_confirmation, label: false %>
   <%= f.button :submit %>
 <% end %>
 ```
@@ -116,9 +130,9 @@ option, for instance:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :username, :input_html => { :class => 'special' } %>
-  <%= f.input :password, :input_html => { :maxlength => 20 } %>
-  <%= f.input :remember_me, :input_html => { :value => '1' } %>
+  <%= f.input :username, input_html: { class: 'special' } %>
+  <%= f.input :password, input_html: { maxlength: 20 } %>
+  <%= f.input :remember_me, input_html: { value: '1' } %>
   <%= f.button :submit %>
 <% end %>
 ```
@@ -128,80 +142,90 @@ you can use the `:defaults` option in `simple_form_for`. Specific options in `in
 overwrite the defaults:
 
 ```erb
-<%= simple_form_for @user, :defaults => { :input_html => { :class => 'default_class' } } do |f| %>
-  <%= f.input :username, :input_html => { :class => 'special' } %>
-  <%= f.input :password, :input_html => { :maxlength => 20 } %>
-  <%= f.input :remember_me, :input_html => { :value => '1' } %>
+<%= simple_form_for @user, defaults: { input_html: { class: 'default_class' } } do |f| %>
+  <%= f.input :username, input_html: { class: 'special' } %>
+  <%= f.input :password, input_html: { maxlength: 20 } %>
+  <%= f.input :remember_me, input_html: { value: '1' } %>
   <%= f.button :submit %>
 <% end %>
 ```
 
-Since **SimpleForm** generates a wrapper div around your label and input by default, you can pass
+Since **Simple Form** generates a wrapper div around your label and input by default, you can pass
 any html attribute to that wrapper as well using the `:wrapper_html` option, like so:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :username, :wrapper_html => { :class => 'username' } %>
-  <%= f.input :password, :wrapper_html => { :id => 'password' } %>
-  <%= f.input :remember_me, :wrapper_html => { :class => 'options' } %>
+  <%= f.input :username, wrapper_html: { class: 'username' } %>
+  <%= f.input :password, wrapper_html: { id: 'password' } %>
+  <%= f.input :remember_me, wrapper_html: { class: 'options' } %>
   <%= f.button :submit %>
 <% end %>
 ```
 
 Required fields are marked with an * prepended to their labels.
 
-By default all inputs are required. When the form object has `presence` validations attached to its fields, **SimpleForm** tells required and optional fields apart. For performance reasons, this detection is skipped on validations that make use of conditional options, such as `:if` and `:unless`.
+By default all inputs are required. When the form object has `presence` validations attached to its
+fields, **Simple Form** tells required and optional fields apart. For performance reasons, this
+detection is skipped on validations that make use of conditional options, such as `:if` and `:unless`.
 
 And of course, the `required` property of any input can be overwritten as needed:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :name, :required => false %>
+  <%= f.input :name, required: false %>
   <%= f.input :username %>
   <%= f.input :password %>
   <%= f.button :submit %>
 <% end %>
 ```
 
-**SimpleForm** also lets you overwrite the default input type it creates:
+By default, **Simple Form** will look at the column type in the database and use an
+appropriate input for the column. For example, a column created with type
+`:text` in the database will use a `textarea` input by default. See the section
+[Available input types and defaults for each column
+type](https://github.com/plataformatec/simple_form#available-input-types-and-defaults-for-each-column-type)
+for a complete list of defaults.
+
+**Simple Form** also lets you overwrite the default input type it creates:
 
 ```erb
 <%= simple_form_for @user do |f| %>
   <%= f.input :username %>
   <%= f.input :password %>
-  <%= f.input :description, :as => :text %>
-  <%= f.input :accepts,     :as => :radio_buttons %>
+  <%= f.input :description, as: :text %>
+  <%= f.input :accepts,     as: :radio_buttons %>
   <%= f.button :submit %>
 <% end %>
 ```
 
 So instead of a checkbox for the *accepts* attribute, you'll have a pair of radio buttons with yes/no
-labels and a text area instead of a text field for the description. You can also render boolean
-attributes using `:as => :select` to show a dropdown.
+labels and a textarea instead of a text field for the description. You can also render boolean
+attributes using `as: :select` to show a dropdown.
 
-It is also possible to give the `:disabled` option to **SimpleForm**, and it'll automatically mark
-the wrapper as disabled with a css class, so you can style labels, hints and other components inside
+It is also possible to give the `:disabled` option to **Simple Form**, and it'll automatically mark
+the wrapper as disabled with a CSS class, so you can style labels, hints and other components inside
 the wrapper as well:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :username, :disabled => true, :hint => 'You cannot change your username.' %>
+  <%= f.input :username, disabled: true, hint: 'You cannot change your username.' %>
   <%= f.button :submit %>
 <% end %>
 ```
 
-**SimpleForm** accepts same options as their corresponding input type helper in Rails:
+**Simple Form** accepts same options as their corresponding input type helper in Rails:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :date_of_birth, :as => :date, :start_year => Date.today.year - 90,
-                              :end_year => Date.today.year - 12, :discard_day => true,
-                              :order => [:month, :year] %>
+  <%= f.input :date_of_birth, as: :date, start_year: Date.today.year - 90,
+                              end_year: Date.today.year - 12, discard_day: true,
+                              order: [:month, :year] %>
+  <%= f.input :accepts, as: :boolean, checked_value: true, unchecked_value: false %>
   <%= f.button :submit %>
 <% end %>
 ```
 
-**SimpleForm** also allows you to use label, hint, input_field, error and full_error helpers
+**Simple Form** also allows you to use label, hint, input_field, error and full_error helpers
 (please take a look at the rdocs for each method for more info):
 
 ```erb
@@ -209,7 +233,7 @@ the wrapper as well:
   <%= f.label :username %>
   <%= f.input_field :username %>
   <%= f.hint 'No special characters, please!' %>
-  <%= f.error :username, :id => 'user_name_error' %>
+  <%= f.error :username, id: 'user_name_error' %>
   <%= f.full_error :token %>
   <%= f.submit 'Save' %>
 <% end %>
@@ -217,6 +241,61 @@ the wrapper as well:
 
 Any extra option passed to these methods will be rendered as html option.
 
+### Stripping away all wrapper divs
+
+**Simple Form** also allows you to strip away all the div wrappers around the `<input>` field that is
+generated with the usual `f.input`.
+The easiest way to achieve this is to use `f.input_field`.
+
+Example:
+
+```ruby
+simple_form_for @user do |f|
+  f.input_field :name
+  f.input_field :remember_me, as: :boolean
+end
+```
+
+```html
+<form>
+  ...
+  <input class="string required" id="user_name" maxlength="255" name="user[name]" size="255" type="text">
+  <input name="user[remember_me]" type="hidden" value="0">
+  <label class="checkbox">
+    <input class="boolean optional" id="user_published" name="user[remember_me]" type="checkbox" value="1">
+  </label>
+</form>
+```
+
+For check boxes and radio buttons you can remove the label changing `boolean_style` from default value `:nested` to `:inline`.
+
+Example:
+
+```ruby
+simple_form_for @user do |f|
+  f.input_field :name
+  f.input_field :remember_me, as: :boolean, boolean_style: :inline
+end
+```
+
+```html
+<form>
+  ...
+  <input class="string required" id="user_name" maxlength="255" name="user[name]" size="255" type="text">
+  <input name="user[remember_me]" type="hidden" value="0">
+  <input class="boolean optional" id="user_remember_me" name="user[remember_me]" type="checkbox" value="1">
+</form>
+```
+
+Produces:
+
+```html
+<input class="string required" id="user_name" maxlength="100"
+   name="user[name]" size="100" type="text" value="Carlos" />
+```
+
+To view the actual RDocs for this, check them out here - http://rubydoc.info/github/plataformatec/simple_form/master/SimpleForm/FormBuilder:input_field
+
 ### Collections
 
 And what if you want to create a select containing the age from 18 to 60 in your form? You can do it
@@ -225,22 +304,22 @@ overriding the `:collection` option:
 ```erb
 <%= simple_form_for @user do |f| %>
   <%= f.input :user %>
-  <%= f.input :age, :collection => 18..60 %>
+  <%= f.input :age, collection: 18..60 %>
   <%= f.button :submit %>
 <% end %>
 ```
 
 Collections can be arrays or ranges, and when a `:collection` is given the `:select` input will be
-rendered by default, so we don't need to pass the `:as => :select` option. Other types of collection
-are `:radio_buttons` and `:check_boxes`. Those are added by **SimpleForm** to Rails set of form
-helpers (read Extra Helpers session below for more information).
+rendered by default, so we don't need to pass the `as: :select` option. Other types of collection
+are `:radio_buttons` and `:check_boxes`. Those are added by **Simple Form** to Rails set of form
+helpers (read Extra Helpers section below for more information).
 
 Collection inputs accept two other options beside collections:
 
-* _label_method_ => the label method to be applied to the collection to retrieve the label (use this
+* *label_method* => the label method to be applied to the collection to retrieve the label (use this
   instead of the `text_method` option in `collection_select`)
 
-* _value_method_ => the value method to be applied to the collection to retrieve the value
+* *value_method* => the value method to be applied to the collection to retrieve the value
 
 Those methods are useful to manipulate the given collection. Both of these options also accept
 lambda/procs in case you want to calculate the value or label in a special way eg. custom
@@ -248,49 +327,50 @@ translation. All other options given are sent straight to the underlying helper.
 can give prompt as:
 
 ```ruby
-f.input :age, :collection => 18..60, :prompt => "Select your age"
+f.input :age, collection: 18..60, prompt: "Select your age", selected: 21
 ```
+Extra options are passed into helper [`collection_select`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select).
 
 It is also possible to create grouped collection selects, that will use the html *optgroup* tags, like this:
 
 ```ruby
-f.input :country_id, :collection => @continents, :as => :grouped_select, :group_method => :countries
+f.input :country_id, collection: @continents, as: :grouped_select, group_method: :countries
 ```
 
 Grouped collection inputs accept the same `:label_method` and `:value_method` options, which will be
 used to retrieve label/value attributes for the `option` tags. Besides that, you can give:
 
-* _group_method_ => the method to be called on the given collection to generate the options for
+* *group_method* => the method to be called on the given collection to generate the options for
   each group (required)
 
-* _group_label_method_ => the label method to be applied on the given collection to retrieve the label
-  for the _optgroup_ (**SimpleForm** will attempt to guess the best one the same way it does with
+* *group_label_method* => the label method to be applied on the given collection to retrieve the label
+  for the _optgroup_ (**Simple Form** will attempt to guess the best one the same way it does with
   `:label_method`)
 
 ### Priority
 
-**SimpleForm** also supports `:time_zone` and `:country`. When using such helpers, you can give
-`:priority` as option to select which time zones and/or countries should be given higher priority:
+**Simple Form** also supports `:time_zone` and `:country`. When using such helpers, you can give
+`:priority` as an option to select which time zones and/or countries should be given higher priority:
 
 ```ruby
-f.input :residence_country, :priority => [ "Brazil" ]
-f.input :time_zone, :priority => /US/
+f.input :residence_country, priority: [ "Brazil" ]
+f.input :time_zone, priority: /US/
 ```
 
-Those values can also be configured with a default value to be used site use through the
+Those values can also be configured with a default value to be used on the site through the
 `SimpleForm.country_priority` and `SimpleForm.time_zone_priority` helpers.
 
 Note: While using `country_select` if you want to restrict to only a subset of countries for a specific
 drop down then you may use the `:collection` option:
 
 ```ruby
-f.input :shipping_country, :priority => [ "Brazil" ], :collection => [ "Australia", "Brazil", "New Zealand"]
+f.input :shipping_country, priority: [ "Brazil" ], collection: [ "Australia", "Brazil", "New Zealand"]
 ```
 
 ### Associations
 
-To deal with associations, **SimpleForm** can generate select inputs, a series of radios buttons or check boxes.
-Lets see how it works: imagine you have a user model that belongs to a company and has_and_belongs_to_many
+To deal with associations, **Simple Form** can generate select inputs, a series of radios buttons or checkboxes.
+Lets see how it works: imagine you have a user model that belongs to a company and `has_and_belongs_to_many`
 roles. The structure would be something like:
 
 ```ruby
@@ -321,11 +401,11 @@ Now we have the user form:
 
 Simple enough, right? This is going to render a `:select` input for choosing the `:company`, and another
 `:select` input with `:multiple` option for the `:roles`. You can, of course, change it to use radio
-buttons and check boxes as well:
+buttons and checkboxes as well:
 
 ```ruby
-f.association :company, :as => :radio_buttons
-f.association :roles,   :as => :check_boxes
+f.association :company, as: :radio_buttons
+f.association :roles,   as: :check_boxes
 ```
 
 The association helper just invokes `input` under the hood, so all options available to `:select`,
@@ -333,18 +413,21 @@ The association helper just invokes `input` under the hood, so all options avail
 the collection by hand, all together with the prompt:
 
 ```ruby
-f.association :company, :collection => Company.active.all(:order => 'name'), :prompt => "Choose a Company"
+f.association :company, collection: Company.active.order(:name), prompt: "Choose a Company"
 ```
 
 In case you want to declare different labels and values:
 
 ```ruby
-f.association :company, :label_method => :company_name, :value_method => :id, :include_blank => false
+f.association :company, label_method: :company_name, value_method: :id, include_blank: false
 ```
 
+Please note that the association helper is currently only tested with Active Record. It currently
+does not work well with Mongoid and depending on the ORM you're using your mileage may vary.
+
 ### Buttons
 
-All web forms need buttons, right? **SimpleForm** wraps them in the DSL, acting like a proxy:
+All web forms need buttons, right? **Simple Form** wraps them in the DSL, acting like a proxy:
 
 ```erb
 <%= simple_form_for @user do |f| %>
@@ -355,14 +438,30 @@ All web forms need buttons, right? **SimpleForm** wraps them in the DSL, acting
 
 The above will simply call submit. You choose to use it or not, it's just a question of taste.
 
+The button method also accepts optional parameters, that are delegated to the underlying submit call:
+
+```erb
+<%= f.button :submit, "Custom Button Text", class: "my-button" %>
+```
+
+To create a `<button>` element, use the following syntax:
+
+```erb
+<%= f.button :button, "Custom Button Text" %>
+
+<%= f.button :button do %>
+  Custom Button Text
+<% end %>
+```
+
 ### Wrapping Rails Form Helpers
 
-Say you wanted to use a rails form helper but still wrap it in **SimpleForm** goodness? You can, by
+Say you wanted to use a rails form helper but still wrap it in **Simple Form** goodness? You can, by
 calling input with a block like so:
 
 ```erb
 <%= f.input :role do %>
-  <%= f.select :role, Role.all.map { |r| [r.name, r.id, { :class => r.company.id }] }, :include_blank => true %>
+  <%= f.select :role, Role.all.map { |r| [r.name, r.id, { class: r.company.id }] }, include_blank: true %>
 <% end %>
 ```
 
@@ -371,12 +470,12 @@ hash of additional attributes for each option.
 
 ### Extra helpers
 
-**SimpleForm** also comes with some extra helpers you can use inside rails default forms without relying
+**Simple Form** also comes with some extra helpers you can use inside rails default forms without relying
 on `simple_form_for` helper. They are listed below.
 
 #### Simple Fields For
 
-Wrapper to use **SimpleForm** inside a default rails form. It works in the same way that the `field_for`
+Wrapper to use **Simple Form** inside a default rails form. It works in the same way that the `fields_for`
 Rails helper, but change the builder to use the `SimpleForm::FormBuilder`.
 
 ```ruby
@@ -388,7 +487,6 @@ form_for @user do |f|
 end
 ```
 
-
 #### Collection Radio Buttons
 
 Creates a collection of radio inputs with labels associated (same API as `collection_select`):
@@ -408,7 +506,7 @@ end
 
 #### Collection Check Boxes
 
-Creates a collection of check boxes with labels associated (same API as `collection_select`):
+Creates a collection of checkboxes with labels associated (same API as `collection_select`):
 
 ```ruby
 form_for @user do |f|
@@ -433,47 +531,50 @@ form_for @user do |f|
 end
 ```
 
-## Mappings/Inputs available
-
-**SimpleForm** comes with a lot of default mappings:
-
-```text
-Mapping               Input                         Column Type
-
-boolean               check box                     boolean
-string                text field                    string
-email                 email field                   string with name matching "email"
-url                   url field                     string with name matching "url"
-tel                   tel field                     string with name matching "phone"
-password              password field                string with name matching "password"
-search                search                        -
-text                  text area                     text
-file                  file field                    string, responding to file methods
-hidden                hidden field                  -
-integer               number field                  integer
-float                 number field                  float
-decimal               number field                  decimal
-range                 range field                   -
-datetime              datetime select               datetime/timestamp
-date                  date select                   date
-time                  time select                   time
-select                collection select             belongs_to/has_many/has_and_belongs_to_many associations
-radio_buttons         collection radio buttons      belongs_to
-check_boxes           collection check boxes        has_many/has_and_belongs_to_many associations
-country               country select                string with name matching "country"
-time_zone             time zone select              string with name matching "time_zone"
-```
+## Available input types and defaults for each column type
+
+The following table shows the html element you will get for each attribute
+according to its database definition. These defaults can be changed by
+specifying the helper method in the column `Mapping` as the `as:` option.
+
+     Mapping         | Generated HTML Element               | Database Column Type
+     --------------- |:-------------------------------------|:--------------------
+     `boolean`       | `input[type=checkbox]`               | `boolean`
+     `string`        | `input[type=text]`                   | `string`
+     `email`         | `input[type=email]`                  | `string` with `name =~ /email/`
+     `url`           | `input[type=url]`                    | `string` with `name =~ /url/`
+     `tel`           | `input[type=tel]`                    | `string` with `name =~ /phone/`
+     `password`      | `input[type=password]`               | `string` with `name =~ /password/`
+     `search`        | `input[type=search]`                 | -
+     `uuid`          | `input[type=text]`                   | `uuid`
+     `text`          | `textarea`                           | `text`
+     `file`          | `input[type=file]`                   | `string` responding to file methods
+     `hidden`        | `input[type=hidden]`                 | -
+     `integer`       | `input[type=number]`                 | `integer`
+     `float`         | `input[type=number]`                 | `float`
+     `decimal`       | `input[type=number]`                 | `decimal`
+     `range`         | `input[type=range]`                  | -
+     `datetime`      | `datetime select`                    | `datetime/timestamp`
+     `date`          | `date select`                        | `date`
+     `time`          | `time select`                        | `time`
+     `select`        | `select`                             | `belongs_to`/`has_many`/`has_and_belongs_to_many` associations
+     `radio_buttons` | collection of `input[type=radio]`    | `belongs_to` associations
+     `check_boxes`   | collection of `input[type=checkbox]` | `has_many`/`has_and_belongs_to_many` associations
+     `country`       | `select` (countries as options)      | `string` with `name =~ /country/`
+     `time_zone`     | `select` (timezones as options)      | `string` with `name =~ /time_zone/`
 
 ## Custom inputs
 
-It is very easy to add custom inputs to **SimpleForm**. For instance, if you want to add a custom input
+It is very easy to add custom inputs to **Simple Form**. For instance, if you want to add a custom input
 that extends the string one, you just need to add this file:
 
 ```ruby
 # app/inputs/currency_input.rb
 class CurrencyInput < SimpleForm::Inputs::Base
-  def input
-    "$ #{@builder.text_field(attribute_name, input_html_options)}".html_safe
+  def input(wrapper_options)
+    merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+    "$ #{@builder.text_field(attribute_name, merged_input_options)}".html_safe
   end
 end
 ```
@@ -481,16 +582,17 @@ end
 And use it in your views:
 
 ```ruby
-f.input :money, :as => :currency
+f.input :money, as: :currency
 ```
+Note, you may have to create the `app/inputs/` directory and restart your webserver.
 
-You can also redefine existing **SimpleForm** inputs by creating a new class with the same name. For
+You can also redefine existing **Simple Form** inputs by creating a new class with the same name. For
 instance, if you want to wrap date/time/datetime in a div, you can do:
 
 ```ruby
 # app/inputs/date_time_input.rb
 class DateTimeInput < SimpleForm::Inputs::DateTimeInput
-  def input
+  def input(wrapper_options)
     template.content_tag(:div, super)
   end
 end
@@ -507,16 +609,38 @@ class CollectionSelectInput < SimpleForm::Inputs::CollectionSelectInput
 end
 ```
 
+If needed, you can namespace your custom inputs in a module and tell **Simple Form** to look for
+their definitions in this module. This can avoid conflicts with other form libraries (like Formtastic) that look up
+the global context to find inputs definition too.
+
+```ruby
+# app/inputs/custom_inputs/numeric_input
+module CustomInputs
+  class NumericInput < SimpleForm::Inputs::NumericInput
+    def input_html_classes
+      super.push('no-spinner')
+    end
+  end
+end
+```
+
+And in the **SimpleForm** initializer :
+
+```ruby
+# config/simple_form.rb
+config.custom_inputs_namespaces << "CustomInputs"
+```
+
 ## Custom form builder
 
-You can create a custom form builder that uses **SimpleForm**.
+You can create a custom form builder that uses **Simple Form**.
 
 Create a helper method that calls `simple_form_for` with a custom builder:
 
 ```ruby
 def custom_form_for(object, *args, &block)
   options = args.extract_options!
-  simple_form_for(object, *(args << options.merge(:builder => CustomFormBuilder)), &block)
+  simple_form_for(object, *(args << options.merge(builder: CustomFormBuilder)), &block)
 end
 ```
 
@@ -525,15 +649,14 @@ Create a form builder class that inherits from `SimpleForm::FormBuilder`.
 ```ruby
 class CustomFormBuilder < SimpleForm::FormBuilder
   def input(attribute_name, options = {}, &block)
-    options[:input_html].merge! :class => 'custom'
-    super
+    super(attribute_name, options.merge(label: false), &block)
   end
 end
 ```
 
 ## I18n
 
-**SimpleForm** uses all power of I18n API to lookup labels, hints and placeholders. To customize your
+**Simple Form** uses all power of I18n API to lookup labels, hints, prompts and placeholders. To customize your
 forms you can create a locale file like this:
 
 ```yaml
@@ -551,12 +674,18 @@ en:
       user:
         username: 'Your username'
         password: '****'
+    include_blanks:
+      user:
+        age: 'Rather not say'
+    prompts:
+      user:
+        gender: 'Select your gender'
 ```
 
 And your forms will use this information to render the components for you.
 
-**SimpleForm** also lets you be more specific, separating lookups through actions for labels, hints and
-placeholders. Let's say you want a different label for new and edit actions, the locale file would
+**Simple Form** also lets you be more specific, separating lookups through actions.
+Let's say you want a different label for new and edit actions, the locale file would
 be something like:
 
 ```yaml
@@ -571,7 +700,7 @@ en:
           password: 'Change password'
 ```
 
-This way **SimpleForm** will figure out the right translation for you, based on the action being
+This way **Simple Form** will figure out the right translation for you, based on the action being
 rendered. And to be a little bit DRYer with your locale file, you can specify defaults for all
 models under the 'defaults' key:
 
@@ -594,24 +723,30 @@ en:
         password: '****'
 ```
 
-**SimpleForm** will always look for a default attribute translation under the "defaults" key if no
-specific is found inside the model key. Note that this syntax is different from 1.x. To migrate to
-the new syntax, just move "labels.#{attribute}" to "labels.defaults.#{attribute}".
+**Simple Form** will always look for a default attribute translation under the "defaults" key if no
+specific is found inside the model key.
 
-In addition, **SimpleForm** will fallback to default human_attribute_name from Rails when no other
+In addition, **Simple Form** will fallback to default `human_attribute_name` from Rails when no other
 translation is found for labels. Finally, you can also overwrite any label, hint or placeholder
 inside your view, just by passing the option manually. This way the I18n lookup will be skipped.
 
-**SimpleForm** also has support for translating options in collection helpers. For instance, given a
+For `:prompt` and `:include_blank` the I18n lookup is optional and to enable it is necessary to pass
+`:translate` as value.
+
+```ruby
+f.input :gender, prompt: :translate
+```
+
+**Simple Form** also has support for translating options in collection helpers. For instance, given a
 User with a `:gender` attribute, you might want to create a select box showing translated labels
-that would post either `male` or `female` as value. With **SimpleForm** you could create an input
+that would post either `male` or `female` as value. With **Simple Form** you could create an input
 like this:
 
 ```ruby
-f.input :gender, :collection => [:male, :female]
+f.input :gender, collection: [:male, :female]
 ```
 
-And **SimpleForm** will try a lookup like this in your locale file, to find the right labels to show:
+And **Simple Form** will try a lookup like this in your locale file, to find the right labels to show:
 
 ```yaml
 en:
@@ -624,7 +759,7 @@ en:
 ```
 
 You can also use the `defaults` key as you would do with labels, hints and placeholders. It is
-important to notice that **SimpleForm** will only do the lookup for options if you give a collection
+important to notice that **Simple Form** will only do the lookup for options if you give a collection
 composed of symbols only. This is to avoid constant lookups to I18n.
 
 It's also possible to translate buttons, using Rails' built-in I18n support:
@@ -667,27 +802,43 @@ en:
             name: Name
 ```
 
-This difference exists because **SimpleForm** relies on `object_name` provided by Rails'
+This difference exists because **Simple Form** relies on `object_name` provided by Rails'
 FormBuilder to determine the translation path for a given object instead of `i18n_key` from the
 object itself. Thus, similarly, if a form for an `Admin::User` object is defined by calling
-`simple_form_for @admin_user, :as => :some_user`, **SimpleForm** will look for translations
+`simple_form_for @admin_user, as: :some_user`, **Simple Form** will look for translations
 under `some_user` instead of `admin_user`.
 
+When translate `simple_fields_for` attributes be sure to use the same name you pass to it, e.g. `simple_fields_for :posts` should be placed under `posts` not `post`:
+
+```yaml
+en:
+  simple_form:
+    labels:
+      posts:
+        title: 'Post title'
+    hints:
+      posts:
+        title: 'A good title'
+    placeholders:
+      posts:
+        title: 'Once upon a time...'
+```
+
 ## Configuration
 
-**SimpleForm** has several configuration options. You can read and change them in the initializer
-created by **SimpleForm**, so if you haven't executed the command below yet, please do:
+**Simple Form** has several configuration options. You can read and change them in the initializer
+created by **Simple Form**, so if you haven't executed the command below yet, please do:
 
 `rails generate simple_form:install`
 
 ### The wrappers API
 
-With **SimpleForm** you can configure how your components will be rendered using the wrappers API.
+With **Simple Form** you can configure how your components will be rendered using the wrappers API.
 The syntax looks like this:
 
 ```ruby
-config.wrappers :tag => :div, :class => :input,
-                :error_class => :field_with_errors do |b|
+config.wrappers tag: :div, class: :input,
+                error_class: :field_with_errors do |b|
 
   # Form extensions
   b.use :html5
@@ -698,12 +849,13 @@ config.wrappers :tag => :div, :class => :input,
 
   # Form components
   b.use :label_input
-  b.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
-  b.use :error, :wrap_with => { :tag => :span, :class => :error }
+  b.use :hint,  wrap_with: { tag: :span, class: :hint }
+  b.use :error, wrap_with: { tag: :span, class: :error }
 end
 ```
 
-The _Form components_ will generate the form tags like labels, inputs, hints or errors contents. The available components are:
+The _Form components_ will generate the form tags like labels, inputs, hints or errors contents.
+The available components are:
 
 ```ruby
 :label         # The <label> tag alone
@@ -722,24 +874,34 @@ 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.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 }
+  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
 ```
 
 this will wrap the hint and error components within a `div` tag using the class `'separator'`.
 
+You can customize _Form components_ passing options to them:
+
+```ruby
+config.wrappers do |b|
+  b.use :label_input, class: 'label-input-class'
+end
+```
+
+This you set the input and label class to `'label-input-class'`.
+
 If you want to customize the custom _Form components_ on demand you can give it a name like this:
 
 ```ruby
 config.wrappers do |b|
   b.use :placeholder
   b.use :label_input
-  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 }
+  b.wrapper :my_wrapper, tag: :div, class: 'separator', html: { id: 'my_wrapper_id' } do |component|
+    component.use :hint,  wrap_with: { tag: :span, class: :hint }
+    component.use :error, wrap_with: { tag: :span, class: :error }
   end
 end
 ```
@@ -748,13 +910,13 @@ and now you can pass options to your `input` calls to customize the `:my_wrapper
 
 ```ruby
 # Completely turns off the custom wrapper
-f.input :name, :my_wrapper => false
+f.input :name, my_wrapper: false
 
 # Configure the html
-f.input :name, :my_wrapper_html => { :id => 'special_id' }
+f.input :name, my_wrapper_html: { id: 'special_id' }
 
 # Configure the tag
-f.input :name, :my_wrapper_tag => :p
+f.input :name, my_wrapper_tag: :p
 ```
 
 You can also define more than one wrapper and pick one to render in a specific form or input.
@@ -771,37 +933,46 @@ and use it in this way:
 
 ```ruby
 # Specifying to whole form
-simple_form_for @user, :wrapper => :small do |f|
+simple_form_for @user, wrapper: :small do |f|
   f.input :name
 end
 
 # Specifying to one input
 simple_form_for @user do |f|
-  f.input :name, :wrapper => :small
+  f.input :name, wrapper: :small
 end
 ```
 
-**SimpleForm** also allows you to use optional elements. For instance, let's suppose you want to use
+**Simple Form** also allows you to use optional elements. For instance, let's suppose you want to use
 hints or placeholders, but you don't want them to be generated automatically. You can set their
-default values to `false` or use the `optional` method. Is preferible to use the `optional` syntax:
+default values to `false` or use the `optional` method. Is preferable to use the `optional` syntax:
 
 ```ruby
-config.wrappers :placeholder => false do |b|
+config.wrappers placeholder: false do |b|
   b.use :placeholder
   b.use :label_input
-  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 }
+  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
 ```
 
-By setting it as `optional`, a hint will only be generated when `:hint => true` is explicitly used.
-The same for placehold.
+By setting it as `optional`, a hint will only be generated when `hint: true` is explicitly used.
+The same for placeholder.
+
+It is also possible to give the option `:unless_blank` to the wrapper if you want to render it only
+when the content is present.
+
+```ruby
+  b.wrapper tag: :span, class: 'hint', unless_blank: true do |component|
+    component.optional :hint
+  end
+```
 
 ## HTML 5 Notice
 
-By default, **SimpleForm** will generate input field types and attributes that are supported in HTML5,
+By default, **Simple Form** will generate input field types and attributes that are supported in HTML5,
 but are considered invalid HTML for older document types such as HTML4 or XHTML1.0. The HTML5
 extensions include the new field types such as email, number, search, url, tel, and the new
 attributes such as required, autofocus, maxlength, min, max, step.
@@ -811,10 +982,25 @@ required attribute to force a value into an input and will prevent form submissi
 Depending on the design of the application this may or may not be desired. In many cases it can
 break existing UI's.
 
-It is possible to disable all HTML 5 extensions in **SimpleForm** with the following configuration:
+It is possible to disable all HTML 5 extensions in **Simple Form** removing the `html5` component
+from the wrapper used to render the inputs.
+
+For example, change:
 
 ```ruby
-SimpleForm.html5 = false # default is true
+config.wrappers tag: :div do |b|
+  b.use :html5
+
+  b.use :label_input
+end
+```
+
+To:
+
+```ruby
+config.wrappers tag: :div do |b|
+  b.use :label_input
+end
 ```
 
 If you want to have all other HTML 5 features, such as the new field types, you can disable only
@@ -831,14 +1017,23 @@ help you to use some generic javascript validation.
 You can also add `novalidate` to a specific form by setting the option on the form itself:
 
 ```erb
-<%= simple_form_for(resource, :html => {:novalidate => true}) do |form| %>
+<%= simple_form_for(resource, html: { novalidate: true }) do |form| %>
 ```
 
-Please notice that any of the configurations above will disable the `placeholder` component,
-which is an HTML 5 feature. We believe most of the newest browsers are handling this attribute fine,
-and if they aren't, any plugin you use would take of using the placeholder attribute to do it.
-However, you can disable it if you want, by removing the placeholder component from the components
-list in **SimpleForm** configuration file.
+Please notice that none of the configurations above will disable the `placeholder` component,
+which is an HTML 5 feature. We believe most of the newest browsers are handling this attribute
+just fine, and if they aren't, any plugin you use would take care of applying the placeholder.
+In any case, you can disable it if you really want to, by removing the placeholder component
+from the components list in the **Simple Form** configuration file.
+
+HTML 5 date / time inputs are not generated by **Simple Form** by default, so using `date`,
+`time` or `datetime` will all generate select boxes using normal Rails helpers. We believe
+browsers are not totally ready for these yet, but you can easily opt-in on a per-input basis
+by passing the html5 option:
+
+```erb
+<%= f.input :expires_at, as: :date, html5: true %>
+```
 
 ## Information
 
@@ -851,13 +1046,10 @@ http://groups.google.com/group/plataformatec-simpleform
 
 ### RDocs
 
-You can view the **SimpleForm** documentation in RDoc format here:
+You can view the **Simple Form** documentation in RDoc format here:
 
 http://rubydoc.info/github/plataformatec/simple_form/master/frames
 
-If you need to use **SimpleForm** with Rails 2.3, you can always run `gem server` from the command line
-after you install the gem to access the old documentation.
-
 ### Bug reports
 
 If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as
@@ -873,6 +1065,14 @@ https://github.com/plataformatec/simple_form/issues
 * Rafael Mendonça França (https://github.com/rafaelfranca)
 * Vasiliy Ermolovich (https://github.com/nashby)
 
+[![Gem Version](https://fury-badge.herokuapp.com/rb/simple_form.png)](http://badge.fury.io/rb/simple_form)
+[![Build Status](https://api.travis-ci.org/plataformatec/simple_form.svg?branch=master)](http://travis-ci.org/plataformatec/simple_form)
+[![Code Climate](https://codeclimate.com/github/plataformatec/simple_form.png)](https://codeclimate.com/github/plataformatec/simple_form)
+[![Inline docs](http://inch-ci.org/github/plataformatec/simple_form.png)](http://inch-ci.org/github/plataformatec/simple_form)
+
 ## License
 
-MIT License. Copyright 2009-2013 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2009-2015 Plataformatec. http://plataformatec.com.br
+
+You are not granted rights or licenses to the trademarks of the Plataformatec, including without
+limitation the Simple Form name or logo.