Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A Rails Form Builder with semantically rich and accessible markup. It's not production ready yet, but I want it to be!
Branch: master
Pull request Compare This branch is even with carakan:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
docs
generators/formtastic_stylesheets
lib/justin_french
spec
tasks
.gitignore
MIT-LICENSE
README.textile
Rakefile
init.rb
install.rb
uninstall.rb

README.textile

Formtastic Sneaky Preview

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.

The Story

Hacked together forms were easy, but awesome forms with decent semantics, rich mark-up and plenty of CSS hooks were incredibly painful. I was discouraged from doing things properly because it was do much mark-up and code to write. 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:

<% semantic_form_for @article do |form| %>
  
  <% form.input_field_set :name => "Basic" do %>
    <%= form.input :title %>                               
    <%= form.input :body %>                                
    <%= form.input :section_id %>                          
    <%= form.input :publication_state_id, :as => :radio %> 
    <%= form.input :author_id, :as => :select %>                           
    <%= form.input :allow_comments, :label => "Allow commenting on this article" %>                      
  <% end %>                                                
  
  <% form.input_field_set :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 %>                           
  <% end %>

  <% form.button_field_set do %>                                    
    <%= form.cancel_button %>                             
    <%= form.commit_button %>                             
  <% end %>

<% end %>

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>, and then hacked together enough Ruby to prove it could be done.

Why?

  • web apps = lots of forms
  • forms are so friggin’ boring to code
  • semantically rich & accessible forms really are possible
  • the “V” is way behind the “M” and “C” in Rails’ MVC – it’s the ugly sibling
  • best practices and common patterns have to start somewhere
  • i need a challenge

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 still ensure uncommon things are still possible

The Available Inputs

  • :select (a select menu for belongs_to associations) – default for columns ending in ‘_id’
  • :radio (a set of radio inputs for belongs_to associations) – alternative for columns ending in ‘_id’
  • :password (a password input) – default for :string column types with ‘password’ in the method name
  • :text (a textarea) – default for :text column types
  • :date (a date select) – default for :date column types
  • :datetime (a date and time select) – default for :datetime and :timestamp column types
  • :time (a time select) – default for :time column types
  • :boolean (a checkbox) – default for :boolean column types
  • :boolean_select (a yes/no select box)
  • :string (a text field) – default for :string column types
  • :numeric (a text field, like string) – default for :integer, :float and :decimal column types

The documentation is pretty good for each of these (what it does, what the ouput is, etc) so go check it out.

One day…

  • calendars and other more humanized date/time selections
  • vanilla html file selection to work well with things like ThoughtBot’s Paperclip
  • flash-based multi-file selection
  • an interface for tagging and other has_many_through style associations

In the meantime, there’s nothing stopping you from mixing some old fashioned HTML and ERB for custom widgets in with the Formtastic DLS stuff in your views, and I’d love to hear what others are finding a need for.

Fields without database columns

Formtastic is pretty tightly coupled to ActiveRecord database columns, but it will at least attempt to play nicely with your models other methods (like a virtual column ‘full_name’ which is split into first_name and last_name in a before save callback), and I’d like this to continue and improve.

Configuration

If you wish, put something like this in config/initializers/formtastic_config.rb:

JustinFrench::Formtastic::SemanticFormBuilder.all_fields_required_by_default = false
JustinFrench::Formtastic::SemanticFormBuilder.required_string = "(required)"
JustinFrench::Formtastic::SemanticFormBuilder.optional_string = "(optional)"

Status

THIS IS DEFINITELY NOT PRODUCTION-READY. THINGS ARE GOING TO CHANGE A LOT.

It’s incredibly opinionated, incomplete, a work in progress, messy around the edges, messy in the middle too, tightly coupled to the database, tightly coupled to “my way” of doing things and also incredibly lacking in unit tests so far, but I hope you try it and offer some suggestions and improvements any way.

Roadmap

  • There’s plenty of TODOs in the code
  • get the basic form_for implementation complete, proven and well tested (did I mention how laborious testing form builders is?)
  • improve the generic, reusable, stylesheets that prove this stuff works
  • probably do a shortcut like <%= form.inputs :name, :login, :email, :bio %> for those that want the form with zero configuration

Usage

The smallest example:

<% semantic_form_for @user do |form| %>
  <% form.input_field_set do %>
    <%= form.input :name %>
    <%= form.input :email %>
    <%= form.input :password %>
    <%= form.input :department_id, :as => :radio %>
    <%= form.input :date_of_birth %>
  <% end %>
<% end %>

With an output something like:

<form id="new-article-form" action="#" method="post">
  <fieldset>
    <legend><span>Create a new User</span></legend>
    <fieldset class="inputs">
      <ol>
        <li id="user_name_input" class="required string">
          <label for="user_name">Name <abbr title="required">*</abbr></label>
          <input type="text" id="user_name" name="user[name]" size="50" />
        </li>
        <li id="user_email_input" class="required string">
          <label for="user_email">Email <abbr title="required">*</abbr></label>
          <input type="text" id="user_email" name="user[email]" size="50" />
        </li>
      </ol>
    </fieldset>
  </fieldset>
</form>

Conventions & Prerequisites

In a few places (like radio or select widgets for belongs_to associations) Formtastic expects your ActiveRecord instances to respond to the to_label method (returning a String). You can easily add this to your models, for example, a User object might want to return the user’s first name, last name and login:

class User < ActiveRecord::Base
  #...
  def to_label
    "#{first_name} #{last_name} (#{login})"
  end
end

What about Stylesheets?

A proof-of-concept (very much a work-in-progress) stylesheet is provided which you can include in your layout. Customisation is best achieved by overriding these styles in an additional stylesheet so that the formtastic styles can be updated without clobbering your changes.

1. Use the generator to copy the formtastic.css and formtastic_changes.css into your public directory

./script/generate formtastic_stylesheets

2. Add both formtastic.css and formtastic_changes.css to your layout:

<%= stylesheet_link_tag "formtastic" %>
<%= stylesheet_link_tag "formtastic_changes" %>

Compatibility

I’m only testing Formtastic with the latest Rails stable release.

But it doesn’t do that thing I really need!

Oh noes! It might not ever do it either. We’ll see. This is not a silver bullet. I want to make the usual stuff easy, and the unusual stuff possible. That might mean that some of the inputs on your form still have to be hard-coded, but some is better than all, right?

I really hope the plugin will soon be clean and extensible enough to invite others to contribute more complex input types (calendars, etc) to the core.

Contributors

Project Info

Formtastic is hosted on Github: http://github.com/justinfrench/formtastic/, where you contributions are greatly welcomed.

Copyright © 2007 Justin French, released under the MIT license.

Something went wrong with that request. Please try again.