form_options_helper.rb 30.1 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'
5
require 'active_support/core_ext/string/output_safety'
D
Initial  
David Heinemeier Hansson 已提交
6 7

module ActionView
8
  # = Action View Form Option Helpers
D
Initial  
David Heinemeier Hansson 已提交
9
  module Helpers
10
    # Provides a number of methods for turning different kinds of containers into a set of option tags.
11
    # == Options
12
    # The <tt>collection_select</tt>, <tt>select</tt> and <tt>time_zone_select</tt> methods take an <tt>options</tt> parameter, a hash:
13
    #
14 15 16
    # * <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,
17
    #
18 19
    #   select("post", "category", Post::CATEGORIES, {:include_blank => true})
    #
20
    # could become:
21 22 23 24 25 26
    #
    #   <select name="post[category]">
    #     <option></option>
    #     <option>joke</option>
    #     <option>poem</option>
    #   </select>
27
    #
28 29 30 31
    # Another common case is a select tag for an <tt>belongs_to</tt>-associated object.
    #
    # Example with @post.person_id => 2:
    #
32
    #   select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {:include_blank => 'None'})
33 34 35 36 37 38 39 40 41 42
    #
    # 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>
    #
43 44
    # * <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.
    #
45
    # Example:
46
    #
47
    #   select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {:prompt => 'Select Person'})
48 49 50 51
    #
    # could become:
    #
    #   <select name="post[person_id]">
52
    #     <option value="">Select Person</option>
53 54 55 56
    #     <option value="1">David</option>
    #     <option value="2">Sam</option>
    #     <option value="3">Tobias</option>
    #   </select>
57 58
    #
    # 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
59
    # option to be in the +html_options+ parameter.
60 61 62
    #
    # Example:
    #
63
    #   select("album[]", "genre", %w[rap rock country], {}, { :index => nil })
64
    #
65
    # becomes:
66
    #
67 68 69 70 71
    #   <select name="album[][genre]" id="album__genre">
    #     <option value="rap">rap</option>
    #     <option value="rock">rock</option>
    #     <option value="country">country</option>
    #   </select>
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 100 101
    #
    # * <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 已提交
102
    module FormOptionsHelper
W
wycats 已提交
103 104
      # ERB::Util can mask some helpers like textilize. Make sure to include them.
      include TextHelper
105 106

      # Create a select tag and a series of contained option tags for the provided object and method.
107
      # The option currently held by the object will be selected, provided that the object is available.
A
Andrew Radev 已提交
108 109 110 111
      #
      # There are two possible formats for the choices parameter, corresponding to other helpers' output:
      #   * A flat collection: see options_for_select
      #   * A nested collection: see grouped_options_for_select
112 113
      #
      # Example with @post.person_id => 1:
114
      #   select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, { :include_blank => true })
115 116 117
      #
      # could become:
      #
118
      #   <select name="post[person_id]">
119
      #     <option value=""></option>
120 121 122 123
      #     <option value="1" selected="selected">David</option>
      #     <option value="2">Sam</option>
      #     <option value="3">Tobias</option>
      #   </select>
124
      #
125 126 127 128 129
      # 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.
130
      #
131
      # By default, <tt>post.person_id</tt> is the selected option. Specify <tt>:selected => value</tt> to use a different selection
132 133
      # 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.
134 135 136
      #
      # ==== Gotcha
      #
137
      # The HTML specification says when +multiple+ parameter passed to select and all options got deselected
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
      # web browsers do not send any value to server. Unfortunately this introduces a gotcha:
      # if an +User+ model has many +roles+ and have +role_ids+ accessor, and in the form that edits roles of the user
      # the user deselects all roles from +role_ids+ multiple select box, no +role_ids+ parameter is sent. So,
      # any mass-assignment idiom like
      #
      #   @user.update_attributes(params[:user])
      #
      # wouldn't update roles.
      #
      # To prevent this the helper generates an auxiliary hidden field before
      # every multiple select. The hidden field has the same name as multiple select and blank value.
      #
      # This way, the client either sends only the hidden field (representing
      # the deselected multiple select box), 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.
      #
D
Initial  
David Heinemeier Hansson 已提交
156
      def select(object, method, choices, options = {}, html_options = {})
157
        Tags::Select.new(object, method, self, choices, options, html_options).render
D
Initial  
David Heinemeier Hansson 已提交
158
      end
159

160 161 162 163 164 165 166 167
      # 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.
168
      #
169 170 171 172 173 174 175 176 177 178 179
      # 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 已提交
180
      # Sample usage (selecting the associated Author for an instance of Post, <tt>@post</tt>):
181
      #   collection_select(:post, :author_id, Author.all, :id, :name_with_initial, :prompt => true)
182 183 184 185 186 187 188 189
      #
      # 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 已提交
190
      def collection_select(object, method, collection, value_method, text_method, options = {}, html_options = {})
191
        Tags::CollectionSelect.new(object, method, self, collection, value_method, text_method, options, html_options).render
D
Initial  
David Heinemeier Hansson 已提交
192
      end
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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
      # 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 = {})
242
        Tags::GroupedCollectionSelect.new(object, method, self, collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options).render
243 244
      end

245 246 247 248 249
      # 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 已提交
250 251 252
      # 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.)
253
      #
P
Pratik Naik 已提交
254
      # You can also supply an array of ActiveSupport::TimeZone objects
255
      # as +priority_zones+, so that they will be listed above the rest of the
P
Pratik Naik 已提交
256 257
      # (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
258
      # of your choice)
259
      #
260
      # Finally, this method supports a <tt>:default</tt> option, which selects
P
Pratik Naik 已提交
261
      # a default ActiveSupport::TimeZone if the object's time zone is +nil+.
262 263 264 265 266 267
      #
      # 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 已提交
268
      #   time_zone_select( "user", 'time_zone', ActiveSupport::TimeZone.us_zones, :default => "Pacific Time (US & Canada)")
269
      #
P
Pratik Naik 已提交
270
      #   time_zone_select( "user", 'time_zone', [ ActiveSupport::TimeZone['Alaska'], ActiveSupport::TimeZone['Hawaii'] ])
271
      #
272 273
      #   time_zone_select( "user", 'time_zone', /Australia/)
      #
A
Aaron Patterson 已提交
274
      #   time_zone_select( "user", "time_zone", ActiveSupport::TimeZone.all.sort, :model => ActiveSupport::TimeZone)
275
      def time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {})
276
        Tags::TimeZoneSelect.new(object, method, self, priority_zones, options, html_options).render
277 278
      end

279
      # Accepts a container (hash, array, enumerable, your type) and returns a string of option tags. Given a container
D
Initial  
David Heinemeier Hansson 已提交
280 281
      # 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
282
      # become lasts. If +selected+ is specified, the matching "last" or element will get the selected option-tag. +selected+
283
      # may also be an array of values to be selected when using a multiple select.
D
Initial  
David Heinemeier Hansson 已提交
284 285 286 287 288
      #
      # Examples (call, result):
      #   options_for_select([["Dollar", "$"], ["Kroner", "DKK"]])
      #     <option value="$">Dollar</option>\n<option value="DKK">Kroner</option>
      #
289 290
      #   options_for_select([ "VISA", "MasterCard" ], "MasterCard")
      #     <option>VISA</option>\n<option selected="selected">MasterCard</option>
D
Initial  
David Heinemeier Hansson 已提交
291 292 293 294
      #
      #   options_for_select({ "Basic" => "$20", "Plus" => "$40" }, "$40")
      #     <option value="$20">Basic</option>\n<option value="$40" selected="selected">Plus</option>
      #
295 296
      #   options_for_select([ "VISA", "MasterCard", "Discover" ], ["VISA", "Discover"])
      #     <option selected="selected">VISA</option>\n<option>MasterCard</option>\n<option selected="selected">Discover</option>
297
      #
298 299 300
      # You can optionally provide html attributes as the last element of the array.
      #
      # Examples:
301
      #   options_for_select([ "Denmark", ["USA", {:class => 'bold'}], "Sweden" ], ["USA", "Sweden"])
302 303
      #     <option value="Denmark">Denmark</option>\n<option value="USA" class="bold" selected="selected">USA</option>\n<option value="Sweden" selected="selected">Sweden</option>
      #
304
      #   options_for_select([["Dollar", "$", {:class => "bold"}], ["Kroner", "DKK", {:onclick => "alert('HI');"}]])
305 306
      #     <option value="$" class="bold">Dollar</option>\n<option value="DKK" onclick="alert('HI');">Kroner</option>
      #
307 308 309 310 311 312 313 314 315 316 317 318 319
      # 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>
      #
320
      # NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
D
Initial  
David Heinemeier Hansson 已提交
321
      def options_for_select(container, selected = nil)
322 323
        return container if String === container

324 325
        selected, disabled = extract_selected_and_disabled(selected).map do |r|
          Array(r).map { |item| item.to_s }
326
        end
327

328
        container.map do |element|
329
          html_attributes = option_html_attributes(element)
330
          text, value = option_text_and_value(element).map { |item| item.to_s }
331
          selected_attribute = ' selected="selected"' if option_value_selected?(value, selected)
332
          disabled_attribute = ' disabled="disabled"' if disabled && option_value_selected?(value, disabled)
333
          %(<option value="#{ERB::Util.html_escape(value)}"#{selected_attribute}#{disabled_attribute}#{html_attributes}>#{ERB::Util.html_escape(text)}</option>)
334
        end.join("\n").html_safe
D
Initial  
David Heinemeier Hansson 已提交
335 336
      end

R
Rohit Arondekar 已提交
337
      # Returns a string of option tags that have been compiled by iterating over the +collection+ and assigning 
D
Initial  
David Heinemeier Hansson 已提交
338
      # the result of a call to the +value_method+ as the option value and the +text_method+ as the option text.
P
Pratik Naik 已提交
339 340 341 342
      # 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 已提交
343
      #
P
Pratik Naik 已提交
344 345
      # 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')
346
      #
347 348 349 350 351 352 353 354 355
      # 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 已提交
356 357 358 359 360
      # 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.
361 362 363 364
      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
365 366 367 368 369 370
        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 已提交
371 372
      end

P
Pratik Naik 已提交
373
      # Returns a string of <tt><option></tt> tags, like <tt>options_from_collection_for_select</tt>, but
374 375 376
      # groups them by <tt><optgroup></tt> tags based on the object relationships of the arguments.
      #
      # Parameters:
P
Pratik Naik 已提交
377 378 379 380 381 382 383 384 385 386 387
      # * +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
388 389
      #   to +option_key_method+. If +nil+, no selection is made. Can also be a hash if disabled values are
      #   to be specified.
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
      #
      # 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)
A
Aaron Patterson 已提交
420
        collection.map do |group|
D
Initial  
David Heinemeier Hansson 已提交
421
          group_label_string = eval("group.#{group_label_method}")
422
          "<optgroup label=\"#{ERB::Util.html_escape(group_label_string)}\">" +
A
Aaron Patterson 已提交
423 424 425
            options_from_collection_for_select(eval("group.#{group_method}"), option_key_method, option_value_method, selected_key) +
            '</optgroup>'
        end.join.html_safe
426 427
      end

428 429 430 431
      # Returns a string of <tt><option></tt> tags, like <tt>options_for_select</tt>, but
      # wraps them with <tt><optgroup></tt> tags.
      #
      # Parameters:
432
      # * +grouped_options+ - Accepts a nested array or hash of strings. The first value serves as the
433 434 435 436 437
      #   <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
438
      #   as you might have the same option in multiple groups. Each will then get <tt>selected="selected"</tt>.
439 440
      # * +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.
441 442 443 444 445 446 447 448 449 450 451 452
      #
      # 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 = {
453
      #    'North America' => [['United States','US'], 'Canada'],
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
      #    '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 = ''
473
        body << content_tag(:option, prompt, { :value => "" }, true) if prompt
474 475 476 477 478 479 480

        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

481
        body.html_safe
482 483
      end

484
      # Returns a string of option tags for pretty much any time zone in the
P
Pratik Naik 已提交
485 486 487 488 489 490
      # 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)
491
      #
492
      # The +selected+ parameter must be either +nil+, or a string that names
P
Pratik Naik 已提交
493
      # a ActiveSupport::TimeZone.
494
      #
P
Pratik Naik 已提交
495 496 497 498
      # 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.
499 500 501
      #
      # NOTE: Only the option tags are returned, you have to wrap this call in
      # a regular HTML select tag.
502
      def time_zone_options_for_select(selected = nil, priority_zones = nil, model = ::ActiveSupport::TimeZone)
503 504
        zone_options = ""

505 506 507
        zones = model.all
        convert_zones = lambda { |list| list.map { |z| [ z.to_s, z.name ] } }

508
        if priority_zones
509
          if priority_zones.is_a?(Regexp)
510
            priority_zones = model.all.find_all {|z| z =~ priority_zones}
511
          end
512
          zone_options += options_for_select(convert_zones[priority_zones], selected)
513
          zone_options += "<option value=\"\" disabled=\"disabled\">-------------</option>\n"
514

515
          zones = zones.reject { |z| priority_zones.include?( z ) }
516 517
        end

518
        zone_options += options_for_select(convert_zones[zones], selected)
519
        zone_options.html_safe
520
      end
D
Initial  
David Heinemeier Hansson 已提交
521 522

      private
523 524 525 526
        def option_html_attributes(element)
          return "" unless Array === element
          html_attributes = []
          element.select { |e| Hash === e }.reduce({}, :merge).each do |k, v|
527
            html_attributes << " #{k}=\"#{ERB::Util.html_escape(v.to_s)}\""
528 529 530 531
          end
          html_attributes.join
        end

532 533
        def option_text_and_value(option)
          # Options are [text, value] pairs or strings used for both.
534 535 536 537 538
          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)
539 540 541 542 543 544 545 546 547 548 549 550 551
            [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
552 553

        def extract_selected_and_disabled(selected)
554 555
          if selected.is_a?(Proc)
            [ selected, nil ]
556
          else
557 558
            selected = Array.wrap(selected)
            options = selected.extract_options!.symbolize_keys
559 560
            selected_items = options.include?(:selected) ? options[:selected] : selected
            [ selected_items, options[:disabled] ]
561 562 563 564 565 566 567 568 569 570 571 572
          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 已提交
573 574
    end

575 576
    class FormBuilder
      def select(method, choices, options = {}, html_options = {})
577
        @template.select(@object_name, method, choices, objectify_options(options), @default_options.merge(html_options))
578 579 580
      end

      def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
581
        @template.collection_select(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_options.merge(html_options))
582 583
      end

584 585 586 587
      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

588
      def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
589
        @template.time_zone_select(@object_name, method, priority_zones, objectify_options(options), @default_options.merge(html_options))
590 591
      end
    end
D
Initial  
David Heinemeier Hansson 已提交
592
  end
593
end