form_options_helper.rb 31.5 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1 2
require 'cgi'
require 'erb'
3
require 'action_view/helpers/form_helper'
4
require 'active_support/core_ext/object/blank'
D
Initial  
David Heinemeier Hansson 已提交
5 6 7

module ActionView
  module Helpers
8
    # Provides a number of methods for turning different kinds of containers into a set of option tags.
9
    # == Options
10
    # The <tt>collection_select</tt>, <tt>select</tt> and <tt>time_zone_select</tt> methods take an <tt>options</tt> parameter, a hash:
11
    #
12 13 14
    # * <tt>:include_blank</tt> - set to true or a prompt string if the first option element of the select element is a blank. Useful if there is not a default value required for the select element.
    #
    # For example,
15
    #
16 17
    #   select("post", "category", Post::CATEGORIES, {:include_blank => true})
    #
18
    # could become:
19 20 21 22 23 24
    #
    #   <select name="post[category]">
    #     <option></option>
    #     <option>joke</option>
    #     <option>poem</option>
    #   </select>
25
    #
26 27 28 29
    # Another common case is a select tag for an <tt>belongs_to</tt>-associated object.
    #
    # Example with @post.person_id => 2:
    #
30
    #   select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {:include_blank => 'None'})
31 32 33 34 35 36 37 38 39 40
    #
    # could become:
    #
    #   <select name="post[person_id]">
    #     <option value="">None</option>
    #     <option value="1">David</option>
    #     <option value="2" selected="selected">Sam</option>
    #     <option value="3">Tobias</option>
    #   </select>
    #
41 42
    # * <tt>:prompt</tt> - set to true or a prompt string. When the select element doesn't have a value yet, this prepends an option with a generic prompt -- "Please select" -- or the given prompt string.
    #
43
    # Example:
44
    #
45
    #   select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {:prompt => 'Select Person'})
46 47 48 49
    #
    # could become:
    #
    #   <select name="post[person_id]">
50
    #     <option value="">Select Person</option>
51 52 53 54
    #     <option value="1">David</option>
    #     <option value="2">Sam</option>
    #     <option value="3">Tobias</option>
    #   </select>
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
    # 
    # Like the other form helpers, +select+ can accept an <tt>:index</tt> option to manually set the ID used in the resulting output. Unlike other helpers, +select+ expects this 
    # option to be in the +html_options+ parameter.
    # 
    # Example: 
    # 
    #   select("album[]", "genre", %w[rap rock country], {}, { :index => nil })
    # 
    # becomes:
    # 
    #   <select name="album[][genre]" id="album__genre">
    #     <option value="rap">rap</option>
    #     <option value="rock">rock</option>
    #     <option value="country">country</option>
    #   </select>
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    #
    # * <tt>:disabled</tt> - can be a single value or an array of values that will be disabled options in the final output.
    #
    # Example:
    #
    #   select("post", "category", Post::CATEGORIES, {:disabled => 'restricted'})
    #
    # could become:
    #
    #   <select name="post[category]">
    #     <option></option>
    #     <option>joke</option>
    #     <option>poem</option>
    #     <option disabled="disabled">restricted</option>
    #   </select>
    #
    # When used with the <tt>collection_select</tt> helper, <tt>:disabled</tt> can also be a Proc that identifies those options that should be disabled.
    #
    # Example:
    #
    #   collection_select(:post, :category_id, Category.all, :id, :name, {:disabled => lambda{|category| category.archived? }})
    #
    # If the categories "2008 stuff" and "Christmas" return true when the method <tt>archived?</tt> is called, this would return:
    #   <select name="post[category_id]">
    #     <option value="1" disabled="disabled">2008 stuff</option>
    #     <option value="2" disabled="disabled">Christmas</option>
    #     <option value="3">Jokes</option>
    #     <option value="4">Poems</option>
    #   </select>
    #
D
Initial  
David Heinemeier Hansson 已提交
100
    module FormOptionsHelper
W
wycats 已提交
101
      # ERB::Util can mask some helpers like textilize. Make sure to include them.
D
Initial  
David Heinemeier Hansson 已提交
102
      include ERB::Util
W
wycats 已提交
103
      include TextHelper
104 105

      # Create a select tag and a series of contained option tags for the provided object and method.
106
      # The option currently held by the object will be selected, provided that the object is available.
107 108 109
      # See options_for_select for the required format of the choices parameter.
      #
      # Example with @post.person_id => 1:
110
      #   select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, { :include_blank => true })
111 112 113
      #
      # could become:
      #
114
      #   <select name="post[person_id]">
115
      #     <option value=""></option>
116 117 118 119
      #     <option value="1" selected="selected">David</option>
      #     <option value="2">Sam</option>
      #     <option value="3">Tobias</option>
      #   </select>
120
      #
121 122 123 124 125
      # This can be used to provide a default set of options in the standard way: before rendering the create form, a
      # new model instance is assigned the default options and bound to @model_name. Usually this model is not saved
      # to the database. Instead, a second model object is created when the create request is received.
      # This allows the user to submit a form page more than once with the expected results of creating multiple records.
      # In addition, this allows a single partial to be used to generate form inputs for both edit and create forms.
126
      #
127
      # By default, <tt>post.person_id</tt> is the selected option.  Specify <tt>:selected => value</tt> to use a different selection
128 129
      # or <tt>:selected => nil</tt> to leave all options unselected. Similarly, you can specify values to be disabled in the option
      # tags by specifying the <tt>:disabled</tt> option. This can either be a single value or an array of values to be disabled.
D
Initial  
David Heinemeier Hansson 已提交
130
      def select(object, method, choices, options = {}, html_options = {})
131
        InstanceTag.new(object, method, self, options.delete(:object)).to_select_tag(choices, options, html_options)
D
Initial  
David Heinemeier Hansson 已提交
132
      end
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
      # Returns <tt><select></tt> and <tt><option></tt> tags for the collection of existing return values of
      # +method+ for +object+'s class. The value returned from calling +method+ on the instance +object+ will
      # be selected. If calling +method+ returns +nil+, no selection is made without including <tt>:prompt</tt>
      # or <tt>:include_blank</tt> in the +options+ hash.
      #
      # The <tt>:value_method</tt> and <tt>:text_method</tt> parameters are methods to be called on each member
      # of +collection+. The return values are used as the +value+ attribute and contents of each
      # <tt><option></tt> tag, respectively.
      # 
      # Example object structure for use with this method:
      #   class Post < ActiveRecord::Base
      #     belongs_to :author
      #   end
      #   class Author < ActiveRecord::Base
      #     has_many :posts
      #     def name_with_initial
      #       "#{first_name.first}. #{last_name}"
      #     end
      #   end
      #
P
Pratik Naik 已提交
154
      # Sample usage (selecting the associated Author for an instance of Post, <tt>@post</tt>):
155
      #   collection_select(:post, :author_id, Author.all, :id, :name_with_initial, :prompt => true)
156 157 158 159 160 161 162 163
      #
      # If <tt>@post.author_id</tt> is already <tt>1</tt>, this would return:
      #   <select name="post[author_id]">
      #     <option value="">Please select</option>
      #     <option value="1" selected="selected">D. Heinemeier Hansson</option>
      #     <option value="2">D. Thomas</option>
      #     <option value="3">M. Clark</option>
      #   </select>
D
Initial  
David Heinemeier Hansson 已提交
164
      def collection_select(object, method, collection, value_method, text_method, options = {}, html_options = {})
165
        InstanceTag.new(object, method, self, options.delete(:object)).to_collection_select_tag(collection, value_method, text_method, options, html_options)
D
Initial  
David Heinemeier Hansson 已提交
166
      end
167

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

      # Returns <tt><select></tt>, <tt><optgroup></tt> and <tt><option></tt> tags for the collection of existing return values of
      # +method+ for +object+'s class. The value returned from calling +method+ on the instance +object+ will
      # be selected. If calling +method+ returns +nil+, no selection is made without including <tt>:prompt</tt>
      # or <tt>:include_blank</tt> in the +options+ hash.
      #
      # Parameters:
      # * +object+ - The instance of the class to be used for the select tag
      # * +method+ - The attribute of +object+ corresponding to the select tag
      # * +collection+ - An array of objects representing the <tt><optgroup></tt> tags.
      # * +group_method+ - The name of a method which, when called on a member of +collection+, returns an
      #   array of child objects representing the <tt><option></tt> tags.
      # * +group_label_method+ - The name of a method which, when called on a member of +collection+, returns a
      #   string to be used as the +label+ attribute for its <tt><optgroup></tt> tag.
      # * +option_key_method+ - The name of a method which, when called on a child object of a member of
      #   +collection+, returns a value to be used as the +value+ attribute for its <tt><option></tt> tag.
      # * +option_value_method+ - The name of a method which, when called on a child object of a member of
      #   +collection+, returns a value to be used as the contents of its <tt><option></tt> tag.
      #
      # Example object structure for use with this method:
      #   class Continent < ActiveRecord::Base
      #     has_many :countries
      #     # attribs: id, name
      #   end
      #   class Country < ActiveRecord::Base
      #     belongs_to :continent
      #     # attribs: id, name, continent_id
      #   end
      #   class City < ActiveRecord::Base
      #     belongs_to :country
      #     # attribs: id, name, country_id
      #   end
      #
      # Sample usage:
      #   grouped_collection_select(:city, :country_id, @continents, :countries, :name, :id, :name)
      #
      # Possible output:
      #   <select name="city[country_id]">
      #     <optgroup label="Africa">
      #       <option value="1">South Africa</option>
      #       <option value="3">Somalia</option>
      #     </optgroup>
      #     <optgroup label="Europe">
      #       <option value="7" selected="selected">Denmark</option>
      #       <option value="2">Ireland</option>
      #     </optgroup>
      #   </select>
      #
      def grouped_collection_select(object, method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
        InstanceTag.new(object, method, self, options.delete(:object)).to_grouped_collection_select_tag(collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options)
      end

220 221 222 223 224
      # Return select and option tags for the given object and method, using
      # #time_zone_options_for_select to generate the list of option tags.
      #
      # In addition to the <tt>:include_blank</tt> option documented above,
      # this method also supports a <tt>:model</tt> option, which defaults
P
Pratik Naik 已提交
225 226 227
      # to ActiveSupport::TimeZone. This may be used by users to specify a
      # different time zone model object. (See +time_zone_options_for_select+
      # for more information.)
228
      #
P
Pratik Naik 已提交
229
      # You can also supply an array of ActiveSupport::TimeZone objects
230
      # as +priority_zones+, so that they will be listed above the rest of the
P
Pratik Naik 已提交
231 232
      # (long) list. (You can use ActiveSupport::TimeZone.us_zones as a convenience
      # for obtaining a list of the US time zones, or a Regexp to select the zones
233
      # of your choice)
234
      #
235
      # Finally, this method supports a <tt>:default</tt> option, which selects
P
Pratik Naik 已提交
236
      # a default ActiveSupport::TimeZone if the object's time zone is +nil+.
237 238 239 240 241 242
      #
      # Examples:
      #   time_zone_select( "user", "time_zone", nil, :include_blank => true)
      #
      #   time_zone_select( "user", "time_zone", nil, :default => "Pacific Time (US & Canada)" )
      #
P
Pratik Naik 已提交
243
      #   time_zone_select( "user", 'time_zone', ActiveSupport::TimeZone.us_zones, :default => "Pacific Time (US & Canada)")
244
      #
P
Pratik Naik 已提交
245
      #   time_zone_select( "user", 'time_zone', [ ActiveSupport::TimeZone['Alaska'], ActiveSupport::TimeZone['Hawaii'] ])
246
      #
247 248
      #   time_zone_select( "user", 'time_zone', /Australia/)
      #
P
Pratik Naik 已提交
249
      #   time_zone_select( "user", "time_zone", ActiveSupport::Timezone.all.sort, :model => ActiveSupport::Timezone)
250
      def time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {})
251
        InstanceTag.new(object, method, self,  options.delete(:object)).to_time_zone_select_tag(priority_zones, options, html_options)
252 253
      end

254
      # Accepts a container (hash, array, enumerable, your type) and returns a string of option tags. Given a container
D
Initial  
David Heinemeier Hansson 已提交
255 256
      # where the elements respond to first and last (such as a two-element array), the "lasts" serve as option values and
      # the "firsts" as option text. Hashes are turned into this form automatically, so the keys become "firsts" and values
P
Pratik Naik 已提交
257
      # become lasts. If +selected+ is specified, the matching "last" or element will get the selected option-tag.  +selected+
258
      # may also be an array of values to be selected when using a multiple select.
D
Initial  
David Heinemeier Hansson 已提交
259 260 261 262 263
      #
      # Examples (call, result):
      #   options_for_select([["Dollar", "$"], ["Kroner", "DKK"]])
      #     <option value="$">Dollar</option>\n<option value="DKK">Kroner</option>
      #
264 265
      #   options_for_select([ "VISA", "MasterCard" ], "MasterCard")
      #     <option>VISA</option>\n<option selected="selected">MasterCard</option>
D
Initial  
David Heinemeier Hansson 已提交
266 267 268 269
      #
      #   options_for_select({ "Basic" => "$20", "Plus" => "$40" }, "$40")
      #     <option value="$20">Basic</option>\n<option value="$40" selected="selected">Plus</option>
      #
270 271
      #   options_for_select([ "VISA", "MasterCard", "Discover" ], ["VISA", "Discover"])
      #     <option selected="selected">VISA</option>\n<option>MasterCard</option>\n<option selected="selected">Discover</option>
272
      #
273 274 275 276 277 278 279 280 281
      # You can optionally provide html attributes as the last element of the array.
      #
      # Examples:
      #   options_for_select([ "Denmark", ["USA", {:class=>'bold'}], "Sweden" ], ["USA", "Sweden"])
      #     <option value="Denmark">Denmark</option>\n<option value="USA" class="bold" selected="selected">USA</option>\n<option value="Sweden" selected="selected">Sweden</option>
      #
      #   options_for_select([["Dollar", "$", {:class=>"bold"}], ["Kroner", "DKK", {:onclick => "alert('HI');"}]])
      #     <option value="$" class="bold">Dollar</option>\n<option value="DKK" onclick="alert('HI');">Kroner</option>
      #
282 283 284 285 286 287 288 289 290 291 292 293 294
      # If you wish to specify disabled option tags, set +selected+ to be a hash, with <tt>:disabled</tt> being either a value
      # or array of values to be disabled. In this case, you can use <tt>:selected</tt> to specify selected option tags.
      #
      # Examples:
      #   options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], :disabled => "Super Platinum")
      #     <option value="Free">Free</option>\n<option value="Basic">Basic</option>\n<option value="Advanced">Advanced</option>\n<option value="Super Platinum" disabled="disabled">Super Platinum</option>
      #
      #   options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], :disabled => ["Advanced", "Super Platinum"])
      #     <option value="Free">Free</option>\n<option value="Basic">Basic</option>\n<option value="Advanced" disabled="disabled">Advanced</option>\n<option value="Super Platinum" disabled="disabled">Super Platinum</option>
      #
      #   options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], :selected => "Free", :disabled => "Super Platinum")
      #     <option value="Free" selected="selected">Free</option>\n<option value="Basic">Basic</option>\n<option value="Advanced">Advanced</option>\n<option value="Super Platinum" disabled="disabled">Super Platinum</option>
      #
295
      # NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
D
Initial  
David Heinemeier Hansson 已提交
296
      def options_for_select(container, selected = nil)
297 298
        return container if String === container

D
Initial  
David Heinemeier Hansson 已提交
299
        container = container.to_a if Hash === container
300
        selected, disabled = extract_selected_and_disabled(selected)
301 302

        options_for_select = container.inject([]) do |options, element|
303
          html_attributes = option_html_attributes(element)
304 305
          text, value = option_text_and_value(element)
          selected_attribute = ' selected="selected"' if option_value_selected?(value, selected)
306
          disabled_attribute = ' disabled="disabled"' if disabled && option_value_selected?(value, disabled)
307
          options << %(<option value="#{html_escape(value.to_s)}"#{selected_attribute}#{disabled_attribute}#{html_attributes}>#{html_escape(text.to_s)}</option>)
D
Initial  
David Heinemeier Hansson 已提交
308
        end
309

310
        options_for_select.join("\n").html_safe
D
Initial  
David Heinemeier Hansson 已提交
311 312
      end

313
      # Returns a string of option tags that have been compiled by iterating over the +collection+ and assigning the
D
Initial  
David Heinemeier Hansson 已提交
314
      # the result of a call to the +value_method+ as the option value and the +text_method+ as the option text.
P
Pratik Naik 已提交
315 316 317 318
      # Example:
      #   options_from_collection_for_select(@people, 'id', 'name')
      # This will output the same HTML as if you did this:
      #   <option value="#{person.id}">#{person.name}</option>
D
Initial  
David Heinemeier Hansson 已提交
319
      #
P
Pratik Naik 已提交
320 321
      # This is more often than not used inside a #select_tag like this example:
      #   select_tag 'person', options_from_collection_for_select(@people, 'id', 'name')
322
      #
323 324 325 326 327 328 329 330 331
      # If +selected+ is specified as a value or array of values, the element(s) returning a match on +value_method+
      # will be selected option tag(s).
      #
      # If +selected+ is specified as a Proc, those members of the collection that return true for the anonymous
      # function are the selected values.
      #
      # +selected+ can also be a hash, specifying both <tt>:selected</tt> and/or <tt>:disabled</tt> values as required.
      #
      # Be sure to specify the same class as the +value_method+ when specifying selected or disabled options.
P
Pratik Naik 已提交
332 333 334 335 336
      # Failure to do this will produce undesired results. Example:
      #   options_from_collection_for_select(@people, 'id', 'name', '1')
      # Will not select a person with the id of 1 because 1 (an Integer) is not the same as '1' (a string)
      #   options_from_collection_for_select(@people, 'id', 'name', 1)
      # should produce the desired results.
337 338 339 340
      def options_from_collection_for_select(collection, value_method, text_method, selected = nil)
        options = collection.map do |element|
          [element.send(text_method), element.send(value_method)]
        end
341 342 343 344 345 346
        selected, disabled = extract_selected_and_disabled(selected)
        select_deselect = {}
        select_deselect[:selected] = extract_values_from_collection(collection, value_method, selected)
        select_deselect[:disabled] = extract_values_from_collection(collection, value_method, disabled)

        options_for_select(options, select_deselect)
D
Initial  
David Heinemeier Hansson 已提交
347 348
      end

P
Pratik Naik 已提交
349
      # Returns a string of <tt><option></tt> tags, like <tt>options_from_collection_for_select</tt>, but
350 351 352
      # groups them by <tt><optgroup></tt> tags based on the object relationships of the arguments.
      #
      # Parameters:
P
Pratik Naik 已提交
353 354 355 356 357 358 359 360 361 362 363
      # * +collection+ - An array of objects representing the <tt><optgroup></tt> tags.
      # * +group_method+ - The name of a method which, when called on a member of +collection+, returns an
      #   array of child objects representing the <tt><option></tt> tags.
      # * group_label_method+ - The name of a method which, when called on a member of +collection+, returns a
      #   string to be used as the +label+ attribute for its <tt><optgroup></tt> tag.
      # * +option_key_method+ - The name of a method which, when called on a child object of a member of
      #   +collection+, returns a value to be used as the +value+ attribute for its <tt><option></tt> tag.
      # * +option_value_method+ - The name of a method which, when called on a child object of a member of
      #   +collection+, returns a value to be used as the contents of its <tt><option></tt> tag.
      # * +selected_key+ - A value equal to the +value+ attribute for one of the <tt><option></tt> tags,
      #   which will have the +selected+ attribute set. Corresponds to the return value of one of the calls
364 365
      #   to +option_key_method+. If +nil+, no selection is made. Can also be a hash if disabled values are
      #   to be specified.
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
      #
      # Example object structure for use with this method:
      #   class Continent < ActiveRecord::Base
      #     has_many :countries
      #     # attribs: id, name
      #   end
      #   class Country < ActiveRecord::Base
      #     belongs_to :continent
      #     # attribs: id, name, continent_id
      #   end
      #
      # Sample usage:
      #   option_groups_from_collection_for_select(@continents, :countries, :name, :id, :name, 3)
      #
      # Possible output:
      #   <optgroup label="Africa">
      #     <option value="1">Egypt</option>
      #     <option value="4">Rwanda</option>
      #     ...
      #   </optgroup>
      #   <optgroup label="Asia">
      #     <option value="3" selected="selected">China</option>
      #     <option value="12">India</option>
      #     <option value="5">Japan</option>
      #     ...
      #   </optgroup>
      #
      # <b>Note:</b> Only the <tt><optgroup></tt> and <tt><option></tt> tags are returned, so you still have to
      # wrap the output in an appropriate <tt><select></tt> tag.
      def option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, selected_key = nil)
D
Initial  
David Heinemeier Hansson 已提交
396 397 398 399 400 401
        collection.inject("") do |options_for_select, group|
          group_label_string = eval("group.#{group_label_method}")
          options_for_select += "<optgroup label=\"#{html_escape(group_label_string)}\">"
          options_for_select += options_from_collection_for_select(eval("group.#{group_method}"), option_key_method, option_value_method, selected_key)
          options_for_select += '</optgroup>'
        end
402 403
      end

404 405 406 407 408 409 410 411 412 413 414
      # Returns a string of <tt><option></tt> tags, like <tt>options_for_select</tt>, but
      # wraps them with <tt><optgroup></tt> tags.
      #
      # Parameters:
      # * +grouped_options+ - Accepts a nested array or hash of strings.  The first value serves as the
      #   <tt><optgroup></tt> label while the second value must be an array of options. The second value can be a
      #   nested array of text-value pairs. See <tt>options_for_select</tt> for more info.
      #    Ex. ["North America",[["United States","US"],["Canada","CA"]]]
      # * +selected_key+ - A value equal to the +value+ attribute for one of the <tt><option></tt> tags,
      #   which will have the +selected+ attribute set. Note: It is possible for this value to match multiple options
      #   as you might have the same option in multiple groups.  Each will then get <tt>selected="selected"</tt>.
415 416
      # * +prompt+ - set to true or a prompt string. When the select element doesn't have a value yet, this
      #   prepends an option with a generic prompt - "Please select" - or the given prompt string.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
      #
      # Sample usage (Array):
      #   grouped_options = [
      #    ['North America',
      #      [['United States','US'],'Canada']],
      #    ['Europe',
      #      ['Denmark','Germany','France']]
      #   ]
      #   grouped_options_for_select(grouped_options)
      #
      # Sample usage (Hash):
      #   grouped_options = {
      #    'North America' => [['United States','US], 'Canada'],
      #    'Europe' => ['Denmark','Germany','France']
      #   }
      #   grouped_options_for_select(grouped_options)
      #
      # Possible output:
      #   <optgroup label="Europe">
      #     <option value="Denmark">Denmark</option>
      #     <option value="Germany">Germany</option>
      #     <option value="France">France</option>
      #   </optgroup>
      #   <optgroup label="North America">
      #     <option value="US">United States</option>
      #     <option value="Canada">Canada</option>
      #   </optgroup>
      #
      # <b>Note:</b> Only the <tt><optgroup></tt> and <tt><option></tt> tags are returned, so you still have to
      # wrap the output in an appropriate <tt><select></tt> tag.
      def grouped_options_for_select(grouped_options, selected_key = nil, prompt = nil)
        body = ''
        body << content_tag(:option, prompt, :value => "") if prompt

        grouped_options = grouped_options.sort if grouped_options.is_a?(Hash)

        grouped_options.each do |group|
          body << content_tag(:optgroup, options_for_select(group[1], selected_key), :label => group[0])
        end

457
        body.html_safe
458 459
      end

460
      # Returns a string of option tags for pretty much any time zone in the
P
Pratik Naik 已提交
461 462 463 464 465 466
      # world. Supply a ActiveSupport::TimeZone name as +selected+ to have it
      # marked as the selected option tag. You can also supply an array of
      # ActiveSupport::TimeZone objects as +priority_zones+, so that they will
      # be listed above the rest of the (long) list. (You can use
      # ActiveSupport::TimeZone.us_zones as a convenience for obtaining a list
      # of the US time zones, or a Regexp to select the zones of your choice)
467
      #
468
      # The +selected+ parameter must be either +nil+, or a string that names
P
Pratik Naik 已提交
469
      # a ActiveSupport::TimeZone.
470
      #
P
Pratik Naik 已提交
471 472 473 474
      # By default, +model+ is the ActiveSupport::TimeZone constant (which can
      # be obtained in Active Record as a value object). The only requirement
      # is that the +model+ parameter be an object that responds to +all+, and
      # returns an array of objects that represent time zones.
475 476 477
      #
      # NOTE: Only the option tags are returned, you have to wrap this call in
      # a regular HTML select tag.
478
      def time_zone_options_for_select(selected = nil, priority_zones = nil, model = ::ActiveSupport::TimeZone)
479 480
        zone_options = ""

481 482 483
        zones = model.all
        convert_zones = lambda { |list| list.map { |z| [ z.to_s, z.name ] } }

484
        if priority_zones
485
	        if priority_zones.is_a?(Regexp)
486
            priority_zones = model.all.find_all {|z| z =~ priority_zones}
487
	        end
488
          zone_options += options_for_select(convert_zones[priority_zones], selected)
489
          zone_options += "<option value=\"\" disabled=\"disabled\">-------------</option>\n"
490

491
          zones = zones.reject { |z| priority_zones.include?( z ) }
492 493
        end

494
        zone_options += options_for_select(convert_zones[zones], selected)
495 496
        zone_options
      end
D
Initial  
David Heinemeier Hansson 已提交
497 498

      private
499 500 501 502 503 504 505 506 507
        def option_html_attributes(element)
          return "" unless Array === element
          html_attributes = []
          element.select { |e| Hash === e }.reduce({}, :merge).each do |k, v|
            html_attributes << " #{k}=\"#{html_escape(v.to_s)}\""
          end
          html_attributes.join
        end

508 509
        def option_text_and_value(option)
          # Options are [text, value] pairs or strings used for both.
510 511 512 513 514
          case
          when Array === option
            option = option.reject { |e| Hash === e }
            [option.first, option.last]
          when !option.is_a?(String) && option.respond_to?(:first) && option.respond_to?(:last)
515 516 517 518 519 520 521 522 523 524 525 526 527
            [option.first, option.last]
          else
            [option, option]
          end
        end

        def option_value_selected?(value, selected)
          if selected.respond_to?(:include?) && !selected.is_a?(String)
            selected.include? value
          else
            value == selected
          end
        end
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545

        def extract_selected_and_disabled(selected)
          if selected.is_a?(Hash)
            [selected[:selected], selected[:disabled]]
          else
            [selected, nil]
          end
        end

        def extract_values_from_collection(collection, value_method, selected)
          if selected.is_a?(Proc)
            collection.map do |element|
              element.send(value_method) if selected.call(element)
            end.compact
          else
            selected
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
546 547 548 549 550 551
    end

    class InstanceTag #:nodoc:
      include FormOptionsHelper

      def to_select_tag(choices, options, html_options)
552
        html_options = html_options.stringify_keys
D
Initial  
David Heinemeier Hansson 已提交
553
        add_default_name_and_id(html_options)
554
        value = value(object)
555
        selected_value = options.has_key?(:selected) ? options[:selected] : value
556 557
        disabled_value = options.has_key?(:disabled) ? options[:disabled] : nil
        content_tag("select", add_options(options_for_select(choices, :selected => selected_value, :disabled => disabled_value), options, selected_value), html_options)
D
Initial  
David Heinemeier Hansson 已提交
558 559 560
      end

      def to_collection_select_tag(collection, value_method, text_method, options, html_options)
561
        html_options = html_options.stringify_keys
D
Initial  
David Heinemeier Hansson 已提交
562
        add_default_name_and_id(html_options)
563
        value = value(object)
564
        disabled_value = options.has_key?(:disabled) ? options[:disabled] : nil
565
        selected_value = options.has_key?(:selected) ? options[:selected] : value
D
Initial  
David Heinemeier Hansson 已提交
566
        content_tag(
567
          "select", add_options(options_from_collection_for_select(collection, value_method, text_method, :selected => selected_value, :disabled => disabled_value), options, value), html_options
D
Initial  
David Heinemeier Hansson 已提交
568 569
        )
      end
570

571 572 573 574 575 576 577 578 579
      def to_grouped_collection_select_tag(collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options)
        html_options = html_options.stringify_keys
        add_default_name_and_id(html_options)
        value = value(object)
        content_tag(
          "select", add_options(option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, value), options, value), html_options
        )
      end

580
      def to_time_zone_select_tag(priority_zones, options, html_options)
581
        html_options = html_options.stringify_keys
582
        add_default_name_and_id(html_options)
583
        value = value(object)
584
        content_tag("select",
585
          add_options(
586
            time_zone_options_for_select(value || options[:default], priority_zones, options[:model] || ActiveSupport::TimeZone),
587
            options, value
588 589 590 591
          ), html_options
        )
      end

D
Initial  
David Heinemeier Hansson 已提交
592
      private
593
        def add_options(option_tags, options, value = nil)
594 595 596
          if options[:include_blank]
            option_tags = "<option value=\"\">#{options[:include_blank] if options[:include_blank].kind_of?(String)}</option>\n" + option_tags
          end
597
          if value.blank? && options[:prompt]
598
            prompt = options[:prompt].kind_of?(String) ? options[:prompt] : I18n.translate('helpers.select.prompt', :default => 'Please select')
599
            option_tags = "<option value=\"\">#{prompt}</option>\n" + option_tags
600
          end
601
          option_tags.html_safe
D
Initial  
David Heinemeier Hansson 已提交
602 603
        end
    end
604 605 606

    class FormBuilder
      def select(method, choices, options = {}, html_options = {})
607
        @template.select(@object_name, method, choices, objectify_options(options), @default_options.merge(html_options))
608 609 610
      end

      def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
611
        @template.collection_select(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_options.merge(html_options))
612 613
      end

614 615 616 617
      def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
        @template.grouped_collection_select(@object_name, method, collection, group_method, group_label_method, option_key_method, option_value_method, objectify_options(options), @default_options.merge(html_options))
      end

618
      def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
619
        @template.time_zone_select(@object_name, method, priority_zones, objectify_options(options), @default_options.merge(html_options))
620 621
      end
    end
D
Initial  
David Heinemeier Hansson 已提交
622
  end
623
end