formtastic 2.1.0 → 4.0.0

data/{README.textile → README.md}

@@ -1,23 +1,31 @@
-h1. Formtastic
+# Formtastic
+
+[![Build Status](https://github.com/formtastic/formtastic/workflows/test/badge.svg)](https://github.com/formtastic/formtastic/actions)
+[![Inline docs](https://inch-ci.org/github/justinfrench/formtastic.svg?branch=master)](https://inch-ci.org/github/justinfrench/formtastic)
+[![Code Climate](https://codeclimate.com/github/formtastic/formtastic/badges/gpa.svg)](https://codeclimate.com/github/formtastic/formtastic)
+[![Gem Version](https://badge.fury.io/rb/formtastic.svg)](https://badge.fury.io/rb/formtastic)
 
 Formtastic is a Rails FormBuilder DSL (with some other goodies) to make it far easier to create beautiful, semantically rich, syntactically awesome, readily stylable and wonderfully accessible HTML forms in your Rails applications.
 
-<a href='http://www.pledgie.com/campaigns/2178'><img alt='Click here to lend your support to: formtastic and make a donation at www.pledgie.com !' src='http://pledgie.com/campaigns/2178.png?skin_name=chrome' border='0' /></a>
+## Documentation & Support
 
+* [Documentation is available on rdoc.info](https://rdoc.info/projects/formtastic/formtastic)
+* [We track issues & bugs on GitHub](https://github.com/formtastic/formtastic/issues)
+* [We have a wiki on GitHub](https://github.com/formtastic/formtastic/wiki)
+* [StackOverflow can help](https://stackoverflow.com/questions/tagged/formtastic)
 
-h2. Compatibility
+## Compatibility
 
-* Formtastic 2.1.x is Rails 3.x compatible
-* Formtastic 2.0.x is Rails 3.0.x and 3.1.x compatible only
-* Formtastic 1.x is compatible with both Rails 2 and 3, and is being maintained for bug fixes in the the "1.2-stable branch":https://github.com/justinfrench/formtastic/tree/1.2-stable. View the README in that branch for installation instructions, etc.
+* Formtastic 4 requires Rails 5.2 and Ruby 2.5 minimum
+* Formtastic 3 requires Rails 3.2.13 minimum
+* Formtastic 2 requires Rails 3
 * Formtastic, much like Rails, is very ActiveRecord-centric. Many are successfully using other ActiveModel-like ORMs and objects (DataMapper, MongoMapper, Mongoid, Authlogic, Devise...) but we're not guaranteeing full compatibility at this stage. Patches are welcome!
- 
 
-h2. The Story
+## The Story
 
 One day, I finally had enough, so I opened up my text editor, and wrote a DSL for how I'd like to author forms:
 
-<pre>
+```erb
   <%= semantic_form_for @article do |f| %>
 
     <%= f.inputs :name => "Basic" do %>
@@ -47,16 +55,16 @@ One day, I finally had enough, so I opened up my text editor, and wrote a DSL fo
     <% end %>
 
   <% end %>
-</pre>
+```
 
-I also wrote the accompanying HTML output I expected, favoring something very similar to the fieldsets, lists and other semantic elements Aaron Gustafson presented in "Learning to Love Forms":http://www.slideshare.net/AaronGustafson/learning-to-love-forms-web-directions-south-07, hacking together enough Ruby to prove it could be done.
+I also wrote the accompanying HTML output I expected, favoring something very similar to the fieldsets, lists and other semantic elements Aaron Gustafson presented in [Learning to Love Forms](https://www.slideshare.net/AaronGustafson/learning-to-love-forms-webvisions-07), hacking together enough Ruby to prove it could be done.
 
 
-h2. It's awesome because...
+## It's awesome because...
 
-* It can handle @belongs_to@ associations (like Post belongs_to :author), rendering a select or set of radio inputs with choices from the parent model.
-* It can handle @has_many@ and @has_and_belongs_to_many@ associations (like: Post has_many :tags), rendering a multi-select with choices from the child models.
-* It's Rails 3 compatible (including nested forms).
+* It can handle `belongs_to` associations (like Post belongs_to :author), rendering a select or set of radio inputs with choices from the parent model.
+* It can handle `has_many` and `has_and_belongs_to_many` associations (like: Post has_many :tags), rendering a multi-select with choices from the child models.
+* It's Rails 3/4 compatible (including nested forms).
 * It has internationalization (I18n)!
 * It's _really_ quick to get started with a basic form in place (4 lines), then go back to add in more detail if you need it.
 * There's heaps of elements, id and class attributes for you to hook in your CSS and JS.
@@ -67,7 +75,7 @@ h2. It's awesome because...
 * It has growing HTML5 support (new inputs like email/phone/search, new attributes like required/min/max/step/placeholder)
 
 
-h2. Opinions
+## Opinions
 
 * It should be easier to do things the right way than the wrong way.
 * Sometimes _more mark-up_ is better.
@@ -75,95 +83,82 @@ h2. Opinions
 * Make the common things we do easy, yet ensure uncommon things are still possible.
 
 
-h2. Documentation
-
-RDoc documentation _should_ be automatically generated after each commit and made available on the "rdoc.info website":http://rdoc.info/projects/justinfrench/formtastic.
-
-
-h2. Installation
+## Installation
 
 Simply add Formtastic to your Gemfile and bundle it up:
 
-<pre>
-  gem 'formtastic'
-</pre>
+```ruby
+  gem 'formtastic', '~> 4.0'
+```
 
 Run the installation generator:
 
-<pre>
-  $ rails generate formtastic:install 
-</pre>
+```shell
+$ rails generate formtastic:install
+```
 
 
-h2. Stylesheets
+## Stylesheets
 
 A proof-of-concept set of stylesheets are provided which you can include in your layout. Customization is best achieved by overriding these styles in an additional stylesheet.
 
-h3. Stylesheet usage in Rails < 3.1:
-
-<pre>
-  $ rails generate formtastic:install 
-</pre>
-
-<pre>
-  # app/views/layouts/application.html.erb
-  <%= stylesheet_link_tag 'formtastic', 'my_formtastic_changes' %>
-  <!--[if IE 6]><%= stylesheet_link_tag 'formtastic_ie6' %><![endif]-->
-  <!--[if IE 7]><%= stylesheet_link_tag 'formtastic_ie7' %><![endif]-->
-</pre>
-
-h3. Stylesheet usage in Rails >= 3.1:
-
-Rails 3.1 introduces an asset pipeline that allows plugins like Formtastic to serve their own Stylesheets, Javascripts, etc without having to run generators that copy them accross to the host application. Formtastic makes three stylesheets available as an Engine, you just need to require them in your global stylesheets.
+Rails 3.1 introduces an asset pipeline that allows plugins like Formtastic to serve their own Stylesheets, Javascripts, etc without having to run generators that copy them across to the host application. Formtastic makes three stylesheets available as an Engine, you just need to require them in your global stylesheets.
 
-<pre>
+```css
   # app/assets/stylesheets/application.css
   *= require formtastic
   *= require my_formtastic_changes
-  
+```
+
+Conditional stylesheets need to be compiled separately to prevent them being bundled and included with other application styles.  Remove `require_tree .` from application.css and specify required stylesheets individually.
+
+```css
   # app/assets/stylesheets/ie6.css
   *= require formtastic_ie6
-  
+
   # app/assets/stylesheets/ie7.css
   *= require formtastic_ie7
-</pre>
+```
 
-<pre>
+```erb
   # app/views/layouts/application.html.erb
   <%= stylesheet_link_tag 'application' %>
   <!--[if IE 6]><%= stylesheet_link_tag 'ie6' %><![endif]-->
   <!--[if IE 7]><%= stylesheet_link_tag 'ie7' %><![endif]-->
-</pre>
-
+```
 
+```ruby
+  # config/environments/production.rb
+  config.assets.precompile += %w( ie6.css ie7.css )
+```
 
-h2. Usage
+## Usage
 
 Forms are really boring to code... you want to get onto the good stuff as fast as possible.
 
-This renders a set of inputs (one for _most_ columns in the database table, and one for each ActiveRecord @belongs_to@-association), followed by default action buttons (an input submit button):
+This renders a set of inputs (one for _most_ columns in the database table, and one for each ActiveRecord `belongs_to`-association), followed by default action buttons (an input submit button):
 
-<pre>
+```erb
   <%= semantic_form_for @user do |f| %>
     <%= f.inputs %>
     <%= f.actions %>
   <% end %>
-</pre>
+```
 
 This is a great way to get something up fast, but like scaffolding, it's *not recommended for production*. Don't be so lazy!
 
-To specify the order of the fields, skip some of the fields or even add in fields that Formtastic couldn't infer. You can pass in a list of field names to @inputs@ and list of action names to @actions@:
+To specify the order of the fields, skip some of the fields or even add in fields that Formtastic couldn't infer. You can pass in a list of field names to `inputs` and list of action names to `actions`:
 
-<pre>
+```erb
   <%= semantic_form_for @user do |f| %>
     <%= f.inputs :title, :body, :section, :categories, :created_at %>
     <%= f.actions :submit, :cancel %>
   <% end %>
-</pre>
+```
 
-You probably want control over the input type Formtastic uses for each field. You can expand the @inputs@ and @actions@ to block helper format and use the @:as@ option to specify an exact input type:
+You probably want control over the input type Formtastic uses for each field. You can expand the `inputs` and `actions` to block helper format and use the `:as` option to specify an exact input type:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs do %>
       <%= f.input :title %>
@@ -177,11 +172,11 @@ You probably want control over the input type Formtastic uses for each field. Yo
       <%= f.action :cancel, :as => :link %>
     <% end %>
   <% end %>
-</pre>
+```
 
 If you want to customize the label text, or render some hint text below the field, specify which fields are required/optional, or break the form into two fieldsets, the DSL is pretty comprehensive:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs "Basic", :id => "basic" do %>
       <%= f.input :title %>
@@ -190,7 +185,7 @@ If you want to customize the label text, or render some hint text below the fiel
     <%= f.inputs :name => "Advanced Options", :id => "advanced" do %>
       <%= f.input :slug, :label => "URL Title", :hint => "Created automatically if left blank", :required => false %>
       <%= f.input :section, :as => :radio %>
-      <%= f.input :user, :label => "Author", :member_label => :full_name %>
+      <%= f.input :user, :label => "Author" %>
       <%= f.input :categories, :required => false %>
       <%= f.input :created_at, :as => :string, :label => "Publication Date", :required => false %>
     <% end %>
@@ -198,17 +193,17 @@ If you want to customize the label text, or render some hint text below the fiel
       <%= f.action :submit %>
     <% end %>
   <% end %>
-</pre>
+```
 
 You can create forms for nested resources:
 
-<pre>
+```erb
 	<%= semantic_form_for [@author, @post] do |f| %>
-</pre>
+```
 
-Nested forms are also supported (don't forget your models need to be setup correctly with @accepts_nested_attributes_for@). You can do it in the Rails way:
+Nested forms are also supported (don't forget your models need to be setup correctly with `accepts_nested_attributes_for`). You can do it in the Rails way:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs :title, :body, :created_at %>
     <%= f.semantic_fields_for :author do |author| %>
@@ -216,46 +211,41 @@ Nested forms are also supported (don't forget your models need to be setup corre
     <% end %>
     <%= f.actions %>
   <% end %>
-</pre>
+```
 
-Or the Formtastic way with the @:for@ option:
+Or the Formtastic way with the `:for` option:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs :title, :body, :created_at %>
     <%= f.inputs :first_name, :last_name, :for => :author, :name => "Author" %>
     <%= f.actions %>
   <% end %>
-</pre>
+```
 
-When working in has many association, you can even supply @"%i"@ in your fieldset name; they will be properly interpolated with the child index. For example:
+When working in has many association, you can even supply `"%i"` in your fieldset name; they will be properly interpolated with the child index. For example:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs %>
     <%= f.inputs :name => 'Category #%i', :for => :categories %>
     <%= f.actions %>
   <% end %>
-</pre>
+```
 
 Alternatively, the current index can be accessed via the `inputs` block's arguments for use anywhere:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs :for => :categories do |category, i| %>
-      <% if i <= 2 %>
-        <%= f.inputs :name => "Category ##{i}" %>
-      <% else %>
-        <%= f.inputs :name => "Category ##{i} (optional)" %>
-      <% end %>
-    <% end %>
+      ...
     <%= f.actions %>
   <% end %>
-</pre>
+```
 
 If you have more than one form on the same page, it may lead to HTML invalidation because of the way HTML element id attributes are assigned. You can provide a namespace for your form to ensure uniqueness of id attributes on form elements. The namespace attribute will be prefixed with underscore on the generate HTML id. For example:
 
-<pre>
+```erb
   <%= semantic_form_for(@post, :namespace => 'cat_form') do |f| %>
     <%= f.inputs do %>
       <%= f.input :title %>        # id="cat_form_post_title"
@@ -264,11 +254,11 @@ If you have more than one form on the same page, it may lead to HTML invalidatio
     <% end %>
     <%= f.actions %>
   <% end %>
-</pre>
+```
 
-Customize HTML attributes for any input using the @:input_html@ option. Typically this is used to disable the input, change the size of a text field, change the rows in a textarea, or even to add a special class to an input to attach special behavior like "autogrow":http://plugins.jquery.com/project/autogrowtextarea textareas:
+Customize HTML attributes for any input using the `:input_html` option. Typically this is used to disable the input, change the size of a text field, change the rows in a textarea, or even to add a special class to an input to attach special behavior like [autogrow](https://plugins.jquery.com/project/autogrowtextarea) textareas:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs do %>
       <%= f.input :title,      :input_html => { :size => 10 } %>
@@ -278,22 +268,22 @@ Customize HTML attributes for any input using the @:input_html@ option. Typicall
     <% end %>
     <%= f.actions %>
   <% end %>
-</pre>
+```
 
-The same can be done for actions with the @:button_html@ option:
+The same can be done for actions with the `:button_html` option:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     ...
     <%= f.actions do %>
       <%= f.action :submit, :button_html => { :class => "primary", :disable_with => 'Wait...' } %>
     <% end %>
   <% end %>
-</pre>
+```
 
-Customize the HTML attributes for the @<li>@ wrapper around every input with the @:wrapper_html@ option hash. There's one special key in the hash: (@:class@), which will actually _append_ your string of classes to the existing classes provided by Formtastic (like @"required string error"@).
+Customize the HTML attributes for the `<li>` wrapper around every input with the `:wrapper_html` option hash. There's one special key in the hash: (`:class`), which will actually _append_ your string of classes to the existing classes provided by Formtastic (like `"required string error"`).
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs do %>
       <%= f.input :title, :wrapper_html => { :class => "important" } %>
@@ -302,84 +292,80 @@ Customize the HTML attributes for the @<li>@ wrapper around every input with the
     <% end %>
     ...
   <% end %>
-</pre>
-
-Customize the default class used for hints on each attribute or globally in the @config/initializers/formtastic.rb@ file. Similarly, you can customize the error classes on an attribute level or globally.
-
-<pre>
-  <%= semantic_form_for @post do |f| %>
-    <%= f.inputs do %>
-      <%= f.input :title, :hint_class => 'custom-html-class', :error_class => 'custom-error-class' %>
-    <% end %>
-  <% end %>
-</pre>
+```
 
-Many inputs provide a collection of options to choose from (like @:select@, @:radio@, @:check_boxes@, @:boolean@). In many cases, Formtastic can find choices through the model associations, but if you want to use your own set of choices, the @:collection@ option is what you want.  You can pass in an Array of objects, an array of Strings, a Hash... Throw almost anything at it! Examples:
+Many inputs provide a collection of options to choose from (like `:select`, `:radio`, `:check_boxes`, `:boolean`). In many cases, Formtastic can find choices through the model associations, but if you want to use your own set of choices, the `:collection` option is what you want.  You can pass in an Array of objects, an array of Strings, a Hash... Throw almost anything at it! Examples:
 
-<pre>
-  f.input :authors, :as => :check_boxes, :collection => User.find(:all, :order => "last_name ASC")
+```ruby
+  f.input :authors, :as => :check_boxes, :collection => User.order("last_name ASC").all
   f.input :authors, :as => :check_boxes, :collection => current_user.company.users.active
   f.input :authors, :as => :check_boxes, :collection => [@justin, @kate]
   f.input :authors, :as => :check_boxes, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
-  f.input :author,  :as => :select,      :collection => Author.find(:all)
+  f.input :author,  :as => :select,      :collection => Author.all
+  f.input :author,  :as => :select,      :collection => Author.pluck(:first_name, :id)
+  f.input :author,  :as => :select,      :collection => Author.pluck(Arel.sql("CONCAT(`first_name`, ' ', `last_name`)"), :id)
+  f.input :author,  :as => :select,      :collection => Author.your_custom_scope_or_class_method
   f.input :author,  :as => :select,      :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
   f.input :author,  :as => :select,      :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
-  f.input :author,  :as => :radio,       :collection => User.find(:all)
+  f.input :author,  :as => :radio,       :collection => User.all
   f.input :author,  :as => :radio,       :collection => [@justin, @kate]
   f.input :author,  :as => :radio,       :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
   f.input :author,  :as => :radio,       :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
   f.input :admin,   :as => :radio,       :collection => ["Yes!", "No"]
-</pre>
+  f.input :book_id, :as => :select,      :collection => Hash[Book.all.map{|b| [b.name,b.id]}]
+  f.input :fav_book,:as => :datalist   , :collection => Book.pluck(:name)
+```
 
 
-h2. The Available Inputs
+## The Available Inputs
 
 The Formtastic input types:
 
-* @:select@ - a select menu. Default for ActiveRecord associations: @belongs_to@, @has_many@, and @has_and_belongs_to_many@.
-* @:check_boxes@ - a set of check_box inputs. Alternative to @:select@ for ActiveRecord-associations: @has_many@, and @has_and_belongs_to_many@.
-* @:radio@ - a set of radio inputs. Alternative to @:select@ for ActiveRecord-associations: @belongs_to@.
-* @:time_zone@ - a select input. Default for column types: @:string@ with name matching @"time_zone"@.
-* @:password@ - a password input. Default for column types: @:string@ with name matching @"password"@.
-* @:text@ - a textarea. Default for column types: @:text@.
-* @:date@ - a date select. Default for column types: @:date@.
-* @:datetime@ - a date and time select. Default for column types: @:datetime@ and @:timestamp@.
-* @:time@ - a time select. Default for column types: @:time@.
-* @:boolean@ - a checkbox. Default for column types: @:boolean@.
-* @:string@ - a text field. Default for column types: @:string@.
-* @:number@ - a text field (just like string). Default for  column types: @:integer@, @:float@, and @:decimal@.
-* @:file@ - a file field. Default for file-attachment attributes matching: "paperclip":http://github.com/thoughtbot/paperclip or "attachment_fu":http://github.com/technoweenie/attachment_fu.
-* @:country@ - a select menu of country names. Default for column types: :string with name @"country"@ - requires a *country_select* plugin to be installed.
-* @:email@ - a text field (just like string). Default for columns with name matching @"email"@. New in HTML5. Works on some mobile browsers already.
-* @:url@ - a text field (just like string). Default for columns with name matching @"url"@. New in HTML5. Works on some mobile browsers already.
-* @:phone@ - a text field (just like string). Default for columns with name matching @"phone"@ or @"fax"@. New in HTML5.
-* @:search@ - a text field (just like string). Default for columns with name matching @"search"@. New in HTML5. Works on Safari.
-* @:hidden@ - a hidden field. Creates a hidden field (added for compatibility).
-* @:range@ - a slider field.
+* `:select` - a select menu. Default for ActiveRecord associations: `belongs_to`, `has_many`, and `has_and_belongs_to_many`.
+* `:check_boxes` - a set of check_box inputs. Alternative to `:select` for ActiveRecord-associations: `has_many`, and has_and_belongs_to_many`.
+* `:radio` - a set of radio inputs. Alternative to `:select` for ActiveRecord-associations: `belongs_to`.
+* `:time_zone` - a select input. Default for column types: `:string` with name matching `"time_zone"`.
+* `:password` - a password input. Default for column types: `:string` with name matching `"password"`.
+* `:text` - a textarea. Default for column types: `:text`.
+* `:date_select` - a date select. Default for column types: `:date`.
+* `:datetime_select` - a date and time select. Default for column types: `:datetime` and `:timestamp`.
+* `:time_select` - a time select. Default for column types: `:time`.
+* `:boolean` - a checkbox. Default for column types: `:boolean`.
+* `:string` - a text field. Default for column types: `:string`.
+* `:number` - a text field (just like string). Default for  column types: `:integer`, `:float`, and `:decimal`.
+* `:file` - a file field. Default for file-attachment attributes matching: [paperclip](https://github.com/thoughtbot/paperclip) or [attachment_fu](https://github.com/technoweenie/attachment_fu).
+* `:country` - a select menu of country names. Default for column types: `:string` with name `"country"` - requires a *country_select* plugin to be installed.
+* `:email` - a text field (just like string). Default for columns with name matching `"email"`. New in HTML5. Works on some mobile browsers already.
+* `:url` - a text field (just like string). Default for columns with name matching `"url"`. New in HTML5. Works on some mobile browsers already.
+* `:phone` - a text field (just like string). Default for columns with name matching `"phone"` or `"fax"`. New in HTML5.
+* `:search` - a text field (just like string). Default for columns with name matching `"search"`. New in HTML5. Works on Safari.
+* `:hidden` - a hidden field. Creates a hidden field (added for compatibility).
+* `:range` - a slider field.
+* `:datalist` - a text field with a accompanying [datalist tag](https://developer.mozilla.org/en/docs/Web/HTML/Element/datalist) which provides options for autocompletion
 
 The comments in the code are pretty good for each of these (what it does, what the output is, what the options are, etc.) so go check it out.
 
 
-h2. Delegation for label lookups
+## Delegation for label lookups
 
 Formtastic decides which label to use in the following order:
 
-<pre>
+```
   1. :label             # :label => "Choose Title"
   2. Formtastic i18n    # if either :label => true || i18n_lookups_by_default = true (see Internationalization)
   3. Activerecord i18n  # if localization file found for the given attribute
-  4. label_str_method   # if nothing provided this defaults to :humanize but can be set to a custom method 
-</pre>
+  4. label_str_method   # if nothing provided this defaults to :humanize but can be set to a custom method
+```
 
-h2. Internationalization (I18n)
+## Internationalization (I18n)
 
-h3. Basic Localization
+### Basic Localization
 
-Formtastic has some neat I18n-features. ActiveRecord object names and attributes are, by default, taken from calling @@object.human_name@ and @@object.human_attribute_name(attr)@ respectively. There are a few words specific to Formtastic that can be translated. See @lib/locale/en.yml@ for more information.
+Formtastic has some neat I18n-features. ActiveRecord object names and attributes are, by default, taken from calling `@object.human_name` and `@object.human_attribute_name(attr)` respectively. There are a few words specific to Formtastic that can be translated. See `lib/locale/en.yml` for more information.
 
 Basic localization (labels only, with ActiveRecord):
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs do %>
       <%= f.input :title %>        # => :label => I18n.t('activerecord.attributes.user.title')    or 'Title'
@@ -387,23 +373,23 @@ Basic localization (labels only, with ActiveRecord):
       <%= f.input :section %>      # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
     <% end %>
   <% end %>
-</pre>
+```
 
 *Note:* This is perfectly fine if you just want your labels/attributes and/or models to be translated using *ActiveRecord I18n attribute translations*, and you don't use input hints and legends. But what if you do? And what if you don't want same labels in all forms?
 
-h3. Enhanced Localization (Formtastic I18n API)
+### Enhanced Localization (Formtastic I18n API)
 
 Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the I18n API for more advanced usage. Your forms can now be DRYer and more flexible than ever, and still fully localized. This is how:
 
-*1. Enable I18n lookups by default (@config/initializers/formtastic.rb@):*
+*1. Enable I18n lookups by default (`config/initializers/formtastic.rb`):*
 
-<pre>
+```ruby
   Formtastic::FormBuilder.i18n_lookups_by_default = true
-</pre>
+```
 
-*2. Add some cool label-translations/variants (@config/locale/en.yml@):*
+*2. Add some label-translations/variants (`config/locales/en.yml`):*
 
-<pre>
+```yml
   en:
     formtastic:
       titles:
@@ -430,11 +416,11 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
         reset: "Reset form"
         cancel: "Cancel and go back"
         dummie: "Launch!"
-</pre>
+```
 
 *3. ...and now you'll get:*
 
-<pre>
+```erb
   <%= semantic_form_for Post.new do |f| %>
     <%= f.inputs do %>
       <%= f.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for your post."
@@ -445,24 +431,24 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
       <%= f.action :submit %>   # => "Create my %{model}"
     <% end %>
   <% end %>
-</pre>
+```
 
 *4. Localized titles (a.k.a. legends):*
 
 _Note: Slightly different because Formtastic can't guess how you group fields in a form. Legend text can be set with first (as in the sample below) specified value, or :name/:title options - depending on what flavor is preferred._
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs :post_details do %>   # => :title => "Post details"
       # ...
     <% end %>
     # ...
 <% end %>
-</pre>
+```
 
 *5. Override I18n settings:*
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs do %>
       <%= f.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for your post."
@@ -473,17 +459,17 @@ _Note: Slightly different because Formtastic can't guess how you group fields in
       <%= f.action :submit, :label => :dummie %>         # => "Launch!"
     <% end %>
   <% end %>
-</pre>
+```
 
 If I18n-lookups is disabled, i.e.:
 
-<pre>
+```ruby
   Formtastic::FormBuilder.i18n_lookups_by_default = false
-</pre>
+```
 
 ...then you can enable I18n within the forms instead:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.inputs do %>
       <%= f.input :title, :label => true %>      # => :label => "Choose a title..."
@@ -494,25 +480,25 @@ If I18n-lookups is disabled, i.e.:
       <%= f.action :submit, :label => true %>    # => "Update %{model}" (if we are in edit that is...)
     <% end %>
   <% end %>
-</pre>
+```
 
 *6. Advanced I18n lookups*
 
 For more flexible forms; Formtastic finds translations using a bottom-up approach taking the following variables in account:
 
-* @MODEL@, e.g. "post"
-* @ACTION@, e.g. "edit"
-* @KEY/ATTRIBUTE@, e.g. "title", :my_custom_key, ...
+* `MODEL`, e.g. "post"
+* `ACTION`, e.g. "edit"
+* `KEY/ATTRIBUTE`, e.g. "title", :my_custom_key, ...
 
 ...in the following order:
 
-1. @formtastic.{titles,labels,hints,actions}.MODEL.ACTION.ATTRIBUTE@ - by model and action
-2. @formtastic.{titles,labels,hints,actions}.MODEL.ATTRIBUTE@ - by model
-3. @formtastic.{titles,labels,hints,actions}.ATTRIBUTE@ - global default
+1. `formtastic.{titles,labels,hints,actions}.MODEL.ACTION.ATTRIBUTE` - by model and action
+2. `formtastic.{titles,labels,hints,actions}.MODEL.ATTRIBUTE` - by model
+3. `formtastic.{titles,labels,hints,actions}.ATTRIBUTE` - global default
 
 ...which means that you can define translations like this:
 
-<pre>
+```yml
   en:
     formtastic:
       labels:
@@ -526,117 +512,116 @@ For more flexible forms; Formtastic finds translations using a bottom-up approac
           edit:
             title: "Edit title"
             body: "Edit body"
-</pre>
+```
 
-Values for @labels@/@hints@/@actions@ are can take values: @String@ (explicit value), @Symbol@ (i18n-lookup-key relative to the current "type", e.g. actions:), @true@ (force I18n lookup), @false@ (force no I18n lookup). Titles (legends) can only take: @String@ and @Symbol@ - true/false have no meaning.
+Values for `labels`/`hints`/`actions` are can take values: `String` (explicit value), `Symbol` (i18n-lookup-key relative to the current "type", e.g. actions:), `true` (force I18n lookup), `false` (force no I18n lookup). Titles (legends) can only take: `String` and `Symbol` - true/false have no meaning.
 
+*7. Basic Translations*
+If you want some basic translations, take a look on the [formtastic_i18n gem](https://github.com/timoschilling/formtastic_i18n).
 
-h2. Semantic errors
+## Semantic errors
 
-You can show errors on base (by default) and any other attribute just passing it name to semantic_errors method:
+You can show errors on base (by default) and any other attribute just by passing its name to the semantic_errors method:
 
-<pre>
+```erb
   <%= semantic_form_for @post do |f| %>
     <%= f.semantic_errors :state %>
   <% end %>
-</pre>
+```
 
 
-h2. Modified & Custom Inputs
+## Modified & Custom Inputs
 
 You can modify existing inputs, subclass them, or create your own from scratch. Here's the basic process:
 
-* Create a file in @app/inputs@ with a filename ending in @_input.rb@. For example, @app/inputs/hat_size_input.rb@. Formtastic will automatically look in @app/inputs@ and find the file.
-* In that file, declare a classname ending in @Input@. For example, @class HatSizeInput@. It must have a @to_html@ method for rendering.
-* To use that input, leave off the word "input" in your @as@ statement. For example, @f.input(:size, :as => :hat_size)@
+* Run the input generator and provide your custom input name. For example, `rails generate formtastic:input hat_size`. This creates the file `app/inputs/hat_size_input.rb`. You can also provide namespace to input name like `rails generate formtastic:input foo/custom` or `rails generate formtastic:input Foo::Custom`, this will create the file `app/inputs/foo/custom_input.rb` in both cases.
+* To use that input, leave off the word "input" in your `as` statement. For example, `f.input(:size, :as => :hat_size)`
 
 Specific examples follow.
 
-h3. Changing Existing Input Behavior
+### Changing Existing Input Behavior
 
-To modify the behavior of @StringInput@, subclass it in a new file, @app/inputs/string_input.rb@:
+To modify the behavior of `StringInput`, subclass it in a new file, `app/inputs/string_input.rb`:
 
-<pre>
+```ruby
   class StringInput < Formtastic::Inputs::StringInput
     def to_html
       puts "this is my modified version of StringInput"
       super
     end
   end
-</pre>
+```
+
+Another way to modify behavior is by using the input generator:
+```shell
+$ rails generate formtastic:input string --extend
+```
+
+This generates the file `app/inputs/string_input.rb` with its respective content class.
 
-You can use your modified version with @:as => :string@.
+You can use your modified version with `:as => :string`.
 
-h3. Creating New Inputs Based on Existing Ones
+### Creating New Inputs Based on Existing Ones
 
-To create your own new types of inputs based on existing inputs, the process is similar. For example, to create @FlexibleTextInput@ based on @StringInput@, put the following in @app/inputs/flexible_text_input.rb@:
+To create your own new types of inputs based on existing inputs, the process is similar. For example, to create `FlexibleTextInput` based on `StringInput`, put the following in `app/inputs/flexible_text_input.rb`:
 
-<pre>
+```ruby
   class FlexibleTextInput < Formtastic::Inputs::StringInput
     def input_html_options
       super.merge(:class => "flexible-text-area")
     end
   end
-</pre>
+```
 
-You can use your new input with @:as => :flexible_text@.
+You can also extend existing input behavior by using the input generator:
 
-h3. Creating New Inputs From Scratch
+```shell
+$ rails generate formtastic:input FlexibleText --extend string
+```
 
-To create a custom @DatePickerInput@ from scratch, put the following in @app/inputs/date_picker_input.rb@:
+This generates the file `app/inputs/flexible_text_input.rb` with its respective content class.
 
-<pre>
+You can use your new input with `:as => :flexible_text`.
+
+### Creating New Inputs From Scratch
+
+To create a custom `DatePickerInput` from scratch, put the following in `app/inputs/date_picker_input.rb`:
+
+```ruby
   class DatePickerInput
     include Formtastic::Inputs::Base
     def to_html
       # ...
     end
   end
-</pre>
-
-You can use your new input with @:as => :date_picker@.
+```
 
-h3. Don't subclass Formtastic::FormBuilder anymore
+You can use your new input with `:as => :date_picker`.
 
-It was previously recommended in Formtastic 1.x to subclass Formtastic::FormBuilder to add your own inputs. This is no longer recommended in Formtastic 2, and will not work as expected.
 
+## Dependencies
 
-h2. Security
+There are none other than Rails itself, but...
 
-By default, Formtastic escapes HTML entities in both labels and hints unless a string is marked as html_safe. If you are using an older rails version which doesn't know html_safe, or you want to globally turn this feature off, you can set the following in your initializer:
+* If you want to use the `:country` input, you'll need to install the [country-select plugin](https://github.com/stefanpenner/country_select) (or any other country_select plugin with the same API). Both 1.x and 2.x are supported, but they behave differently when storing data, so please see their [upgrade notes](https://github.com/stefanpenner/country_select/blob/master/UPGRADING.md) if switching from 1.x.
+* There are a bunch of development dependencies if you plan to contribute to Formtastic
 
-Formtastic::FormBuilder.escape_html_entities_in_hints_and_labels = false
 
-
-h2. Dependencies
-
-There are none, but...
-
-* If you want to use the @:country@ input, you'll need to install the "country-select plugin":https://github.com/chrislerum/country_select (or any other country_select plugin with the same API).
-* "rspec":http://github.com/dchelimsky/rspec/, "rspec_hpricot_matchers":http://rubyforge.org/projects/rspec-hpricot/ and "rcov":http://github.com/relevance/rcov gems (plus any of their own dependencies) are required for the test suite.
-
-
-h2. How to contribute
+## How to contribute
 
 * Fork the project on Github
+* Install development dependencies (`bundle install` and `bin/appraisal install`)
 * Create a topic branch for your changes
+* Ensure that you provide *documentation* and *test coverage* for your changes (patches won't be accepted without)
 * Ensure that all tests pass (`bundle exec rake`)
-* Ensure that the changes in your branch are as atomic as possible
-* Create a pull request on Github
-
-For significant changes, you may wish to discuss your idea on the Formtastic Google group before coding to ensure that your change is likely to be accepted. Formtastic relies heavily on i18n, so if you're unsure of the impact this has on your changes, please discuss them with the group.
-
-
-h2. Google Group, Twitter, etc
+* Create a pull request on Github (these are also a great place to start a conversation around a patch as early as possible)
 
-Please join the "Formtastic Google Group":http://groups.google.com.au/group/formtastic, especially if you'd like to talk about a new feature, or report a bug.
 
-You can also follow "@justinfrench":http://twitter.com/formtastic or  "@formtastic":http://twitter.com/formtastic on Twitter for announcements, tutorials and links.
+## Project Info
 
-h2. Project Info
+Formtastic was created by [Justin French](https://www.justinfrench.com) with contributions from around 180 awesome developers. Run `git shortlog -n -s` to see the awesome.
 
-Formtastic was created by "Justin French":http://www.justinfrench.com with contributions from around 150 awesome developers. Run @git shortlog -n -s@ to see the awesome.
+The project is hosted on Github: [https://github.com/formtastic/formtastic](https://github.com/formtastic/formtastic), where your contributions, forkings, comments, issues and feedback are greatly welcomed.
 
-The project is hosted on Github: "http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic, where your contributions, forkings, comments, issues and feedback are greatly welcomed.
+Copyright (c) 2007-2021, released under the MIT license.
 
-Copyright (c) 2007-2012 Justin French, released under the MIT license.