OnRails.org: Advanced Rails Studio: Custom Form Builder

Advanced Rails Studio: Custom Form Builder

Daniel Wanja — Fri, 13 Jun 2008 21:42:00 +0000

Custom Form Builder

Use a custom form builder to clean up your html.erb files.

lib/label_form_builder.rb

class LabelFormBuilder < ActionView::Helpers::FormBuilder
  helpers = field_helpers +
            %w{date_select datetime_select time_select} +
            %w{collection_select select country_select time_zone_select} -
            %w{hidden_field label fields_for} # Don't decorate these

  helpers.each do |name|
    define_method(name) do |field, *args|
      options = args.last.is_a?(Hash) ? args.pop : {}
      label = label(field, options[:label], :class => options[:label_clas])
      @template.content_tag(:p, label +'<br/>' + super)  #wrap with a paragraph 
    end
  end
end

Then you can remove all the <p> and label tags from you form.

app/views/users/edit.html.erb

<h1>Editing user</h1>

<% form_for(@user, :builder => LabelFormBuilder) do |f| %>
  <%= f.error_messages %>
    <%= f.text_field :name %>
    <%= f.text_field :address %>
    <%= f.text_area :comment %>
    <%= f.check_box :check %>
    <%= f.submit "Update" %>
<% end %>

<%= link_to 'Show', @user %> |
<%= link_to 'Back', users_path %>

Add this to your application initializer to have all form use this form builder

ActionView::Base.default_form_builder = LabelFormBuilder

Then you can replace

<% form_for(@user, :builder => LabelFormBuilder) do |f| %>

with

<% form_for(@user) do |f| %>

Now the same form with no custom builder was looking like this before.

<h1>Editing user</h1>

<% form_for(@user) do |f| %>
  <%= f.error_messages %>

  <p>
    <%= f.label :name %><br />
    <%= f.text_field :name %>
  </p>
  <p>
    <%= f.label :address %><br />
    <%= f.text_field :address %>
  </p>
  <p>
    <%= f.label :comment %><br />
    <%= f.text_area :comment %>
  </p>
  <p>
    <%= f.label :check %><br />
    <%= f.check_box :check %>
  </p>
  <p>
    <%= f.submit "Update" %>
  </p>
<% end %>

<%= link_to 'Show', @user %> |
<%= link_to 'Back', users_path %>

"Advanced Rails Studio: Custom Form Builder" by Lewis Hoffman

Wed, 07 Jan 2009 23:39:33 +0000

Thanks, Daniel. hit the spot! :)

"Advanced Rails Studio: Custom Form Builder" by Douglas

Mon, 01 Dec 2008 19:20:49 +0000

Works for me in edge rails (2.3.0). I followed @Carlo and made a builder folder and added to environment.rb.

"Advanced Rails Studio: Custom Form Builder" by feh

Tue, 25 Nov 2008 23:55:46 +0000

I’m getting “stack level too deep” errors. Is anyone else seeing this, and have a solution to it?

"Advanced Rails Studio: Custom Form Builder" by RaW

Mon, 25 Aug 2008 11:57:09 +0000

You can replace

options = args.last.is_a?(Hash) ? args.pop : {}

with predefined Rails method

options = args.extract_options!

"Advanced Rails Studio: Custom Form Builder" by Daniel Cadenas

Sun, 06 Jul 2008 19:28:02 +0000

I think a better place to put it is the helpers directory and you won’t need to load the path.

"Advanced Rails Studio: Custom Form Builder" by Carlo

Thu, 19 Jun 2008 13:31:28 +0000

simply put following line into your environment.rb file:

config.load_paths += %W( #{RAILS_ROOT}/app/builders )

and your builder under app/builders

"Advanced Rails Studio: Custom Form Builder" by Michael

Tue, 17 Jun 2008 02:55:14 +0000

Where is the best place to put the customer form builder class?

"Advanced Rails Studio: Custom Form Builder" by Michael

Tue, 17 Jun 2008 02:55:08 +0000

Where is the best place to put the customer form builder class?

"Advanced Rails Studio: Custom Form Builder" by Georg Ledermann

Sat, 14 Jun 2008 09:33:52 +0000

To avoid HTML validation errors you should write in the LabelFormBuilder class:


label = label(field, options.delete(:label), :class => options.delete(:label_class))

Beware of the “options.delete”. Otherwise the inputs will have non-valid attributes “label” and “label_class”.

Now you can write:


<%= f.text_field :name, :label => 'Surname' %>

"Advanced Rails Studio: Custom Form Builder" by k

Sat, 14 Jun 2008 00:37:38 +0000

Thanks!! :)

I was just gonna implement this tomorrow morning, and now it's just a copy and paste job. ;-)

Thanks a lot for sharing!