Module: ActionView::Helpers::FormOptionsHelper
- Includes:
- ERB::Util
- Included in:
- InstanceTag
- Defined in:
- lib/action_view/helpers/form_options_helper.rb
Overview
Provides a number of methods for turning different kinds of containers into a set of option tags.
Options
The collection_select
, country_select
, select
, and time_zone_select
methods take an options
parameter, a hash.
-
:include_blank
- set to true 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. select(“post”, “category”, Post::CATEGORIES, => true)
Could become:
<select name="post[category]">
<option></option>
<option>joke</option>
<option>poem</option>
</select>
Constant Summary collapse
- COUNTRIES =
All the countries included in the country_options output.
[ "Afghanistan", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua And Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahamas", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegowina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "Brunei Darussalam", "Bulgaria", "Burkina Faso", "Burma", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Congo, the Democratic Republic of the", "Cook Islands", "Costa Rica", "Cote d'Ivoire", "Croatia", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "East Timor", "Ecuador", "Egypt", "El Salvador", "England", "Equatorial Guinea", "Eritrea", "Espana", "Estonia", "Ethiopia", "Falkland Islands", "Faroe Islands", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Gambia", "Georgia", "Germany", "Ghana", "Gibraltar", "Great Britain", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard and Mc Donald Islands", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Iran", "Irak", "Jamaica", "Japan", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Korea, Republic of", "Korea (South)", "Kuwait", "Kyrgyzstan", "Lao People's Democratic Republic", "Latvia", "Lebanon", "Lesotho", "Liberia", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia, Federated States of", "Moldova, Republic of", "Monaco", "Mongolia", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Northern Ireland", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russia", "Rwanda", "Saint Kitts and Nevis", "Saint Lucia", "Saint Vincent and the Grenadines", "Samoa (Independent)", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Scotland", "Senegal", "Seychelles", "Sierra Leone", "Singapore", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Korea", "Spain", "Sri Lanka", "St. Helena", "St. Pierre and Miquelon", "Suriname", "Svalbard and Jan Mayen Islands", "Swaziland", "Sweden", "Switzerland", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Togo", "Tokelau", "Tonga", "Trinidad", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "United States Minor Outlying Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Vatican City State (Holy See)", "Venezuela", "Viet Nam", "Virgin Islands (British)", "Virgin Islands (U.S.)", "Wales", "Wallis and Futuna Islands", "Western Sahara", "Yemen", "Zambia", "Zimbabwe" ]
Instance Method Summary collapse
-
#collection_select(object, method, collection, value_method, text_method, options = {}, html_options = {}) ⇒ Object
Return select and option tags for the given object and method using options_from_collection_for_select to generate the list of option tags.
-
#country_options_for_select(selected = nil, priority_countries = nil) ⇒ Object
Returns a string of option tags for pretty much any country in the world.
-
#country_select(object, method, priority_countries = nil, options = {}, html_options = {}) ⇒ Object
Return select and option tags for the given object and method, using country_options_for_select to generate the list of option tags.
-
#option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, selected_key = nil) ⇒ Object
Returns a string of option tags, like options_from_collection_for_select, but surrounds them by <optgroup> tags.
-
#options_for_select(container, selected = nil) ⇒ Object
Accepts a container (hash, array, enumerable, your type) and returns a string of option tags.
-
#options_from_collection_for_select(collection, value_method, text_method, selected_value = nil) ⇒ Object
Returns a string of option tags that has been compiled by iterating over the
collection
and assigning the the result of a call to thevalue_method
as the option value and thetext_method
as the option text. -
#select(object, method, choices, options = {}, html_options = {}) ⇒ Object
Create a select tag and a series of contained option tags for the provided object and method.
-
#time_zone_options_for_select(selected = nil, priority_zones = nil, model = TimeZone) ⇒ Object
Returns a string of option tags for pretty much any time zone in the world.
-
#time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {}) ⇒ Object
Return select and option tags for the given object and method, using #time_zone_options_for_select to generate the list of option tags.
Instance Method Details
#collection_select(object, method, collection, value_method, text_method, options = {}, html_options = {}) ⇒ Object
Return select and option tags for the given object and method using options_from_collection_for_select to generate the list of option tags.
39 40 41 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 39 def collection_select(object, method, collection, value_method, text_method, = {}, = {}) InstanceTag.new(object, method, self).to_collection_select_tag(collection, value_method, text_method, , ) end |
#country_options_for_select(selected = nil, priority_countries = nil) ⇒ Object
Returns a string of option tags for pretty much any country in the world. Supply a country name as selected
to have it marked as the selected option tag. You can also supply an array of countries as priority_countries
, so that they will be listed above the rest of the (long) list.
NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 166 def (selected = nil, priority_countries = nil) = "" if priority_countries += (priority_countries, selected) += "<option>-------------</option>\n" end if priority_countries && priority_countries.include?(selected) += (COUNTRIES - priority_countries, selected) else += (COUNTRIES, selected) end return end |
#country_select(object, method, priority_countries = nil, options = {}, html_options = {}) ⇒ Object
Return select and option tags for the given object and method, using country_options_for_select to generate the list of option tags.
44 45 46 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 44 def country_select(object, method, priority_countries = nil, = {}, = {}) InstanceTag.new(object, method, self).to_country_select_tag(priority_countries, , ) end |
#option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, selected_key = nil) ⇒ Object
Returns a string of option tags, like options_from_collection_for_select, but surrounds them by <optgroup> tags.
An array of group objects are passed. Each group should return an array of options when calling group_method Each group should should return its name when calling group_label_method.
html_option_groups_from_collection(@continents, “countries”, “continent_name”, “country_id”, “country_name”, @selected_country.id)
Could become:
<optgroup label="Africa">
<select>Egypt</select>
<select>Rwanda</select>
...
</optgroup>
<optgroup label="Asia">
<select>China</select>
<select>India</select>
<select>Japan</select>
...
</optgroup>
with objects of the following classes: class Continent
def initialize(p_name, p_countries) @continent_name = p_name; @countries = p_countries; end
def continent_name() @continent_name; end
def countries() @countries; end
end class Country
def initialize(id, name) @id = id; @name = name end
def country_id() @id; end
def country_name() @name; end
end
NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
151 152 153 154 155 156 157 158 159 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 151 def option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, selected_key = nil) collection.inject("") do |, group| group_label_string = eval("group.#{group_label_method}") += "<optgroup label=\"#{html_escape(group_label_string)}\">" += (eval("group.#{group_method}"), option_key_method, option_value_method, selected_key) += '</optgroup>' end end |
#options_for_select(container, selected = nil) ⇒ Object
Accepts a container (hash, array, enumerable, your type) and returns a string of option tags. Given a container 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 become lasts. If selected
is specified, the matching “last” or element will get the selected option-tag. Selected
may also be an array of values to be selected when using a multiple select.
Examples (call, result):
options_for_select([["Dollar", "$"], ["Kroner", "DKK"]])
<option value="$">Dollar</option>\n<option value="DKK">Kroner</option>
options_for_select([ "VISA", "MasterCard" ], "MasterCard")
<option>VISA</option>\n<option selected="selected">MasterCard</option>
options_for_select({ "Basic" => "$20", "Plus" => "$40" }, "$40")
<option value="$20">Basic</option>\n<option value="$40" selected="selected">Plus</option>
options_for_select([ "VISA", "MasterCard", "Discover" ], ["VISA", "Discover"])
<option selected="selected">VISA</option>\n<option>MasterCard</option>\n<option selected="selected">Discover</option>
NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 80 def (container, selected = nil) container = container.to_a if Hash === container = container.inject([]) do |, element| if element.respond_to?(:first) && element.respond_to?(:last) is_selected = ( (selected.respond_to?(:include?) ? selected.include?(element.last) : element.last == selected) ) is_selected = ( (selected.respond_to?(:include?) && !selected.is_a?(String) ? selected.include?(element.last) : element.last == selected) ) if is_selected << "<option value=\"#{html_escape(element.last.to_s)}\" selected=\"selected\">#{html_escape(element.first.to_s)}</option>" else << "<option value=\"#{html_escape(element.last.to_s)}\">#{html_escape(element.first.to_s)}</option>" end else is_selected = ( (selected.respond_to?(:include?) ? selected.include?(element) : element == selected) ) is_selected = ( (selected.respond_to?(:include?) && !selected.is_a?(String) ? selected.include?(element) : element == selected) ) << ((is_selected) ? "<option selected=\"selected\">#{html_escape(element.to_s)}</option>" : "<option>#{html_escape(element.to_s)}</option>") end end .join("\n") end |
#options_from_collection_for_select(collection, value_method, text_method, selected_value = nil) ⇒ Object
Returns a string of option tags that has been compiled by iterating over the collection
and assigning the the result of a call to the value_method
as the option value and the text_method
as the option text. If selected_value
is specified, the element returning a match on value_method
will get the selected option tag.
Example (call, result). Imagine a loop iterating over each person
in @project.people
to generate a input tag:
options_from_collection_for_select(@project.people, "id", "name")
<option value="#{person.id}">#{person.name}</option>
NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
111 112 113 114 115 116 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 111 def (collection, value_method, text_method, selected_value = nil) ( collection.inject([]) { |, object| << [ object.send(text_method), object.send(value_method) ] }, selected_value ) end |
#select(object, method, choices, options = {}, html_options = {}) ⇒ Object
Create a select tag and a series of contained option tags for the provided object and method. The option currently held by the object will be selected, provided that the object is available.
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.
34 35 36 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 34 def select(object, method, choices, = {}, = {}) InstanceTag.new(object, method, self).to_select_tag(choices, , ) end |
#time_zone_options_for_select(selected = nil, priority_zones = nil, model = TimeZone) ⇒ Object
Returns a string of option tags for pretty much any time zone in the world. Supply a TimeZone object as selected
to have it marked as the selected option tag. You can also supply an array of TimeZone objects as priority_zones
, so that they will be listed above the rest of the (long) list. (You can use TimeZone.us_zones as a convenience for obtaining a list of the US time zones.)
The selected
parameter must be either nil
, or a string that names a TimeZone.
By default, model
is the TimeZone constant (which can be obtained in ActiveRecord 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.
NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 200 def (selected = nil, priority_zones = nil, model = TimeZone) = "" zones = model.all convert_zones = lambda { |list| list.map { |z| [ z.to_s, z.name ] } } if priority_zones += (convert_zones[priority_zones], selected) += "<option>-------------</option>\n" zones = zones.reject { |z| priority_zones.include?( z ) } end += (convert_zones[zones], selected) end |
#time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {}) ⇒ Object
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 :include_blank
option documented above, this method also supports a :model
option, which defaults to TimeZone. This may be used by users to specify a different time zone model object. (See #time_zone_options_for_select for more information.)
56 57 58 |
# File 'lib/action_view/helpers/form_options_helper.rb', line 56 def time_zone_select(object, method, priority_zones = nil, = {}, = {}) InstanceTag.new(object, method, self).to_time_zone_select_tag(priority_zones, , ) end |