2 require 'action_view/helpers/date_helper'
3 require 'action_view/helpers/tag_helper'
4 require 'action_view/helpers/form_tag_helper'
8 # Form helpers are designed to make working with models much easier
9 # compared to using just standard HTML elements by providing a set of
10 # methods for creating forms based on your models. This helper generates
11 # the HTML for forms, providing a method for each sort of input
12 # (e.g., text, password, select, and so on). When the form is submitted
13 # (i.e., when the user hits the submit button or <tt>form.submit</tt> is
14 # called via JavaScript), the form inputs will be bundled into the
15 # <tt>params</tt> object and passed back to the controller.
17 # There are two types of form helpers: those that specifically work with
18 # model attributes and those that don't. This helper deals with those that
19 # work with model attributes; to see an example of form helpers that don't
20 # work with model attributes, check the ActionView::Helpers::FormTagHelper
23 # The core method of this helper, form_for, gives you the ability to create
24 # a form for a model instance; for example, let's say that you have a model
25 # <tt>Person</tt> and want to create a new instance of it:
27 # # Note: a @person variable will have been created in the controller.
28 # # For example: @person = Person.new
29 # <% form_for :person, @person, :url => { :action => "create" } do |f| %>
30 # <%= f.text_field :first_name %>
31 # <%= f.text_field :last_name %>
32 # <%= submit_tag 'Create' %>
35 # The HTML generated for this would be:
37 # <form action="/persons/create" method="post">
38 # <input id="person_first_name" name="person[first_name]" size="30" type="text" />
39 # <input id="person_last_name" name="person[last_name]" size="30" type="text" />
40 # <input name="commit" type="submit" value="Create" />
43 # If you are using a partial for your form fields, you can use this shortcut:
45 # <% form_for :person, @person, :url => { :action => "create" } do |f| %>
46 # <%= render :partial => f %>
47 # <%= submit_tag 'Create' %>
50 # This example will render the <tt>people/_form</tt> partial, setting a
51 # local variable called <tt>form</tt> which references the yielded
52 # FormBuilder. The <tt>params</tt> object created when this form is
53 # submitted would look like:
55 # {"action"=>"create", "controller"=>"persons", "person"=>{"first_name"=>"William", "last_name"=>"Smith"}}
57 # The params hash has a nested <tt>person</tt> value, which can therefore
58 # be accessed with <tt>params[:person]</tt> in the controller. If were
59 # editing/updating an instance (e.g., <tt>Person.find(1)</tt> rather than
60 # <tt>Person.new</tt> in the controller), the objects attribute values are
61 # filled into the form (e.g., the <tt>person_first_name</tt> field would
62 # have that person's first name in it).
64 # If the object name contains square brackets the id for the object will be
65 # inserted. For example:
67 # <%= text_field "person[]", "name" %>
69 # ...will generate the following ERb.
71 # <input type="text" id="person_<%= @person.id %>_name" name="person[<%= @person.id %>][name]" value="<%= @person.name %>" />
73 # If the helper is being used to generate a repetitive sequence of similar
74 # form elements, for example in a partial used by
75 # <tt>render_collection_of_partials</tt>, the <tt>index</tt> option may
76 # come in handy. Example:
78 # <%= text_field "person", "name", "index" => 1 %>
82 # <input type="text" id="person_1_name" name="person[1][name]" value="<%= @person.name %>" />
84 # An <tt>index</tt> option may also be passed to <tt>form_for</tt> and
85 # <tt>fields_for</tt>. This automatically applies the <tt>index</tt> to
86 # all the nested fields.
88 # There are also methods for helping to build form tags in
89 # link:classes/ActionView/Helpers/FormOptionsHelper.html,
90 # link:classes/ActionView/Helpers/DateHelper.html, and
91 # link:classes/ActionView/Helpers/ActiveRecordHelper.html
93 # Creates a form and a scope around a specific model object that is used
94 # as a base for questioning about values for the fields.
96 # Rails provides succinct resource-oriented form generation with +form_for+
99 # <% form_for @offer do |f| %>
100 # <%= f.label :version, 'Version' %>:
101 # <%= f.text_field :version %><br />
102 # <%= f.label :author, 'Author' %>:
103 # <%= f.text_field :author %><br />
106 # There, +form_for+ is able to generate the rest of RESTful form
107 # parameters based on introspection on the record, but to understand what
108 # it does we need to dig first into the alternative generic usage it is
111 # === Generic form_for
113 # The generic way to call +form_for+ yields a form builder around a
116 # <% form_for :person, :url => { :action => "update" } do |f| %>
117 # <%= f.error_messages %>
118 # First name: <%= f.text_field :first_name %><br />
119 # Last name : <%= f.text_field :last_name %><br />
120 # Biography : <%= f.text_area :biography %><br />
121 # Admin? : <%= f.check_box :admin %><br />
124 # There, the first argument is a symbol or string with the name of the
125 # object the form is about, and also the name of the instance variable
126 # the object is stored in.
128 # The form builder acts as a regular form helper that somehow carries the
129 # model. Thus, the idea is that
131 # <%= f.text_field :first_name %>
135 # <%= text_field :person, :first_name %>
137 # If the instance variable is not <tt>@person</tt> you can pass the actual
138 # record as the second argument:
140 # <% form_for :person, person, :url => { :action => "update" } do |f| %>
144 # In that case you can think
146 # <%= f.text_field :first_name %>
150 # <%= text_field :person, :first_name, :object => person %>
152 # You can even display error messages of the wrapped model this way:
154 # <%= f.error_messages %>
156 # In any of its variants, the rightmost argument to +form_for+ is an
157 # optional hash of options:
159 # * <tt>:url</tt> - The URL the form is submitted to. It takes the same
160 # fields you pass to +url_for+ or +link_to+. In particular you may pass
161 # here a named route directly as well. Defaults to the current action.
162 # * <tt>:html</tt> - Optional HTML attributes for the form tag.
164 # Worth noting is that the +form_for+ tag is called in a ERb evaluation
165 # block, not an ERb output block. So that's <tt><% %></tt>, not
168 # Also note that +form_for+ doesn't create an exclusive scope. It's still
169 # possible to use both the stand-alone FormHelper methods and methods
170 # from FormTagHelper. For example:
172 # <% form_for :person, @person, :url => { :action => "update" } do |f| %>
173 # First name: <%= f.text_field :first_name %>
174 # Last name : <%= f.text_field :last_name %>
175 # Biography : <%= text_area :person, :biography %>
176 # Admin? : <%= check_box_tag "person[admin]", @person.company.admin? %>
179 # This also works for the methods in FormOptionHelper and DateHelper that
180 # are designed to work with an object as base, like
181 # FormOptionHelper#collection_select and DateHelper#datetime_select.
183 # === Resource-oriented style
185 # As we said above, in addition to manually configuring the +form_for+
186 # call, you can rely on automated resource identification, which will use
187 # the conventions and named routes of that approach. This is the
188 # preferred way to use +form_for+ nowadays.
190 # For example, if <tt>@post</tt> is an existing record you want to edit
192 # <% form_for @post do |f| %>
196 # is equivalent to something like:
198 # <% form_for :post, @post, :url => post_path(@post), :html => { :method => :put, :class => "edit_post", :id => "edit_post_45" } do |f| %>
202 # And for new records
204 # <% form_for(Post.new) do |f| %>
210 # <% form_for :post, Post.new, :url => posts_path, :html => { :class => "new_post", :id => "new_post" } do |f| %>
214 # You can also overwrite the individual conventions, like this:
216 # <% form_for(@post, :url => super_post_path(@post)) do |f| %>
220 # And for namespaced routes, like +admin_post_url+:
222 # <% form_for([:admin, @post]) do |f| %>
226 # === Customized form builders
228 # You can also build forms using a customized FormBuilder class. Subclass
229 # FormBuilder and override or define some more helpers, then use your
230 # custom builder. For example, let's say you made a helper to
231 # automatically add labels to form inputs.
233 # <% form_for :person, @person, :url => { :action => "update" }, :builder => LabellingFormBuilder do |f| %>
234 # <%= f.text_field :first_name %>
235 # <%= f.text_field :last_name %>
236 # <%= text_area :person, :biography %>
237 # <%= check_box_tag "person[admin]", @person.company.admin? %>
240 # In this case, if you use this:
242 # <%= render :partial => f %>
244 # The rendered template is <tt>people/_labelling_form</tt> and the local
245 # variable referencing the form builder is called
246 # <tt>labelling_form</tt>.
248 # The custom FormBuilder class is automatically merged with the options
249 # of a nested fields_for call, unless it's explicitely set.
251 # In many cases you will want to wrap the above in another helper, so you
252 # could do something like the following:
254 # def labelled_form_for(record_or_name_or_array, *args, &proc)
255 # options = args.extract_options!
256 # form_for(record_or_name_or_array, *(args << options.merge(:builder => LabellingFormBuilder)), &proc)
259 # If you don't need to attach a form to a model instance, then check out
260 # FormTagHelper#form_tag.
261 def form_for(record_or_name_or_array
, *args
, &proc
)
262 raise ArgumentError
, "Missing block" unless block_given
?
264 options
= args
.extract_options
!
266 case record_or_name_or_array
268 object_name
= record_or_name_or_array
270 object
= record_or_name_or_array
.last
271 object_name
= ActionController
::RecordIdentifier.singular_class_name(object
)
272 apply_form_for_options
!(record_or_name_or_array
, options
)
275 object
= record_or_name_or_array
276 object_name
= ActionController
::RecordIdentifier.singular_class_name(object
)
277 apply_form_for_options
!([object
], options
)
281 concat(form_tag(options
.delete(:url) || {}, options
.delete(:html) || {}))
282 fields_for(object_name
, *(args
<< options
), &proc
)
286 def apply_form_for_options
!(object_or_array
, options
) #:nodoc:
287 object
= object_or_array
.is_a
?(Array
) ? object_or_array
.last
: object_or_array
290 if object
.respond_to
?(:new_record?) && object
.new_record
?
291 { :class => dom_class(object
, :new), :id => dom_id(object
), :method => :post }
293 { :class => dom_class(object
, :edit), :id => dom_id(object
, :edit), :method => :put }
296 options
[:html] ||= {}
297 options
[:html].reverse_merge
!(html_options
)
298 options
[:url] ||= polymorphic_path(object_or_array
)
301 # Creates a scope around a specific model object like form_for, but
302 # doesn't create the form tags themselves. This makes fields_for suitable
303 # for specifying additional model objects in the same form.
305 # === Generic Examples
307 # <% form_for @person, :url => { :action => "update" } do |person_form| %>
308 # First name: <%= person_form.text_field :first_name %>
309 # Last name : <%= person_form.text_field :last_name %>
311 # <% fields_for @person.permission do |permission_fields| %>
312 # Admin? : <%= permission_fields.check_box :admin %>
316 # ...or if you have an object that needs to be represented as a different
317 # parameter, like a Client that acts as a Person:
319 # <% fields_for :person, @client do |permission_fields| %>
320 # Admin?: <%= permission_fields.check_box :admin %>
323 # ...or if you don't have an object, just a name of the parameter:
325 # <% fields_for :person do |permission_fields| %>
326 # Admin?: <%= permission_fields.check_box :admin %>
329 # Note: This also works for the methods in FormOptionHelper and
330 # DateHelper that are designed to work with an object as base, like
331 # FormOptionHelper#collection_select and DateHelper#datetime_select.
333 # === Nested Attributes Examples
335 # When the object belonging to the current scope has a nested attribute
336 # writer for a certain attribute, fields_for will yield a new scope
337 # for that attribute. This allows you to create forms that set or change
338 # the attributes of a parent object and its associations in one go.
340 # Nested attribute writers are normal setter methods named after an
341 # association. The most common way of defining these writers is either
342 # with +accepts_nested_attributes_for+ in a model definition or by
343 # defining a method with the proper name. For example: the attribute
344 # writer for the association <tt>:address</tt> is called
345 # <tt>address_attributes=</tt>.
347 # Whether a one-to-one or one-to-many style form builder will be yielded
348 # depends on whether the normal reader method returns a _single_ object
349 # or an _array_ of objects.
353 # Consider a Person class which returns a _single_ Address from the
354 # <tt>address</tt> reader method and responds to the
355 # <tt>address_attributes=</tt> writer method:
362 # def address_attributes=(attributes)
363 # # Process the attributes hash
367 # This model can now be used with a nested fields_for, like so:
369 # <% form_for @person, :url => { :action => "update" } do |person_form| %>
371 # <% person_form.fields_for :address do |address_fields| %>
372 # Street : <%= address_fields.text_field :street %>
373 # Zip code: <%= address_fields.text_field :zip_code %>
377 # When address is already an association on a Person you can use
378 # +accepts_nested_attributes_for+ to define the writer method for you:
380 # class Person < ActiveRecord::Base
382 # accepts_nested_attributes_for :address
385 # If you want to destroy the associated model through the form, you have
386 # to enable it first using the <tt>:allow_destroy</tt> option for
387 # +accepts_nested_attributes_for+:
389 # class Person < ActiveRecord::Base
391 # accepts_nested_attributes_for :address, :allow_destroy => true
394 # Now, when you use a form element with the <tt>_delete</tt> parameter,
395 # with a value that evaluates to +true+, you will destroy the associated
396 # model (eg. 1, '1', true, or 'true'):
398 # <% form_for @person, :url => { :action => "update" } do |person_form| %>
400 # <% person_form.fields_for :address do |address_fields| %>
402 # Delete: <%= address_fields.check_box :_delete %>
408 # Consider a Person class which returns an _array_ of Project instances
409 # from the <tt>projects</tt> reader method and responds to the
410 # <tt>projects_attributes=</tt> writer method:
414 # [@project1, @project2]
417 # def projects_attributes=(attributes)
418 # # Process the attributes hash
422 # This model can now be used with a nested fields_for. The block given to
423 # the nested fields_for call will be repeated for each instance in the
426 # <% form_for @person, :url => { :action => "update" } do |person_form| %>
428 # <% person_form.fields_for :projects do |project_fields| %>
429 # <% if project_fields.object.active? %>
430 # Name: <%= project_fields.text_field :name %>
435 # It's also possible to specify the instance to be used:
437 # <% form_for @person, :url => { :action => "update" } do |person_form| %>
439 # <% @person.projects.each do |project| %>
440 # <% if project.active? %>
441 # <% person_form.fields_for :projects, project do |project_fields| %>
442 # Name: <%= project_fields.text_field :name %>
448 # When projects is already an association on Person you can use
449 # +accepts_nested_attributes_for+ to define the writer method for you:
451 # class Person < ActiveRecord::Base
453 # accepts_nested_attributes_for :projects
456 # If you want to destroy any of the associated models through the
457 # form, you have to enable it first using the <tt>:allow_destroy</tt>
458 # option for +accepts_nested_attributes_for+:
460 # class Person < ActiveRecord::Base
462 # accepts_nested_attributes_for :projects, :allow_destroy => true
465 # This will allow you to specify which models to destroy in the
466 # attributes hash by adding a form element for the <tt>_delete</tt>
467 # parameter with a value that evaluates to +true+
468 # (eg. 1, '1', true, or 'true'):
470 # <% form_for @person, :url => { :action => "update" } do |person_form| %>
472 # <% person_form.fields_for :projects do |project_fields| %>
473 # Delete: <%= project_fields.check_box :_delete %>
476 def fields_for(record_or_name_or_array
, *args
, &block
)
477 raise ArgumentError
, "Missing block" unless block_given
?
478 options
= args
.extract_options
!
480 case record_or_name_or_array
482 object_name
= record_or_name_or_array
485 object
= record_or_name_or_array
486 object_name
= ActionController
::RecordIdentifier.singular_class_name(object
)
489 builder
= options
[:builder] || ActionView
::Base.default_form_builder
490 yield builder
.new(object_name
, object
, self, options
, block
)
493 # Returns a label tag tailored for labelling an input field for a specified attribute (identified by +method+) on an object
494 # assigned to the template (identified by +object+). The text of label will default to the attribute name unless you specify
495 # it explicitly. Additional options on the label tag can be passed as a hash with +options+. These options will be tagged
496 # onto the HTML as an HTML element attribute as in the example shown.
499 # label(:post, :title)
500 # # => <label for="post_title">Title</label>
502 # label(:post, :title, "A short title")
503 # # => <label for="post_title">A short title</label>
505 # label(:post, :title, "A short title", :class => "title_label")
506 # # => <label for="post_title" class="title_label">A short title</label>
508 def label(object_name
, method
, text
= nil, options
= {})
509 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_label_tag(text
, options
)
512 # Returns an input tag of the "text" type tailored for accessing a specified attribute (identified by +method+) on an object
513 # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
514 # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
518 # text_field(:post, :title, :size => 20)
519 # # => <input type="text" id="post_title" name="post[title]" size="20" value="#{@post.title}" />
521 # text_field(:post, :title, :class => "create_input")
522 # # => <input type="text" id="post_title" name="post[title]" value="#{@post.title}" class="create_input" />
524 # text_field(:session, :user, :onchange => "if $('session[user]').value == 'admin' { alert('Your login can not be admin!'); }")
525 # # => <input type="text" id="session_user" name="session[user]" value="#{@session.user}" onchange = "if $('session[user]').value == 'admin' { alert('Your login can not be admin!'); }"/>
527 # text_field(:snippet, :code, :size => 20, :class => 'code_input')
528 # # => <input type="text" id="snippet_code" name="snippet[code]" size="20" value="#{@snippet.code}" class="code_input" />
530 def text_field(object_name
, method
, options
= {})
531 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_input_field_tag("text", options
)
534 # Returns an input tag of the "password" type tailored for accessing a specified attribute (identified by +method+) on an object
535 # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
536 # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
540 # password_field(:login, :pass, :size => 20)
541 # # => <input type="text" id="login_pass" name="login[pass]" size="20" value="#{@login.pass}" />
543 # password_field(:account, :secret, :class => "form_input")
544 # # => <input type="text" id="account_secret" name="account[secret]" value="#{@account.secret}" class="form_input" />
546 # password_field(:user, :password, :onchange => "if $('user[password]').length > 30 { alert('Your password needs to be shorter!'); }")
547 # # => <input type="text" id="user_password" name="user[password]" value="#{@user.password}" onchange = "if $('user[password]').length > 30 { alert('Your password needs to be shorter!'); }"/>
549 # password_field(:account, :pin, :size => 20, :class => 'form_input')
550 # # => <input type="text" id="account_pin" name="account[pin]" size="20" value="#{@account.pin}" class="form_input" />
552 def password_field(object_name
, method
, options
= {})
553 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_input_field_tag("password", options
)
556 # Returns a hidden input tag tailored for accessing a specified attribute (identified by +method+) on an object
557 # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
558 # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
562 # hidden_field(:signup, :pass_confirm)
563 # # => <input type="hidden" id="signup_pass_confirm" name="signup[pass_confirm]" value="#{@signup.pass_confirm}" />
565 # hidden_field(:post, :tag_list)
566 # # => <input type="hidden" id="post_tag_list" name="post[tag_list]" value="#{@post.tag_list}" />
568 # hidden_field(:user, :token)
569 # # => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" />
570 def hidden_field(object_name
, method
, options
= {})
571 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_input_field_tag("hidden", options
)
574 # Returns an file upload input tag tailored for accessing a specified attribute (identified by +method+) on an object
575 # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
576 # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
580 # file_field(:user, :avatar)
581 # # => <input type="file" id="user_avatar" name="user[avatar]" />
583 # file_field(:post, :attached, :accept => 'text/html')
584 # # => <input type="file" id="post_attached" name="post[attached]" />
586 # file_field(:attachment, :file, :class => 'file_input')
587 # # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
589 def file_field(object_name
, method
, options
= {})
590 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_input_field_tag("file", options
)
593 # Returns a textarea opening and closing tag set tailored for accessing a specified attribute (identified by +method+)
594 # on an object assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
595 # hash with +options+.
598 # text_area(:post, :body, :cols => 20, :rows => 40)
599 # # => <textarea cols="20" rows="40" id="post_body" name="post[body]">
603 # text_area(:comment, :text, :size => "20x30")
604 # # => <textarea cols="20" rows="30" id="comment_text" name="comment[text]">
608 # text_area(:application, :notes, :cols => 40, :rows => 15, :class => 'app_input')
609 # # => <textarea cols="40" rows="15" id="application_notes" name="application[notes]" class="app_input">
610 # # #{@application.notes}
613 # text_area(:entry, :body, :size => "20x20", :disabled => 'disabled')
614 # # => <textarea cols="20" rows="20" id="entry_body" name="entry[body]" disabled="disabled">
617 def text_area(object_name
, method
, options
= {})
618 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_text_area_tag(options
)
621 # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object
622 # assigned to the template (identified by +object+). This object must be an instance object (@object) and not a local object.
623 # It's intended that +method+ returns an integer and if that integer is above zero, then the checkbox is checked.
624 # Additional options on the input tag can be passed as a hash with +options+. The +checked_value+ defaults to 1
625 # while the default +unchecked_value+ is set to 0 which is convenient for boolean values.
629 # The HTML specification says unchecked check boxes are not successful, and
630 # thus web browsers do not send them. Unfortunately this introduces a gotcha:
631 # if an Invoice model has a +paid+ flag, and in the form that edits a paid
632 # invoice the user unchecks its check box, no +paid+ parameter is sent. So,
633 # any mass-assignment idiom like
635 # @invoice.update_attributes(params[:invoice])
637 # wouldn't update the flag.
639 # To prevent this the helper generates a hidden field with the same name as
640 # the checkbox after the very check box. So, the client either sends only the
641 # hidden field (representing the check box is unchecked), or both fields.
642 # Since the HTML specification says key/value pairs have to be sent in the
643 # same order they appear in the form and Rails parameters extraction always
644 # gets the first occurrence of any given key, that works in ordinary forms.
646 # Unfortunately that workaround does not work when the check box goes
647 # within an array-like parameter, as in
649 # <% fields_for "project[invoice_attributes][]", invoice, :index => nil do |form| %>
650 # <%= form.check_box :paid %>
654 # because parameter name repetition is precisely what Rails seeks to distinguish
655 # the elements of the array.
658 # # Let's say that @post.validated? is 1:
659 # check_box("post", "validated")
660 # # => <input type="checkbox" id="post_validated" name="post[validated]" value="1" />
661 # # <input name="post[validated]" type="hidden" value="0" />
663 # # Let's say that @puppy.gooddog is "no":
664 # check_box("puppy", "gooddog", {}, "yes", "no")
665 # # => <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />
666 # # <input name="puppy[gooddog]" type="hidden" value="no" />
668 # check_box("eula", "accepted", { :class => 'eula_check' }, "yes", "no")
669 # # => <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" />
670 # # <input name="eula[accepted]" type="hidden" value="no" />
672 def check_box(object_name
, method
, options
= {}, checked_value
= "1", unchecked_value
= "0")
673 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_check_box_tag(options
, checked_value
, unchecked_value
)
676 # Returns a radio button tag for accessing a specified attribute (identified by +method+) on an object
677 # assigned to the template (identified by +object+). If the current value of +method+ is +tag_value+ the
678 # radio button will be checked.
680 # To force the radio button to be checked pass <tt>:checked => true</tt> in the
681 # +options+ hash. You may pass HTML options there as well.
684 # # Let's say that @post.category returns "rails":
685 # radio_button("post", "category", "rails")
686 # radio_button("post", "category", "java")
687 # # => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" />
688 # # <input type="radio" id="post_category_java" name="post[category]" value="java" />
690 # radio_button("user", "receive_newsletter", "yes")
691 # radio_button("user", "receive_newsletter", "no")
692 # # => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" />
693 # # <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" />
694 def radio_button(object_name
, method
, tag_value
, options
= {})
695 InstanceTag
.new(object_name
, method
, self, options
.delete(:object)).to_radio_button_tag(tag_value
, options
)
699 class InstanceTag
#:nodoc:
700 include Helpers
::TagHelper, Helpers
::FormTagHelper
702 attr_reader
:method_name, :object_name
704 DEFAULT_FIELD_OPTIONS
= { "size" => 30 }.freeze
unless const_defined
?(:DEFAULT_FIELD_OPTIONS)
705 DEFAULT_RADIO_OPTIONS
= { }.freeze
unless const_defined
?(:DEFAULT_RADIO_OPTIONS)
706 DEFAULT_TEXT_AREA_OPTIONS
= { "cols" => 40, "rows" => 20 }.freeze
unless const_defined
?(:DEFAULT_TEXT_AREA_OPTIONS)
708 def initialize(object_name
, method_name
, template_object
, object
= nil)
709 @object_name, @method_name = object_name
.to_s
.dup
, method_name
.to_s
.dup
710 @template_object = template_object
712 if @object_name.sub
!(/\[\]$/,"") || @object_name.sub
!(/\[\]\]$/,"]")
713 if (object
||= @template_object.instance_variable_get("@#{Regexp.last_match.pre_match}")) && object
.respond_to
?(:to_param)
714 @auto_index = object
.to_param
716 raise ArgumentError
, "object[] naming but object param and @object var don't exist or don't respond to to_param: #{object.inspect}"
721 def to_label_tag(text
= nil, options
= {})
722 options
= options
.stringify_keys
723 name_and_id
= options
.dup
724 add_default_name_and_id(name_and_id
)
725 options
.delete("index")
726 options
["for"] ||= name_and_id
["id"]
727 content
= (text
.blank
? ? nil : text
.to_s
) || method_name
.humanize
728 label_tag(name_and_id
["id"], content
, options
)
731 def to_input_field_tag(field_type
, options
= {})
732 options
= options
.stringify_keys
733 options
["size"] = options
["maxlength"] || DEFAULT_FIELD_OPTIONS
["size"] unless options
.key
?("size")
734 options
= DEFAULT_FIELD_OPTIONS
.merge(options
)
735 if field_type
== "hidden"
736 options
.delete("size")
738 options
["type"] = field_type
739 options
["value"] ||= value_before_type_cast(object
) unless field_type
== "file"
740 options
["value"] &&= html_escape(options
["value"])
741 add_default_name_and_id(options
)
742 tag("input", options
)
745 def to_radio_button_tag(tag_value
, options
= {})
746 options
= DEFAULT_RADIO_OPTIONS
.merge(options
.stringify_keys
)
747 options
["type"] = "radio"
748 options
["value"] = tag_value
749 if options
.has_key
?("checked")
750 cv
= options
.delete
"checked"
751 checked
= cv
== true || cv
== "checked"
753 checked
= self.class.radio_button_checked
?(value(object
), tag_value
)
755 options
["checked"] = "checked" if checked
756 pretty_tag_value
= tag_value
.to_s
.gsub(/\s/, "_").gsub(/\W/, "").downcase
757 options
["id"] ||= defined?(@auto_index) ?
758 "#{tag_id_with_index(@auto_index)}_#{pretty_tag_value}" :
759 "#{tag_id}_#{pretty_tag_value}"
760 add_default_name_and_id(options
)
761 tag("input", options
)
764 def to_text_area_tag(options
= {})
765 options
= DEFAULT_TEXT_AREA_OPTIONS
.merge(options
.stringify_keys
)
766 add_default_name_and_id(options
)
768 if size
= options
.delete("size")
769 options
["cols"], options
["rows"] = size
.split("x") if size
.respond_to
?(:split)
772 content_tag("textarea", html_escape(options
.delete('value') || value_before_type_cast(object
)), options
)
775 def to_check_box_tag(options
= {}, checked_value
= "1", unchecked_value
= "0")
776 options
= options
.stringify_keys
777 options
["type"] = "checkbox"
778 options
["value"] = checked_value
779 if options
.has_key
?("checked")
780 cv
= options
.delete
"checked"
781 checked
= cv
== true || cv
== "checked"
783 checked
= self.class.check_box_checked
?(value(object
), checked_value
)
785 options
["checked"] = "checked" if checked
786 add_default_name_and_id(options
)
787 hidden
= tag("input", "name" => options
["name"], "type" => "hidden", "value" => options
['disabled'] && checked
? checked_value
: unchecked_value
)
788 checkbox
= tag("input", options
)
792 def to_boolean_select_tag(options
= {})
793 options
= options
.stringify_keys
794 add_default_name_and_id(options
)
795 value
= value(object
)
797 tag_text
<< tag_options(options
)
798 tag_text
<< "><option value=\"false\""
799 tag_text
<< " selected" if value
== false
800 tag_text
<< ">False</option><option value=\"true\""
801 tag_text
<< " selected" if value
802 tag_text
<< ">True</option></select>"
805 def to_content_tag(tag_name
, options
= {})
806 content_tag(tag_name
, value(object
), options
)
810 @object || @template_object.instance_variable_get("@#{@object_name}")
812 # As @object_name may contain the nested syntax (item[subobject]) we
813 # need to fallback to nil.
818 self.class.value(object
, @method_name)
821 def value_before_type_cast(object
)
822 self.class.value_before_type_cast(object
, @method_name)
826 def value(object
, method_name
)
827 object
.send method_name
unless object
.nil?
830 def value_before_type_cast(object
, method_name
)
832 object
.respond_to
?(method_name
+ "_before_type_cast") ?
833 object
.send(method_name
+ "_before_type_cast") :
834 object
.send(method_name
)
838 def check_box_checked
?(value
, checked_value
)
840 when TrueClass
, FalseClass
847 value
== checked_value
849 value
.include?(checked_value
)
855 def radio_button_checked
?(value
, checked_value
)
856 value
.to_s
== checked_value
.to_s
861 def add_default_name_and_id(options
)
862 if options
.has_key
?("index")
863 options
["name"] ||= tag_name_with_index(options
["index"])
864 options
["id"] ||= tag_id_with_index(options
["index"])
865 options
.delete("index")
866 elsif defined?(@auto_index)
867 options
["name"] ||= tag_name_with_index(@auto_index)
868 options
["id"] ||= tag_id_with_index(@auto_index)
870 options
["name"] ||= tag_name
+ (options
.has_key
?('multiple') ? '[]' : '')
871 options
["id"] ||= tag_id
876 "#{@object_name}[#{sanitized_method_name}]"
879 def tag_name_with_index(index
)
880 "#{@object_name}[#{index}][#{sanitized_method_name}]"
884 "#{sanitized_object_name}_#{sanitized_method_name}"
887 def tag_id_with_index(index
)
888 "#{sanitized_object_name}_#{index}_#{sanitized_method_name}"
891 def sanitized_object_name
892 @sanitized_object_name ||= @object_name.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
895 def sanitized_method_name
896 @sanitized_method_name ||= @method_name.sub(/\?$/,"")
900 class FormBuilder
#:nodoc:
901 # The methods which wrap a form helper call.
902 class_inheritable_accessor
:field_helpers
903 self.field_helpers
= (FormHelper
.instance_methods
- ['form_for'])
905 attr_accessor
:object_name, :object, :options
907 def initialize(object_name
, object
, template
, options
, proc
)
908 @object_name, @object, @template, @options, @proc = object_name
, object
, template
, options
, proc
909 @default_options = @options ? @options.slice(:index) : {}
910 if @object_name.to_s
.match(/\[\]$/)
911 if object
||= @template.instance_variable_get("@#{Regexp.last_match.pre_match}") and object
.respond_to
?(:to_param)
912 @auto_index = object
.to_param
914 raise ArgumentError
, "object[] naming but object param and @object var don't exist or don't respond to to_param: #{object.inspect}"
919 (field_helpers
- %w(label check_box radio_button fields_for
)).each
do |selector
|
921 def #{selector}(method, options = {}) # def text_field(method, options = {})
922 @template.send( # @template.send(
923 #{selector.inspect}, # "text_field",
924 @object_name, # @object_name,
926 objectify_options(options)) # objectify_options(options))
929 class_eval src
, __FILE__
, __LINE__
932 def fields_for(record_or_name_or_array
, *args
, &block
)
933 if options
.has_key
?(:index)
934 index
= "[#{options[:index]}]"
935 elsif defined?(@auto_index)
936 self.object_name
= @object_name.to_s
.sub(/\[\]$/,"")
937 index
= "[#{@auto_index}]"
943 args
<< {} unless args
.last
.is_a
?(Hash
)
944 args
.last
[:builder] ||= options
[:builder]
947 case record_or_name_or_array
949 if nested_attributes_association
?(record_or_name_or_array
)
950 return fields_for_with_nested_attributes(record_or_name_or_array
, args
, block
)
952 name
= "#{object_name}#{index}[#{record_or_name_or_array}]"
955 object
= record_or_name_or_array
.last
956 name
= "#{object_name}#{index}[#{ActionController::RecordIdentifier.singular_class_name(object)}]"
959 object
= record_or_name_or_array
960 name
= "#{object_name}#{index}[#{ActionController::RecordIdentifier.singular_class_name(object)}]"
964 @template.fields_for(name
, *args
, &block
)
967 def label(method
, text
= nil, options
= {})
968 @template.label(@object_name, method
, text
, objectify_options(options
))
971 def check_box(method
, options
= {}, checked_value
= "1", unchecked_value
= "0")
972 @template.check_box(@object_name, method
, objectify_options(options
), checked_value
, unchecked_value
)
975 def radio_button(method
, tag_value
, options
= {})
976 @template.radio_button(@object_name, method
, tag_value
, objectify_options(options
))
979 def error_message_on(method
, *args
)
980 @template.error_message_on(@object, method
, *args
)
983 def error_messages(options
= {})
984 @template.error_messages_for(@object_name, objectify_options(options
))
987 def submit(value
= "Save changes", options
= {})
988 @template.submit_tag(value
, options
.reverse_merge(:id => "#{object_name}_submit"))
992 def objectify_options(options
)
993 @default_options.merge(options
.merge(:object => @object))
996 def nested_attributes_association
?(association_name
)
997 @object.respond_to
?("#{association_name}_attributes=")
1000 def fields_for_with_nested_attributes(association_name
, args
, block
)
1001 name
= "#{object_name}[#{association_name}_attributes]"
1002 association
= @object.send(association_name
)
1003 explicit_object
= args
.first
if args
.first
.respond_to
?(:new_record?)
1005 if association
.is_a
?(Array
)
1006 children
= explicit_object
? [explicit_object
] : association
1007 explicit_child_index
= args
.last
[:child_index] if args
.last
.is_a
?(Hash
)
1009 children
.map
do |child
|
1010 fields_for_nested_model("#{name}[#{explicit_child_index || nested_child_index}]", child
, args
, block
)
1013 fields_for_nested_model(name
, explicit_object
|| association
, args
, block
)
1017 def fields_for_nested_model(name
, object
, args
, block
)
1018 if object
.new_record
?
1019 @template.fields_for(name
, object
, *args
, &block
)
1021 @template.fields_for(name
, object
, *args
) do |builder
|
1022 @template.concat builder
.hidden_field(:id)
1028 def nested_child_index
1029 @nested_child_index ||= -1
1030 @nested_child_index += 1
1036 cattr_accessor
:default_form_builder
1037 self.default_form_builder
= ::ActionView::Helpers::FormBuilder