formtastic 2.0.2 → 2.1.0.beta1

data/.gitignore

@@ -4,10 +4,13 @@ coverage
 coverage.data
 pkg
 *~
+*.swp
 *watchr.rb
 log/*
 .rvmrc
 .bundle
 Gemfile.lock
 .yardoc
-doc/
+doc/
+tmp
+gemfiles/*.lock

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails-3.0' do
+  gem 'rails',      '~> 3.0.0'
+end
+
+appraise 'rails-3.1' do
+  gem 'rails',      '~> 3.1.0'
+end
+
+appraise 'rails-3.2' do
+  gem 'rails',      '~> 3.2.0.rc2'
+end

data/CHANGELOG

@@ -1,6 +1,6 @@
-2.0.2
+HEAD
 
-* fixed MongoMapper argument errors on associations
+* Fixed that MongoMapper does not use `associations(method)`. `.associations` is an accessor.
 
 2.0.1
 

data/Gemfile

@@ -1,5 +1,3 @@
 source :rubygems
 
-gem 'rake', '< 0.9'
-
 gemspec

data/README.textile

@@ -17,31 +17,32 @@ h2. 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>
-  <%= semantic_form_for @article do |form| %>
-
-    <%= form.inputs :name => "Basic" do %>
-      <%= form.input :title %>
-      <%= form.input :body %>
-      <%= form.input :section %>
-      <%= form.input :publication_state, :as => :radio %>
-      <%= form.input :category %>
-      <%= form.input :allow_comments, :label => "Allow commenting on this article" %>
+  <%= semantic_form_for @article do |f| %>
+
+    <%= f.inputs :name => "Basic" do %>
+      <%= f.input :title %>
+      <%= f.input :body %>
+      <%= f.input :section %>
+      <%= f.input :publication_state, :as => :radio %>
+      <%= f.input :category %>
+      <%= f.input :allow_comments, :label => "Allow commenting on this article" %>
     <% end %>
 
-    <%= form.inputs :name => "Advanced" do %>
-      <%= form.input :keywords, :required => false, :hint => "Example: ruby, rails, forms" %>
-      <%= form.input :extract, :required => false %>
-      <%= form.input :description, :required => false %>
-      <%= form.input :url_title, :required => false %>
+    <%= f.inputs :name => "Advanced" do %>
+      <%= f.input :keywords, :required => false, :hint => "Example: ruby, rails, forms" %>
+      <%= f.input :extract, :required => false %>
+      <%= f.input :description, :required => false %>
+      <%= f.input :url_title, :required => false %>
     <% end %>
 
-    <%= form.inputs :name => "Author", :for => :author do |author_form| %>
+    <%= f.inputs :name => "Author", :for => :author do |author_form| %>
       <%= author_form.input :first_name %>
       <%= author_form.input :last_name %>
     <% end %>
 
-    <%= form.buttons do %>
-      <%= form.commit_button %>
+    <%= f.actions do %>
+      <%= f.action :submit, :as => :button %>
+      <%= f.action :cancel, :as => :link %>
     <% end %>
 
   <% end %>
@@ -52,25 +53,25 @@ I also wrote the accompanying HTML output I expected, favoring something very si
 
 h2. 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 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.
-* it handles real world stuff like inline hints, inline error messages & help text.
-* it doesn't hijack or change any of the standard Rails form inputs, so you can still use them as expected (even mix and match).
-* it's got absolutely awesome spec coverage.
-* there's a bunch of people using and working on it (it's not just one developer building half a solution).
-* it has growing HTML5 support (new inputs like email/phone/search, new attributes like required/min/max/step/placeholder)
+* 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 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.
+* It handles real world stuff like inline hints, inline error messages & help text.
+* It doesn't hijack or change any of the standard Rails form inputs, so you can still use them as expected (even mix and match).
+* It's got absolutely awesome spec coverage.
+* There's a bunch of people using and working on it (it's not just one developer building half a solution).
+* It has growing HTML5 support (new inputs like email/phone/search, new attributes like required/min/max/step/placeholder)
 
 
 h2. Opinions
 
-* it should be easier to do things the right way than the wrong way.
-* sometimes _more mark-up_ is better.
-* elements and attribute hooks are _gold_ for stylesheet authors.
-* make the common things we do easy, yet ensure uncommon things are still possible.
+* It should be easier to do things the right way than the wrong way.
+* Sometimes _more mark-up_ is better.
+* Elements and attribute hooks are _gold_ for stylesheet authors.
+* Make the common things we do easy, yet ensure uncommon things are still possible.
 
 
 h2. Documentation
@@ -139,39 +140,40 @@ h2. 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 a 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>
-  <%= semantic_form_for @user do |form| %>
-    <%= form.inputs %>
-    <%= form.buttons %>
+  <%= 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 button names to @buttons@:
+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>
-  <%= semantic_form_for @user do |form| %>
-    <%= form.inputs :title, :body, :section, :categories, :created_at %>
-    <%= form.buttons :commit %>
+  <%= 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 @buttons@ 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>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs do %>
-      <%= form.input :title %>
-      <%= form.input :body %>
-      <%= form.input :section, :as => :radio %>
-      <%= form.input :categories %>
-      <%= form.input :created_at, :as => :string %>
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs do %>
+      <%= f.input :title %>
+      <%= f.input :body %>
+      <%= f.input :section, :as => :radio %>
+      <%= f.input :categories %>
+      <%= f.input :created_at, :as => :string %>
     <% end %>
-    <%= form.buttons do %>
-      <%= form.commit_button %>
+    <%= f.actions do %>
+      <%= f.action :submit, :as => :button %>
+      <%= f.action :cancel, :as => :link %>
     <% end %>
   <% end %>
 </pre>
@@ -179,20 +181,20 @@ You probably want control over the input type Formtastic uses for each field. Yo
 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>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs "Basic", :id => "basic" do %>
-      <%= form.input :title %>
-      <%= form.input :body %>
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs "Basic", :id => "basic" do %>
+      <%= f.input :title %>
+      <%= f.input :body %>
     <% end %>
-    <%= form.inputs :name => "Advanced Options", :id => "advanced" do %>
-      <%= form.input :slug, :label => "URL Title", :hint => "Created automatically if left blank", :required => false %>
-      <%= form.input :section, :as => :radio %>
-      <%= form.input :user, :label => "Author", :member_label => :full_name %>
-      <%= form.input :categories, :required => false %>
-      <%= form.input :created_at, :as => :string, :label => "Publication Date", :required => false %>
+    <%= 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 :categories, :required => false %>
+      <%= f.input :created_at, :as => :string, :label => "Publication Date", :required => false %>
     <% end %>
-    <%= form.buttons do %>
-      <%= form.commit_button %>
+    <%= f.actions do %>
+      <%= f.action(:submit) %>
     <% end %>
   <% end %>
 </pre>
@@ -200,91 +202,99 @@ If you want to customize the label text, or render some hint text below the fiel
 You can create forms for nested resources:
 
 <pre>
-	<%= semantic_form_for [@author, @post] do |form| %>
+	<%= 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:
 
 <pre>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs :title, :body, :created_at %>
-    <%= form.semantic_fields_for :author do |author| %>
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs :title, :body, :created_at %>
+    <%= f.semantic_fields_for :author do |author| %>
       <%= author.inputs :first_name, :last_name, :name => "Author" %>
     <% end %>
-    <%= form.buttons %>
+    <%= f.actions %>
   <% end %>
 </pre>
 
 Or the Formtastic way with the @:for@ option:
 
 <pre>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs :title, :body, :created_at %>
-    <%= form.inputs :first_name, :last_name, :for => :author, :name => "Author" %>
-    <%= form.buttons %>
+  <%= 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 that it 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>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs %>
-    <%= form.inputs :name => 'Category #%i', :for => :categories %>
-    <%= form.buttons %>
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs %>
+    <%= f.inputs :name => 'Category #%i', :for => :categories %>
+    <%= 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:
+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>
-  <%= semantic_form_for(@post, :namespace => 'cat_form') do |form| %>
-    <%= form.input :title %>        # id="cat_form_post_title"
-    <%= form.input :body %>         # id="cat_form_post_body"
-    <%= form.input :created_at %>   # id="cat_form_post_created_at"
-    <%= form.buttons %>
+  <%= semantic_form_for(@post, :namespace => 'cat_form') do |f| %>
+    <%= f.inputs do %>
+      <%= f.input :title %>        # id="cat_form_post_title"
+      <%= f.input :body %>         # id="cat_form_post_body"
+      <%= f.input :created_at %>   # id="cat_form_post_created_at"
+    <% 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/autogrow 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":http://plugins.jquery.com/project/autogrowtextarea textareas:
 
 <pre>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.input :title,      :input_html => {  :cols => 10 } %>
-    <%= form.input :body,       :input_html => { :class => 'autogrow', :rows => 10, :cols => 20, :maxlength => 10  } %>
-    <%= form.input :created_at, :input_html => { :disabled => true } %>
-    <%= form.buttons %>
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs do %>
+      <%= f.input :title,      :input_html => { :size => 10 } %>
+      <%= f.input :body,       :input_html => { :class => 'autogrow', :rows => 10, :cols => 20, :maxlength => 10  } %>
+      <%= f.input :created_at, :input_html => { :disabled => true } %>
+      <%= f.input :updated_at, :input_html => { :readonly => true } %>
+    <% end %>
+    <%= f.actions %>
   <% end %>
 </pre>
 
-The same can be done for buttons with the @:button_html@ option:
+The same can be done for actions with the @:button_html@ option:
 
 <pre>
-  <%= semantic_form_for @post do |form| %>
+  <%= semantic_form_for @post do |f| %>
     ...
-    <%= form.buttons do %>
-      <%= form.commit_button :button_html => { :class => "primary", :disable_with => 'Wait...' } %>
+    <%= 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>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.input :title, :wrapper_html => { :class => "important" } %>
-    <%= form.input :body %>
-    <%= form.input :description, :wrapper_html => { :style => "display:none;" } %>
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs do %>
+      <%= f.input :title, :wrapper_html => { :class => "important" } %>
+      <%= f.input :body %>
+      <%= f.input :description, :wrapper_html => { :style => "display:none;" } %>
+    <% end %>
     ...
   <% end %>
 </pre>
 
-Customize the default class used for hints on each attribute or globally in the @config/formtastic.rb@ file. Similarly you can customize the error classes on an attribute level or globally.
+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 |form| %>
-    <%= form.input :title, :hint_class => 'custom-html-class', :error_class => 'custom-error-class' %>
+  <%= 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>
 
@@ -349,15 +359,17 @@ h2. Internationalization (I18n)
 
 h3. Basic Localization
 
-Formtastic got 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>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.input :title %>        # => :label => I18n.t('activerecord.attributes.user.title')    or 'Title'
-    <%= form.input :body %>         # => :label => I18n.t('activerecord.attributes.user.body')     or 'Body'
-    <%= form.input :section %>      # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs do %>
+      <%= f.input :title %>        # => :label => I18n.t('activerecord.attributes.user.title')    or 'Title'
+      <%= f.input :body %>         # => :label => I18n.t('activerecord.attributes.user.body')     or 'Body'
+      <%= f.input :section %>      # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+    <% end %>
   <% end %>
 </pre>
 
@@ -388,7 +400,7 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
             title: "Edit title"
       hints:
         post:
-          title: "Choose a good title for you post."
+          title: "Choose a good title for your post."
           body: "Write something inspiring here."
       placeholders:
         post:
@@ -399,20 +411,22 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
       actions:
         create: "Create my %{model}"
         update: "Save changes"
+        reset: "Reset form"
+        cancel: "Cancel and go back"
         dummie: "Launch!"
 </pre>
 
 *3. ...and now you'll get:*
 
 <pre>
-  <%= semantic_form_for Post.new do |form| %>
-    <%= form.inputs do %>
-      <%= form.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for you post."
-      <%= form.input :body %>       # => :label => "Write something...", :hint => "Write something inspiring here."
-      <%= form.input :section %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+  <%= 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."
+      <%= f.input :body %>       # => :label => "Write something...", :hint => "Write something inspiring here."
+      <%= f.input :section %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
     <% end %>
-    <%= form.buttons do %>
-      <%= form.commit_button %>     # => "Create my %{model}"
+    <%= f.actions do %>
+      <%= f.action(:submit) %>   # => "Create my %{model}"
     <% end %>
   <% end %>
 </pre>
@@ -422,8 +436,8 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
 _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>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs :post_details do %>   # => :title => "Post details"
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs :post_details do %>   # => :title => "Post details"
       # ...
     <% end %>
     # ...
@@ -433,14 +447,14 @@ _Note: Slightly different because Formtastic can't guess how you group fields in
 *5. Override I18n settings:*
 
 <pre>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs do %>
-      <%= form.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for you post."
-      <%= form.input :body, :hint => false %>                 # => :label => "Write something..."
-      <%= form.input :section, :label => 'Some section' %>    # => :label => 'Some section'
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs do %>
+      <%= f.input :title %>      # => :label => "Choose a title...", :hint => "Choose a good title for your post."
+      <%= f.input :body, :hint => false %>                 # => :label => "Write something..."
+      <%= f.input :section, :label => 'Some section' %>    # => :label => 'Some section'
     <% end %>
-    <%= form.buttons do %>
-      <%= form.commit_button :dummie %>     # => "Launch!"
+    <%= f.actions do %>
+      <%= f.actions(:submit, :label => :dummie) %>         # => "Launch!"
     <% end %>
   <% end %>
 </pre>
@@ -454,21 +468,21 @@ If I18n-lookups is disabled, i.e.:
 ...then you can enable I18n within the forms instead:
 
 <pre>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.inputs do %>
-      <%= form.input :title, :label => true %>      # => :label => "Choose a title..."
-      <%= form.input :body, :label => true %>       # => :label => "Write something..."
-      <%= form.input :section, :label => true %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
+  <%= semantic_form_for @post do |f| %>
+    <%= f.inputs do %>
+      <%= f.input :title, :label => true %>      # => :label => "Choose a title..."
+      <%= f.input :body, :label => true %>       # => :label => "Write something..."
+      <%= f.input :section, :label => true %>    # => :label => I18n.t('activerecord.attributes.user.section')  or 'Section'
     <% end %>
-    <%= form.buttons do %>
-      <%= form.commit_button true %>                # => "Update %{model}" (if we are in edit that is...)
+    <%= f.actions do %>
+      <%= 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 find translations using a bottom-up approach taking the following variables in account:
+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"
@@ -506,15 +520,25 @@ h2. Semantic errors
 You can show errors on base (by default) and any other attribute just passing it name to semantic_errors method:
 
 <pre>
-  <%= semantic_form_for @post do |form| %>
-    <%= form.semantic_errors :state %>
+  <%= semantic_form_for @post do |f| %>
+    <%= f.semantic_errors :state %>
   <% end %>
 </pre>
 
 
 h2. Modified & Custom Inputs
 
-If you want to change the behaviour of an input, you can subclass it in your app. For example, to tweak @StringInput@, create a new file @app/inputs/string_input.rb@:
+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)@
+
+Specific examples follow.
+
+h3. Changing Existing Input Behavior
+
+To modify the behavior of @StringInput@, subclass it in a new file, @app/inputs/string_input.rb@:
 
 <pre>
   class StringInput < Formtastic::Inputs::StringInput
@@ -525,10 +549,13 @@ If you want to change the behaviour of an input, you can subclass it in your app
   end
 </pre>
 
-To create your own new types of inputs based on existing inputs, the process is similar:
+You can use your modified version with @:as => :string@.
+
+h3. 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@:
 
 <pre>
-  # f.input(:body, :as => :flexible_text)
   class FlexibleTextInput < Formtastic::Inputs::StringInput
     def input_html_options
       super.merge(:class => "flexible-text-area")
@@ -536,10 +563,13 @@ To create your own new types of inputs based on existing inputs, the process is
   end
 </pre>
 
-To create your own new types of inputs from scratch:
+You can use your new input with @:as => :flexible_text@.
+
+h3. Creating New Inputs From Scratch
+
+To create a custom @DatePickerInput@ from scratch, put the following in @app/inputs/date_picker_input.rb@:
 
 <pre>
-  # f.input(:created_at, :as => :date_picker)
   class DatePickerInput
     include Formtastic::Inputs::Base
     def to_html
@@ -548,12 +578,16 @@ To create your own new types of inputs from scratch:
   end
 </pre>
 
+You can use your new input with @:as => :date_picker@.
+
+h3. Don't subclass Formtastic::FormBuilder anymore
+
 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.
 
 
 h2. Security
 
-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:
+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:
 
 Formtastic::FormBuilder.escape_html_entities_in_hints_and_labels = false
 
@@ -562,33 +596,31 @@ 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).
+* 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
 
-Please ensure that you provide appropriate spec/test coverage and ensure the documentation is up-to-date.  Bonus points if you perform your changes in a clean topic branch rather than master, and if you create a pull request for your changes to be discussed and reviewed.
-
-Please also keep your commits *atomic* so that they are more likely to apply cleanly.  That means that each commit should contain the smallest possible logical change.  Don't commit two features at once, don't update the gemspec at the same time you add a feature, don't fix a whole bunch of whitespace in a file at the same time you change a few lines, etc, etc.
+* Fork the project on Github
+* Create a topic branch for your changes
+* 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.
-
-See below for installation of a development environment.
+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
 
 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 @formtastic on Twitter":http://twitter.com/formtastic for announcements, tutorials and awesome Formtastic links.
+You can also follow "@justinfrench":http://twitter.com/formtastic or  "@formtastic":http://twitter.com/formtastic on Twitter for announcements, tutorials and links.
 
 h2. Project Info
 
-Formtastic was created by "Justin French":http://www.justinfrench.com with contributions from over 100 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: "http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic, where your contributions, forkings, comments, issues and feedback are greatly welcomed.
 
-Copyright (c) 2007-2010 Justin French, released under the MIT license.
+Copyright (c) 2007-2012 Justin French, released under the MIT license.