form_options_helper.rb 32.6 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.
108 109 110
      # See options_for_select for the required format of the choices parameter.
      #
      # Example with @post.person_id => 1:
111
      #   select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, { :include_blank => true })
112 113 114
      #
      # could become:
      #
115
      #   <select name="post[person_id]">
116
      #     <option value=""></option>
117 118 119 120
      #     <option value="1" selected="selected">David</option>
      #     <option value="2">Sam</option>
      #     <option value="3">Tobias</option>
      #   </select>
121
      #
122 123 124 125 126
      # 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.
127
      #
128
      # By default, <tt>post.person_id</tt> is the selected option. Specify <tt>:selected => value</tt> to use a different selection
129 130
      # 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.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
      #
      # ==== Gotcha
      #
      # The HTML specification says when +multiple+ parameter passed to select and all options got deselected 
      # 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 已提交
153
      def select(object, method, choices, options = {}, html_options = {})
154
        InstanceTag.new(object, method, self, options.delete(:object)).to_select_tag(choices, options, html_options)
D
Initial  
David Heinemeier Hansson 已提交
155
      end
156

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

      # 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

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

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

322 323 324
        selected, disabled = extract_selected_and_disabled(selected).map do | r |
           Array.wrap(r).map(&:to_s)
        end
325

326
        container.map do |element|
327
          html_attributes = option_html_attributes(element)
328
          text, value = option_text_and_value(element).map(&:to_s)
329
          selected_attribute = ' selected="selected"' if option_value_selected?(value, selected)
330
          disabled_attribute = ' disabled="disabled"' if disabled && option_value_selected?(value, disabled)
331
          %(<option value="#{ERB::Util.html_escape(value)}"#{selected_attribute}#{disabled_attribute}#{html_attributes}>#{ERB::Util.html_escape(text)}</option>)
332
        end.join("\n").html_safe
333

D
Initial  
David Heinemeier Hansson 已提交
334 335
      end

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

P
Pratik Naik 已提交
372
      # Returns a string of <tt><option></tt> tags, like <tt>options_from_collection_for_select</tt>, but
373 374 375
      # groups them by <tt><optgroup></tt> tags based on the object relationships of the arguments.
      #
      # Parameters:
P
Pratik Naik 已提交
376 377 378 379 380 381 382 383 384 385 386
      # * +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
387 388
      #   to +option_key_method+. If +nil+, no selection is made. Can also be a hash if disabled values are
      #   to be specified.
389 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
      #
      # 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 已提交
419
        collection.map do |group|
D
Initial  
David Heinemeier Hansson 已提交
420
          group_label_string = eval("group.#{group_label_method}")
421
          "<optgroup label=\"#{ERB::Util.html_escape(group_label_string)}\">" +
A
Aaron Patterson 已提交
422 423 424
            options_from_collection_for_select(eval("group.#{group_method}"), option_key_method, option_value_method, selected_key) +
            '</optgroup>'
        end.join.html_safe
425 426
      end

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

        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

480
        body.html_safe
481 482
      end

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

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

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

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

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

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

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

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

    class InstanceTag #:nodoc:
      include FormOptionsHelper

      def to_select_tag(choices, options, html_options)
577 578
        selected_value = options.has_key?(:selected) ? options[:selected] : value(object)
        select_content_tag(options_for_select(choices, :selected => selected_value, :disabled => options[:disabled]), options, html_options)
D
Initial  
David Heinemeier Hansson 已提交
579 580 581
      end

      def to_collection_select_tag(collection, value_method, text_method, options, html_options)
582
        selected_value = options.has_key?(:selected) ? options[:selected] : value(object)
583
        select_content_tag(
584
          options_from_collection_for_select(collection, value_method, text_method, :selected => selected_value, :disabled => options[:disabled]), options, html_options
D
Initial  
David Heinemeier Hansson 已提交
585 586
        )
      end
587

588
      def to_grouped_collection_select_tag(collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options)
589
        select_content_tag(
590
          option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, value(object)), options, html_options
591 592 593
        )
      end

594
      def to_time_zone_select_tag(priority_zones, options, html_options)
595
        select_content_tag(
596
            time_zone_options_for_select(value(object) || options[:default], priority_zones, options[:model] || ActiveSupport::TimeZone), options, html_options
597 598 599
        )
      end

D
Initial  
David Heinemeier Hansson 已提交
600
      private
601
        def add_options(option_tags, options, value = nil)
602
          if options[:include_blank]
603
            option_tags = "<option value=\"\">#{ERB::Util.html_escape(options[:include_blank]) if options[:include_blank].kind_of?(String)}</option>\n" + option_tags
604
          end
605
          if value.blank? && options[:prompt]
606
            prompt = options[:prompt].kind_of?(String) ? options[:prompt] : I18n.translate('helpers.select.prompt', :default => 'Please select')
607
            option_tags = "<option value=\"\">#{ERB::Util.html_escape(prompt)}</option>\n" + option_tags
608
          end
609
          option_tags.html_safe
D
Initial  
David Heinemeier Hansson 已提交
610
        end
611

612 613 614 615
        def select_content_tag(option_tags, options, html_options)
          html_options = html_options.stringify_keys
          add_default_name_and_id(html_options)
          select = content_tag("select", add_options(option_tags, options, value(object)), html_options)
616 617 618 619 620 621
          if html_options["multiple"]
            tag("input", :disabled => html_options["disabled"], :name => html_options["name"], :type => "hidden", :value => "") + select 
          else
            select
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
622
    end
623 624 625

    class FormBuilder
      def select(method, choices, options = {}, html_options = {})
626
        @template.select(@object_name, method, choices, objectify_options(options), @default_options.merge(html_options))
627 628 629
      end

      def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
630
        @template.collection_select(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_options.merge(html_options))
631 632
      end

633 634 635 636
      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

637
      def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
638
        @template.time_zone_select(@object_name, method, priority_zones, objectify_options(options), @default_options.merge(html_options))
639 640
      end
    end
D
Initial  
David Heinemeier Hansson 已提交
641
  end
642
end