halorgium-actionpack 3.0.pre

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (154) hide show
  1. data/CHANGELOG +5179 -0
  2. data/MIT-LICENSE +21 -0
  3. data/README +409 -0
  4. data/lib/abstract_controller.rb +16 -0
  5. data/lib/abstract_controller/base.rb +158 -0
  6. data/lib/abstract_controller/callbacks.rb +113 -0
  7. data/lib/abstract_controller/exceptions.rb +12 -0
  8. data/lib/abstract_controller/helpers.rb +151 -0
  9. data/lib/abstract_controller/layouts.rb +250 -0
  10. data/lib/abstract_controller/localized_cache.rb +49 -0
  11. data/lib/abstract_controller/logger.rb +61 -0
  12. data/lib/abstract_controller/rendering_controller.rb +188 -0
  13. data/lib/action_controller.rb +72 -0
  14. data/lib/action_controller/base.rb +168 -0
  15. data/lib/action_controller/caching.rb +80 -0
  16. data/lib/action_controller/caching/actions.rb +163 -0
  17. data/lib/action_controller/caching/fragments.rb +116 -0
  18. data/lib/action_controller/caching/pages.rb +154 -0
  19. data/lib/action_controller/caching/sweeping.rb +97 -0
  20. data/lib/action_controller/deprecated.rb +4 -0
  21. data/lib/action_controller/deprecated/integration_test.rb +2 -0
  22. data/lib/action_controller/deprecated/performance_test.rb +1 -0
  23. data/lib/action_controller/dispatch/dispatcher.rb +57 -0
  24. data/lib/action_controller/metal.rb +129 -0
  25. data/lib/action_controller/metal/benchmarking.rb +73 -0
  26. data/lib/action_controller/metal/compatibility.rb +145 -0
  27. data/lib/action_controller/metal/conditional_get.rb +86 -0
  28. data/lib/action_controller/metal/configuration.rb +28 -0
  29. data/lib/action_controller/metal/cookies.rb +105 -0
  30. data/lib/action_controller/metal/exceptions.rb +55 -0
  31. data/lib/action_controller/metal/filter_parameter_logging.rb +77 -0
  32. data/lib/action_controller/metal/flash.rb +162 -0
  33. data/lib/action_controller/metal/head.rb +27 -0
  34. data/lib/action_controller/metal/helpers.rb +115 -0
  35. data/lib/action_controller/metal/hide_actions.rb +47 -0
  36. data/lib/action_controller/metal/http_authentication.rb +312 -0
  37. data/lib/action_controller/metal/layouts.rb +171 -0
  38. data/lib/action_controller/metal/mime_responds.rb +317 -0
  39. data/lib/action_controller/metal/rack_convenience.rb +27 -0
  40. data/lib/action_controller/metal/redirector.rb +22 -0
  41. data/lib/action_controller/metal/render_options.rb +103 -0
  42. data/lib/action_controller/metal/rendering_controller.rb +57 -0
  43. data/lib/action_controller/metal/request_forgery_protection.rb +108 -0
  44. data/lib/action_controller/metal/rescuable.rb +13 -0
  45. data/lib/action_controller/metal/responder.rb +200 -0
  46. data/lib/action_controller/metal/session.rb +15 -0
  47. data/lib/action_controller/metal/session_management.rb +45 -0
  48. data/lib/action_controller/metal/streaming.rb +188 -0
  49. data/lib/action_controller/metal/testing.rb +39 -0
  50. data/lib/action_controller/metal/url_for.rb +41 -0
  51. data/lib/action_controller/metal/verification.rb +130 -0
  52. data/lib/action_controller/middleware.rb +38 -0
  53. data/lib/action_controller/notifications.rb +10 -0
  54. data/lib/action_controller/polymorphic_routes.rb +183 -0
  55. data/lib/action_controller/record_identifier.rb +91 -0
  56. data/lib/action_controller/testing/process.rb +111 -0
  57. data/lib/action_controller/testing/test_case.rb +345 -0
  58. data/lib/action_controller/translation.rb +13 -0
  59. data/lib/action_controller/url_rewriter.rb +204 -0
  60. data/lib/action_controller/vendor/html-scanner.rb +16 -0
  61. data/lib/action_controller/vendor/html-scanner/html/document.rb +68 -0
  62. data/lib/action_controller/vendor/html-scanner/html/node.rb +537 -0
  63. data/lib/action_controller/vendor/html-scanner/html/sanitizer.rb +176 -0
  64. data/lib/action_controller/vendor/html-scanner/html/selector.rb +828 -0
  65. data/lib/action_controller/vendor/html-scanner/html/tokenizer.rb +105 -0
  66. data/lib/action_controller/vendor/html-scanner/html/version.rb +11 -0
  67. data/lib/action_dispatch.rb +70 -0
  68. data/lib/action_dispatch/http/headers.rb +33 -0
  69. data/lib/action_dispatch/http/mime_type.rb +231 -0
  70. data/lib/action_dispatch/http/mime_types.rb +23 -0
  71. data/lib/action_dispatch/http/request.rb +539 -0
  72. data/lib/action_dispatch/http/response.rb +290 -0
  73. data/lib/action_dispatch/http/status_codes.rb +42 -0
  74. data/lib/action_dispatch/http/utils.rb +20 -0
  75. data/lib/action_dispatch/middleware/callbacks.rb +50 -0
  76. data/lib/action_dispatch/middleware/params_parser.rb +79 -0
  77. data/lib/action_dispatch/middleware/rescue.rb +26 -0
  78. data/lib/action_dispatch/middleware/session/abstract_store.rb +208 -0
  79. data/lib/action_dispatch/middleware/session/cookie_store.rb +235 -0
  80. data/lib/action_dispatch/middleware/session/mem_cache_store.rb +47 -0
  81. data/lib/action_dispatch/middleware/show_exceptions.rb +143 -0
  82. data/lib/action_dispatch/middleware/stack.rb +116 -0
  83. data/lib/action_dispatch/middleware/static.rb +44 -0
  84. data/lib/action_dispatch/middleware/string_coercion.rb +29 -0
  85. data/lib/action_dispatch/middleware/templates/rescues/_request_and_response.erb +24 -0
  86. data/lib/action_dispatch/middleware/templates/rescues/_trace.erb +26 -0
  87. data/lib/action_dispatch/middleware/templates/rescues/diagnostics.erb +10 -0
  88. data/lib/action_dispatch/middleware/templates/rescues/layout.erb +29 -0
  89. data/lib/action_dispatch/middleware/templates/rescues/missing_template.erb +2 -0
  90. data/lib/action_dispatch/middleware/templates/rescues/routing_error.erb +10 -0
  91. data/lib/action_dispatch/middleware/templates/rescues/template_error.erb +21 -0
  92. data/lib/action_dispatch/middleware/templates/rescues/unknown_action.erb +2 -0
  93. data/lib/action_dispatch/routing.rb +381 -0
  94. data/lib/action_dispatch/routing/deprecated_mapper.rb +878 -0
  95. data/lib/action_dispatch/routing/mapper.rb +327 -0
  96. data/lib/action_dispatch/routing/route.rb +49 -0
  97. data/lib/action_dispatch/routing/route_set.rb +497 -0
  98. data/lib/action_dispatch/testing/assertions.rb +8 -0
  99. data/lib/action_dispatch/testing/assertions/dom.rb +35 -0
  100. data/lib/action_dispatch/testing/assertions/model.rb +19 -0
  101. data/lib/action_dispatch/testing/assertions/response.rb +145 -0
  102. data/lib/action_dispatch/testing/assertions/routing.rb +144 -0
  103. data/lib/action_dispatch/testing/assertions/selector.rb +639 -0
  104. data/lib/action_dispatch/testing/assertions/tag.rb +123 -0
  105. data/lib/action_dispatch/testing/integration.rb +504 -0
  106. data/lib/action_dispatch/testing/performance_test.rb +15 -0
  107. data/lib/action_dispatch/testing/test_request.rb +83 -0
  108. data/lib/action_dispatch/testing/test_response.rb +131 -0
  109. data/lib/action_pack.rb +24 -0
  110. data/lib/action_pack/version.rb +9 -0
  111. data/lib/action_view.rb +58 -0
  112. data/lib/action_view/base.rb +308 -0
  113. data/lib/action_view/context.rb +44 -0
  114. data/lib/action_view/erb/util.rb +48 -0
  115. data/lib/action_view/helpers.rb +62 -0
  116. data/lib/action_view/helpers/active_model_helper.rb +306 -0
  117. data/lib/action_view/helpers/ajax_helper.rb +68 -0
  118. data/lib/action_view/helpers/asset_tag_helper.rb +830 -0
  119. data/lib/action_view/helpers/atom_feed_helper.rb +198 -0
  120. data/lib/action_view/helpers/cache_helper.rb +39 -0
  121. data/lib/action_view/helpers/capture_helper.rb +168 -0
  122. data/lib/action_view/helpers/date_helper.rb +988 -0
  123. data/lib/action_view/helpers/debug_helper.rb +38 -0
  124. data/lib/action_view/helpers/form_helper.rb +1102 -0
  125. data/lib/action_view/helpers/form_options_helper.rb +600 -0
  126. data/lib/action_view/helpers/form_tag_helper.rb +495 -0
  127. data/lib/action_view/helpers/javascript_helper.rb +208 -0
  128. data/lib/action_view/helpers/number_helper.rb +311 -0
  129. data/lib/action_view/helpers/prototype_helper.rb +1309 -0
  130. data/lib/action_view/helpers/raw_output_helper.rb +9 -0
  131. data/lib/action_view/helpers/record_identification_helper.rb +20 -0
  132. data/lib/action_view/helpers/record_tag_helper.rb +58 -0
  133. data/lib/action_view/helpers/sanitize_helper.rb +259 -0
  134. data/lib/action_view/helpers/scriptaculous_helper.rb +226 -0
  135. data/lib/action_view/helpers/tag_helper.rb +151 -0
  136. data/lib/action_view/helpers/text_helper.rb +594 -0
  137. data/lib/action_view/helpers/translation_helper.rb +39 -0
  138. data/lib/action_view/helpers/url_helper.rb +639 -0
  139. data/lib/action_view/locale/en.yml +117 -0
  140. data/lib/action_view/paths.rb +80 -0
  141. data/lib/action_view/render/partials.rb +342 -0
  142. data/lib/action_view/render/rendering.rb +134 -0
  143. data/lib/action_view/safe_buffer.rb +28 -0
  144. data/lib/action_view/template/error.rb +101 -0
  145. data/lib/action_view/template/handler.rb +36 -0
  146. data/lib/action_view/template/handlers.rb +52 -0
  147. data/lib/action_view/template/handlers/builder.rb +17 -0
  148. data/lib/action_view/template/handlers/erb.rb +53 -0
  149. data/lib/action_view/template/handlers/rjs.rb +18 -0
  150. data/lib/action_view/template/resolver.rb +165 -0
  151. data/lib/action_view/template/template.rb +131 -0
  152. data/lib/action_view/template/text.rb +38 -0
  153. data/lib/action_view/test_case.rb +163 -0
  154. metadata +236 -0
@@ -0,0 +1,600 @@
1
+ require 'cgi'
2
+ require 'erb'
3
+ require 'action_view/helpers/form_helper'
4
+
5
+ module ActionView
6
+ module Helpers
7
+ # Provides a number of methods for turning different kinds of containers into a set of option tags.
8
+ # == Options
9
+ # The <tt>collection_select</tt>, <tt>select</tt> and <tt>time_zone_select</tt> methods take an <tt>options</tt> parameter, a hash:
10
+ #
11
+ # * <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.
12
+ #
13
+ # For example,
14
+ #
15
+ # select("post", "category", Post::CATEGORIES, {:include_blank => true})
16
+ #
17
+ # could become:
18
+ #
19
+ # <select name="post[category]">
20
+ # <option></option>
21
+ # <option>joke</option>
22
+ # <option>poem</option>
23
+ # </select>
24
+ #
25
+ # Another common case is a select tag for an <tt>belongs_to</tt>-associated object.
26
+ #
27
+ # Example with @post.person_id => 2:
28
+ #
29
+ # select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {:include_blank => 'None'})
30
+ #
31
+ # could become:
32
+ #
33
+ # <select name="post[person_id]">
34
+ # <option value="">None</option>
35
+ # <option value="1">David</option>
36
+ # <option value="2" selected="selected">Sam</option>
37
+ # <option value="3">Tobias</option>
38
+ # </select>
39
+ #
40
+ # * <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.
41
+ #
42
+ # Example:
43
+ #
44
+ # select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, {:prompt => 'Select Person'})
45
+ #
46
+ # could become:
47
+ #
48
+ # <select name="post[person_id]">
49
+ # <option value="">Select Person</option>
50
+ # <option value="1">David</option>
51
+ # <option value="2">Sam</option>
52
+ # <option value="3">Tobias</option>
53
+ # </select>
54
+ #
55
+ # 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
56
+ # option to be in the +html_options+ parameter.
57
+ #
58
+ # Example:
59
+ #
60
+ # select("album[]", "genre", %w[rap rock country], {}, { :index => nil })
61
+ #
62
+ # becomes:
63
+ #
64
+ # <select name="album[][genre]" id="album__genre">
65
+ # <option value="rap">rap</option>
66
+ # <option value="rock">rock</option>
67
+ # <option value="country">country</option>
68
+ # </select>
69
+ #
70
+ # * <tt>:disabled</tt> - can be a single value or an array of values that will be disabled options in the final output.
71
+ #
72
+ # Example:
73
+ #
74
+ # select("post", "category", Post::CATEGORIES, {:disabled => 'restricted'})
75
+ #
76
+ # could become:
77
+ #
78
+ # <select name="post[category]">
79
+ # <option></option>
80
+ # <option>joke</option>
81
+ # <option>poem</option>
82
+ # <option disabled="disabled">restricted</option>
83
+ # </select>
84
+ #
85
+ # 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.
86
+ #
87
+ # Example:
88
+ #
89
+ # collection_select(:post, :category_id, Category.all, :id, :name, {:disabled => lambda{|category| category.archived? }})
90
+ #
91
+ # If the categories "2008 stuff" and "Christmas" return true when the method <tt>archived?</tt> is called, this would return:
92
+ # <select name="post[category_id]">
93
+ # <option value="1" disabled="disabled">2008 stuff</option>
94
+ # <option value="2" disabled="disabled">Christmas</option>
95
+ # <option value="3">Jokes</option>
96
+ # <option value="4">Poems</option>
97
+ # </select>
98
+ #
99
+ module FormOptionsHelper
100
+ include ERB::Util
101
+
102
+ # Create a select tag and a series of contained option tags for the provided object and method.
103
+ # The option currently held by the object will be selected, provided that the object is available.
104
+ # See options_for_select for the required format of the choices parameter.
105
+ #
106
+ # Example with @post.person_id => 1:
107
+ # select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, { :include_blank => true })
108
+ #
109
+ # could become:
110
+ #
111
+ # <select name="post[person_id]">
112
+ # <option value=""></option>
113
+ # <option value="1" selected="selected">David</option>
114
+ # <option value="2">Sam</option>
115
+ # <option value="3">Tobias</option>
116
+ # </select>
117
+ #
118
+ # This can be used to provide a default set of options in the standard way: before rendering the create form, a
119
+ # new model instance is assigned the default options and bound to @model_name. Usually this model is not saved
120
+ # to the database. Instead, a second model object is created when the create request is received.
121
+ # This allows the user to submit a form page more than once with the expected results of creating multiple records.
122
+ # In addition, this allows a single partial to be used to generate form inputs for both edit and create forms.
123
+ #
124
+ # By default, <tt>post.person_id</tt> is the selected option. Specify <tt>:selected => value</tt> to use a different selection
125
+ # or <tt>:selected => nil</tt> to leave all options unselected. Similarly, you can specify values to be disabled in the option
126
+ # tags by specifying the <tt>:disabled</tt> option. This can either be a single value or an array of values to be disabled.
127
+ def select(object, method, choices, options = {}, html_options = {})
128
+ InstanceTag.new(object, method, self, options.delete(:object)).to_select_tag(choices, options, html_options)
129
+ end
130
+
131
+ # Returns <tt><select></tt> and <tt><option></tt> tags for the collection of existing return values of
132
+ # +method+ for +object+'s class. The value returned from calling +method+ on the instance +object+ will
133
+ # be selected. If calling +method+ returns +nil+, no selection is made without including <tt>:prompt</tt>
134
+ # or <tt>:include_blank</tt> in the +options+ hash.
135
+ #
136
+ # The <tt>:value_method</tt> and <tt>:text_method</tt> parameters are methods to be called on each member
137
+ # of +collection+. The return values are used as the +value+ attribute and contents of each
138
+ # <tt><option></tt> tag, respectively.
139
+ #
140
+ # Example object structure for use with this method:
141
+ # class Post < ActiveRecord::Base
142
+ # belongs_to :author
143
+ # end
144
+ # class Author < ActiveRecord::Base
145
+ # has_many :posts
146
+ # def name_with_initial
147
+ # "#{first_name.first}. #{last_name}"
148
+ # end
149
+ # end
150
+ #
151
+ # Sample usage (selecting the associated Author for an instance of Post, <tt>@post</tt>):
152
+ # collection_select(:post, :author_id, Author.all, :id, :name_with_initial, {:prompt => true})
153
+ #
154
+ # If <tt>@post.author_id</tt> is already <tt>1</tt>, this would return:
155
+ # <select name="post[author_id]">
156
+ # <option value="">Please select</option>
157
+ # <option value="1" selected="selected">D. Heinemeier Hansson</option>
158
+ # <option value="2">D. Thomas</option>
159
+ # <option value="3">M. Clark</option>
160
+ # </select>
161
+ def collection_select(object, method, collection, value_method, text_method, options = {}, html_options = {})
162
+ InstanceTag.new(object, method, self, options.delete(:object)).to_collection_select_tag(collection, value_method, text_method, options, html_options)
163
+ end
164
+
165
+
166
+ # Returns <tt><select></tt>, <tt><optgroup></tt> and <tt><option></tt> tags for the collection of existing return values of
167
+ # +method+ for +object+'s class. The value returned from calling +method+ on the instance +object+ will
168
+ # be selected. If calling +method+ returns +nil+, no selection is made without including <tt>:prompt</tt>
169
+ # or <tt>:include_blank</tt> in the +options+ hash.
170
+ #
171
+ # Parameters:
172
+ # * +object+ - The instance of the class to be used for the select tag
173
+ # * +method+ - The attribute of +object+ corresponding to the select tag
174
+ # * +collection+ - An array of objects representing the <tt><optgroup></tt> tags.
175
+ # * +group_method+ - The name of a method which, when called on a member of +collection+, returns an
176
+ # array of child objects representing the <tt><option></tt> tags.
177
+ # * +group_label_method+ - The name of a method which, when called on a member of +collection+, returns a
178
+ # string to be used as the +label+ attribute for its <tt><optgroup></tt> tag.
179
+ # * +option_key_method+ - The name of a method which, when called on a child object of a member of
180
+ # +collection+, returns a value to be used as the +value+ attribute for its <tt><option></tt> tag.
181
+ # * +option_value_method+ - The name of a method which, when called on a child object of a member of
182
+ # +collection+, returns a value to be used as the contents of its <tt><option></tt> tag.
183
+ #
184
+ # Example object structure for use with this method:
185
+ # class Continent < ActiveRecord::Base
186
+ # has_many :countries
187
+ # # attribs: id, name
188
+ # end
189
+ # class Country < ActiveRecord::Base
190
+ # belongs_to :continent
191
+ # # attribs: id, name, continent_id
192
+ # end
193
+ # class City < ActiveRecord::Base
194
+ # belongs_to :country
195
+ # # attribs: id, name, country_id
196
+ # end
197
+ #
198
+ # Sample usage:
199
+ # grouped_collection_select(:city, :country_id, @continents, :countries, :name, :id, :name)
200
+ #
201
+ # Possible output:
202
+ # <select name="city[country_id]">
203
+ # <optgroup label="Africa">
204
+ # <option value="1">South Africa</option>
205
+ # <option value="3">Somalia</option>
206
+ # </optgroup>
207
+ # <optgroup label="Europe">
208
+ # <option value="7" selected="selected">Denmark</option>
209
+ # <option value="2">Ireland</option>
210
+ # </optgroup>
211
+ # </select>
212
+ #
213
+ def grouped_collection_select(object, method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
214
+ 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)
215
+ end
216
+
217
+
218
+
219
+ # Return select and option tags for the given object and method, using
220
+ # #time_zone_options_for_select to generate the list of option tags.
221
+ #
222
+ # In addition to the <tt>:include_blank</tt> option documented above,
223
+ # this method also supports a <tt>:model</tt> option, which defaults
224
+ # to ActiveSupport::TimeZone. This may be used by users to specify a
225
+ # different time zone model object. (See +time_zone_options_for_select+
226
+ # for more information.)
227
+ #
228
+ # You can also supply an array of ActiveSupport::TimeZone objects
229
+ # as +priority_zones+, so that they will be listed above the rest of the
230
+ # (long) list. (You can use ActiveSupport::TimeZone.us_zones as a convenience
231
+ # for obtaining a list of the US time zones, or a Regexp to select the zones
232
+ # of your choice)
233
+ #
234
+ # Finally, this method supports a <tt>:default</tt> option, which selects
235
+ # a default ActiveSupport::TimeZone if the object's time zone is +nil+.
236
+ #
237
+ # Examples:
238
+ # time_zone_select( "user", "time_zone", nil, :include_blank => true)
239
+ #
240
+ # time_zone_select( "user", "time_zone", nil, :default => "Pacific Time (US & Canada)" )
241
+ #
242
+ # time_zone_select( "user", 'time_zone', ActiveSupport::TimeZone.us_zones, :default => "Pacific Time (US & Canada)")
243
+ #
244
+ # time_zone_select( "user", 'time_zone', [ ActiveSupport::TimeZone['Alaska'], ActiveSupport::TimeZone['Hawaii'] ])
245
+ #
246
+ # time_zone_select( "user", 'time_zone', /Australia/)
247
+ #
248
+ # time_zone_select( "user", "time_zone", ActiveSupport::Timezone.all.sort, :model => ActiveSupport::Timezone)
249
+ def time_zone_select(object, method, priority_zones = nil, options = {}, html_options = {})
250
+ InstanceTag.new(object, method, self, options.delete(:object)).to_time_zone_select_tag(priority_zones, options, html_options)
251
+ end
252
+
253
+ # Accepts a container (hash, array, enumerable, your type) and returns a string of option tags. Given a container
254
+ # where the elements respond to first and last (such as a two-element array), the "lasts" serve as option values and
255
+ # the "firsts" as option text. Hashes are turned into this form automatically, so the keys become "firsts" and values
256
+ # become lasts. If +selected+ is specified, the matching "last" or element will get the selected option-tag. +selected+
257
+ # may also be an array of values to be selected when using a multiple select.
258
+ #
259
+ # Examples (call, result):
260
+ # options_for_select([["Dollar", "$"], ["Kroner", "DKK"]])
261
+ # <option value="$">Dollar</option>\n<option value="DKK">Kroner</option>
262
+ #
263
+ # options_for_select([ "VISA", "MasterCard" ], "MasterCard")
264
+ # <option>VISA</option>\n<option selected="selected">MasterCard</option>
265
+ #
266
+ # options_for_select({ "Basic" => "$20", "Plus" => "$40" }, "$40")
267
+ # <option value="$20">Basic</option>\n<option value="$40" selected="selected">Plus</option>
268
+ #
269
+ # options_for_select([ "VISA", "MasterCard", "Discover" ], ["VISA", "Discover"])
270
+ # <option selected="selected">VISA</option>\n<option>MasterCard</option>\n<option selected="selected">Discover</option>
271
+ #
272
+ # If you wish to specify disabled option tags, set +selected+ to be a hash, with <tt>:disabled</tt> being either a value
273
+ # or array of values to be disabled. In this case, you can use <tt>:selected</tt> to specify selected option tags.
274
+ #
275
+ # Examples:
276
+ # options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], :disabled => "Super Platinum")
277
+ # <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>
278
+ #
279
+ # options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], :disabled => ["Advanced", "Super Platinum"])
280
+ # <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>
281
+ #
282
+ # options_for_select(["Free", "Basic", "Advanced", "Super Platinum"], :selected => "Free", :disabled => "Super Platinum")
283
+ # <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>
284
+ #
285
+ # NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.
286
+ def options_for_select(container, selected = nil)
287
+ return container if String === container
288
+
289
+ container = container.to_a if Hash === container
290
+ selected, disabled = extract_selected_and_disabled(selected)
291
+
292
+ options_for_select = container.inject([]) do |options, element|
293
+ text, value = option_text_and_value(element)
294
+ selected_attribute = ' selected="selected"' if option_value_selected?(value, selected)
295
+ disabled_attribute = ' disabled="disabled"' if disabled && option_value_selected?(value, disabled)
296
+ options << %(<option value="#{html_escape(value.to_s)}"#{selected_attribute}#{disabled_attribute}>#{html_escape(text.to_s)}</option>)
297
+ end
298
+
299
+ options_for_select.join("\n").html_safe!
300
+ end
301
+
302
+ # Returns a string of option tags that have been compiled by iterating over the +collection+ and assigning the
303
+ # the result of a call to the +value_method+ as the option value and the +text_method+ as the option text.
304
+ # Example:
305
+ # options_from_collection_for_select(@people, 'id', 'name')
306
+ # This will output the same HTML as if you did this:
307
+ # <option value="#{person.id}">#{person.name}</option>
308
+ #
309
+ # This is more often than not used inside a #select_tag like this example:
310
+ # select_tag 'person', options_from_collection_for_select(@people, 'id', 'name')
311
+ #
312
+ # If +selected+ is specified as a value or array of values, the element(s) returning a match on +value_method+
313
+ # will be selected option tag(s).
314
+ #
315
+ # If +selected+ is specified as a Proc, those members of the collection that return true for the anonymous
316
+ # function are the selected values.
317
+ #
318
+ # +selected+ can also be a hash, specifying both <tt>:selected</tt> and/or <tt>:disabled</tt> values as required.
319
+ #
320
+ # Be sure to specify the same class as the +value_method+ when specifying selected or disabled options.
321
+ # Failure to do this will produce undesired results. Example:
322
+ # options_from_collection_for_select(@people, 'id', 'name', '1')
323
+ # Will not select a person with the id of 1 because 1 (an Integer) is not the same as '1' (a string)
324
+ # options_from_collection_for_select(@people, 'id', 'name', 1)
325
+ # should produce the desired results.
326
+ def options_from_collection_for_select(collection, value_method, text_method, selected = nil)
327
+ options = collection.map do |element|
328
+ [element.send(text_method), element.send(value_method)]
329
+ end
330
+ selected, disabled = extract_selected_and_disabled(selected)
331
+ select_deselect = {}
332
+ select_deselect[:selected] = extract_values_from_collection(collection, value_method, selected)
333
+ select_deselect[:disabled] = extract_values_from_collection(collection, value_method, disabled)
334
+
335
+ options_for_select(options, select_deselect)
336
+ end
337
+
338
+ # Returns a string of <tt><option></tt> tags, like <tt>options_from_collection_for_select</tt>, but
339
+ # groups them by <tt><optgroup></tt> tags based on the object relationships of the arguments.
340
+ #
341
+ # Parameters:
342
+ # * +collection+ - An array of objects representing the <tt><optgroup></tt> tags.
343
+ # * +group_method+ - The name of a method which, when called on a member of +collection+, returns an
344
+ # array of child objects representing the <tt><option></tt> tags.
345
+ # * group_label_method+ - The name of a method which, when called on a member of +collection+, returns a
346
+ # string to be used as the +label+ attribute for its <tt><optgroup></tt> tag.
347
+ # * +option_key_method+ - The name of a method which, when called on a child object of a member of
348
+ # +collection+, returns a value to be used as the +value+ attribute for its <tt><option></tt> tag.
349
+ # * +option_value_method+ - The name of a method which, when called on a child object of a member of
350
+ # +collection+, returns a value to be used as the contents of its <tt><option></tt> tag.
351
+ # * +selected_key+ - A value equal to the +value+ attribute for one of the <tt><option></tt> tags,
352
+ # which will have the +selected+ attribute set. Corresponds to the return value of one of the calls
353
+ # to +option_key_method+. If +nil+, no selection is made. Can also be a hash if disabled values are
354
+ # to be specified.
355
+ #
356
+ # Example object structure for use with this method:
357
+ # class Continent < ActiveRecord::Base
358
+ # has_many :countries
359
+ # # attribs: id, name
360
+ # end
361
+ # class Country < ActiveRecord::Base
362
+ # belongs_to :continent
363
+ # # attribs: id, name, continent_id
364
+ # end
365
+ #
366
+ # Sample usage:
367
+ # option_groups_from_collection_for_select(@continents, :countries, :name, :id, :name, 3)
368
+ #
369
+ # Possible output:
370
+ # <optgroup label="Africa">
371
+ # <option value="1">Egypt</option>
372
+ # <option value="4">Rwanda</option>
373
+ # ...
374
+ # </optgroup>
375
+ # <optgroup label="Asia">
376
+ # <option value="3" selected="selected">China</option>
377
+ # <option value="12">India</option>
378
+ # <option value="5">Japan</option>
379
+ # ...
380
+ # </optgroup>
381
+ #
382
+ # <b>Note:</b> Only the <tt><optgroup></tt> and <tt><option></tt> tags are returned, so you still have to
383
+ # wrap the output in an appropriate <tt><select></tt> tag.
384
+ def option_groups_from_collection_for_select(collection, group_method, group_label_method, option_key_method, option_value_method, selected_key = nil)
385
+ collection.inject("") do |options_for_select, group|
386
+ group_label_string = eval("group.#{group_label_method}")
387
+ options_for_select += "<optgroup label=\"#{html_escape(group_label_string)}\">"
388
+ options_for_select += options_from_collection_for_select(eval("group.#{group_method}"), option_key_method, option_value_method, selected_key)
389
+ options_for_select += '</optgroup>'
390
+ end
391
+ end
392
+
393
+ # Returns a string of <tt><option></tt> tags, like <tt>options_for_select</tt>, but
394
+ # wraps them with <tt><optgroup></tt> tags.
395
+ #
396
+ # Parameters:
397
+ # * +grouped_options+ - Accepts a nested array or hash of strings. The first value serves as the
398
+ # <tt><optgroup></tt> label while the second value must be an array of options. The second value can be a
399
+ # nested array of text-value pairs. See <tt>options_for_select</tt> for more info.
400
+ # Ex. ["North America",[["United States","US"],["Canada","CA"]]]
401
+ # * +selected_key+ - A value equal to the +value+ attribute for one of the <tt><option></tt> tags,
402
+ # which will have the +selected+ attribute set. Note: It is possible for this value to match multiple options
403
+ # as you might have the same option in multiple groups. Each will then get <tt>selected="selected"</tt>.
404
+ # * +prompt+ - set to true or a prompt string. When the select element doesn’t have a value yet, this
405
+ # prepends an option with a generic prompt — "Please select" — or the given prompt string.
406
+ #
407
+ # Sample usage (Array):
408
+ # grouped_options = [
409
+ # ['North America',
410
+ # [['United States','US'],'Canada']],
411
+ # ['Europe',
412
+ # ['Denmark','Germany','France']]
413
+ # ]
414
+ # grouped_options_for_select(grouped_options)
415
+ #
416
+ # Sample usage (Hash):
417
+ # grouped_options = {
418
+ # 'North America' => [['United States','US], 'Canada'],
419
+ # 'Europe' => ['Denmark','Germany','France']
420
+ # }
421
+ # grouped_options_for_select(grouped_options)
422
+ #
423
+ # Possible output:
424
+ # <optgroup label="Europe">
425
+ # <option value="Denmark">Denmark</option>
426
+ # <option value="Germany">Germany</option>
427
+ # <option value="France">France</option>
428
+ # </optgroup>
429
+ # <optgroup label="North America">
430
+ # <option value="US">United States</option>
431
+ # <option value="Canada">Canada</option>
432
+ # </optgroup>
433
+ #
434
+ # <b>Note:</b> Only the <tt><optgroup></tt> and <tt><option></tt> tags are returned, so you still have to
435
+ # wrap the output in an appropriate <tt><select></tt> tag.
436
+ def grouped_options_for_select(grouped_options, selected_key = nil, prompt = nil)
437
+ body = ''
438
+ body << content_tag(:option, prompt, :value => "") if prompt
439
+
440
+ grouped_options = grouped_options.sort if grouped_options.is_a?(Hash)
441
+
442
+ grouped_options.each do |group|
443
+ body << content_tag(:optgroup, options_for_select(group[1], selected_key), :label => group[0])
444
+ end
445
+
446
+ body
447
+ end
448
+
449
+ # Returns a string of option tags for pretty much any time zone in the
450
+ # world. Supply a ActiveSupport::TimeZone name as +selected+ to have it
451
+ # marked as the selected option tag. You can also supply an array of
452
+ # ActiveSupport::TimeZone objects as +priority_zones+, so that they will
453
+ # be listed above the rest of the (long) list. (You can use
454
+ # ActiveSupport::TimeZone.us_zones as a convenience for obtaining a list
455
+ # of the US time zones, or a Regexp to select the zones of your choice)
456
+ #
457
+ # The +selected+ parameter must be either +nil+, or a string that names
458
+ # a ActiveSupport::TimeZone.
459
+ #
460
+ # By default, +model+ is the ActiveSupport::TimeZone constant (which can
461
+ # be obtained in Active Record as a value object). The only requirement
462
+ # is that the +model+ parameter be an object that responds to +all+, and
463
+ # returns an array of objects that represent time zones.
464
+ #
465
+ # NOTE: Only the option tags are returned, you have to wrap this call in
466
+ # a regular HTML select tag.
467
+ def time_zone_options_for_select(selected = nil, priority_zones = nil, model = ::ActiveSupport::TimeZone)
468
+ zone_options = ""
469
+
470
+ zones = model.all
471
+ convert_zones = lambda { |list| list.map { |z| [ z.to_s, z.name ] } }
472
+
473
+ if priority_zones
474
+ if priority_zones.is_a?(Regexp)
475
+ priority_zones = model.all.find_all {|z| z =~ priority_zones}
476
+ end
477
+ zone_options += options_for_select(convert_zones[priority_zones], selected)
478
+ zone_options += "<option value=\"\" disabled=\"disabled\">-------------</option>\n"
479
+
480
+ zones = zones.reject { |z| priority_zones.include?( z ) }
481
+ end
482
+
483
+ zone_options += options_for_select(convert_zones[zones], selected)
484
+ zone_options
485
+ end
486
+
487
+ private
488
+ def option_text_and_value(option)
489
+ # Options are [text, value] pairs or strings used for both.
490
+ if !option.is_a?(String) and option.respond_to?(:first) and option.respond_to?(:last)
491
+ [option.first, option.last]
492
+ else
493
+ [option, option]
494
+ end
495
+ end
496
+
497
+ def option_value_selected?(value, selected)
498
+ if selected.respond_to?(:include?) && !selected.is_a?(String)
499
+ selected.include? value
500
+ else
501
+ value == selected
502
+ end
503
+ end
504
+
505
+ def extract_selected_and_disabled(selected)
506
+ if selected.is_a?(Hash)
507
+ [selected[:selected], selected[:disabled]]
508
+ else
509
+ [selected, nil]
510
+ end
511
+ end
512
+
513
+ def extract_values_from_collection(collection, value_method, selected)
514
+ if selected.is_a?(Proc)
515
+ collection.map do |element|
516
+ element.send(value_method) if selected.call(element)
517
+ end.compact
518
+ else
519
+ selected
520
+ end
521
+ end
522
+ end
523
+
524
+ class InstanceTag #:nodoc:
525
+ include FormOptionsHelper
526
+
527
+ def to_select_tag(choices, options, html_options)
528
+ html_options = html_options.stringify_keys
529
+ add_default_name_and_id(html_options)
530
+ value = value(object)
531
+ selected_value = options.has_key?(:selected) ? options[:selected] : value
532
+ disabled_value = options.has_key?(:disabled) ? options[:disabled] : nil
533
+ content_tag("select", add_options(options_for_select(choices, :selected => selected_value, :disabled => disabled_value), options, selected_value), html_options)
534
+ end
535
+
536
+ def to_collection_select_tag(collection, value_method, text_method, options, html_options)
537
+ html_options = html_options.stringify_keys
538
+ add_default_name_and_id(html_options)
539
+ value = value(object)
540
+ disabled_value = options.has_key?(:disabled) ? options[:disabled] : nil
541
+ selected_value = options.has_key?(:selected) ? options[:selected] : value
542
+ content_tag(
543
+ "select", add_options(options_from_collection_for_select(collection, value_method, text_method, :selected => selected_value, :disabled => disabled_value), options, value), html_options
544
+ )
545
+ end
546
+
547
+ def to_grouped_collection_select_tag(collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options)
548
+ html_options = html_options.stringify_keys
549
+ add_default_name_and_id(html_options)
550
+ value = value(object)
551
+ content_tag(
552
+ "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
553
+ )
554
+ end
555
+
556
+ def to_time_zone_select_tag(priority_zones, options, html_options)
557
+ html_options = html_options.stringify_keys
558
+ add_default_name_and_id(html_options)
559
+ value = value(object)
560
+ content_tag("select",
561
+ add_options(
562
+ time_zone_options_for_select(value || options[:default], priority_zones, options[:model] || ActiveSupport::TimeZone),
563
+ options, value
564
+ ), html_options
565
+ )
566
+ end
567
+
568
+ private
569
+ def add_options(option_tags, options, value = nil)
570
+ if options[:include_blank]
571
+ option_tags = "<option value=\"\">#{options[:include_blank] if options[:include_blank].kind_of?(String)}</option>\n" + option_tags
572
+ end
573
+ if value.blank? && options[:prompt]
574
+ prompt = options[:prompt].kind_of?(String) ? options[:prompt] : I18n.translate('support.select.prompt', :default => 'Please select')
575
+ "<option value=\"\">#{prompt}</option>\n" + option_tags
576
+ else
577
+ option_tags
578
+ end
579
+ end
580
+ end
581
+
582
+ class FormBuilder
583
+ def select(method, choices, options = {}, html_options = {})
584
+ @template.select(@object_name, method, choices, objectify_options(options), @default_options.merge(html_options))
585
+ end
586
+
587
+ def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
588
+ @template.collection_select(@object_name, method, collection, value_method, text_method, objectify_options(options), @default_options.merge(html_options))
589
+ end
590
+
591
+ def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
592
+ @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))
593
+ end
594
+
595
+ def time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
596
+ @template.time_zone_select(@object_name, method, priority_zones, objectify_options(options), @default_options.merge(html_options))
597
+ end
598
+ end
599
+ end
600
+ end