form_helper.rb 86.5 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'cgi'
2 3
require 'action_view/helpers/date_helper'
require 'action_view/helpers/tag_helper'
4
require 'action_view/helpers/form_tag_helper'
5
require 'action_view/helpers/active_model_helper'
P
Piotr Sarnacki 已提交
6
require 'action_view/model_naming'
7
require 'active_support/core_ext/module/attribute_accessors'
8
require 'active_support/core_ext/hash/slice'
9
require 'active_support/core_ext/string/output_safety'
10
require 'active_support/core_ext/string/inflections'
D
Initial  
David Heinemeier Hansson 已提交
11 12

module ActionView
13
  # = Action View Form Helpers
D
Initial  
David Heinemeier Hansson 已提交
14
  module Helpers
15 16 17
    # Form helpers are designed to make working with resources much easier
    # compared to using vanilla HTML.
    #
18 19 20 21
    # Typically, a form designed to create or update a resource reflects the
    # identity of the resource in several ways: (i) the url that the form is
    # sent to (the form element's +action+ attribute) should result in a request
    # being routed to the appropriate controller action (with the appropriate <tt>:id</tt>
22
    # parameter in the case of an existing resource), (ii) input fields should
23
    # be named in such a way that in the controller their values appear in the
24
    # appropriate places within the +params+ hash, and (iii) for an existing record,
25 26
    # when the form is initially displayed, input fields corresponding to attributes
    # of the resource should show the current values of those attributes.
27
    #
28 29 30 31 32 33 34 35
    # In Rails, this is usually achieved by creating the form using +form_for+ and
    # a number of related helper methods. +form_for+ generates an appropriate <tt>form</tt>
    # tag and yields a form builder object that knows the model the form is about.
    # Input fields are created by calling methods defined on the form builder, which
    # means they are able to generate the appropriate names and default values
    # corresponding to the model attributes, as well as convenient IDs, etc.
    # Conventions in the generated field names allow controllers to receive form data
    # nicely structured in +params+ with no effort on your side.
36
    #
37 38
    # For example, to create a new person you typically set up a new instance of
    # +Person+ in the <tt>PeopleController#new</tt> action, <tt>@person</tt>, and
39
    # in the view template pass that object to +form_for+:
40 41
    #
    #   <%= form_for @person do |f| %>
42 43 44 45 46 47
    #     <%= f.label :first_name %>:
    #     <%= f.text_field :first_name %><br />
    #
    #     <%= f.label :last_name %>:
    #     <%= f.text_field :last_name %><br />
    #
48 49 50 51 52 53
    #     <%= f.submit %>
    #   <% end %>
    #
    # The HTML generated for this would be (modulus formatting):
    #
    #   <form action="/people" class="new_person" id="new_person" method="post">
54
    #     <div style="display:none">
55 56
    #       <input name="authenticity_token" type="hidden" value="NrOp5bsjoLRuK8IW5+dQEYjKGUJDe7TQoZVvq95Wteg=" />
    #     </div>
57
    #     <label for="person_first_name">First name</label>:
58
    #     <input id="person_first_name" name="person[first_name]" type="text" /><br />
59 60
    #
    #     <label for="person_last_name">Last name</label>:
61
    #     <input id="person_last_name" name="person[last_name]" type="text" /><br />
62
    #
63
    #     <input name="commit" type="submit" value="Create Person" />
64 65
    #   </form>
    #
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
    # As you see, the HTML reflects knowledge about the resource in several spots,
    # like the path the form should be submitted to, or the names of the input fields.
    #
    # In particular, thanks to the conventions followed in the generated field names, the
    # controller gets a nested hash <tt>params[:person]</tt> with the person attributes
    # set in the form. That hash is ready to be passed to <tt>Person.create</tt>:
    #
    #   if @person = Person.create(params[:person])
    #     # success
    #   else
    #     # error handling
    #   end
    #
    # Interestingly, the exact same view code in the previous example can be used to edit
    # a person. If <tt>@person</tt> is an existing record with name "John Smith" and ID 256,
    # the code above as is would yield instead:
    #
83
    #   <form action="/people/256" class="edit_person" id="edit_person_256" method="post">
84
    #     <div style="display:none">
A
Akira Matsuda 已提交
85
    #       <input name="_method" type="hidden" value="patch" />
86 87 88
    #       <input name="authenticity_token" type="hidden" value="NrOp5bsjoLRuK8IW5+dQEYjKGUJDe7TQoZVvq95Wteg=" />
    #     </div>
    #     <label for="person_first_name">First name</label>:
89
    #     <input id="person_first_name" name="person[first_name]" type="text" value="John" /><br />
90 91
    #
    #     <label for="person_last_name">Last name</label>:
92
    #     <input id="person_last_name" name="person[last_name]" type="text" value="Smith" /><br />
93
    #
94
    #     <input name="commit" type="submit" value="Update Person" />
95 96 97 98 99 100 101
    #   </form>
    #
    # Note that the endpoint, default values, and submit button label are tailored for <tt>@person</tt>.
    # That works that way because the involved helpers know whether the resource is a new record or not,
    # and generate HTML accordingly.
    #
    # The controller would receive the form data again in <tt>params[:person]</tt>, ready to be
102
    # passed to <tt>Person#update</tt>:
103
    #
104
    #   if @person.update(params[:person])
105
    #     # success
106
    #   else
107 108 109
    #     # error handling
    #   end
    #
V
Vijay Dev 已提交
110
    # That's how you typically work with resources.
D
Initial  
David Heinemeier Hansson 已提交
111
    module FormHelper
W
wycats 已提交
112 113 114
      extend ActiveSupport::Concern

      include FormTagHelper
115
      include UrlHelper
P
Piotr Sarnacki 已提交
116
      include ModelNaming
J
José Valim 已提交
117

118 119
      # Creates a form that allows the user to create or update the attributes
      # of a specific model object.
120
      #
121 122 123 124 125
      # The method can be used in several slightly different ways, depending on
      # how much you wish to rely on Rails to infer automatically from the model
      # how the form should be constructed. For a generic model object, a form
      # can be created by passing +form_for+ a string or symbol representing
      # the object we are concerned with:
126
      #
127
      #   <%= form_for :person do |f| %>
128 129 130 131
      #     First name: <%= f.text_field :first_name %><br />
      #     Last name : <%= f.text_field :last_name %><br />
      #     Biography : <%= f.text_area :biography %><br />
      #     Admin?    : <%= f.check_box :admin %><br />
132
      #     <%= f.submit %>
133
      #   <% end %>
134
      #
135 136 137 138
      # The variable +f+ yielded to the block is a FormBuilder object that
      # incorporates the knowledge about the model object represented by
      # <tt>:person</tt> passed to +form_for+. Methods defined on the FormBuilder
      # are used to generate fields bound to this model. Thus, for example,
P
Pratik Naik 已提交
139 140 141
      #
      #   <%= f.text_field :first_name %>
      #
142
      # will get expanded to
P
Pratik Naik 已提交
143 144
      #
      #   <%= text_field :person, :first_name %>
H
Hendy Tanata 已提交
145
      # which results in an HTML <tt><input></tt> tag whose +name+ attribute is
146 147 148
      # <tt>person[first_name]</tt>. This means that when the form is submitted,
      # the value entered by the user will be available in the controller as
      # <tt>params[:person][:first_name]</tt>.
P
Pratik Naik 已提交
149
      #
150 151
      # For fields generated in this way using the FormBuilder,
      # if <tt>:person</tt> also happens to be the name of an instance variable
152 153
      # <tt>@person</tt>, the default value of the field shown when the form is
      # initially displayed (e.g. in the situation where you are editing an
154
      # existing record) will be the value of the corresponding attribute of
155
      # <tt>@person</tt>.
P
Pratik Naik 已提交
156
      #
157
      # The rightmost argument to +form_for+ is an
158 159 160 161 162 163 164 165 166 167
      # optional hash of options -
      #
      # * <tt>:url</tt> - The URL the form is to be submitted to. This may be
      #   represented in the same way as values passed to +url_for+ or +link_to+.
      #   So for example you may use a named route directly. When the model is
      #   represented by a string or symbol, as in the example above, if the
      #   <tt>:url</tt> option is not specified, by default the form will be
      #   sent back to the current url (We will describe below an alternative
      #   resource-oriented usage of +form_for+ in which the URL does not need
      #   to be specified explicitly).
168 169
      # * <tt>:namespace</tt> - A namespace for your form to ensure uniqueness of
      #   id attributes on form elements. The namespace attribute will be prefixed
V
Vijay Dev 已提交
170
      #   with underscore on the generated HTML id.
P
Pratik Naik 已提交
171 172
      # * <tt>:html</tt> - Optional HTML attributes for the form tag.
      #
173
      # Also note that +form_for+ doesn't create an exclusive scope. It's still
174 175
      # possible to use both the stand-alone FormHelper methods and methods
      # from FormTagHelper. For example:
176
      #
177
      #   <%= form_for :person do |f| %>
178 179 180
      #     First name: <%= f.text_field :first_name %>
      #     Last name : <%= f.text_field :last_name %>
      #     Biography : <%= text_area :person, :biography %>
181
      #     Admin?    : <%= check_box_tag "person[admin]", "1", @person.company.admin? %>
182
      #     <%= f.submit %>
183 184
      #   <% end %>
      #
185 186 187
      # This also works for the methods in FormOptionHelper and DateHelper that
      # are designed to work with an object as base, like
      # FormOptionHelper#collection_select and DateHelper#datetime_select.
188
      #
189
      # === #form_for with a model object
190
      #
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
      # In the examples above, the object to be created or edited was
      # represented by a symbol passed to +form_for+, and we noted that
      # a string can also be used equivalently. It is also possible, however,
      # to pass a model object itself to +form_for+. For example, if <tt>@post</tt>
      # is an existing record you wish to edit, you can create the form using
      #
      #   <%= form_for @post do |f| %>
      #     ...
      #   <% end %>
      #
      # This behaves in almost the same way as outlined previously, with a
      # couple of small exceptions. First, the prefix used to name the input
      # elements within the form (hence the key that denotes them in the +params+
      # hash) is actually derived from the object's _class_, e.g. <tt>params[:post]</tt>
      # if the object's class is +Post+. However, this can be overwritten using
      # the <tt>:as</tt> option, e.g. -
207
      #
208
      #   <%= form_for(@person, as: :client) do |f| %>
209 210
      #     ...
      #   <% end %>
P
Pratik Naik 已提交
211
      #
212 213 214
      # would result in <tt>params[:client]</tt>.
      #
      # Secondly, the field values shown when the form is initially displayed
215 216
      # are taken from the attributes of the object passed to +form_for+,
      # regardless of whether the object is an instance
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
      # variable. So, for example, if we had a _local_ variable +post+
      # representing an existing record,
      #
      #   <%= form_for post do |f| %>
      #     ...
      #   <% end %>
      #
      # would produce a form with fields whose initial state reflect the current
      # values of the attributes of +post+.
      #
      # === Resource-oriented style
      #
      # In the examples just shown, although not indicated explicitly, we still
      # need to use the <tt>:url</tt> option in order to specify where the
      # form is going to be sent. However, further simplification is possible
      # if the record passed to +form_for+ is a _resource_, i.e. it corresponds
      # to a set of RESTful routes, e.g. defined using the +resources+ method
      # in <tt>config/routes.rb</tt>. In this case Rails will simply infer the
      # appropriate URL from the record itself. For example,
236
      #
237
      #   <%= form_for @post do |f| %>
238 239 240
      #     ...
      #   <% end %>
      #
241
      # is then equivalent to something like:
242
      #
A
Akira Matsuda 已提交
243
      #   <%= form_for @post, as: :post, url: post_path(@post), method: :patch, html: { class: "edit_post", id: "edit_post_45" } do |f| %>
244 245 246
      #     ...
      #   <% end %>
      #
247
      # And for a new record
248
      #
249
      #   <%= form_for(Post.new) do |f| %>
250 251 252
      #     ...
      #   <% end %>
      #
253
      # is equivalent to something like:
254
      #
255
      #   <%= form_for @post, as: :post, url: posts_path, html: { class: "new_post", id: "new_post" } do |f| %>
256 257 258
      #     ...
      #   <% end %>
      #
259
      # However you can still overwrite individual conventions, such as:
260
      #
261
      #   <%= form_for(@post, url: super_posts_path) do |f| %>
262 263 264
      #     ...
      #   <% end %>
      #
265 266
      # You can also set the answer format, like this:
      #
267
      #   <%= form_for(@post, format: :json) do |f| %>
268 269 270
      #     ...
      #   <% end %>
      #
271
      # For namespaced routes, like +admin_post_url+:
272
      #
273
      #   <%= form_for([:admin, @post]) do |f| %>
274 275 276
      #    ...
      #   <% end %>
      #
277
      # If your resource has associations defined, for example, you want to add comments
R
Ray Baxter 已提交
278
      # to the document given that the routes are set correctly:
279 280 281 282 283
      #
      #   <%= form_for([@document, @comment]) do |f| %>
      #    ...
      #   <% end %>
      #
R
Typos  
rspeicher 已提交
284 285
      # Where <tt>@document = Document.find(params[:id])</tt> and
      # <tt>@comment = Comment.new</tt>.
286
      #
287 288
      # === Setting the method
      #
289
      # You can force the form to use the full array of HTTP verbs by setting
290
      #
291
      #    method: (:get|:post|:patch|:put|:delete)
292
      #
293 294 295
      # in the options hash. If the verb is not GET or POST, which are natively
      # supported by HTML forms, the form will be set to POST and a hidden input
      # called _method will carry the intended verb for the server to interpret.
296
      #
S
Stefan Penner 已提交
297
      # === Unobtrusive JavaScript
298 299 300
      #
      # Specifying:
      #
301
      #    remote: true
S
Stefan Penner 已提交
302 303
      #
      # in the options hash creates a form that will allow the unobtrusive JavaScript drivers to modify its
304
      # behavior. The expected default behavior is an XMLHttpRequest in the background instead of the regular
305
      # POST arrangement, but ultimately the behavior is the choice of the JavaScript driver implementor.
306
      # Even though it's using JavaScript to serialize the form elements, the form submission will work just like
S
Stefan Penner 已提交
307 308 309 310
      # a regular submission as viewed by the receiving side (all elements available in <tt>params</tt>).
      #
      # Example:
      #
311
      #   <%= form_for(@post, remote: true) do |f| %>
S
Stefan Penner 已提交
312 313 314 315 316
      #     ...
      #   <% end %>
      #
      # The HTML generated for this would be:
      #
317
      #   <form action='http://www.example.com' method='post' data-remote='true'>
318
      #     <div style='display:none'>
A
Akira Matsuda 已提交
319
      #       <input name='_method' type='hidden' value='patch' />
S
Stefan Penner 已提交
320 321 322 323
      #     </div>
      #     ...
      #   </form>
      #
324 325 326 327 328 329 330 331 332 333 334 335
      # === Setting HTML options
      #
      # You can set data attributes directly by passing in a data hash, but all other HTML options must be wrapped in
      # the HTML key. Example:
      #
      #   <%= form_for(@post, data: { behavior: "autosave" }, html: { name: "go" }) do |f| %>
      #     ...
      #   <% end %>
      #
      # The HTML generated for this would be:
      #
      #   <form action='http://www.example.com' method='post' data-behavior='autosave' name='go'>
336
      #     <div style='display:none'>
A
Akira Matsuda 已提交
337
      #       <input name='_method' type='hidden' value='patch' />
338 339 340 341
      #     </div>
      #     ...
      #   </form>
      #
342 343 344
      # === Removing hidden model id's
      #
      # The form_for method automatically includes the model id as a hidden field in the form.
A
Akira Matsuda 已提交
345 346
      # This is used to maintain the correlation between the form data and its associated model.
      # Some ORM systems do not use IDs on nested models so in this case you want to be able
347 348 349 350 351 352 353
      # to disable the hidden id.
      #
      # In the following example the Post model has many Comments stored within it in a NoSQL database,
      # thus there is no primary key for comments.
      #
      # Example:
      #
V
Vijay Dev 已提交
354
      #   <%= form_for(@post) do |f| %>
355
      #     <%= f.fields_for(:comments, include_id: false) do |cf| %>
356 357 358 359
      #       ...
      #     <% end %>
      #   <% end %>
      #
360 361
      # === Customized form builders
      #
362 363 364 365
      # You can also build forms using a customized FormBuilder class. Subclass
      # FormBuilder and override or define some more helpers, then use your
      # custom builder. For example, let's say you made a helper to
      # automatically add labels to form inputs.
366
      #
367
      #   <%= form_for @person, url: { action: "create" }, builder: LabellingFormBuilder do |f| %>
368 369
      #     <%= f.text_field :first_name %>
      #     <%= f.text_field :last_name %>
S
Santiago Pastorino 已提交
370 371
      #     <%= f.text_area :biography %>
      #     <%= f.check_box :admin %>
372
      #     <%= f.submit %>
373
      #   <% end %>
374
      #
375 376
      # In this case, if you use this:
      #
377
      #   <%= render f %>
378
      #
379 380 381 382 383
      # The rendered template is <tt>people/_labelling_form</tt> and the local
      # variable referencing the form builder is called
      # <tt>labelling_form</tt>.
      #
      # The custom FormBuilder class is automatically merged with the options
384
      # of a nested fields_for call, unless it's explicitly set.
385
      #
386 387
      # In many cases you will want to wrap the above in another helper, so you
      # could do something like the following:
388
      #
389
      #   def labelled_form_for(record_or_name_or_array, *args, &block)
390
      #     options = args.extract_options!
391
      #     form_for(record_or_name_or_array, *(args << options.merge(builder: LabellingFormBuilder)), &block)
392 393
      #   end
      #
394 395
      # If you don't need to attach a form to a model instance, then check out
      # FormTagHelper#form_tag.
396 397 398 399 400 401
      #
      # === Form to external resources
      #
      # When you build forms to external resources sometimes you need to set an authenticity token or just render a form
      # without it, for example when you submit data to a payment gateway number and types of fields could be limited.
      #
402
      # To set an authenticity token you need to pass an <tt>:authenticity_token</tt> parameter
403
      #
404
      #   <%= form_for @invoice, url: external_url, authenticity_token: 'external_token' do |f|
405 406 407 408 409
      #     ...
      #   <% end %>
      #
      # If you don't want to an authenticity token field be rendered at all just pass <tt>false</tt>:
      #
410
      #   <%= form_for @invoice, url: external_url, authenticity_token: false do |f|
411 412
      #     ...
      #   <% end %>
413
      def form_for(record, options = {}, &block)
414
        raise ArgumentError, "Missing block" unless block_given?
415
        html_options = options[:html] ||= {}
416

417 418 419 420 421 422
        case record
        when String, Symbol
          object_name = record
          object      = nil
        else
          object      = record.is_a?(Array) ? record.last : record
423
          raise ArgumentError, "First argument in form cannot contain nil or be empty" unless object
424
          object_name = options[:as] || model_name_from_record_or_class(object).param_key
425
          apply_form_for_options!(record, object, options)
426
        end
427

428 429 430 431
        html_options[:data]   = options.delete(:data)   if options.has_key?(:data)
        html_options[:remote] = options.delete(:remote) if options.has_key?(:remote)
        html_options[:method] = options.delete(:method) if options.has_key?(:method)
        html_options[:authenticity_token] = options.delete(:authenticity_token)
432

433
        builder = instantiate_builder(object_name, object, options)
434
        output  = capture(builder, &block)
435
        html_options[:multipart] ||= builder.multipart?
436

437 438
        html_options = html_options_for_form(options[:url] || {}, html_options)
        form_tag_with_body(html_options, output)
439
      end
440

441
      def apply_form_for_options!(record, object, options) #:nodoc:
442 443
        object = convert_to_model(object)

444
        as = options[:as]
445
        namespace = options[:namespace]
446
        action, method = object.respond_to?(:persisted?) && object.persisted? ? [:edit, :patch] : [:new, :post]
447
        options[:html].reverse_merge!(
448
          class:  as ? "#{action}_#{as}" : dom_class(object, action),
449
          id:     (as ? [namespace, action, as] : [namespace, dom_id(object, action)]).compact.join("_").presence,
450
          method: method
451
        )
452

453 454 455 456 457
        options[:url] ||= if options.key?(:format)
                            polymorphic_path(record, format: options.delete(:format))
                          else
                            polymorphic_path(record, {})
                          end
458
      end
459
      private :apply_form_for_options!
460

461 462 463 464
      # Creates a scope around a specific model object like form_for, but
      # doesn't create the form tags themselves. This makes fields_for suitable
      # for specifying additional model objects in the same form.
      #
465
      # Although the usage and purpose of +fields_for+ is similar to +form_for+'s,
466 467 468 469 470 471 472 473 474 475 476
      # its method signature is slightly different. Like +form_for+, it yields
      # a FormBuilder object associated with a particular model object to a block,
      # and within the block allows methods to be called on the builder to
      # generate fields associated with the model object. Fields may reflect
      # a model object in two ways - how they are named (hence how submitted
      # values appear within the +params+ hash in the controller) and what
      # default values are shown when the form the fields appear in is first
      # displayed. In order for both of these features to be specified independently,
      # both an object name (represented by either a symbol or string) and the
      # object itself can be passed to the method separately -
      #
477
      #   <%= form_for @person do |person_form| %>
478 479
      #     First name: <%= person_form.text_field :first_name %>
      #     Last name : <%= person_form.text_field :last_name %>
480
      #
481
      #     <%= fields_for :permission, @person.permission do |permission_fields| %>
482 483
      #       Admin?  : <%= permission_fields.check_box :admin %>
      #     <% end %>
484
      #
485
      #     <%= person_form.submit %>
486 487
      #   <% end %>
      #
488 489 490 491 492 493 494 495 496
      # In this case, the checkbox field will be represented by an HTML +input+
      # tag with the +name+ attribute <tt>permission[admin]</tt>, and the submitted
      # value will appear in the controller as <tt>params[:permission][:admin]</tt>.
      # If <tt>@person.permission</tt> is an existing record with an attribute
      # +admin+, the initial state of the checkbox when first displayed will
      # reflect the value of <tt>@person.permission.admin</tt>.
      #
      # Often this can be simplified by passing just the name of the model
      # object to +fields_for+ -
497
      #
498
      #   <%= fields_for :permission do |permission_fields| %>
499 500 501
      #     Admin?: <%= permission_fields.check_box :admin %>
      #   <% end %>
      #
502 503 504
      # ...in which case, if <tt>:permission</tt> also happens to be the name of an
      # instance variable <tt>@permission</tt>, the initial state of the input
      # field will reflect the value of that variable's attribute <tt>@permission.admin</tt>.
505
      #
506 507 508 509 510
      # Alternatively, you can pass just the model object itself (if the first
      # argument isn't a string or symbol +fields_for+ will realize that the
      # name has been omitted) -
      #
      #   <%= fields_for @person.permission do |permission_fields| %>
511 512 513
      #     Admin?: <%= permission_fields.check_box :admin %>
      #   <% end %>
      #
514 515 516 517
      # and +fields_for+ will derive the required name of the field from the
      # _class_ of the model object, e.g. if <tt>@person.permission</tt>, is
      # of class +Permission+, the field will still be named <tt>permission[admin]</tt>.
      #
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
      # Note: This also works for the methods in FormOptionHelper and
      # DateHelper that are designed to work with an object as base, like
      # FormOptionHelper#collection_select and DateHelper#datetime_select.
      #
      # === Nested Attributes Examples
      #
      # When the object belonging to the current scope has a nested attribute
      # writer for a certain attribute, fields_for will yield a new scope
      # for that attribute. This allows you to create forms that set or change
      # the attributes of a parent object and its associations in one go.
      #
      # Nested attribute writers are normal setter methods named after an
      # association. The most common way of defining these writers is either
      # with +accepts_nested_attributes_for+ in a model definition or by
      # defining a method with the proper name. For example: the attribute
      # writer for the association <tt>:address</tt> is called
      # <tt>address_attributes=</tt>.
      #
      # Whether a one-to-one or one-to-many style form builder will be yielded
      # depends on whether the normal reader method returns a _single_ object
      # or an _array_ of objects.
      #
      # ==== One-to-one
      #
      # Consider a Person class which returns a _single_ Address from the
      # <tt>address</tt> reader method and responds to the
      # <tt>address_attributes=</tt> writer method:
      #
      #   class Person
      #     def address
      #       @address
      #     end
      #
      #     def address_attributes=(attributes)
      #       # Process the attributes hash
      #     end
      #   end
      #
      # This model can now be used with a nested fields_for, like so:
      #
558
      #   <%= form_for @person do |person_form| %>
559
      #     ...
560
      #     <%= person_form.fields_for :address do |address_fields| %>
561 562 563
      #       Street  : <%= address_fields.text_field :street %>
      #       Zip code: <%= address_fields.text_field :zip_code %>
      #     <% end %>
564
      #     ...
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
      #   <% end %>
      #
      # When address is already an association on a Person you can use
      # +accepts_nested_attributes_for+ to define the writer method for you:
      #
      #   class Person < ActiveRecord::Base
      #     has_one :address
      #     accepts_nested_attributes_for :address
      #   end
      #
      # If you want to destroy the associated model through the form, you have
      # to enable it first using the <tt>:allow_destroy</tt> option for
      # +accepts_nested_attributes_for+:
      #
      #   class Person < ActiveRecord::Base
      #     has_one :address
581
      #     accepts_nested_attributes_for :address, allow_destroy: true
582 583
      #   end
      #
584
      # Now, when you use a form element with the <tt>_destroy</tt> parameter,
585 586 587
      # with a value that evaluates to +true+, you will destroy the associated
      # model (eg. 1, '1', true, or 'true'):
      #
588
      #   <%= form_for @person do |person_form| %>
589
      #     ...
590
      #     <%= person_form.fields_for :address do |address_fields| %>
591
      #       ...
592
      #       Delete: <%= address_fields.check_box :_destroy %>
593
      #     <% end %>
594
      #     ...
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
      #   <% end %>
      #
      # ==== One-to-many
      #
      # Consider a Person class which returns an _array_ of Project instances
      # from the <tt>projects</tt> reader method and responds to the
      # <tt>projects_attributes=</tt> writer method:
      #
      #   class Person
      #     def projects
      #       [@project1, @project2]
      #     end
      #
      #     def projects_attributes=(attributes)
      #       # Process the attributes hash
      #     end
      #   end
      #
613 614 615 616 617 618 619 620 621 622 623 624
      # Note that the <tt>projects_attributes=</tt> writer method is in fact
      # required for fields_for to correctly identify <tt>:projects</tt> as a
      # collection, and the correct indices to be set in the form markup.
      #
      # When projects is already an association on Person you can use
      # +accepts_nested_attributes_for+ to define the writer method for you:
      #
      #   class Person < ActiveRecord::Base
      #     has_many :projects
      #     accepts_nested_attributes_for :projects
      #   end
      #
625 626 627 628
      # This model can now be used with a nested fields_for. The block given to
      # the nested fields_for call will be repeated for each instance in the
      # collection:
      #
629
      #   <%= form_for @person do |person_form| %>
630
      #     ...
631
      #     <%= person_form.fields_for :projects do |project_fields| %>
632 633 634 635
      #       <% if project_fields.object.active? %>
      #         Name: <%= project_fields.text_field :name %>
      #       <% end %>
      #     <% end %>
636
      #     ...
637 638 639 640
      #   <% end %>
      #
      # It's also possible to specify the instance to be used:
      #
641
      #   <%= form_for @person do |person_form| %>
642 643 644
      #     ...
      #     <% @person.projects.each do |project| %>
      #       <% if project.active? %>
645
      #         <%= person_form.fields_for :projects, project do |project_fields| %>
646 647 648 649
      #           Name: <%= project_fields.text_field :name %>
      #         <% end %>
      #       <% end %>
      #     <% end %>
650
      #     ...
651 652
      #   <% end %>
      #
653 654
      # Or a collection to be used:
      #
655
      #   <%= form_for @person do |person_form| %>
656
      #     ...
657
      #     <%= person_form.fields_for :projects, @active_projects do |project_fields| %>
658 659
      #       Name: <%= project_fields.text_field :name %>
      #     <% end %>
660
      #     ...
661 662
      #   <% end %>
      #
663 664 665 666 667 668
      # If you want to destroy any of the associated models through the
      # form, you have to enable it first using the <tt>:allow_destroy</tt>
      # option for +accepts_nested_attributes_for+:
      #
      #   class Person < ActiveRecord::Base
      #     has_many :projects
669
      #     accepts_nested_attributes_for :projects, allow_destroy: true
670 671 672
      #   end
      #
      # This will allow you to specify which models to destroy in the
673
      # attributes hash by adding a form element for the <tt>_destroy</tt>
674 675 676
      # parameter with a value that evaluates to +true+
      # (eg. 1, '1', true, or 'true'):
      #
677
      #   <%= form_for @person do |person_form| %>
678
      #     ...
679
      #     <%= person_form.fields_for :projects do |project_fields| %>
680
      #       Delete: <%= project_fields.check_box :_destroy %>
681
      #     <% end %>
682
      #     ...
683
      #   <% end %>
684 685 686 687 688 689 690 691 692 693 694 695 696
      #
      # When a collection is used you might want to know the index of each
      # object into the array. For this purpose, the <tt>index</tt> method
      # is available in the FormBuilder object.
      #
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <%= person_form.fields_for :projects do |project_fields| %>
      #       Project #<%= project_fields.index %>
      #       ...
      #     <% end %>
      #     ...
      #   <% end %>
697 698 699
      #
      # Note that fields_for will automatically generate a hidden field
      # to store the ID of the record. There are circumstances where this
700
      # hidden field is not needed and you can pass <tt>include_id: false</tt>
701
      # to prevent fields_for from rendering it automatically.
702
      def fields_for(record_name, record_object = nil, options = {}, &block)
703
        builder = instantiate_builder(record_name, record_object, options)
704
        capture(builder, &block)
705 706
      end

707
      # Returns a label tag tailored for labelling an input field for a specified attribute (identified by +method+) on an object
708
      # assigned to the template (identified by +object+). The text of label will default to the attribute name unless a translation
709
      # is found in the current I18n locale (through helpers.label.<modelname>.<attribute>) or you specify it explicitly.
710
      # Additional options on the label tag can be passed as a hash with +options+. These options will be tagged
711 712
      # onto the HTML as an HTML element attribute as in the example shown, except for the <tt>:value</tt> option, which is designed to
      # target labels for radio_button tags (where the value is used in the ID of the input tag).
713 714 715
      #
      # ==== Examples
      #   label(:post, :title)
P
Pratik Naik 已提交
716
      #   # => <label for="post_title">Title</label>
717
      #
J
Janko Marohnić 已提交
718 719
      # You can localize your labels based on model and attribute names.
      # For example you can define the following in your locale (e.g. en.yml)
720
      #
721 722
      #   helpers:
      #     label:
723 724 725
      #       post:
      #         body: "Write your entire text here"
      #
J
Janko Marohnić 已提交
726
      # Which then will result in
727 728 729 730
      #
      #   label(:post, :body)
      #   # => <label for="post_body">Write your entire text here</label>
      #
731 732
      # Localization can also be based purely on the translation of the attribute-name
      # (if you are using ActiveRecord):
733
      #
734
      #   activerecord:
J
José Valim 已提交
735
      #     attributes:
736 737 738 739 740 741
      #       post:
      #         cost: "Total cost"
      #
      #   label(:post, :cost)
      #   # => <label for="post_cost">Total cost</label>
      #
742
      #   label(:post, :title, "A short title")
P
Pratik Naik 已提交
743
      #   # => <label for="post_title">A short title</label>
744
      #
745
      #   label(:post, :title, "A short title", class: "title_label")
P
Pratik Naik 已提交
746
      #   # => <label for="post_title" class="title_label">A short title</label>
747
      #
748
      #   label(:post, :privacy, "Public Post", value: "public")
749 750
      #   # => <label for="post_privacy_public">Public Post</label>
      #
S
Stephen Celis 已提交
751
      #   label(:post, :terms) do
752
      #     'Accept <a href="/terms">Terms</a>.'.html_safe
S
Stephen Celis 已提交
753
      #   end
754
      #   # => <label for="post_terms">Accept <a href="/terms">Terms</a>.</label>
755
      def label(object_name, method, content_or_options = nil, options = nil, &block)
756
        Tags::Label.new(object_name, method, self, content_or_options, options).render(&block)
757 758
      end

D
Initial  
David Heinemeier Hansson 已提交
759 760
      # Returns an input tag of the "text" type tailored for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
761
      # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
D
David Heinemeier Hansson 已提交
762
      # shown.
D
Initial  
David Heinemeier Hansson 已提交
763
      #
764
      # ==== Examples
765
      #   text_field(:post, :title, size: 20)
766 767
      #   # => <input type="text" id="post_title" name="post[title]" size="20" value="#{@post.title}" />
      #
768
      #   text_field(:post, :title, class: "create_input")
769 770
      #   # => <input type="text" id="post_title" name="post[title]" value="#{@post.title}" class="create_input" />
      #
771 772
      #   text_field(:session, :user, onchange: "if ($('#session_user').val() === 'admin') { alert('Your login cannot be admin!'); }")
      #   # => <input type="text" id="session_user" name="session[user]" value="#{@session.user}" onchange="if ($('#session_user').val() === 'admin') { alert('Your login cannot be admin!'); }"/>
773
      #
774
      #   text_field(:snippet, :code, size: 20, class: 'code_input')
775
      #   # => <input type="text" id="snippet_code" name="snippet[code]" size="20" value="#{@snippet.code}" class="code_input" />
776
      def text_field(object_name, method, options = {})
777
        Tags::TextField.new(object_name, method, self, options).render
D
Initial  
David Heinemeier Hansson 已提交
778 779
      end

780 781
      # Returns an input tag of the "password" type tailored for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
782
      # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
X
Xavier Noria 已提交
783
      # shown. For security reasons this field is blank by default; pass in a value via +options+ if this is not desired.
784 785
      #
      # ==== Examples
786
      #   password_field(:login, :pass, size: 20)
787
      #   # => <input type="password" id="login_pass" name="login[pass]" size="20" />
788
      #
789
      #   password_field(:account, :secret, class: "form_input", value: @account.secret)
790
      #   # => <input type="password" id="account_secret" name="account[secret]" value="#{@account.secret}" class="form_input" />
791
      #
792 793
      #   password_field(:user, :password, onchange: "if ($('#user_password').val().length > 30) { alert('Your password needs to be shorter!'); }")
      #   # => <input type="password" id="user_password" name="user[password]" onchange="if ($('#user_password').val().length > 30) { alert('Your password needs to be shorter!'); }"/>
794
      #
795
      #   password_field(:account, :pin, size: 20, class: 'form_input')
796
      #   # => <input type="password" id="account_pin" name="account[pin]" size="20" class="form_input" />
797
      def password_field(object_name, method, options = {})
798
        Tags::PasswordField.new(object_name, method, self, options).render
D
Initial  
David Heinemeier Hansson 已提交
799 800
      end

801 802
      # Returns a hidden input tag tailored for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
803
      # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
804 805
      # shown.
      #
806
      # ==== Examples
807 808 809 810 811 812 813
      #   hidden_field(:signup, :pass_confirm)
      #   # => <input type="hidden" id="signup_pass_confirm" name="signup[pass_confirm]" value="#{@signup.pass_confirm}" />
      #
      #   hidden_field(:post, :tag_list)
      #   # => <input type="hidden" id="post_tag_list" name="post[tag_list]" value="#{@post.tag_list}" />
      #
      #   hidden_field(:user, :token)
814
      #   # => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" />
815
      def hidden_field(object_name, method, options = {})
816
        Tags::HiddenField.new(object_name, method, self, options).render
D
Initial  
David Heinemeier Hansson 已提交
817 818
      end

819
      # Returns a file upload input tag tailored for accessing a specified attribute (identified by +method+) on an object
820
      # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
821
      # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
822 823
      # shown.
      #
824 825
      # Using this method inside a +form_for+ block will set the enclosing form's encoding to <tt>multipart/form-data</tt>.
      #
826 827 828 829 830 831
      # ==== Options
      # * Creates standard HTML attributes for the tag.
      # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input.
      # * <tt>:multiple</tt> - If set to true, *in most updated browsers* the user will be allowed to select multiple files.
      # * <tt>:accept</tt> - If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations.
      #
832 833 834 835
      # ==== Examples
      #   file_field(:user, :avatar)
      #   # => <input type="file" id="user_avatar" name="user[avatar]" />
      #
T
Thiago Pinto 已提交
836 837 838
      #   file_field(:post, :image, :multiple => true)
      #   # => <input type="file" id="post_image" name="post[image]" multiple="true" />
      #
839
      #   file_field(:post, :attached, accept: 'text/html')
840
      #   # => <input accept="text/html" type="file" id="post_attached" name="post[attached]" />
841
      #
T
Thiago Pinto 已提交
842 843 844
      #   file_field(:post, :image, accept: 'image/png,image/gif,image/jpeg')
      #   # => <input type="file" id="post_image" name="post[image]" accept="image/png,image/gif,image/jpeg" />
      #
845
      #   file_field(:attachment, :file, class: 'file_input')
846
      #   # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
847
      def file_field(object_name, method, options = {})
848
        Tags::FileField.new(object_name, method, self, options).render
849 850
      end

D
Initial  
David Heinemeier Hansson 已提交
851 852 853 854
      # Returns a textarea opening and closing tag set tailored for accessing a specified attribute (identified by +method+)
      # on an object assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
      # hash with +options+.
      #
855
      # ==== Examples
856
      #   text_area(:post, :body, cols: 20, rows: 40)
857 858 859 860
      #   # => <textarea cols="20" rows="40" id="post_body" name="post[body]">
      #   #      #{@post.body}
      #   #    </textarea>
      #
861
      #   text_area(:comment, :text, size: "20x30")
862 863 864 865
      #   # => <textarea cols="20" rows="30" id="comment_text" name="comment[text]">
      #   #      #{@comment.text}
      #   #    </textarea>
      #
866
      #   text_area(:application, :notes, cols: 40, rows: 15, class: 'app_input')
867
      #   # => <textarea cols="40" rows="15" id="application_notes" name="application[notes]" class="app_input">
868 869 870
      #   #      #{@application.notes}
      #   #    </textarea>
      #
871
      #   text_area(:entry, :body, size: "20x20", disabled: 'disabled')
872 873 874
      #   # => <textarea cols="20" rows="20" id="entry_body" name="entry[body]" disabled="disabled">
      #   #      #{@entry.body}
      #   #    </textarea>
875
      def text_area(object_name, method, options = {})
876
        Tags::TextArea.new(object_name, method, self, options).render
D
Initial  
David Heinemeier Hansson 已提交
877
      end
878

D
Initial  
David Heinemeier Hansson 已提交
879
      # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object
P
Pratik Naik 已提交
880
      # assigned to the template (identified by +object+). This object must be an instance object (@object) and not a local object.
Y
Yehuda Katz 已提交
881 882
      # It's intended that +method+ returns an integer and if that integer is above zero, then the checkbox is checked.
      # Additional options on the input tag can be passed as a hash with +options+. The +checked_value+ defaults to 1
P
Pratik Naik 已提交
883
      # while the default +unchecked_value+ is set to 0 which is convenient for boolean values.
P
Pratik Naik 已提交
884 885 886 887 888
      #
      # ==== Gotcha
      #
      # The HTML specification says unchecked check boxes are not successful, and
      # thus web browsers do not send them. Unfortunately this introduces a gotcha:
P
Pratik Naik 已提交
889
      # if an +Invoice+ model has a +paid+ flag, and in the form that edits a paid
P
Pratik Naik 已提交
890 891 892
      # invoice the user unchecks its check box, no +paid+ parameter is sent. So,
      # any mass-assignment idiom like
      #
893
      #   @invoice.update(params[:invoice])
P
Pratik Naik 已提交
894 895 896
      #
      # wouldn't update the flag.
      #
P
Pratik Naik 已提交
897 898
      # To prevent this the helper generates an auxiliary hidden field before
      # the very check box. The hidden field has the same name and its
899
      # attributes mimic an unchecked check box.
P
Pratik Naik 已提交
900 901 902 903 904 905
      #
      # This way, the client either sends only the hidden field (representing
      # the check box is unchecked), or both fields. Since the HTML specification
      # says key/value pairs have to be sent in the same order they appear in the
      # form, and parameters extraction gets the last occurrence of any repeated
      # key in the query string, that works for ordinary forms.
P
Pratik Naik 已提交
906 907 908 909
      #
      # Unfortunately that workaround does not work when the check box goes
      # within an array-like parameter, as in
      #
910
      #   <%= fields_for "project[invoice_attributes][]", invoice, index: nil do |form| %>
P
Pratik Naik 已提交
911 912 913 914 915
      #     <%= form.check_box :paid %>
      #     ...
      #   <% end %>
      #
      # because parameter name repetition is precisely what Rails seeks to distinguish
P
Pratik Naik 已提交
916 917 918 919 920
      # the elements of the array. For each item with a checked check box you
      # get an extra ghost item with only that attribute, assigned to "0".
      #
      # In that case it is preferable to either use +check_box_tag+ or to use
      # hashes instead of arrays.
D
Initial  
David Heinemeier Hansson 已提交
921
      #
922
      #   # Let's say that @post.validated? is 1:
D
Initial  
David Heinemeier Hansson 已提交
923
      #   check_box("post", "validated")
P
Pratik Naik 已提交
924
      #   # => <input name="post[validated]" type="hidden" value="0" />
925
      #   #    <input checked="checked" type="checkbox" id="post_validated" name="post[validated]" value="1" />
D
Initial  
David Heinemeier Hansson 已提交
926
      #
927
      #   # Let's say that @puppy.gooddog is "no":
D
Initial  
David Heinemeier Hansson 已提交
928
      #   check_box("puppy", "gooddog", {}, "yes", "no")
P
Pratik Naik 已提交
929 930
      #   # => <input name="puppy[gooddog]" type="hidden" value="no" />
      #   #    <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />
931
      #
932
      #   check_box("eula", "accepted", { class: 'eula_check' }, "yes", "no")
P
Pratik Naik 已提交
933 934
      #   # => <input name="eula[accepted]" type="hidden" value="no" />
      #   #    <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" />
935
      def check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0")
936
        Tags::CheckBox.new(object_name, method, self, checked_value, unchecked_value, options).render
D
Initial  
David Heinemeier Hansson 已提交
937
      end
938 939 940

      # Returns a radio button tag for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). If the current value of +method+ is +tag_value+ the
P
Pratik Naik 已提交
941 942
      # radio button will be checked.
      #
943
      # To force the radio button to be checked pass <tt>checked: true</tt> in the
P
Pratik Naik 已提交
944
      # +options+ hash. You may pass HTML options there as well.
945 946
      #
      #   # Let's say that @post.category returns "rails":
947 948
      #   radio_button("post", "category", "rails")
      #   radio_button("post", "category", "java")
P
Pratik Naik 已提交
949 950
      #   # => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" />
      #   #    <input type="radio" id="post_category_java" name="post[category]" value="java" />
951
      #
952 953
      #   radio_button("user", "receive_newsletter", "yes")
      #   radio_button("user", "receive_newsletter", "no")
P
Pratik Naik 已提交
954 955
      #   # => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" />
      #   #    <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" />
956
      def radio_button(object_name, method, tag_value, options = {})
957
        Tags::RadioButton.new(object_name, method, self, tag_value, options).render
958
      end
959

960 961 962 963 964 965 966 967
      # Returns a text_field of type "color".
      #
      #   color_field("car", "color")
      #   # => <input id="car_color" name="car[color]" type="color" value="#000000" />
      def color_field(object_name, method, options = {})
        Tags::ColorField.new(object_name, method, self, options).render
      end

R
Ray Baxter 已提交
968
      # Returns an input of type "search" for accessing a specified attribute (identified by +method+) on an object
969 970
      # assigned to the template (identified by +object_name+). Inputs of type "search" may be styled differently by
      # some browsers.
R
Ray Baxter 已提交
971 972
      #
      #   search_field(:user, :name)
973
      #   # => <input id="user_name" name="user[name]" type="search" />
974
      #   search_field(:user, :name, autosave: false)
975
      #   # => <input autosave="false" id="user_name" name="user[name]" type="search" />
976
      #   search_field(:user, :name, results: 3)
977
      #   # => <input id="user_name" name="user[name]" results="3" type="search" />
R
Ray Baxter 已提交
978
      #   #  Assume request.host returns "www.example.com"
979
      #   search_field(:user, :name, autosave: true)
980
      #   # => <input autosave="com.example.www" id="user_name" name="user[name]" results="10" type="search" />
981
      #   search_field(:user, :name, onsearch: true)
982
      #   # => <input id="user_name" incremental="true" name="user[name]" onsearch="true" type="search" />
983
      #   search_field(:user, :name, autosave: false, onsearch: true)
984
      #   # => <input autosave="false" id="user_name" incremental="true" name="user[name]" onsearch="true" type="search" />
985
      #   search_field(:user, :name, autosave: true, onsearch: true)
986
      #   # => <input autosave="com.example.www" id="user_name" incremental="true" name="user[name]" onsearch="true" results="10" type="search" />
987
      def search_field(object_name, method, options = {})
988
        Tags::SearchField.new(object_name, method, self, options).render
989 990 991
      end

      # Returns a text_field of type "tel".
992
      #
993
      #   telephone_field("user", "phone")
994
      #   # => <input id="user_phone" name="user[phone]" type="tel" />
995
      #
996
      def telephone_field(object_name, method, options = {})
997
        Tags::TelField.new(object_name, method, self, options).render
998
      end
999
      # aliases telephone_field
1000 1001
      alias phone_field telephone_field

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
      # Returns a text_field of type "date".
      #
      #   date_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="date" />
      #
      # The default value is generated by trying to call "to_date"
      # on the object's value, which makes it behave as expected for instances
      # of DateTime and ActiveSupport::TimeWithZone. You can still override that
      # by passing the "value" option explicitly, e.g.
      #
      #   @user.born_on = Date.new(1984, 1, 27)
      #   date_field("user", "born_on", value: "1984-05-12")
      #   # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-05-12" />
      #
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
      # You can create values for the "min" and "max" attributes by passing
      # instances of Date or Time to the options hash.
      #
      #   date_field("user", "born_on", min: Date.today)
      #   # => <input id="user_born_on" name="user[born_on]" type="date" min="2014-05-20" />
      #
      # Alternatively, you can pass a String formatted as an ISO8601 date as the
      # values for "min" and "max."
      #
      #   date_field("user", "born_on", min: "2014-05-20")
      #   # => <input id="user_born_on" name="user[born_on]" type="date" min="2014-05-20" />
      #
1028 1029 1030 1031
      def date_field(object_name, method, options = {})
        Tags::DateField.new(object_name, method, self, options).render
      end

1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
      # Returns a text_field of type "time".
      #
      # The default value is generated by trying to call +strftime+ with "%T.%L"
      # on the objects's value. It is still possible to override that
      # by passing the "value" option.
      #
      # === Options
      # * Accepts same options as time_field_tag
      #
      # === Example
      #   time_field("task", "started_at")
      #   # => <input id="task_started_at" name="task[started_at]" type="time" />
      #
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
      # You can create values for the "min" and "max" attributes by passing
      # instances of Date or Time to the options hash.
      #
      #   time_field("task", "started_at", min: Time.now)
      #   # => <input id="task_started_at" name="task[started_at]" type="time" min="01:00:00.000" />
      #
      # Alternatively, you can pass a String formatted as an ISO8601 time as the
      # values for "min" and "max."
      #
      #   time_field("task", "started_at", min: "01:00:00")
      #   # => <input id="task_started_at" name="task[started_at]" type="time" min="01:00:00.000" />
      #
1057 1058 1059 1060
      def time_field(object_name, method, options = {})
        Tags::TimeField.new(object_name, method, self, options).render
      end

C
Carlos Galdino 已提交
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
      # Returns a text_field of type "datetime".
      #
      #   datetime_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime" />
      #
      # The default value is generated by trying to call +strftime+ with "%Y-%m-%dT%T.%L%z"
      # on the object's value, which makes it behave as expected for instances
      # of DateTime and ActiveSupport::TimeWithZone.
      #
      #   @user.born_on = Date.new(1984, 1, 12)
      #   datetime_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime" value="1984-01-12T00:00:00.000+0000" />
      #
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
      # You can create values for the "min" and "max" attributes by passing
      # instances of Date or Time to the options hash.
      #
      #   datetime_field("user", "born_on", min: Date.today)
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime" min="2014-05-20T00:00:00.000+0000" />
      #
      # Alternatively, you can pass a String formatted as an ISO8601 datetime
      # with UTC offset as the values for "min" and "max."
      #
      #   datetime_field("user", "born_on", min: "2014-05-20T00:00:00+0000")
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime" min="2014-05-20T00:00:00.000+0000" />
      #
C
Carlos Galdino 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
      def datetime_field(object_name, method, options = {})
        Tags::DatetimeField.new(object_name, method, self, options).render
      end

      # Returns a text_field of type "datetime-local".
      #
      #   datetime_local_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime-local" />
      #
      # The default value is generated by trying to call +strftime+ with "%Y-%m-%dT%T"
      # on the object's value, which makes it behave as expected for instances
      # of DateTime and ActiveSupport::TimeWithZone.
      #
      #   @user.born_on = Date.new(1984, 1, 12)
      #   datetime_local_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime-local" value="1984-01-12T00:00:00" />
      #
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
      # You can create values for the "min" and "max" attributes by passing
      # instances of Date or Time to the options hash.
      #
      #   datetime_local_field("user", "born_on", min: Date.today)
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime-local" min="2014-05-20T00:00:00.000" />
      #
      # Alternatively, you can pass a String formatted as an ISO8601 datetime as
      # the values for "min" and "max."
      #
      #   datetime_local_field("user", "born_on", min: "2014-05-20T00:00:00")
      #   # => <input id="user_born_on" name="user[born_on]" type="datetime-local" min="2014-05-20T00:00:00.000" />
      #
C
Carlos Galdino 已提交
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
      def datetime_local_field(object_name, method, options = {})
        Tags::DatetimeLocalField.new(object_name, method, self, options).render
      end

      # Returns a text_field of type "month".
      #
      #   month_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="month" />
      #
      # The default value is generated by trying to call +strftime+ with "%Y-%m"
      # on the object's value, which makes it behave as expected for instances
      # of DateTime and ActiveSupport::TimeWithZone.
      #
      #   @user.born_on = Date.new(1984, 1, 27)
      #   month_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-01" />
      #
      def month_field(object_name, method, options = {})
        Tags::MonthField.new(object_name, method, self, options).render
      end

      # Returns a text_field of type "week".
      #
      #   week_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="week" />
      #
      # The default value is generated by trying to call +strftime+ with "%Y-W%W"
      # on the object's value, which makes it behave as expected for instances
      # of DateTime and ActiveSupport::TimeWithZone.
      #
      #   @user.born_on = Date.new(1984, 5, 12)
      #   week_field("user", "born_on")
      #   # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-W19" />
      #
      def week_field(object_name, method, options = {})
        Tags::WeekField.new(object_name, method, self, options).render
      end

1153
      # Returns a text_field of type "url".
1154 1155
      #
      #   url_field("user", "homepage")
1156
      #   # => <input id="user_homepage" name="user[homepage]" type="url" />
1157
      #
1158
      def url_field(object_name, method, options = {})
1159
        Tags::UrlField.new(object_name, method, self, options).render
1160 1161 1162
      end

      # Returns a text_field of type "email".
1163 1164
      #
      #   email_field("user", "address")
1165
      #   # => <input id="user_address" name="user[address]" type="email" />
1166
      #
1167
      def email_field(object_name, method, options = {})
1168
        Tags::EmailField.new(object_name, method, self, options).render
1169 1170 1171 1172 1173 1174 1175
      end

      # Returns an input tag of type "number".
      #
      # ==== Options
      # * Accepts same options as number_field_tag
      def number_field(object_name, method, options = {})
1176
        Tags::NumberField.new(object_name, method, self, options).render
1177 1178 1179 1180 1181 1182 1183
      end

      # Returns an input tag of type "range".
      #
      # ==== Options
      # * Accepts same options as range_field_tag
      def range_field(object_name, method, options = {})
1184
        Tags::RangeField.new(object_name, method, self, options).render
1185
      end
1186 1187 1188

      private

1189
        def instantiate_builder(record_name, record_object, options)
1190
          case record_name
1191 1192
          when String, Symbol
            object = record_object
1193
            object_name = record_name
1194
          else
1195
            object = record_name
1196
            object_name = model_name_from_record_or_class(object).param_key
1197 1198
          end

1199
          builder = options[:builder] || default_form_builder
1200
          builder.new(object_name, object, self, options)
1201
        end
1202 1203 1204 1205 1206

        def default_form_builder
          builder = ActionView::Base.default_form_builder
          builder.respond_to?(:constantize) ? builder.constantize : builder
        end
D
Initial  
David Heinemeier Hansson 已提交
1207 1208
    end

1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
    # A +FormBuilder+ object is associated with a particular model object and
    # allows you to generate fields associated with the model object. The
    # +FormBuilder+ object is yielded when using +form_for+ or +fields_for+.
    # For example:
    #
    #   <%= form_for @person do |person_form| %>
    #     Name: <%= person_form.text_field :name %>
    #     Admin: <%= person_form.check_box :admin %>
    #   <% end %>
    #
    # In the above block, the a +FormBuilder+ object is yielded as the
    # +person_form+ variable. This allows you to generate the +text_field+
    # and +check_box+ fields by specifying their eponymous methods, which
    # modify the underlying template and associates the +@person+ model object
    # with the form.
    #
    # The +FormBuilder+ object can be thought of as serving as a proxy for the
    # methods in the +FormHelper+ module. This class, however, allows you to
    # call methods with the model object you are building the form for.
    #
A
Adam Jahnke 已提交
1229
    # You can create your own custom FormBuilder templates by subclassing this
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
    # class. For example:
    #
    #   class MyFormBuilder < ActionView::Helpers::FormBuilder
    #     def div_radio_button(method, tag_value, options = {})
    #       @template.content_tag(:div,
    #         @template.radio_button(
    #           @object_name, method, tag_value, objectify_options(options)
    #         )
    #       )
    #     end
    #
    # The above code creates a new method +div_radio_button+ which wraps a div
    # around the a new radio button. Note that when options are passed in, you
    # must called +objectify_options+ in order for the model object to get
    # correctly passed to the method. If +objectify_options+ is not called,
    # then the newly created helper will not be linked back to the model.
    #
    # The +div_radio_button+ code from above can now be used as follows:
    #
    #   <%= form_for @person, :builder => MyFormBuilder do |f| %>
    #     I am a child: <%= f.div_radio_button(:admin, "child") %>
    #     I am an adult: <%= f.div_radio_button(:admin, "adult") %>
    #   <% end -%>
    #
    # The standard set of helper methods for form building are located in the
    # +field_helpers+ class attribute.
1256
    class FormBuilder
P
Piotr Sarnacki 已提交
1257
      include ModelNaming
1258

1259
      # The methods which wrap a form helper call.
1260
      class_attribute :field_helpers
1261 1262 1263 1264 1265 1266 1267
      self.field_helpers = [:fields_for, :label, :text_field, :password_field,
                            :hidden_field, :file_field, :text_area, :check_box,
                            :radio_button, :color_field, :search_field,
                            :telephone_field, :phone_field, :date_field,
                            :time_field, :datetime_field, :datetime_local_field,
                            :month_field, :week_field, :url_field, :email_field,
                            :number_field, :range_field]
1268

1269
      attr_accessor :object_name, :object, :options
1270

1271
      attr_reader :multipart, :index
1272 1273
      alias :multipart? :multipart

1274 1275
      def multipart=(multipart)
        @multipart = multipart
1276 1277 1278 1279

        if parent_builder = @options[:parent_builder]
          parent_builder.multipart = multipart
        end
1280 1281
      end

1282 1283
      def self._to_partial_path
        @_to_partial_path ||= name.demodulize.underscore.sub!(/_builder$/, '')
1284 1285
      end

1286 1287
      def to_partial_path
        self.class._to_partial_path
Y
Yehuda Katz 已提交
1288 1289
      end

1290 1291 1292 1293
      def to_model
        self
      end

1294
      def initialize(object_name, object, template, options)
1295
        @nested_child_index = {}
1296
        @object_name, @object, @template, @options = object_name, object, template, options
1297
        @default_options = @options ? @options.slice(:index, :namespace) : {}
1298 1299 1300 1301 1302 1303 1304
        if @object_name.to_s.match(/\[\]$/)
          if object ||= @template.instance_variable_get("@#{Regexp.last_match.pre_match}") and object.respond_to?(:to_param)
            @auto_index = object.to_param
          else
            raise ArgumentError, "object[] naming but object param and @object var don't exist or don't respond to to_param: #{object.inspect}"
          end
        end
1305
        @multipart = nil
1306
        @index = options[:index] || options[:child_index]
1307
      end
1308

1309
      (field_helpers - [:label, :check_box, :radio_button, :fields_for, :hidden_field, :file_field]).each do |selector|
1310
        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
1311 1312 1313 1314 1315 1316 1317
          def #{selector}(method, options = {})  # def text_field(method, options = {})
            @template.send(                      #   @template.send(
              #{selector.inspect},               #     "text_field",
              @object_name,                      #     @object_name,
              method,                            #     method,
              objectify_options(options))        #     objectify_options(options))
          end                                    # end
1318
        RUBY_EVAL
1319
      end
1320

1321 1322 1323 1324
      # Creates a scope around a specific model object like form_for, but
      # doesn't create the form tags themselves. This makes fields_for suitable
      # for specifying additional model objects in the same form.
      #
1325
      # Although the usage and purpose of +fields_for+ is similar to +form_for+'s,
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
      # its method signature is slightly different. Like +form_for+, it yields
      # a FormBuilder object associated with a particular model object to a block,
      # and within the block allows methods to be called on the builder to
      # generate fields associated with the model object. Fields may reflect
      # a model object in two ways - how they are named (hence how submitted
      # values appear within the +params+ hash in the controller) and what
      # default values are shown when the form the fields appear in is first
      # displayed. In order for both of these features to be specified independently,
      # both an object name (represented by either a symbol or string) and the
      # object itself can be passed to the method separately -
      #
      #   <%= form_for @person do |person_form| %>
      #     First name: <%= person_form.text_field :first_name %>
      #     Last name : <%= person_form.text_field :last_name %>
      #
      #     <%= fields_for :permission, @person.permission do |permission_fields| %>
      #       Admin?  : <%= permission_fields.check_box :admin %>
      #     <% end %>
      #
1345
      #     <%= person_form.submit %>
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
      #   <% end %>
      #
      # In this case, the checkbox field will be represented by an HTML +input+
      # tag with the +name+ attribute <tt>permission[admin]</tt>, and the submitted
      # value will appear in the controller as <tt>params[:permission][:admin]</tt>.
      # If <tt>@person.permission</tt> is an existing record with an attribute
      # +admin+, the initial state of the checkbox when first displayed will
      # reflect the value of <tt>@person.permission.admin</tt>.
      #
      # Often this can be simplified by passing just the name of the model
      # object to +fields_for+ -
      #
      #   <%= fields_for :permission do |permission_fields| %>
      #     Admin?: <%= permission_fields.check_box :admin %>
      #   <% end %>
      #
      # ...in which case, if <tt>:permission</tt> also happens to be the name of an
      # instance variable <tt>@permission</tt>, the initial state of the input
      # field will reflect the value of that variable's attribute <tt>@permission.admin</tt>.
      #
      # Alternatively, you can pass just the model object itself (if the first
      # argument isn't a string or symbol +fields_for+ will realize that the
      # name has been omitted) -
      #
      #   <%= fields_for @person.permission do |permission_fields| %>
      #     Admin?: <%= permission_fields.check_box :admin %>
      #   <% end %>
      #
      # and +fields_for+ will derive the required name of the field from the
      # _class_ of the model object, e.g. if <tt>@person.permission</tt>, is
      # of class +Permission+, the field will still be named <tt>permission[admin]</tt>.
      #
      # Note: This also works for the methods in FormOptionHelper and
      # DateHelper that are designed to work with an object as base, like
      # FormOptionHelper#collection_select and DateHelper#datetime_select.
      #
      # === Nested Attributes Examples
      #
      # When the object belonging to the current scope has a nested attribute
      # writer for a certain attribute, fields_for will yield a new scope
      # for that attribute. This allows you to create forms that set or change
      # the attributes of a parent object and its associations in one go.
      #
      # Nested attribute writers are normal setter methods named after an
      # association. The most common way of defining these writers is either
      # with +accepts_nested_attributes_for+ in a model definition or by
      # defining a method with the proper name. For example: the attribute
      # writer for the association <tt>:address</tt> is called
      # <tt>address_attributes=</tt>.
      #
      # Whether a one-to-one or one-to-many style form builder will be yielded
      # depends on whether the normal reader method returns a _single_ object
      # or an _array_ of objects.
      #
      # ==== One-to-one
      #
      # Consider a Person class which returns a _single_ Address from the
      # <tt>address</tt> reader method and responds to the
      # <tt>address_attributes=</tt> writer method:
      #
      #   class Person
      #     def address
      #       @address
      #     end
      #
      #     def address_attributes=(attributes)
      #       # Process the attributes hash
      #     end
      #   end
      #
      # This model can now be used with a nested fields_for, like so:
      #
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <%= person_form.fields_for :address do |address_fields| %>
      #       Street  : <%= address_fields.text_field :street %>
      #       Zip code: <%= address_fields.text_field :zip_code %>
      #     <% end %>
      #     ...
      #   <% end %>
      #
      # When address is already an association on a Person you can use
      # +accepts_nested_attributes_for+ to define the writer method for you:
      #
      #   class Person < ActiveRecord::Base
      #     has_one :address
      #     accepts_nested_attributes_for :address
      #   end
      #
      # If you want to destroy the associated model through the form, you have
      # to enable it first using the <tt>:allow_destroy</tt> option for
      # +accepts_nested_attributes_for+:
      #
      #   class Person < ActiveRecord::Base
      #     has_one :address
      #     accepts_nested_attributes_for :address, allow_destroy: true
      #   end
      #
      # Now, when you use a form element with the <tt>_destroy</tt> parameter,
      # with a value that evaluates to +true+, you will destroy the associated
      # model (eg. 1, '1', true, or 'true'):
      #
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <%= person_form.fields_for :address do |address_fields| %>
      #       ...
      #       Delete: <%= address_fields.check_box :_destroy %>
      #     <% end %>
      #     ...
      #   <% end %>
      #
      # ==== One-to-many
      #
      # Consider a Person class which returns an _array_ of Project instances
      # from the <tt>projects</tt> reader method and responds to the
      # <tt>projects_attributes=</tt> writer method:
      #
      #   class Person
      #     def projects
      #       [@project1, @project2]
      #     end
      #
      #     def projects_attributes=(attributes)
      #       # Process the attributes hash
      #     end
      #   end
      #
      # Note that the <tt>projects_attributes=</tt> writer method is in fact
      # required for fields_for to correctly identify <tt>:projects</tt> as a
      # collection, and the correct indices to be set in the form markup.
      #
      # When projects is already an association on Person you can use
      # +accepts_nested_attributes_for+ to define the writer method for you:
      #
      #   class Person < ActiveRecord::Base
      #     has_many :projects
      #     accepts_nested_attributes_for :projects
      #   end
      #
      # This model can now be used with a nested fields_for. The block given to
      # the nested fields_for call will be repeated for each instance in the
      # collection:
      #
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <%= person_form.fields_for :projects do |project_fields| %>
      #       <% if project_fields.object.active? %>
      #         Name: <%= project_fields.text_field :name %>
      #       <% end %>
      #     <% end %>
      #     ...
      #   <% end %>
      #
      # It's also possible to specify the instance to be used:
      #
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <% @person.projects.each do |project| %>
      #       <% if project.active? %>
      #         <%= person_form.fields_for :projects, project do |project_fields| %>
      #           Name: <%= project_fields.text_field :name %>
      #         <% end %>
      #       <% end %>
      #     <% end %>
      #     ...
      #   <% end %>
      #
      # Or a collection to be used:
      #
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <%= person_form.fields_for :projects, @active_projects do |project_fields| %>
      #       Name: <%= project_fields.text_field :name %>
      #     <% end %>
      #     ...
      #   <% end %>
      #
      # If you want to destroy any of the associated models through the
      # form, you have to enable it first using the <tt>:allow_destroy</tt>
      # option for +accepts_nested_attributes_for+:
      #
      #   class Person < ActiveRecord::Base
      #     has_many :projects
      #     accepts_nested_attributes_for :projects, allow_destroy: true
      #   end
      #
      # This will allow you to specify which models to destroy in the
      # attributes hash by adding a form element for the <tt>_destroy</tt>
      # parameter with a value that evaluates to +true+
      # (eg. 1, '1', true, or 'true'):
1536
      #
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <%= person_form.fields_for :projects do |project_fields| %>
      #       Delete: <%= project_fields.check_box :_destroy %>
      #     <% end %>
      #     ...
      #   <% end %>
      #
      # When a collection is used you might want to know the index of each
      # object into the array. For this purpose, the <tt>index</tt> method
      # is available in the FormBuilder object.
      #
      #   <%= form_for @person do |person_form| %>
      #     ...
      #     <%= person_form.fields_for :projects do |project_fields| %>
      #       Project #<%= project_fields.index %>
      #       ...
      #     <% end %>
      #     ...
      #   <% end %>
      #
      # Note that fields_for will automatically generate a hidden field
      # to store the ID of the record. There are circumstances where this
1560
      # hidden field is not needed and you can pass <tt>include_id: false</tt>
1561
      # to prevent fields_for from rendering it automatically.
1562
      def fields_for(record_name, record_object = nil, fields_options = {}, &block)
1563
        fields_options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options?
1564
        fields_options[:builder] ||= options[:builder]
1565
        fields_options[:namespace] = options[:namespace]
1566
        fields_options[:parent_builder] = self
1567

1568
        case record_name
1569
        when String, Symbol
1570 1571
          if nested_attributes_association?(record_name)
            return fields_for_with_nested_attributes(record_name, record_object, fields_options, block)
1572
          end
1573
        else
1574
          record_object = record_name.is_a?(Array) ? record_name.last : record_name
1575
          record_name   = model_name_from_record_or_class(record_object).param_key
1576 1577 1578
        end

        index = if options.has_key?(:index)
1579
          options[:index]
1580 1581
        elsif defined?(@auto_index)
          self.object_name = @object_name.to_s.sub(/\[\]$/,"")
1582
          @auto_index
1583
        end
1584 1585 1586

        record_name = index ? "#{object_name}[#{index}][#{record_name}]" : "#{object_name}[#{record_name}]"
        fields_options[:child_index] = index
1587

1588
        @template.fields_for(record_name, record_object, fields_options, &block)
1589
      end
1590

1591 1592 1593 1594 1595 1596
      # Returns a label tag tailored for labelling an input field for a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). The text of label will default to the attribute name unless a translation
      # is found in the current I18n locale (through helpers.label.<modelname>.<attribute>) or you specify it explicitly.
      # Additional options on the label tag can be passed as a hash with +options+. These options will be tagged
      # onto the HTML as an HTML element attribute as in the example shown, except for the <tt>:value</tt> option, which is designed to
      # target labels for radio_button tags (where the value is used in the ID of the input tag).
1597
      #
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
      # ==== Examples
      #   label(:post, :title)
      #   # => <label for="post_title">Title</label>
      #
      # You can localize your labels based on model and attribute names.
      # For example you can define the following in your locale (e.g. en.yml)
      #
      #   helpers:
      #     label:
      #       post:
      #         body: "Write your entire text here"
      #
      # Which then will result in
      #
      #   label(:post, :body)
      #   # => <label for="post_body">Write your entire text here</label>
      #
      # Localization can also be based purely on the translation of the attribute-name
      # (if you are using ActiveRecord):
      #
      #   activerecord:
      #     attributes:
      #       post:
      #         cost: "Total cost"
      #
      #   label(:post, :cost)
      #   # => <label for="post_cost">Total cost</label>
      #
      #   label(:post, :title, "A short title")
      #   # => <label for="post_title">A short title</label>
      #
      #   label(:post, :title, "A short title", class: "title_label")
      #   # => <label for="post_title" class="title_label">A short title</label>
      #
      #   label(:post, :privacy, "Public Post", value: "public")
      #   # => <label for="post_privacy_public">Public Post</label>
      #
      #   label(:post, :terms) do
      #     'Accept <a href="/terms">Terms</a>.'.html_safe
      #   end
S
Stephen Celis 已提交
1638 1639
      def label(method, text = nil, options = {}, &block)
        @template.label(@object_name, method, text, objectify_options(options), &block)
1640
      end
1641

1642 1643 1644 1645 1646
      # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). This object must be an instance object (@object) and not a local object.
      # It's intended that +method+ returns an integer and if that integer is above zero, then the checkbox is checked.
      # Additional options on the input tag can be passed as a hash with +options+. The +checked_value+ defaults to 1
      # while the default +unchecked_value+ is set to 0 which is convenient for boolean values.
1647
      #
1648 1649 1650 1651 1652 1653 1654 1655
      # ==== Gotcha
      #
      # The HTML specification says unchecked check boxes are not successful, and
      # thus web browsers do not send them. Unfortunately this introduces a gotcha:
      # if an +Invoice+ model has a +paid+ flag, and in the form that edits a paid
      # invoice the user unchecks its check box, no +paid+ parameter is sent. So,
      # any mass-assignment idiom like
      #
1656
      #   @invoice.update(params[:invoice])
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
      #
      # wouldn't update the flag.
      #
      # To prevent this the helper generates an auxiliary hidden field before
      # the very check box. The hidden field has the same name and its
      # attributes mimic an unchecked check box.
      #
      # This way, the client either sends only the hidden field (representing
      # the check box is unchecked), or both fields. Since the HTML specification
      # says key/value pairs have to be sent in the same order they appear in the
      # form, and parameters extraction gets the last occurrence of any repeated
      # key in the query string, that works for ordinary forms.
      #
      # Unfortunately that workaround does not work when the check box goes
      # within an array-like parameter, as in
      #
      #   <%= fields_for "project[invoice_attributes][]", invoice, index: nil do |form| %>
      #     <%= form.check_box :paid %>
      #     ...
      #   <% end %>
      #
      # because parameter name repetition is precisely what Rails seeks to distinguish
      # the elements of the array. For each item with a checked check box you
      # get an extra ghost item with only that attribute, assigned to "0".
      #
      # In that case it is preferable to either use +check_box_tag+ or to use
      # hashes instead of arrays.
      #
      #   # Let's say that @post.validated? is 1:
      #   check_box("post", "validated")
      #   # => <input name="post[validated]" type="hidden" value="0" />
      #   #    <input checked="checked" type="checkbox" id="post_validated" name="post[validated]" value="1" />
      #
      #   # Let's say that @puppy.gooddog is "no":
      #   check_box("puppy", "gooddog", {}, "yes", "no")
      #   # => <input name="puppy[gooddog]" type="hidden" value="no" />
      #   #    <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />
      #
      #   check_box("eula", "accepted", { class: 'eula_check' }, "yes", "no")
      #   # => <input name="eula[accepted]" type="hidden" value="no" />
      #   #    <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" />
1698
      def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
1699
        @template.check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value)
1700
      end
1701

1702 1703 1704 1705 1706 1707
      # Returns a radio button tag for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). If the current value of +method+ is +tag_value+ the
      # radio button will be checked.
      #
      # To force the radio button to be checked pass <tt>checked: true</tt> in the
      # +options+ hash. You may pass HTML options there as well.
1708
      #
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718
      #   # Let's say that @post.category returns "rails":
      #   radio_button("post", "category", "rails")
      #   radio_button("post", "category", "java")
      #   # => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" />
      #   #    <input type="radio" id="post_category_java" name="post[category]" value="java" />
      #
      #   radio_button("user", "receive_newsletter", "yes")
      #   radio_button("user", "receive_newsletter", "no")
      #   # => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" />
      #   #    <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" />
1719
      def radio_button(method, tag_value, options = {})
1720
        @template.radio_button(@object_name, method, tag_value, objectify_options(options))
1721
      end
1722

1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736
      # Returns a hidden input tag tailored for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
      # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
      # shown.
      #
      # ==== Examples
      #   hidden_field(:signup, :pass_confirm)
      #   # => <input type="hidden" id="signup_pass_confirm" name="signup[pass_confirm]" value="#{@signup.pass_confirm}" />
      #
      #   hidden_field(:post, :tag_list)
      #   # => <input type="hidden" id="post_tag_list" name="post[tag_list]" value="#{@post.tag_list}" />
      #
      #   hidden_field(:user, :token)
      #   # => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" />
1737
      #
1738 1739 1740 1741
      def hidden_field(method, options = {})
        @emitted_hidden_id = true if method == :id
        @template.hidden_field(@object_name, method, objectify_options(options))
      end
1742

1743 1744 1745 1746 1747 1748
      # Returns a file upload input tag tailored for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
      # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
      # shown.
      #
      # Using this method inside a +form_for+ block will set the enclosing form's encoding to <tt>multipart/form-data</tt>.
1749
      #
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
      # ==== Options
      # * Creates standard HTML attributes for the tag.
      # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input.
      # * <tt>:multiple</tt> - If set to true, *in most updated browsers* the user will be allowed to select multiple files.
      # * <tt>:accept</tt> - If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations.
      #
      # ==== Examples
      #   file_field(:user, :avatar)
      #   # => <input type="file" id="user_avatar" name="user[avatar]" />
      #
      #   file_field(:post, :image, :multiple => true)
      #   # => <input type="file" id="post_image" name="post[image]" multiple="true" />
      #
      #   file_field(:post, :attached, accept: 'text/html')
      #   # => <input accept="text/html" type="file" id="post_attached" name="post[attached]" />
      #
      #   file_field(:post, :image, accept: 'image/png,image/gif,image/jpeg')
      #   # => <input type="file" id="post_image" name="post[image]" accept="image/png,image/gif,image/jpeg" />
      #
      #   file_field(:attachment, :file, class: 'file_input')
      #   # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
1771
      def file_field(method, options = {})
1772
        self.multipart = true
1773 1774
        @template.file_field(@object_name, method, objectify_options(options))
      end
1775

1776 1777 1778
      # Add the submit button for the given form. When no value is given, it checks
      # if the object is a new resource or not to create the proper label:
      #
1779
      #   <%= form_for @post do |f| %>
1780 1781
      #     <%= f.submit %>
      #   <% end %>
1782
      #
1783 1784 1785 1786
      # In the example above, if @post is a new record, it will use "Create Post" as
      # submit button label, otherwise, it uses "Update Post".
      #
      # Those labels can be customized using I18n, under the helpers.submit key and accept
1787
      # the %{model} as translation interpolation:
1788 1789 1790 1791
      #
      #   en:
      #     helpers:
      #       submit:
1792 1793
      #         create: "Create a %{model}"
      #         update: "Confirm changes to %{model}"
1794
      #
1795 1796 1797 1798 1799 1800
      # It also searches for a key specific for the given object:
      #
      #   en:
      #     helpers:
      #       submit:
      #         post:
1801
      #           create: "Add %{model}"
1802
      #
1803 1804
      def submit(value=nil, options={})
        value, options = nil, value if value.is_a?(Hash)
1805
        value ||= submit_default_value
1806
        @template.submit_tag(value, options)
1807
      end
1808

1809 1810 1811 1812 1813 1814 1815 1816
      # Add the submit button for the given form. When no value is given, it checks
      # if the object is a new resource or not to create the proper label:
      #
      #   <%= form_for @post do |f| %>
      #     <%= f.button %>
      #   <% end %>
      #
      # In the example above, if @post is a new record, it will use "Create Post" as
1817
      # button label, otherwise, it uses "Update Post".
1818
      #
1819 1820
      # Those labels can be customized using I18n, under the helpers.submit key
      # (the same as submit helper) and accept the %{model} as translation interpolation:
1821 1822 1823
      #
      #   en:
      #     helpers:
1824
      #       submit:
1825 1826 1827 1828 1829 1830 1831
      #         create: "Create a %{model}"
      #         update: "Confirm changes to %{model}"
      #
      # It also searches for a key specific for the given object:
      #
      #   en:
      #     helpers:
1832
      #       submit:
1833 1834 1835
      #         post:
      #           create: "Add %{model}"
      #
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
      # ==== Examples
      #   button("Create a post")
      #   # => <button name='button' type='submit'>Create post</button>
      #
      #   button do
      #     content_tag(:strong, 'Ask me!')
      #   end
      #   # => <button name='button' type='submit'>
      #   #      <strong>Ask me!</strong>
      #   #    </button>
      #
      def button(value = nil, options = {}, &block)
1848 1849
        value, options = nil, value if value.is_a?(Hash)
        value ||= submit_default_value
1850
        @template.button_tag(value, options, &block)
1851 1852
      end

1853
      def emitted_hidden_id?
1854
        @emitted_hidden_id ||= nil
1855 1856
      end

1857 1858
      private
        def objectify_options(options)
1859
          @default_options.merge(options.merge(object: @object))
1860
        end
1861

1862
        def submit_default_value
1863
          object = convert_to_model(@object)
1864
          key    = object ? (object.persisted? ? :update : :create) : :submit
1865 1866 1867 1868 1869 1870 1871

          model = if object.class.respond_to?(:model_name)
            object.class.model_name.human
          else
            @object_name.to_s.humanize
          end

1872 1873 1874 1875 1876
          defaults = []
          defaults << :"helpers.submit.#{object_name}.#{key}"
          defaults << :"helpers.submit.#{key}"
          defaults << "#{key.to_s.humanize} #{model}"

1877
          I18n.t(defaults.shift, model: model, default: defaults)
1878 1879
        end

1880 1881 1882 1883
        def nested_attributes_association?(association_name)
          @object.respond_to?("#{association_name}_attributes=")
        end

1884
        def fields_for_with_nested_attributes(association_name, association, options, block)
1885
          name = "#{object_name}[#{association_name}_attributes]"
1886
          association = convert_to_model(association)
1887

1888
          if association.respond_to?(:persisted?)
1889
            association = [association] if @object.send(association_name).respond_to?(:to_ary)
1890
          elsif !association.respond_to?(:to_ary)
1891 1892
            association = @object.send(association_name)
          end
1893

1894
          if association.respond_to?(:to_ary)
1895
            explicit_child_index = options[:child_index]
W
wycats 已提交
1896 1897
            output = ActiveSupport::SafeBuffer.new
            association.each do |child|
1898 1899
              options[:child_index] = nested_child_index(name) unless explicit_child_index
              output << fields_for_nested_model("#{name}[#{options[:child_index]}]", child, options, block)
W
wycats 已提交
1900 1901
            end
            output
1902
          elsif association
1903
            fields_for_nested_model(name, association, options, block)
1904 1905 1906
          end
        end

1907
        def fields_for_nested_model(name, object, fields_options, block)
1908
          object = convert_to_model(object)
1909 1910 1911
          emit_hidden_id = object.persisted? && fields_options.fetch(:include_id) {
            options.fetch(:include_id, true)
          }
1912

1913
          @template.fields_for(name, object, fields_options) do |f|
1914
            output = @template.capture(f, &block)
1915
            output.concat f.hidden_field(:id) if output && emit_hidden_id && !f.emitted_hidden_id?
1916 1917
            output
          end
1918 1919
        end

1920 1921 1922
        def nested_child_index(name)
          @nested_child_index[name] ||= -1
          @nested_child_index[name] += 1
1923
        end
1924
    end
D
Initial  
David Heinemeier Hansson 已提交
1925
  end
1926

1927
  ActiveSupport.on_load(:action_view) do
1928
    cattr_accessor(:default_form_builder) { ::ActionView::Helpers::FormBuilder }
1929
  end
J
Jeremy Kemper 已提交
1930
end