form_helper.rb 29.3 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'
D
Initial  
David Heinemeier Hansson 已提交
4 5 6

module ActionView
  module Helpers
7 8 9 10 11
    # Form helpers are designed to make working with models much easier than just standard html elements by
    # providing a set of methods for creating forms based on your models.  This helper generates the HTML for forms,
    # providing a method for each sort of input (e.g., text, password, select, and so on).  When the form is 
    # submitted (i.e., when the user hits the submit button or <tt>form.submit</tt> is called via JavaScript), the form 
    # inputs will be bundled into the <tt>params</tt> object and passed back to the controller.
D
David Heinemeier Hansson 已提交
12
    #
13 14 15
    # There are two types of form helpers: those that specifically work with model attributes and those that don't.  
    # This helper deals with those that work with model attributes; to see an example of form helpers that don't work
    # with model attributes, check the ActionView::Helpers::FormTagHelper documentation.
D
David Heinemeier Hansson 已提交
16
    #
17 18
    # The core method of this helper, form_for, gives you the ability to create a form for a model instance; 
    # for example, let's say that you have a model <tt>Person</tt> and want to create a new instance of it:
D
Initial  
David Heinemeier Hansson 已提交
19
    #
20 21 22
    #     # Note: a @person variable will have been created in the controller. 
    #     # For example: @person = Person.new
    #     <% form_for :person, @person, :url => { :action => "create" } do |f| %>
D
David Heinemeier Hansson 已提交
23 24
    #       <%= f.text_field :first_name %>
    #       <%= f.text_field :last_name %>
25
    #       <%= submit_tag 'Create' %>
D
David Heinemeier Hansson 已提交
26
    #     <% end %>
D
Initial  
David Heinemeier Hansson 已提交
27
    #
28
    # The HTML generated for this would be:
D
Initial  
David Heinemeier Hansson 已提交
29
    #
30
    #     <form action="/persons/create" method="post">
D
David Heinemeier Hansson 已提交
31 32
    #       <input id="person_first_name" name="person[first_name]" size="30" type="text" />
    #       <input id="person_last_name" name="person[last_name]" size="30" type="text" />
33
    #       <input name="commit" type="submit" value="Create" />
D
David Heinemeier Hansson 已提交
34
    #     </form>
D
Initial  
David Heinemeier Hansson 已提交
35
    #
36
    # The <tt>params</tt> object created when this form is submitted would look like:
D
Initial  
David Heinemeier Hansson 已提交
37
    #
38
    #     {"action"=>"create", "controller"=>"persons", "person"=>{"first_name"=>"William", "last_name"=>"Smith"}}
D
David Heinemeier Hansson 已提交
39
    # 
40 41 42
    # The params hash has a nested <tt>person</tt> value, which can therefore be accessed with <tt>params[:person]</tt> in the controller.
    # If were editing/updating an instance (e.g., <tt>Person.find(1)</tt> rather than <tt>Person.new</tt> in the controller), the objects
    # attribute values are filled into the form (e.g., the <tt>person_first_name</tt> field would have that person's first name in it).
D
David Heinemeier Hansson 已提交
43
    #    
44
    # If the object name contains square brackets the id for the object will be inserted. For example:
45
    #
46
    #   <%= text_field "person[]", "name" %> 
47
    # 
48
    # ...will generate the following ERb.
49 50 51
    #
    #   <input type="text" id="person_<%= @person.id %>_name" name="person[<%= @person.id %>][name]" value="<%= @person.name %>" />
    #
52
    # If the helper is being used to generate a repetitive sequence of similar form elements, for example in a partial
53
    # used by <tt>render_collection_of_partials</tt>, the <tt>index</tt> option may come in handy. Example:
54 55 56
    #
    #   <%= text_field "person", "name", "index" => 1 %>
    #
57
    # ...becomes...
58
    #
59 60
    #   <input type="text" id="person_1_name" name="person[1][name]" value="<%= @person.name %>" />
    #
D
David Heinemeier Hansson 已提交
61
    # There are also methods for helping to build form tags in link:classes/ActionView/Helpers/FormOptionsHelper.html,
D
Initial  
David Heinemeier Hansson 已提交
62 63
    # link:classes/ActionView/Helpers/DateHelper.html, and link:classes/ActionView/Helpers/ActiveRecordHelper.html
    module FormHelper
64 65
      # Creates a form and a scope around a specific model object that is used as a base for questioning about
      # values for the fields.  
66
      #
N
Nicholas Seckar 已提交
67
      #   <% form_for :person, @person, :url => { :action => "update" } do |f| %>
68 69 70 71 72 73
      #     First name: <%= f.text_field :first_name %>
      #     Last name : <%= f.text_field :last_name %>
      #     Biography : <%= f.text_area :biography %>
      #     Admin?    : <%= f.check_box :admin %>
      #   <% end %>
      #
D
David Heinemeier Hansson 已提交
74
      # Worth noting is that the form_for tag is called in a ERb evaluation block, not an ERb output block. So that's <tt><% %></tt>, 
75
      # not <tt><%= %></tt>. Also worth noting is that form_for yields a <tt>form_builder</tt> object, in this example as <tt>f</tt>, which emulates
76 77 78
      # the API for the stand-alone FormHelper methods, but without the object name. So instead of <tt>text_field :person, :name</tt>,
      # you get away with <tt>f.text_field :name</tt>. 
      #
79 80
      # Even further, the form_for method allows you to more easily escape the instance variable convention.  So while the stand-alone 
      # approach would require <tt>text_field :person, :name, :object => person</tt> 
81
      # to work with local variables instead of instance ones, the form_for calls remain the same. You simply declare once with 
82
      # <tt>:person, person</tt> and all subsequent field calls save <tt>:person</tt> and <tt>:object => person</tt>.
83 84
      #
      # Also note that form_for doesn't create an exclusive scope. It's still possible to use both the stand-alone FormHelper methods
85
      # and methods from FormTagHelper. For example:
86
      #
87
      #   <% form_for :person, @person, :url => { :action => "update" } do |f| %>
88 89 90 91 92 93 94
      #     First name: <%= f.text_field :first_name %>
      #     Last name : <%= f.text_field :last_name %>
      #     Biography : <%= text_area :person, :biography %>
      #     Admin?    : <%= check_box_tag "person[admin]", @person.company.admin? %>
      #   <% end %>
      #
      # Note: This also works for the methods in FormOptionHelper and DateHelper that are designed to work with an object as base.
95
      # Like FormOptionHelper#collection_select and DateHelper#datetime_select.
96
      #
97
      # HTML attributes for the form tag can be given as :html => {...}. For example:
98 99 100 101 102
      #     
      #   <% form_for :person, @person, :html => {:id => 'person_form'} do |f| %>
      #     ...
      #   <% end %>
      #
103 104 105
      # The above form will then have the <tt>id</tt> attribute with the value </tt>person_form</tt>, which you can then
      # style with CSS or manipulate with JavaScript.
      #
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
      # === Relying on record identification
      #
      # In addition to manually configuring the form_for call, you can also rely on record identification, which will use
      # the conventions and named routes of that approach. Examples:
      #
      #   <% form_for(@post) do |f| %>
      #     ...
      #   <% end %>
      #
      # This will expand to be the same as:
      #
      #   <% form_for :post, @post, :url => post_path(@post), :html => { :method => :put, :class => "edit_post", :id => "edit_post_45" } do |f| %>
      #     ...
      #   <% end %>
      #
      # And for new records:
      #
      #   <% form_for(Post.new) do |f| %>
      #     ...
      #   <% end %>
      #
      # This will expand to be the same as:
      #
      #   <% form_for :post, @post, :url => posts_path, :html => { :class => "new_post", :id => "new_post" } do |f| %>
      #     ...
      #   <% end %>
      #
      # You can also overwrite the individual conventions, like this:
      #
      #   <% form_for(@post, :url => super_post_path(@post)) do |f| %>
      #     ...
      #   <% end %>
      #
      # === Customized form builders
      #
141
      # You can also build forms using a customized FormBuilder class. Subclass FormBuilder and override or define some more helpers,
142
      # then use your custom builder.  For example, let's say you made a helper to automatically add labels to form inputs.
143 144 145 146 147 148 149 150
      #   
      #   <% form_for :person, @person, :url => { :action => "update" }, :builder => LabellingFormBuilder do |f| %>
      #     <%= f.text_field :first_name %>
      #     <%= f.text_field :last_name %>
      #     <%= text_area :person, :biography %>
      #     <%= check_box_tag "person[admin]", @person.company.admin? %>
      #   <% end %>
      # 
151
      # In many cases you will want to wrap the above in another helper, so you could do something like the following:
152 153 154 155 156
      #
      #   def labelled_form_for(name, object, options, &proc)
      #     form_for(name, object, options.merge(:builder => LabellingFormBuiler), &proc)
      #   end
      #
157
      # If you don't need to attach a form to a model instance, then check out FormTagHelper#form_tag.
158
      def form_for(record_or_name_or_array, *args, &proc)
159
        raise ArgumentError, "Missing block" unless block_given?
160

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

163
        case record_or_name_or_array
164
        when String, Symbol
165
          object_name = record_or_name_or_array
166
        when Array
167
          object = record_or_name_or_array.last
168
          object_name = ActionController::RecordIdentifier.singular_class_name(object)
169 170
          # apply_form_for_options!(object, options, *record_or_name_or_array)
          apply_form_for_options!(record_or_name_or_array, options)
171
          args.unshift object
172
        else
173
          object = record_or_name_or_array
174
          object_name = ActionController::RecordIdentifier.singular_class_name(object)
175
          apply_form_for_options!([ object ], options)
176
          args.unshift object
177 178
        end

179
        concat(form_tag(options.delete(:url) || {}, options.delete(:html) || {}), proc.binding)
180
        fields_for(object_name, *(args << options), &proc)
181
        concat('</form>', proc.binding)
182
      end
183

184 185 186
      def apply_form_for_options!(object_or_array, options) #:nodoc:
        object = object_or_array.is_a?(Array) ? object_or_array.last : object_or_array
        
187 188 189 190 191 192 193
        html_options =
          if object.respond_to?(:new_record?) && object.new_record?
            { :class  => dom_class(object, :new),  :id => dom_id(object), :method => :post }
          else
            { :class  => dom_class(object, :edit), :id => dom_id(object, :edit), :method => :put }
          end

194 195
        options[:html] ||= {}
        options[:html].reverse_merge!(html_options)
196
        options[:url] ||= polymorphic_path(object_or_array)
197
      end
198 199

      # Creates a scope around a specific model object like form_for, but doesn't create the form tags themselves. This makes
200
      # fields_for suitable for specifying additional model objects in the same form:
201
      #
202
      # ==== Examples
203
      #   <% form_for :person, @person, :url => { :action => "update" } do |person_form| %>
204 205 206
      #     First name: <%= person_form.text_field :first_name %>
      #     Last name : <%= person_form.text_field :last_name %>
      #     
207
      #     <% fields_for :permission, @person.permission do |permission_fields| %>
208 209 210 211
      #       Admin?  : <%= permission_fields.check_box :admin %>
      #     <% end %>
      #   <% end %>
      #
212 213
      # 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.
214
      def fields_for(object_name, *args, &block)
215
        raise ArgumentError, "Missing block" unless block_given?
216 217
        options = args.last.is_a?(Hash) ? args.pop : {}
        object  = args.first
218 219 220

        builder = options[:builder] || ActionView::Base.default_form_builder
        yield builder.new(object_name, object, self, options, block)
221 222
      end

D
Initial  
David Heinemeier Hansson 已提交
223 224
      # 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
225
      # hash with +options+.  These options will be tagged onto the html as an HTML element attribute as in the example
D
David Heinemeier Hansson 已提交
226
      # shown.
D
Initial  
David Heinemeier Hansson 已提交
227
      #
228
      # ==== Examples
D
David Heinemeier Hansson 已提交
229
      #   text_field(:post, :title, :size => 20)
230 231 232 233 234 235 236 237 238 239 240
      #   # => <input type="text" id="post_title" name="post[title]" size="20" value="#{@post.title}" />
      #
      #   text_field(:post, :title, :class => "create_input")
      #   # => <input type="text" id="post_title" name="post[title]" value="#{@post.title}" class="create_input" />
      #
      #   text_field(:session, :user, :onchange => "if $('session[user]').value == 'admin' { alert('Your login can not be admin!'); }")
      #   # => <input type="text" id="session_user" name="session[user]" value="#{@session.user}" onchange = "if $('session[user]').value == 'admin' { alert('Your login can not be admin!'); }"/>
      #
      #   text_field(:snippet, :code, :size => 20, :class => 'code_input')
      #   # => <input type="text" id="snippet_code" name="snippet[code]" size="20" value="#{@snippet.code}" class="code_input" />
      #
241 242
      def text_field(object_name, method, options = {})
        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_input_field_tag("text", options)
D
Initial  
David Heinemeier Hansson 已提交
243 244
      end

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
      # 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
      # hash with +options+.  These options will be tagged onto the html as an HTML element attribute as in the example
      # shown.
      #
      # ==== Examples
      #   password_field(:login, :pass, :size => 20)
      #   # => <input type="text" id="login_pass" name="login[pass]" size="20" value="#{@login.pass}" />
      #
      #   password_field(:account, :secret, :class => "form_input")
      #   # => <input type="text" id="account_secret" name="account[secret]" value="#{@account.secret}" class="form_input" />
      #
      #   password_field(:user, :password, :onchange => "if $('user[password]').length > 30 { alert('Your password needs to be shorter!'); }")
      #   # => <input type="text" id="user_password" name="user[password]" value="#{@user.password}" onchange = "if $('user[password]').length > 30 { alert('Your password needs to be shorter!'); }"/>
      #
      #   password_field(:account, :pin, :size => 20, :class => 'form_input')
      #   # => <input type="text" id="account_pin" name="account[pin]" size="20" value="#{@account.pin}" class="form_input" />
      #
263 264
      def password_field(object_name, method, options = {})
        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_input_field_tag("password", options)
D
Initial  
David Heinemeier Hansson 已提交
265 266
      end

267 268 269 270 271 272 273 274 275 276 277 278 279 280
      # 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}" />   
281
      def hidden_field(object_name, method, options = {})
282
        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_input_field_tag("hidden", options)
D
Initial  
David Heinemeier Hansson 已提交
283 284
      end

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
      # Returns an 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.
      #
      # ==== Examples
      #   file_field(:user, :avatar)
      #   # => <input type="file" id="user_avatar" name="user[avatar]" />
      #
      #   file_field(:post, :attached, :accept => 'text/html')
      #   # => <input type="file" id="post_attached" name="post[attached]" />
      #
      #   file_field(:attachment, :file, :class => 'file_input')
      #   # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
      #
300 301
      def file_field(object_name, method, options = {})
        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_input_field_tag("file", options)
302 303
      end

D
Initial  
David Heinemeier Hansson 已提交
304 305 306 307
      # 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+.
      #
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
      # ==== Examples
      #   text_area(:post, :body, :cols => 20, :rows => 40)
      #   # => <textarea cols="20" rows="40" id="post_body" name="post[body]">
      #   #      #{@post.body}
      #   #    </textarea>
      #
      #   text_area(:comment, :text, :size => "20x30")
      #   # => <textarea cols="20" rows="30" id="comment_text" name="comment[text]">
      #   #      #{@comment.text}
      #   #    </textarea>
      #
      #   text_area(:application, :notes, :cols => 40, :rows => 15, :class => 'app_input')
      #   # => <textarea cols="40" rows="15" id="application_notes" name="application[notes]" class="app_input">
      #   #      #{@application.notes}
      #   #    </textarea>
      #
      #   text_area(:entry, :body, :size => "20x20", :disabled => 'disabled')
      #   # => <textarea cols="20" rows="20" id="entry_body" name="entry[body]" disabled="disabled">
      #   #      #{@entry.body}
      #   #    </textarea>
328 329
      def text_area(object_name, method, options = {})
        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_text_area_tag(options)
D
Initial  
David Heinemeier Hansson 已提交
330
      end
331

D
Initial  
David Heinemeier Hansson 已提交
332 333 334 335
      # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object
      # assigned to the template (identified by +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+
336 337
      # is set to 0 which is convenient for boolean values. Since HTTP standards say that unchecked checkboxes don't post anything,
      # we add a hidden value with the same name as the checkbox as a work around.
D
Initial  
David Heinemeier Hansson 已提交
338
      #
339 340
      # ==== Examples 
      #   # Let's say that @post.validated? is 1:
D
Initial  
David Heinemeier Hansson 已提交
341
      #   check_box("post", "validated")
342 343
      #   # => <input type="checkbox" id="post_validate" name="post[validated]" value="1" checked="checked" />
      #   #    <input name="post[validated]" type="hidden" value="0" />
D
Initial  
David Heinemeier Hansson 已提交
344
      #
345
      #   # Let's say that @puppy.gooddog is "no":
D
Initial  
David Heinemeier Hansson 已提交
346
      #   check_box("puppy", "gooddog", {}, "yes", "no")
347 348 349 350 351 352 353
      #   # => <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />
      #   #    <input name="puppy[gooddog]" type="hidden" value="no" />
      #
      #   check_box("eula", "accepted", {}, "yes", "no", :class => 'eula_check')
      #   # => <input type="checkbox" id="eula_accepted" name="eula[accepted]" value="no" />
      #   #    <input name="eula[accepted]" type="hidden" value="no" />
      #
354 355
      def check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0")
        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_check_box_tag(options, checked_value, unchecked_value)
D
Initial  
David Heinemeier Hansson 已提交
356
      end
357 358 359 360

      # 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. Additional options on the input tag can be passed as a
361
      # hash with +options+.
362 363 364
      #
      # ==== Examples
      #   # Let's say that @post.category returns "rails":
365 366
      #   radio_button("post", "category", "rails")
      #   radio_button("post", "category", "java")
367 368
      #   # => <input type="radio" id="post_category" name="post[category]" value="rails" checked="checked" />
      #   #    <input type="radio" id="post_category" name="post[category]" value="java" />
369
      #
370 371 372 373
      #   radio_button("user", "receive_newsletter", "yes")
      #   radio_button("user", "receive_newsletter", "no")
      #   # => <input type="radio" id="user_receive_newsletter" name="user[receive_newsletter]" value="yes" />
      #   #    <input type="radio" id="user_receive_newsletter" name="user[receive_newsletter]" value="no" checked="checked" />
374 375
      def radio_button(object_name, method, tag_value, options = {})
        InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_radio_button_tag(tag_value, options)
376
      end
D
Initial  
David Heinemeier Hansson 已提交
377 378 379 380 381 382
    end

    class InstanceTag #:nodoc:
      include Helpers::TagHelper

      attr_reader :method_name, :object_name
383 384

      DEFAULT_FIELD_OPTIONS     = { "size" => 30 }.freeze unless const_defined?(:DEFAULT_FIELD_OPTIONS)
385
      DEFAULT_RADIO_OPTIONS     = { }.freeze unless const_defined?(:DEFAULT_RADIO_OPTIONS)
386
      DEFAULT_TEXT_AREA_OPTIONS = { "cols" => 40, "rows" => 20 }.freeze unless const_defined?(:DEFAULT_TEXT_AREA_OPTIONS)
387
      DEFAULT_DATE_OPTIONS = { :discard_type => true }.freeze unless const_defined?(:DEFAULT_DATE_OPTIONS)
D
Initial  
David Heinemeier Hansson 已提交
388

389
      def initialize(object_name, method_name, template_object, local_binding = nil, object = nil)
390
        @object_name, @method_name = object_name.to_s.dup, method_name.to_s.dup
D
Initial  
David Heinemeier Hansson 已提交
391
        @template_object, @local_binding = template_object, local_binding
392
        @object = object
393
        if @object_name.sub!(/\[\]$/,"")
394 395 396 397 398
          if object ||= @template_object.instance_variable_get("@#{Regexp.last_match.pre_match}") and object.respond_to?(:id_before_type_cast)
            @auto_index = object.id_before_type_cast
          else
            raise ArgumentError, "object[] naming but object param and @object var don't exist or don't respond to id_before_type_cast: #{object.inspect}"
          end
399
        end
D
Initial  
David Heinemeier Hansson 已提交
400
      end
401

D
Initial  
David Heinemeier Hansson 已提交
402
      def to_input_field_tag(field_type, options = {})
403
        options = options.stringify_keys
404
        options["size"] = options["maxlength"] || DEFAULT_FIELD_OPTIONS["size"] unless options.key?("size")
405
        options = DEFAULT_FIELD_OPTIONS.merge(options)
406 407 408 409
        if field_type == "hidden"
          options.delete("size")
        end
        options["type"] = field_type
410
        options["value"] ||= value_before_type_cast(object) unless field_type == "file"
411 412 413 414 415
        add_default_name_and_id(options)
        tag("input", options)
      end

      def to_radio_button_tag(tag_value, options = {})
416
        options = DEFAULT_RADIO_OPTIONS.merge(options.stringify_keys)
417 418
        options["type"]     = "radio"
        options["value"]    = tag_value
419 420 421 422 423 424
        if options.has_key?("checked")
          cv = options.delete "checked"
          checked = cv == true || cv == "checked"
        else
          checked = self.class.radio_button_checked?(value(object), tag_value)
        end
425
        options["checked"]  = "checked" if checked
426
        pretty_tag_value    = tag_value.to_s.gsub(/\s/, "_").gsub(/\W/, "").downcase
427
        options["id"]     ||= defined?(@auto_index) ?             
428 429
          "#{@object_name}_#{@auto_index}_#{@method_name}_#{pretty_tag_value}" :
          "#{@object_name}_#{@method_name}_#{pretty_tag_value}"
430 431 432 433
        add_default_name_and_id(options)
        tag("input", options)
      end

D
Initial  
David Heinemeier Hansson 已提交
434
      def to_text_area_tag(options = {})
435
        options = DEFAULT_TEXT_AREA_OPTIONS.merge(options.stringify_keys)
D
Initial  
David Heinemeier Hansson 已提交
436
        add_default_name_and_id(options)
437 438

        if size = options.delete("size")
439
          options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split)
440 441
        end

442
        content_tag("textarea", html_escape(options.delete('value') || value_before_type_cast(object)), options)
D
Initial  
David Heinemeier Hansson 已提交
443 444 445
      end

      def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
446 447 448
        options = options.stringify_keys
        options["type"]     = "checkbox"
        options["value"]    = checked_value
449 450 451
        if options.has_key?("checked")
          cv = options.delete "checked"
          checked = cv == true || cv == "checked"
452
        else
453
          checked = self.class.check_box_checked?(value(object), checked_value)
454
        end
455
        options["checked"] = "checked" if checked
D
Initial  
David Heinemeier Hansson 已提交
456
        add_default_name_and_id(options)
457
        tag("input", options) << tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value)
D
Initial  
David Heinemeier Hansson 已提交
458 459 460
      end

      def to_date_tag()
461
        defaults = DEFAULT_DATE_OPTIONS.dup
462
        date     = value(object) || Date.today
463
        options  = Proc.new { |position| defaults.merge(:prefix => "#{@object_name}[#{@method_name}(#{position}i)]") }
D
Initial  
David Heinemeier Hansson 已提交
464
        html_day_select(date, options.call(3)) +
465
        html_month_select(date, options.call(2)) +
D
Initial  
David Heinemeier Hansson 已提交
466 467 468 469
        html_year_select(date, options.call(1))
      end

      def to_boolean_select_tag(options = {})
470
        options = options.stringify_keys
D
Initial  
David Heinemeier Hansson 已提交
471
        add_default_name_and_id(options)
472
        value = value(object)
D
Initial  
David Heinemeier Hansson 已提交
473 474 475 476 477 478 479 480
        tag_text = "<select"
        tag_text << tag_options(options)
        tag_text << "><option value=\"false\""
        tag_text << " selected" if value == false
        tag_text << ">False</option><option value=\"true\""
        tag_text << " selected" if value
        tag_text << ">True</option></select>"
      end
481 482
      
      def to_content_tag(tag_name, options = {})
483
        content_tag(tag_name, value(object), options)
484 485
      end
      
D
Initial  
David Heinemeier Hansson 已提交
486
      def object
487
        @object || @template_object.instance_variable_get("@#{@object_name}")
D
Initial  
David Heinemeier Hansson 已提交
488 489
      end

490 491
      def value(object)
        self.class.value(object, @method_name)
D
Initial  
David Heinemeier Hansson 已提交
492 493
      end

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
      def value_before_type_cast(object)
        self.class.value_before_type_cast(object, @method_name)
      end
      
      class << self
        def value(object, method_name)
          object.send method_name unless object.nil?
        end
        
        def value_before_type_cast(object, method_name)
          unless object.nil?
            object.respond_to?(method_name + "_before_type_cast") ?
            object.send(method_name + "_before_type_cast") :
            object.send(method_name)
          end
        end
        
        def check_box_checked?(value, checked_value)
          case value
          when TrueClass, FalseClass
            value
          when NilClass
            false
          when Integer
            value != 0
          when String
            value == checked_value
          else
            value.to_i != 0
          end
        end
        
        def radio_button_checked?(value, checked_value)
          value.to_s == checked_value.to_s
528
        end
529 530
      end

D
Initial  
David Heinemeier Hansson 已提交
531 532
      private
        def add_default_name_and_id(options)
533 534 535
          if options.has_key?("index")
            options["name"] ||= tag_name_with_index(options["index"])
            options["id"]   ||= tag_id_with_index(options["index"])
536
            options.delete("index")
537
          elsif defined?(@auto_index)
538 539
            options["name"] ||= tag_name_with_index(@auto_index)
            options["id"]   ||= tag_id_with_index(@auto_index)
540
          else
541
            options["name"] ||= tag_name + (options.has_key?('multiple') ? '[]' : '')
542
            options["id"]   ||= tag_id
543
          end
D
Initial  
David Heinemeier Hansson 已提交
544
        end
545

D
Initial  
David Heinemeier Hansson 已提交
546 547 548
        def tag_name
          "#{@object_name}[#{@method_name}]"
        end
549

550 551 552
        def tag_name_with_index(index)
          "#{@object_name}[#{index}][#{@method_name}]"
        end
D
Initial  
David Heinemeier Hansson 已提交
553 554

        def tag_id
555
          "#{sanitized_object_name}_#{@method_name}"
D
Initial  
David Heinemeier Hansson 已提交
556
        end
557 558

        def tag_id_with_index(index)
559 560 561 562 563
          "#{sanitized_object_name}_#{index}_#{@method_name}"
        end

        def sanitized_object_name
          @object_name.gsub(/[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
564
        end
D
Initial  
David Heinemeier Hansson 已提交
565
    end
566

567
    class FormBuilder #:nodoc:
568 569 570
      # The methods which wrap a form helper call.
      class_inheritable_accessor :field_helpers
      self.field_helpers = (FormHelper.instance_methods - ['form_for'])
571

572
      attr_accessor :object_name, :object, :options
573

574 575
      def initialize(object_name, object, template, options, proc)
        @object_name, @object, @template, @options, @proc = object_name, object, template, options, proc        
576
      end
577
      
578
      (field_helpers - %w(check_box radio_button fields_for)).each do |selector|
579 580 581 582 583 584 585
        src = <<-end_src
          def #{selector}(method, options = {})
            @template.send(#{selector.inspect}, @object_name, method, options.merge(:object => @object))
          end
        end_src
        class_eval src, __FILE__, __LINE__
      end
586 587 588 589 590 591

      def fields_for(name, *args, &block)
        name = "#{object_name}[#{name}]"
        @template.fields_for(name, *args, &block)
      end

592 593 594 595 596
      def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
        @template.check_box(@object_name, method, options.merge(:object => @object), checked_value, unchecked_value)
      end
      
      def radio_button(method, tag_value, options = {})
597
        @template.radio_button(@object_name, method, tag_value, options.merge(:object => @object))
598
      end
599 600 601 602 603 604 605 606
      
      def error_message_on(method, prepend_text = "", append_text = "", css_class = "formError")
        @template.error_message_on(@object_name, method, prepend_text, append_text, css_class)
      end      

      def error_messages(options = {})
        @template.error_messages_for(@object_name, options)
      end
607 608 609 610
      
      def submit(value = "Save changes", options = {})
        @template.submit_tag(value, options.reverse_merge(:id => "#{object_name}_submit"))
      end
611
    end
D
Initial  
David Heinemeier Hansson 已提交
612
  end
613 614 615 616 617

  class Base
    cattr_accessor :default_form_builder
    self.default_form_builder = ::ActionView::Helpers::FormBuilder
  end
618
end