actionpack 3.2.19 → 4.0.0

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 (263) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +850 -401
  3. data/MIT-LICENSE +1 -1
  4. data/README.rdoc +5 -288
  5. data/lib/abstract_controller/asset_paths.rb +2 -2
  6. data/lib/abstract_controller/base.rb +39 -37
  7. data/lib/abstract_controller/callbacks.rb +101 -82
  8. data/lib/abstract_controller/collector.rb +7 -3
  9. data/lib/abstract_controller/helpers.rb +25 -13
  10. data/lib/abstract_controller/layouts.rb +74 -74
  11. data/lib/abstract_controller/logger.rb +1 -2
  12. data/lib/abstract_controller/rendering.rb +30 -13
  13. data/lib/abstract_controller/translation.rb +16 -1
  14. data/lib/abstract_controller/url_for.rb +6 -6
  15. data/lib/abstract_controller/view_paths.rb +1 -1
  16. data/lib/abstract_controller.rb +1 -8
  17. data/lib/action_controller/base.rb +46 -22
  18. data/lib/action_controller/caching/fragments.rb +23 -53
  19. data/lib/action_controller/caching.rb +46 -33
  20. data/lib/action_controller/deprecated/integration_test.rb +3 -0
  21. data/lib/action_controller/deprecated.rb +5 -1
  22. data/lib/action_controller/log_subscriber.rb +16 -8
  23. data/lib/action_controller/metal/conditional_get.rb +76 -32
  24. data/lib/action_controller/metal/data_streaming.rb +20 -26
  25. data/lib/action_controller/metal/exceptions.rb +19 -6
  26. data/lib/action_controller/metal/flash.rb +24 -9
  27. data/lib/action_controller/metal/force_ssl.rb +70 -12
  28. data/lib/action_controller/metal/head.rb +25 -4
  29. data/lib/action_controller/metal/helpers.rb +5 -9
  30. data/lib/action_controller/metal/hide_actions.rb +0 -1
  31. data/lib/action_controller/metal/http_authentication.rb +107 -83
  32. data/lib/action_controller/metal/implicit_render.rb +1 -1
  33. data/lib/action_controller/metal/instrumentation.rb +2 -1
  34. data/lib/action_controller/metal/live.rb +175 -0
  35. data/lib/action_controller/metal/mime_responds.rb +161 -47
  36. data/lib/action_controller/metal/params_wrapper.rb +112 -74
  37. data/lib/action_controller/metal/rack_delegation.rb +9 -3
  38. data/lib/action_controller/metal/redirecting.rb +15 -20
  39. data/lib/action_controller/metal/renderers.rb +11 -9
  40. data/lib/action_controller/metal/rendering.rb +9 -1
  41. data/lib/action_controller/metal/request_forgery_protection.rb +112 -19
  42. data/lib/action_controller/metal/responder.rb +20 -19
  43. data/lib/action_controller/metal/streaming.rb +12 -18
  44. data/lib/action_controller/metal/strong_parameters.rb +520 -0
  45. data/lib/action_controller/metal/testing.rb +13 -18
  46. data/lib/action_controller/metal/url_for.rb +28 -25
  47. data/lib/action_controller/metal.rb +17 -32
  48. data/lib/action_controller/model_naming.rb +12 -0
  49. data/lib/action_controller/railtie.rb +33 -17
  50. data/lib/action_controller/railties/helpers.rb +22 -0
  51. data/lib/action_controller/record_identifier.rb +18 -72
  52. data/lib/action_controller/test_case.rb +251 -131
  53. data/lib/action_controller/vendor/html-scanner.rb +4 -19
  54. data/lib/action_controller.rb +15 -6
  55. data/lib/action_dispatch/http/cache.rb +63 -11
  56. data/lib/action_dispatch/http/filter_parameters.rb +18 -8
  57. data/lib/action_dispatch/http/filter_redirect.rb +37 -0
  58. data/lib/action_dispatch/http/headers.rb +49 -17
  59. data/lib/action_dispatch/http/mime_negotiation.rb +24 -1
  60. data/lib/action_dispatch/http/mime_type.rb +154 -100
  61. data/lib/action_dispatch/http/mime_types.rb +1 -1
  62. data/lib/action_dispatch/http/parameter_filter.rb +44 -46
  63. data/lib/action_dispatch/http/parameters.rb +28 -28
  64. data/lib/action_dispatch/http/rack_cache.rb +2 -3
  65. data/lib/action_dispatch/http/request.rb +64 -18
  66. data/lib/action_dispatch/http/response.rb +130 -35
  67. data/lib/action_dispatch/http/upload.rb +63 -20
  68. data/lib/action_dispatch/http/url.rb +98 -35
  69. data/lib/action_dispatch/journey/backwards.rb +5 -0
  70. data/lib/action_dispatch/journey/formatter.rb +146 -0
  71. data/lib/action_dispatch/journey/gtg/builder.rb +162 -0
  72. data/lib/action_dispatch/journey/gtg/simulator.rb +44 -0
  73. data/lib/action_dispatch/journey/gtg/transition_table.rb +156 -0
  74. data/lib/action_dispatch/journey/nfa/builder.rb +76 -0
  75. data/lib/action_dispatch/journey/nfa/dot.rb +36 -0
  76. data/lib/action_dispatch/journey/nfa/simulator.rb +47 -0
  77. data/lib/action_dispatch/journey/nfa/transition_table.rb +163 -0
  78. data/lib/action_dispatch/journey/nodes/node.rb +124 -0
  79. data/lib/action_dispatch/journey/parser.rb +206 -0
  80. data/lib/action_dispatch/journey/parser.y +47 -0
  81. data/lib/action_dispatch/journey/parser_extras.rb +23 -0
  82. data/lib/action_dispatch/journey/path/pattern.rb +196 -0
  83. data/lib/action_dispatch/journey/route.rb +124 -0
  84. data/lib/action_dispatch/journey/router/strexp.rb +24 -0
  85. data/lib/action_dispatch/journey/router/utils.rb +54 -0
  86. data/lib/action_dispatch/journey/router.rb +166 -0
  87. data/lib/action_dispatch/journey/routes.rb +75 -0
  88. data/lib/action_dispatch/journey/scanner.rb +61 -0
  89. data/lib/action_dispatch/journey/visitors.rb +197 -0
  90. data/lib/action_dispatch/journey/visualizer/fsm.css +34 -0
  91. data/lib/action_dispatch/journey/visualizer/fsm.js +134 -0
  92. data/lib/action_dispatch/journey/visualizer/index.html.erb +52 -0
  93. data/lib/action_dispatch/journey.rb +5 -0
  94. data/lib/action_dispatch/middleware/callbacks.rb +9 -4
  95. data/lib/action_dispatch/middleware/cookies.rb +259 -114
  96. data/lib/action_dispatch/middleware/debug_exceptions.rb +26 -17
  97. data/lib/action_dispatch/middleware/exception_wrapper.rb +29 -3
  98. data/lib/action_dispatch/middleware/flash.rb +58 -58
  99. data/lib/action_dispatch/middleware/params_parser.rb +14 -29
  100. data/lib/action_dispatch/middleware/public_exceptions.rb +30 -14
  101. data/lib/action_dispatch/middleware/reloader.rb +6 -6
  102. data/lib/action_dispatch/middleware/remote_ip.rb +145 -39
  103. data/lib/action_dispatch/middleware/request_id.rb +2 -6
  104. data/lib/action_dispatch/middleware/session/abstract_store.rb +22 -20
  105. data/lib/action_dispatch/middleware/session/cookie_store.rb +82 -28
  106. data/lib/action_dispatch/middleware/session/mem_cache_store.rb +8 -3
  107. data/lib/action_dispatch/middleware/show_exceptions.rb +12 -45
  108. data/lib/action_dispatch/middleware/ssl.rb +70 -0
  109. data/lib/action_dispatch/middleware/stack.rb +6 -1
  110. data/lib/action_dispatch/middleware/static.rb +2 -1
  111. data/lib/action_dispatch/middleware/templates/rescues/_request_and_response.erb +14 -11
  112. data/lib/action_dispatch/middleware/templates/rescues/_source.erb +25 -0
  113. data/lib/action_dispatch/middleware/templates/rescues/_trace.erb +7 -9
  114. data/lib/action_dispatch/middleware/templates/rescues/diagnostics.erb +15 -9
  115. data/lib/action_dispatch/middleware/templates/rescues/layout.erb +127 -5
  116. data/lib/action_dispatch/middleware/templates/rescues/missing_template.erb +7 -2
  117. data/lib/action_dispatch/middleware/templates/rescues/routing_error.erb +30 -15
  118. data/lib/action_dispatch/middleware/templates/rescues/template_error.erb +39 -13
  119. data/lib/action_dispatch/middleware/templates/rescues/unknown_action.erb +6 -2
  120. data/lib/action_dispatch/middleware/templates/routes/_route.html.erb +16 -0
  121. data/lib/action_dispatch/middleware/templates/routes/_table.html.erb +144 -0
  122. data/lib/action_dispatch/railtie.rb +16 -6
  123. data/lib/action_dispatch/request/session.rb +181 -0
  124. data/lib/action_dispatch/routing/inspector.rb +240 -0
  125. data/lib/action_dispatch/routing/mapper.rb +540 -291
  126. data/lib/action_dispatch/routing/polymorphic_routes.rb +16 -20
  127. data/lib/action_dispatch/routing/redirection.rb +46 -29
  128. data/lib/action_dispatch/routing/route_set.rb +207 -164
  129. data/lib/action_dispatch/routing/routes_proxy.rb +2 -0
  130. data/lib/action_dispatch/routing/url_for.rb +48 -33
  131. data/lib/action_dispatch/routing.rb +48 -83
  132. data/lib/action_dispatch/testing/assertions/dom.rb +3 -13
  133. data/lib/action_dispatch/testing/assertions/response.rb +32 -40
  134. data/lib/action_dispatch/testing/assertions/routing.rb +42 -41
  135. data/lib/action_dispatch/testing/assertions/selector.rb +17 -22
  136. data/lib/action_dispatch/testing/assertions/tag.rb +20 -23
  137. data/lib/action_dispatch/testing/integration.rb +65 -51
  138. data/lib/action_dispatch/testing/test_process.rb +9 -6
  139. data/lib/action_dispatch/testing/test_request.rb +7 -3
  140. data/lib/action_dispatch.rb +21 -15
  141. data/lib/action_pack/version.rb +7 -6
  142. data/lib/action_pack.rb +1 -1
  143. data/lib/action_view/base.rb +15 -34
  144. data/lib/action_view/buffers.rb +7 -1
  145. data/lib/action_view/context.rb +4 -4
  146. data/lib/action_view/dependency_tracker.rb +93 -0
  147. data/lib/action_view/digestor.rb +85 -0
  148. data/lib/action_view/flows.rb +1 -4
  149. data/lib/action_view/helpers/active_model_helper.rb +3 -4
  150. data/lib/action_view/helpers/asset_tag_helper.rb +215 -352
  151. data/lib/action_view/helpers/asset_url_helper.rb +355 -0
  152. data/lib/action_view/helpers/atom_feed_helper.rb +13 -10
  153. data/lib/action_view/helpers/cache_helper.rb +150 -18
  154. data/lib/action_view/helpers/capture_helper.rb +44 -31
  155. data/lib/action_view/helpers/csrf_helper.rb +0 -2
  156. data/lib/action_view/helpers/date_helper.rb +269 -248
  157. data/lib/action_view/helpers/debug_helper.rb +10 -11
  158. data/lib/action_view/helpers/form_helper.rb +931 -537
  159. data/lib/action_view/helpers/form_options_helper.rb +341 -166
  160. data/lib/action_view/helpers/form_tag_helper.rb +190 -90
  161. data/lib/action_view/helpers/javascript_helper.rb +23 -16
  162. data/lib/action_view/helpers/number_helper.rb +148 -329
  163. data/lib/action_view/helpers/output_safety_helper.rb +3 -3
  164. data/lib/action_view/helpers/record_tag_helper.rb +17 -22
  165. data/lib/action_view/helpers/rendering_helper.rb +2 -2
  166. data/lib/action_view/helpers/sanitize_helper.rb +3 -6
  167. data/lib/action_view/helpers/tag_helper.rb +46 -33
  168. data/lib/action_view/helpers/tags/base.rb +147 -0
  169. data/lib/action_view/helpers/tags/check_box.rb +64 -0
  170. data/lib/action_view/helpers/tags/checkable.rb +16 -0
  171. data/lib/action_view/helpers/tags/collection_check_boxes.rb +43 -0
  172. data/lib/action_view/helpers/tags/collection_helpers.rb +83 -0
  173. data/lib/action_view/helpers/tags/collection_radio_buttons.rb +36 -0
  174. data/lib/action_view/helpers/tags/collection_select.rb +28 -0
  175. data/lib/action_view/helpers/tags/color_field.rb +25 -0
  176. data/lib/action_view/helpers/tags/date_field.rb +13 -0
  177. data/lib/action_view/helpers/tags/date_select.rb +72 -0
  178. data/lib/action_view/helpers/tags/datetime_field.rb +22 -0
  179. data/lib/action_view/helpers/tags/datetime_local_field.rb +19 -0
  180. data/lib/action_view/helpers/tags/datetime_select.rb +8 -0
  181. data/lib/action_view/helpers/tags/email_field.rb +8 -0
  182. data/lib/action_view/helpers/tags/file_field.rb +8 -0
  183. data/lib/action_view/helpers/tags/grouped_collection_select.rb +29 -0
  184. data/lib/action_view/helpers/tags/hidden_field.rb +8 -0
  185. data/lib/action_view/helpers/tags/label.rb +65 -0
  186. data/lib/action_view/helpers/tags/month_field.rb +13 -0
  187. data/lib/action_view/helpers/tags/number_field.rb +18 -0
  188. data/lib/action_view/helpers/tags/password_field.rb +12 -0
  189. data/lib/action_view/helpers/tags/radio_button.rb +31 -0
  190. data/lib/action_view/helpers/tags/range_field.rb +8 -0
  191. data/lib/action_view/helpers/tags/search_field.rb +24 -0
  192. data/lib/action_view/helpers/tags/select.rb +40 -0
  193. data/lib/action_view/helpers/tags/tel_field.rb +8 -0
  194. data/lib/action_view/helpers/tags/text_area.rb +18 -0
  195. data/lib/action_view/helpers/tags/text_field.rb +29 -0
  196. data/lib/action_view/helpers/tags/time_field.rb +13 -0
  197. data/lib/action_view/helpers/tags/time_select.rb +8 -0
  198. data/lib/action_view/helpers/tags/time_zone_select.rb +20 -0
  199. data/lib/action_view/helpers/tags/url_field.rb +8 -0
  200. data/lib/action_view/helpers/tags/week_field.rb +13 -0
  201. data/lib/action_view/helpers/tags.rb +39 -0
  202. data/lib/action_view/helpers/text_helper.rb +130 -114
  203. data/lib/action_view/helpers/translation_helper.rb +32 -16
  204. data/lib/action_view/helpers/url_helper.rb +211 -270
  205. data/lib/action_view/helpers.rb +2 -4
  206. data/lib/action_view/locale/en.yml +1 -105
  207. data/lib/action_view/log_subscriber.rb +6 -4
  208. data/lib/action_view/lookup_context.rb +15 -28
  209. data/lib/action_view/model_naming.rb +12 -0
  210. data/lib/action_view/path_set.rb +8 -20
  211. data/lib/action_view/railtie.rb +6 -22
  212. data/lib/action_view/record_identifier.rb +84 -0
  213. data/lib/action_view/renderer/abstract_renderer.rb +25 -19
  214. data/lib/action_view/renderer/partial_renderer.rb +158 -81
  215. data/lib/action_view/renderer/renderer.rb +8 -12
  216. data/lib/action_view/renderer/streaming_template_renderer.rb +2 -5
  217. data/lib/action_view/renderer/template_renderer.rb +12 -10
  218. data/lib/action_view/routing_url_for.rb +107 -0
  219. data/lib/action_view/template/error.rb +22 -12
  220. data/lib/action_view/template/handlers/builder.rb +1 -1
  221. data/lib/action_view/template/handlers/erb.rb +40 -19
  222. data/lib/action_view/template/handlers/raw.rb +11 -0
  223. data/lib/action_view/template/handlers.rb +12 -9
  224. data/lib/action_view/template/resolver.rb +107 -53
  225. data/lib/action_view/template/text.rb +12 -8
  226. data/lib/action_view/template/types.rb +57 -0
  227. data/lib/action_view/template.rb +25 -23
  228. data/lib/action_view/test_case.rb +67 -42
  229. data/lib/{action_controller → action_view}/vendor/html-scanner/html/document.rb +0 -0
  230. data/lib/{action_controller → action_view}/vendor/html-scanner/html/node.rb +12 -12
  231. data/lib/{action_controller → action_view}/vendor/html-scanner/html/sanitizer.rb +13 -2
  232. data/lib/{action_controller → action_view}/vendor/html-scanner/html/selector.rb +9 -9
  233. data/lib/{action_controller → action_view}/vendor/html-scanner/html/tokenizer.rb +1 -1
  234. data/lib/{action_controller → action_view}/vendor/html-scanner/html/version.rb +0 -0
  235. data/lib/action_view/vendor/html-scanner.rb +20 -0
  236. data/lib/action_view.rb +17 -8
  237. metadata +184 -214
  238. data/lib/action_controller/caching/actions.rb +0 -185
  239. data/lib/action_controller/caching/pages.rb +0 -187
  240. data/lib/action_controller/caching/sweeping.rb +0 -97
  241. data/lib/action_controller/deprecated/performance_test.rb +0 -1
  242. data/lib/action_controller/metal/compatibility.rb +0 -65
  243. data/lib/action_controller/metal/session_management.rb +0 -14
  244. data/lib/action_controller/railties/paths.rb +0 -25
  245. data/lib/action_dispatch/middleware/best_standards_support.rb +0 -30
  246. data/lib/action_dispatch/middleware/body_proxy.rb +0 -30
  247. data/lib/action_dispatch/middleware/head.rb +0 -18
  248. data/lib/action_dispatch/middleware/rescue.rb +0 -26
  249. data/lib/action_dispatch/testing/performance_test.rb +0 -10
  250. data/lib/action_view/asset_paths.rb +0 -142
  251. data/lib/action_view/helpers/asset_paths.rb +0 -7
  252. data/lib/action_view/helpers/asset_tag_helpers/asset_include_tag.rb +0 -146
  253. data/lib/action_view/helpers/asset_tag_helpers/asset_paths.rb +0 -93
  254. data/lib/action_view/helpers/asset_tag_helpers/javascript_tag_helpers.rb +0 -193
  255. data/lib/action_view/helpers/asset_tag_helpers/stylesheet_tag_helpers.rb +0 -148
  256. data/lib/sprockets/assets.rake +0 -99
  257. data/lib/sprockets/bootstrap.rb +0 -37
  258. data/lib/sprockets/compressors.rb +0 -83
  259. data/lib/sprockets/helpers/isolated_helper.rb +0 -13
  260. data/lib/sprockets/helpers/rails_helper.rb +0 -182
  261. data/lib/sprockets/helpers.rb +0 -6
  262. data/lib/sprockets/railtie.rb +0 -62
  263. data/lib/sprockets/static_compiler.rb +0 -56
@@ -3,12 +3,11 @@ require 'action_view/helpers/date_helper'
3
3
  require 'action_view/helpers/tag_helper'
4
4
  require 'action_view/helpers/form_tag_helper'
5
5
  require 'action_view/helpers/active_model_helper'
6
- require 'active_support/core_ext/class/attribute'
6
+ require 'action_view/helpers/tags'
7
+ require 'action_view/model_naming'
8
+ require 'active_support/core_ext/class/attribute_accessors'
7
9
  require 'active_support/core_ext/hash/slice'
8
- require 'active_support/core_ext/module/method_names'
9
- require 'active_support/core_ext/object/blank'
10
10
  require 'active_support/core_ext/string/output_safety'
11
- require 'active_support/core_ext/array/extract_options'
12
11
  require 'active_support/core_ext/string/inflections'
13
12
 
14
13
  module ActionView
@@ -17,17 +16,28 @@ module ActionView
17
16
  # Form helpers are designed to make working with resources much easier
18
17
  # compared to using vanilla HTML.
19
18
  #
20
- # Forms for models are created with +form_for+. That method yields a form
21
- # builder that knows the model the form is about. The form builder is thus
22
- # able to generate default values for input fields that correspond to model
23
- # attributes, and also convenient names, IDs, endpoints, etc.
19
+ # Typically, a form designed to create or update a resource reflects the
20
+ # identity of the resource in several ways: (i) the url that the form is
21
+ # sent to (the form element's +action+ attribute) should result in a request
22
+ # being routed to the appropriate controller action (with the appropriate <tt>:id</tt>
23
+ # parameter in the case of an existing resource), (ii) input fields should
24
+ # be named in such a way that in the controller their values appear in the
25
+ # appropriate places within the +params+ hash, and (iii) for an existing record,
26
+ # when the form is initially displayed, input fields corresponding to attributes
27
+ # of the resource should show the current values of those attributes.
24
28
  #
25
- # Conventions in the generated field names allow controllers to receive form
26
- # data nicely structured in +params+ with no effort on your side.
29
+ # In Rails, this is usually achieved by creating the form using +form_for+ and
30
+ # a number of related helper methods. +form_for+ generates an appropriate <tt>form</tt>
31
+ # tag and yields a form builder object that knows the model the form is about.
32
+ # Input fields are created by calling methods defined on the form builder, which
33
+ # means they are able to generate the appropriate names and default values
34
+ # corresponding to the model attributes, as well as convenient IDs, etc.
35
+ # Conventions in the generated field names allow controllers to receive form data
36
+ # nicely structured in +params+ with no effort on your side.
27
37
  #
28
38
  # For example, to create a new person you typically set up a new instance of
29
39
  # +Person+ in the <tt>PeopleController#new</tt> action, <tt>@person</tt>, and
30
- # pass it to +form_for+:
40
+ # in the view template pass that object to +form_for+:
31
41
  #
32
42
  # <%= form_for @person do |f| %>
33
43
  # <%= f.label :first_name %>:
@@ -46,10 +56,10 @@ module ActionView
46
56
  # <input name="authenticity_token" type="hidden" value="NrOp5bsjoLRuK8IW5+dQEYjKGUJDe7TQoZVvq95Wteg=" />
47
57
  # </div>
48
58
  # <label for="person_first_name">First name</label>:
49
- # <input id="person_first_name" name="person[first_name]" size="30" type="text" /><br />
59
+ # <input id="person_first_name" name="person[first_name]" type="text" /><br />
50
60
  #
51
61
  # <label for="person_last_name">Last name</label>:
52
- # <input id="person_last_name" name="person[last_name]" size="30" type="text" /><br />
62
+ # <input id="person_last_name" name="person[last_name]" type="text" /><br />
53
63
  #
54
64
  # <input name="commit" type="submit" value="Create Person" />
55
65
  # </form>
@@ -73,14 +83,14 @@ module ActionView
73
83
  #
74
84
  # <form action="/people/256" class="edit_person" id="edit_person_256" method="post">
75
85
  # <div style="margin:0;padding:0;display:inline">
76
- # <input name="_method" type="hidden" value="put" />
86
+ # <input name="_method" type="hidden" value="patch" />
77
87
  # <input name="authenticity_token" type="hidden" value="NrOp5bsjoLRuK8IW5+dQEYjKGUJDe7TQoZVvq95Wteg=" />
78
88
  # </div>
79
89
  # <label for="person_first_name">First name</label>:
80
- # <input id="person_first_name" name="person[first_name]" size="30" type="text" value="John" /><br />
90
+ # <input id="person_first_name" name="person[first_name]" type="text" value="John" /><br />
81
91
  #
82
92
  # <label for="person_last_name">Last name</label>:
83
- # <input id="person_last_name" name="person[last_name]" size="30" type="text" value="Smith" /><br />
93
+ # <input id="person_last_name" name="person[last_name]" type="text" value="Smith" /><br />
84
94
  #
85
95
  # <input name="commit" type="submit" value="Update Person" />
86
96
  # </form>
@@ -90,9 +100,9 @@ module ActionView
90
100
  # and generate HTML accordingly.
91
101
  #
92
102
  # The controller would receive the form data again in <tt>params[:person]</tt>, ready to be
93
- # passed to <tt>Person#update_attributes</tt>:
103
+ # passed to <tt>Person#update</tt>:
94
104
  #
95
- # if @person.update_attributes(params[:person])
105
+ # if @person.update(params[:person])
96
106
  # # success
97
107
  # else
98
108
  # # error handling
@@ -104,35 +114,16 @@ module ActionView
104
114
 
105
115
  include FormTagHelper
106
116
  include UrlHelper
117
+ include ModelNaming
107
118
 
108
- # Converts the given object to an ActiveModel compliant one.
109
- def convert_to_model(object)
110
- object.respond_to?(:to_model) ? object.to_model : object
111
- end
112
-
113
- # Creates a form and a scope around a specific model object that is used
114
- # as a base for questioning about values for the fields.
115
- #
116
- # Rails provides succinct resource-oriented form generation with +form_for+
117
- # like this:
118
- #
119
- # <%= form_for @offer do |f| %>
120
- # <%= f.label :version, 'Version' %>:
121
- # <%= f.text_field :version %><br />
122
- # <%= f.label :author, 'Author' %>:
123
- # <%= f.text_field :author %><br />
124
- # <%= f.submit %>
125
- # <% end %>
126
- #
127
- # There, +form_for+ is able to generate the rest of RESTful form
128
- # parameters based on introspection on the record, but to understand what
129
- # it does we need to dig first into the alternative generic usage it is
130
- # based upon.
131
- #
132
- # === Generic form_for
119
+ # Creates a form that allows the user to create or update the attributes
120
+ # of a specific model object.
133
121
  #
134
- # The generic way to call +form_for+ yields a form builder around a
135
- # model:
122
+ # The method can be used in several slightly different ways, depending on
123
+ # how much you wish to rely on Rails to infer automatically from the model
124
+ # how the form should be constructed. For a generic model object, a form
125
+ # can be created by passing +form_for+ a string or symbol representing
126
+ # the object we are concerned with:
136
127
  #
137
128
  # <%= form_for :person do |f| %>
138
129
  # First name: <%= f.text_field :first_name %><br />
@@ -142,24 +133,39 @@ module ActionView
142
133
  # <%= f.submit %>
143
134
  # <% end %>
144
135
  #
145
- # There, the argument is a symbol or string with the name of the
146
- # object the form is about.
147
- #
148
- # The form builder acts as a regular form helper that somehow carries the
149
- # model. Thus, the idea is that
136
+ # The variable +f+ yielded to the block is a FormBuilder object that
137
+ # incorporates the knowledge about the model object represented by
138
+ # <tt>:person</tt> passed to +form_for+. Methods defined on the FormBuilder
139
+ # are used to generate fields bound to this model. Thus, for example,
150
140
  #
151
141
  # <%= f.text_field :first_name %>
152
142
  #
153
- # gets expanded to
143
+ # will get expanded to
154
144
  #
155
145
  # <%= text_field :person, :first_name %>
146
+ # which results in an html <tt><input></tt> tag whose +name+ attribute is
147
+ # <tt>person[first_name]</tt>. This means that when the form is submitted,
148
+ # the value entered by the user will be available in the controller as
149
+ # <tt>params[:person][:first_name]</tt>.
150
+ #
151
+ # For fields generated in this way using the FormBuilder,
152
+ # if <tt>:person</tt> also happens to be the name of an instance variable
153
+ # <tt>@person</tt>, the default value of the field shown when the form is
154
+ # initially displayed (e.g. in the situation where you are editing an
155
+ # existing record) will be the value of the corresponding attribute of
156
+ # <tt>@person</tt>.
156
157
  #
157
158
  # The rightmost argument to +form_for+ is an
158
- # optional hash of options:
159
- #
160
- # * <tt>:url</tt> - The URL the form is submitted to. It takes the same
161
- # fields you pass to +url_for+ or +link_to+. In particular you may pass
162
- # here a named route directly as well. Defaults to the current action.
159
+ # optional hash of options -
160
+ #
161
+ # * <tt>:url</tt> - The URL the form is to be submitted to. This may be
162
+ # represented in the same way as values passed to +url_for+ or +link_to+.
163
+ # So for example you may use a named route directly. When the model is
164
+ # represented by a string or symbol, as in the example above, if the
165
+ # <tt>:url</tt> option is not specified, by default the form will be
166
+ # sent back to the current url (We will describe below an alternative
167
+ # resource-oriented usage of +form_for+ in which the URL does not need
168
+ # to be specified explicitly).
163
169
  # * <tt>:namespace</tt> - A namespace for your form to ensure uniqueness of
164
170
  # id attributes on form elements. The namespace attribute will be prefixed
165
171
  # with underscore on the generated HTML id.
@@ -169,11 +175,11 @@ module ActionView
169
175
  # possible to use both the stand-alone FormHelper methods and methods
170
176
  # from FormTagHelper. For example:
171
177
  #
172
- # <%= form_for @person do |f| %>
178
+ # <%= form_for :person do |f| %>
173
179
  # First name: <%= f.text_field :first_name %>
174
180
  # Last name : <%= f.text_field :last_name %>
175
181
  # Biography : <%= text_area :person, :biography %>
176
- # Admin? : <%= check_box_tag "person[admin]", @person.company.admin? %>
182
+ # Admin? : <%= check_box_tag "person[admin]", "1", @person.company.admin? %>
177
183
  # <%= f.submit %>
178
184
  # <% end %>
179
185
  #
@@ -181,53 +187,85 @@ module ActionView
181
187
  # are designed to work with an object as base, like
182
188
  # FormOptionHelper#collection_select and DateHelper#datetime_select.
183
189
  #
184
- # === Resource-oriented style
185
- #
186
- # As we said above, in addition to manually configuring the +form_for+
187
- # call, you can rely on automated resource identification, which will use
188
- # the conventions and named routes of that approach. This is the
189
- # preferred way to use +form_for+ nowadays.
190
+ # === #form_for with a model object
190
191
  #
191
- # For example, if <tt>@post</tt> is an existing record you want to edit
192
+ # In the examples above, the object to be created or edited was
193
+ # represented by a symbol passed to +form_for+, and we noted that
194
+ # a string can also be used equivalently. It is also possible, however,
195
+ # to pass a model object itself to +form_for+. For example, if <tt>@post</tt>
196
+ # is an existing record you wish to edit, you can create the form using
192
197
  #
193
198
  # <%= form_for @post do |f| %>
194
199
  # ...
195
200
  # <% end %>
196
201
  #
197
- # is equivalent to something like:
202
+ # This behaves in almost the same way as outlined previously, with a
203
+ # couple of small exceptions. First, the prefix used to name the input
204
+ # elements within the form (hence the key that denotes them in the +params+
205
+ # hash) is actually derived from the object's _class_, e.g. <tt>params[:post]</tt>
206
+ # if the object's class is +Post+. However, this can be overwritten using
207
+ # the <tt>:as</tt> option, e.g. -
198
208
  #
199
- # <%= form_for @post, :as => :post, :url => post_path(@post), :method => :put, :html => { :class => "edit_post", :id => "edit_post_45" } do |f| %>
209
+ # <%= form_for(@person, as: :client) do |f| %>
200
210
  # ...
201
211
  # <% end %>
202
212
  #
203
- # And for new records
213
+ # would result in <tt>params[:client]</tt>.
204
214
  #
205
- # <%= form_for(Post.new) do |f| %>
215
+ # Secondly, the field values shown when the form is initially displayed
216
+ # are taken from the attributes of the object passed to +form_for+,
217
+ # regardless of whether the object is an instance
218
+ # variable. So, for example, if we had a _local_ variable +post+
219
+ # representing an existing record,
220
+ #
221
+ # <%= form_for post do |f| %>
206
222
  # ...
207
223
  # <% end %>
208
224
  #
209
- # is equivalent to something like:
225
+ # would produce a form with fields whose initial state reflect the current
226
+ # values of the attributes of +post+.
227
+ #
228
+ # === Resource-oriented style
229
+ #
230
+ # In the examples just shown, although not indicated explicitly, we still
231
+ # need to use the <tt>:url</tt> option in order to specify where the
232
+ # form is going to be sent. However, further simplification is possible
233
+ # if the record passed to +form_for+ is a _resource_, i.e. it corresponds
234
+ # to a set of RESTful routes, e.g. defined using the +resources+ method
235
+ # in <tt>config/routes.rb</tt>. In this case Rails will simply infer the
236
+ # appropriate URL from the record itself. For example,
210
237
  #
211
- # <%= form_for @post, :as => :post, :url => posts_path, :html => { :class => "new_post", :id => "new_post" } do |f| %>
238
+ # <%= form_for @post do |f| %>
212
239
  # ...
213
240
  # <% end %>
214
241
  #
215
- # You can also overwrite the individual conventions, like this:
242
+ # is then equivalent to something like:
216
243
  #
217
- # <%= form_for(@post, :url => super_posts_path) do |f| %>
244
+ # <%= form_for @post, as: :post, url: post_path(@post), method: :patch, html: { class: "edit_post", id: "edit_post_45" } do |f| %>
218
245
  # ...
219
246
  # <% end %>
220
247
  #
221
- # You can also set the answer format, like this:
248
+ # And for a new record
249
+ #
250
+ # <%= form_for(Post.new) do |f| %>
251
+ # ...
252
+ # <% end %>
253
+ #
254
+ # is equivalent to something like:
255
+ #
256
+ # <%= form_for @post, as: :post, url: posts_path, html: { class: "new_post", id: "new_post" } do |f| %>
257
+ # ...
258
+ # <% end %>
259
+ #
260
+ # However you can still overwrite individual conventions, such as:
222
261
  #
223
- # <%= form_for(@post, :format => :json) do |f| %>
262
+ # <%= form_for(@post, url: super_posts_path) do |f| %>
224
263
  # ...
225
264
  # <% end %>
226
265
  #
227
- # If you have an object that needs to be represented as a different
228
- # parameter, like a Person that acts as a Client:
266
+ # You can also set the answer format, like this:
229
267
  #
230
- # <%= form_for(@person, :as => :client) do |f| %>
268
+ # <%= form_for(@post, format: :json) do |f| %>
231
269
  # ...
232
270
  # <% end %>
233
271
  #
@@ -251,17 +289,17 @@ module ActionView
251
289
  #
252
290
  # You can force the form to use the full array of HTTP verbs by setting
253
291
  #
254
- # :method => (:get|:post|:put|:delete)
292
+ # method: (:get|:post|:patch|:put|:delete)
255
293
  #
256
- # in the options hash. If the verb is not GET or POST, which are natively supported by HTML forms, the
257
- # form will be set to POST and a hidden input called _method will carry the intended verb for the server
258
- # to interpret.
294
+ # in the options hash. If the verb is not GET or POST, which are natively
295
+ # supported by HTML forms, the form will be set to POST and a hidden input
296
+ # called _method will carry the intended verb for the server to interpret.
259
297
  #
260
298
  # === Unobtrusive JavaScript
261
299
  #
262
300
  # Specifying:
263
301
  #
264
- # :remote => true
302
+ # remote: true
265
303
  #
266
304
  # in the options hash creates a form that will allow the unobtrusive JavaScript drivers to modify its
267
305
  # behavior. The expected default behavior is an XMLHttpRequest in the background instead of the regular
@@ -271,7 +309,7 @@ module ActionView
271
309
  #
272
310
  # Example:
273
311
  #
274
- # <%= form_for(@post, :remote => true) do |f| %>
312
+ # <%= form_for(@post, remote: true) do |f| %>
275
313
  # ...
276
314
  # <% end %>
277
315
  #
@@ -279,7 +317,25 @@ module ActionView
279
317
  #
280
318
  # <form action='http://www.example.com' method='post' data-remote='true'>
281
319
  # <div style='margin:0;padding:0;display:inline'>
282
- # <input name='_method' type='hidden' value='put' />
320
+ # <input name='_method' type='hidden' value='patch' />
321
+ # </div>
322
+ # ...
323
+ # </form>
324
+ #
325
+ # === Setting HTML options
326
+ #
327
+ # You can set data attributes directly by passing in a data hash, but all other HTML options must be wrapped in
328
+ # the HTML key. Example:
329
+ #
330
+ # <%= form_for(@post, data: { behavior: "autosave" }, html: { name: "go" }) do |f| %>
331
+ # ...
332
+ # <% end %>
333
+ #
334
+ # The HTML generated for this would be:
335
+ #
336
+ # <form action='http://www.example.com' method='post' data-behavior='autosave' name='go'>
337
+ # <div style='margin:0;padding:0;display:inline'>
338
+ # <input name='_method' type='hidden' value='patch' />
283
339
  # </div>
284
340
  # ...
285
341
  # </form>
@@ -297,7 +353,7 @@ module ActionView
297
353
  # Example:
298
354
  #
299
355
  # <%= form_for(@post) do |f| %>
300
- # <% f.fields_for(:comments, :include_id => false) do |cf| %>
356
+ # <%= f.fields_for(:comments, include_id: false) do |cf| %>
301
357
  # ...
302
358
  # <% end %>
303
359
  # <% end %>
@@ -309,7 +365,7 @@ module ActionView
309
365
  # custom builder. For example, let's say you made a helper to
310
366
  # automatically add labels to form inputs.
311
367
  #
312
- # <%= form_for @person, :url => { :action => "create" }, :builder => LabellingFormBuilder do |f| %>
368
+ # <%= form_for @person, url: { action: "create" }, builder: LabellingFormBuilder do |f| %>
313
369
  # <%= f.text_field :first_name %>
314
370
  # <%= f.text_field :last_name %>
315
371
  # <%= f.text_area :biography %>
@@ -333,7 +389,7 @@ module ActionView
333
389
  #
334
390
  # def labelled_form_for(record_or_name_or_array, *args, &block)
335
391
  # options = args.extract_options!
336
- # form_for(record_or_name_or_array, *(args << options.merge(:builder => LabellingFormBuilder)), &block)
392
+ # form_for(record_or_name_or_array, *(args << options.merge(builder: LabellingFormBuilder)), &block)
337
393
  # end
338
394
  #
339
395
  # If you don't need to attach a form to a model instance, then check out
@@ -346,19 +402,18 @@ module ActionView
346
402
  #
347
403
  # To set an authenticity token you need to pass an <tt>:authenticity_token</tt> parameter
348
404
  #
349
- # <%= form_for @invoice, :url => external_url, :authenticity_token => 'external_token' do |f|
405
+ # <%= form_for @invoice, url: external_url, authenticity_token: 'external_token' do |f|
350
406
  # ...
351
407
  # <% end %>
352
408
  #
353
409
  # If you don't want to an authenticity token field be rendered at all just pass <tt>false</tt>:
354
410
  #
355
- # <%= form_for @invoice, :url => external_url, :authenticity_token => false do |f|
411
+ # <%= form_for @invoice, url: external_url, authenticity_token: false do |f|
356
412
  # ...
357
413
  # <% end %>
358
414
  def form_for(record, options = {}, &block)
359
415
  raise ArgumentError, "Missing block" unless block_given?
360
-
361
- options[:html] ||= {}
416
+ html_options = options[:html] ||= {}
362
417
 
363
418
  case record
364
419
  when String, Symbol
@@ -366,33 +421,35 @@ module ActionView
366
421
  object = nil
367
422
  else
368
423
  object = record.is_a?(Array) ? record.last : record
369
- object_name = options[:as] || ActiveModel::Naming.param_key(object)
370
- apply_form_for_options!(record, options)
424
+ raise ArgumentError, "First argument in form cannot contain nil or be empty" unless object
425
+ object_name = options[:as] || model_name_from_record_or_class(object).param_key
426
+ apply_form_for_options!(record, object, options)
371
427
  end
372
428
 
373
- options[:html][:remote] = options.delete(:remote) if options.has_key?(:remote)
374
- options[:html][:method] = options.delete(:method) if options.has_key?(:method)
375
- options[:html][:authenticity_token] = options.delete(:authenticity_token)
429
+ html_options[:data] = options.delete(:data) if options.has_key?(:data)
430
+ html_options[:remote] = options.delete(:remote) if options.has_key?(:remote)
431
+ html_options[:method] = options.delete(:method) if options.has_key?(:method)
432
+ html_options[:authenticity_token] = options.delete(:authenticity_token)
376
433
 
377
- builder = options[:parent_builder] = instantiate_builder(object_name, object, options, &block)
434
+ builder = instantiate_builder(object_name, object, options)
378
435
  output = capture(builder, &block)
379
- default_options = builder.multipart? ? { :multipart => true } : {}
380
- form_tag(options.delete(:url) || {}, default_options.merge!(options.delete(:html))) { output }
436
+ html_options[:multipart] ||= builder.multipart?
437
+
438
+ form_tag(options[:url] || {}, html_options) { output }
381
439
  end
382
440
 
383
- def apply_form_for_options!(object_or_array, options) #:nodoc:
384
- object = object_or_array.is_a?(Array) ? object_or_array.last : object_or_array
441
+ def apply_form_for_options!(record, object, options) #:nodoc:
385
442
  object = convert_to_model(object)
386
443
 
387
444
  as = options[:as]
388
- action, method = object.respond_to?(:persisted?) && object.persisted? ? [:edit, :put] : [:new, :post]
445
+ action, method = object.respond_to?(:persisted?) && object.persisted? ? [:edit, :patch] : [:new, :post]
389
446
  options[:html].reverse_merge!(
390
- :class => as ? "#{action}_#{as}" : dom_class(object, action),
391
- :id => as ? "#{action}_#{as}" : [options[:namespace], dom_id(object, action)].compact.join("_").presence,
392
- :method => method
447
+ class: as ? "#{action}_#{as}" : dom_class(object, action),
448
+ id: as ? "#{action}_#{as}" : [options[:namespace], dom_id(object, action)].compact.join("_").presence,
449
+ method: method
393
450
  )
394
451
 
395
- options[:url] ||= polymorphic_path(object_or_array, :format => options.delete(:format))
452
+ options[:url] ||= polymorphic_path(record, format: options.delete(:format))
396
453
  end
397
454
  private :apply_form_for_options!
398
455
 
@@ -400,32 +457,59 @@ module ActionView
400
457
  # doesn't create the form tags themselves. This makes fields_for suitable
401
458
  # for specifying additional model objects in the same form.
402
459
  #
403
- # === Generic Examples
460
+ # Although the usage and purpose of +field_for+ is similar to +form_for+'s,
461
+ # its method signature is slightly different. Like +form_for+, it yields
462
+ # a FormBuilder object associated with a particular model object to a block,
463
+ # and within the block allows methods to be called on the builder to
464
+ # generate fields associated with the model object. Fields may reflect
465
+ # a model object in two ways - how they are named (hence how submitted
466
+ # values appear within the +params+ hash in the controller) and what
467
+ # default values are shown when the form the fields appear in is first
468
+ # displayed. In order for both of these features to be specified independently,
469
+ # both an object name (represented by either a symbol or string) and the
470
+ # object itself can be passed to the method separately -
404
471
  #
405
472
  # <%= form_for @person do |person_form| %>
406
473
  # First name: <%= person_form.text_field :first_name %>
407
474
  # Last name : <%= person_form.text_field :last_name %>
408
475
  #
409
- # <%= fields_for @person.permission do |permission_fields| %>
476
+ # <%= fields_for :permission, @person.permission do |permission_fields| %>
410
477
  # Admin? : <%= permission_fields.check_box :admin %>
411
478
  # <% end %>
412
479
  #
413
480
  # <%= f.submit %>
414
481
  # <% end %>
415
482
  #
416
- # ...or if you have an object that needs to be represented as a different
417
- # parameter, like a Client that acts as a Person:
483
+ # In this case, the checkbox field will be represented by an HTML +input+
484
+ # tag with the +name+ attribute <tt>permission[admin]</tt>, and the submitted
485
+ # value will appear in the controller as <tt>params[:permission][:admin]</tt>.
486
+ # If <tt>@person.permission</tt> is an existing record with an attribute
487
+ # +admin+, the initial state of the checkbox when first displayed will
488
+ # reflect the value of <tt>@person.permission.admin</tt>.
489
+ #
490
+ # Often this can be simplified by passing just the name of the model
491
+ # object to +fields_for+ -
418
492
  #
419
- # <%= fields_for :person, @client do |permission_fields| %>
493
+ # <%= fields_for :permission do |permission_fields| %>
420
494
  # Admin?: <%= permission_fields.check_box :admin %>
421
495
  # <% end %>
422
496
  #
423
- # ...or if you don't have an object, just a name of the parameter:
497
+ # ...in which case, if <tt>:permission</tt> also happens to be the name of an
498
+ # instance variable <tt>@permission</tt>, the initial state of the input
499
+ # field will reflect the value of that variable's attribute <tt>@permission.admin</tt>.
424
500
  #
425
- # <%= fields_for :person do |permission_fields| %>
501
+ # Alternatively, you can pass just the model object itself (if the first
502
+ # argument isn't a string or symbol +fields_for+ will realize that the
503
+ # name has been omitted) -
504
+ #
505
+ # <%= fields_for @person.permission do |permission_fields| %>
426
506
  # Admin?: <%= permission_fields.check_box :admin %>
427
507
  # <% end %>
428
508
  #
509
+ # and +fields_for+ will derive the required name of the field from the
510
+ # _class_ of the model object, e.g. if <tt>@person.permission</tt>, is
511
+ # of class +Permission+, the field will still be named <tt>permission[admin]</tt>.
512
+ #
429
513
  # Note: This also works for the methods in FormOptionHelper and
430
514
  # DateHelper that are designed to work with an object as base, like
431
515
  # FormOptionHelper#collection_select and DateHelper#datetime_select.
@@ -489,7 +573,7 @@ module ActionView
489
573
  #
490
574
  # class Person < ActiveRecord::Base
491
575
  # has_one :address
492
- # accepts_nested_attributes_for :address, :allow_destroy => true
576
+ # accepts_nested_attributes_for :address, allow_destroy: true
493
577
  # end
494
578
  #
495
579
  # Now, when you use a form element with the <tt>_destroy</tt> parameter,
@@ -571,21 +655,13 @@ module ActionView
571
655
  # ...
572
656
  # <% end %>
573
657
  #
574
- # When projects is already an association on Person you can use
575
- # +accepts_nested_attributes_for+ to define the writer method for you:
576
- #
577
- # class Person < ActiveRecord::Base
578
- # has_many :projects
579
- # accepts_nested_attributes_for :projects
580
- # end
581
- #
582
658
  # If you want to destroy any of the associated models through the
583
659
  # form, you have to enable it first using the <tt>:allow_destroy</tt>
584
660
  # option for +accepts_nested_attributes_for+:
585
661
  #
586
662
  # class Person < ActiveRecord::Base
587
663
  # has_many :projects
588
- # accepts_nested_attributes_for :projects, :allow_destroy => true
664
+ # accepts_nested_attributes_for :projects, allow_destroy: true
589
665
  # end
590
666
  #
591
667
  # This will allow you to specify which models to destroy in the
@@ -600,11 +676,27 @@ module ActionView
600
676
  # <% end %>
601
677
  # ...
602
678
  # <% end %>
679
+ #
680
+ # When a collection is used you might want to know the index of each
681
+ # object into the array. For this purpose, the <tt>index</tt> method
682
+ # is available in the FormBuilder object.
683
+ #
684
+ # <%= form_for @person do |person_form| %>
685
+ # ...
686
+ # <%= person_form.fields_for :projects do |project_fields| %>
687
+ # Project #<%= project_fields.index %>
688
+ # ...
689
+ # <% end %>
690
+ # ...
691
+ # <% end %>
692
+ #
693
+ # Note that fields_for will automatically generate a hidden field
694
+ # to store the ID of the record. There are circumstances where this
695
+ # hidden field is not needed and you can pass <tt>hidden_field_id: false</tt>
696
+ # to prevent fields_for from rendering it automatically.
603
697
  def fields_for(record_name, record_object = nil, options = {}, &block)
604
- builder = instantiate_builder(record_name, record_object, options, &block)
605
- output = capture(builder, &block)
606
- output.concat builder.hidden_field(:id) if output && options[:hidden_field_id] && !builder.emitted_hidden_id?
607
- output
698
+ builder = instantiate_builder(record_name, record_object, options)
699
+ capture(builder, &block)
608
700
  end
609
701
 
610
702
  # Returns a label tag tailored for labelling an input field for a specified attribute (identified by +method+) on an object
@@ -618,15 +710,15 @@ module ActionView
618
710
  # label(:post, :title)
619
711
  # # => <label for="post_title">Title</label>
620
712
  #
621
- # You can localize your labels based on model and attribute names.
622
- # For example you can define the following in your locale (e.g. en.yml)
713
+ # You can localize your labels based on model and attribute names.
714
+ # For example you can define the following in your locale (e.g. en.yml)
623
715
  #
624
716
  # helpers:
625
717
  # label:
626
718
  # post:
627
719
  # body: "Write your entire text here"
628
720
  #
629
- # Which then will result in
721
+ # Which then will result in
630
722
  #
631
723
  # label(:post, :body)
632
724
  # # => <label for="post_body">Write your entire text here</label>
@@ -645,27 +737,17 @@ module ActionView
645
737
  # label(:post, :title, "A short title")
646
738
  # # => <label for="post_title">A short title</label>
647
739
  #
648
- # label(:post, :title, "A short title", :class => "title_label")
740
+ # label(:post, :title, "A short title", class: "title_label")
649
741
  # # => <label for="post_title" class="title_label">A short title</label>
650
742
  #
651
- # label(:post, :privacy, "Public Post", :value => "public")
743
+ # label(:post, :privacy, "Public Post", value: "public")
652
744
  # # => <label for="post_privacy_public">Public Post</label>
653
745
  #
654
746
  # label(:post, :terms) do
655
747
  # 'Accept <a href="/terms">Terms</a>.'.html_safe
656
748
  # end
657
749
  def label(object_name, method, content_or_options = nil, options = nil, &block)
658
- options ||= {}
659
-
660
- content_is_options = content_or_options.is_a?(Hash)
661
- if content_is_options || block_given?
662
- options.merge!(content_or_options) if content_is_options
663
- text = nil
664
- else
665
- text = content_or_options
666
- end
667
-
668
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_label_tag(text, options, &block)
750
+ Tags::Label.new(object_name, method, self, content_or_options, options).render(&block)
669
751
  end
670
752
 
671
753
  # Returns an input tag of the "text" type tailored for accessing a specified attribute (identified by +method+) on an object
@@ -674,42 +756,40 @@ module ActionView
674
756
  # shown.
675
757
  #
676
758
  # ==== Examples
677
- # text_field(:post, :title, :size => 20)
759
+ # text_field(:post, :title, size: 20)
678
760
  # # => <input type="text" id="post_title" name="post[title]" size="20" value="#{@post.title}" />
679
761
  #
680
- # text_field(:post, :title, :class => "create_input")
762
+ # text_field(:post, :title, class: "create_input")
681
763
  # # => <input type="text" id="post_title" name="post[title]" value="#{@post.title}" class="create_input" />
682
764
  #
683
- # text_field(:session, :user, :onchange => "if $('session[user]').value == 'admin' { alert('Your login can not be admin!'); }")
684
- # # => <input type="text" id="session_user" name="session[user]" value="#{@session.user}" onchange = "if $('session[user]').value == 'admin' { alert('Your login can not be admin!'); }"/>
765
+ # text_field(:session, :user, onchange: "if ($('#session_user').val() === 'admin') { alert('Your login can not be admin!'); }")
766
+ # # => <input type="text" id="session_user" name="session[user]" value="#{@session.user}" onchange="if ($('#session_user').val() === 'admin') { alert('Your login can not be admin!'); }"/>
685
767
  #
686
- # text_field(:snippet, :code, :size => 20, :class => 'code_input')
768
+ # text_field(:snippet, :code, size: 20, class: 'code_input')
687
769
  # # => <input type="text" id="snippet_code" name="snippet[code]" size="20" value="#{@snippet.code}" class="code_input" />
688
- #
689
770
  def text_field(object_name, method, options = {})
690
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag("text", options)
771
+ Tags::TextField.new(object_name, method, self, options).render
691
772
  end
692
773
 
693
774
  # Returns an input tag of the "password" type tailored for accessing a specified attribute (identified by +method+) on an object
694
775
  # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
695
776
  # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
696
- # shown.
777
+ # shown. For security reasons this field is blank by default; pass in a value via +options+ if this is not desired.
697
778
  #
698
779
  # ==== Examples
699
- # password_field(:login, :pass, :size => 20)
780
+ # password_field(:login, :pass, size: 20)
700
781
  # # => <input type="password" id="login_pass" name="login[pass]" size="20" />
701
782
  #
702
- # password_field(:account, :secret, :class => "form_input", :value => @account.secret)
783
+ # password_field(:account, :secret, class: "form_input", value: @account.secret)
703
784
  # # => <input type="password" id="account_secret" name="account[secret]" value="#{@account.secret}" class="form_input" />
704
785
  #
705
- # password_field(:user, :password, :onchange => "if $('user[password]').length > 30 { alert('Your password needs to be shorter!'); }")
706
- # # => <input type="password" id="user_password" name="user[password]" onchange = "if $('user[password]').length > 30 { alert('Your password needs to be shorter!'); }"/>
786
+ # password_field(:user, :password, onchange: "if ($('#user_password').val().length > 30) { alert('Your password needs to be shorter!'); }")
787
+ # # => <input type="password" id="user_password" name="user[password]" onchange="if ($('#user_password').val().length > 30) { alert('Your password needs to be shorter!'); }"/>
707
788
  #
708
- # password_field(:account, :pin, :size => 20, :class => 'form_input')
789
+ # password_field(:account, :pin, size: 20, class: 'form_input')
709
790
  # # => <input type="password" id="account_pin" name="account[pin]" size="20" class="form_input" />
710
- #
711
791
  def password_field(object_name, method, options = {})
712
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag("password", { :value => nil }.merge!(options))
792
+ Tags::PasswordField.new(object_name, method, self, options).render
713
793
  end
714
794
 
715
795
  # Returns a hidden input tag tailored for accessing a specified attribute (identified by +method+) on an object
@@ -727,7 +807,7 @@ module ActionView
727
807
  # hidden_field(:user, :token)
728
808
  # # => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" />
729
809
  def hidden_field(object_name, method, options = {})
730
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag("hidden", options)
810
+ Tags::HiddenField.new(object_name, method, self, options).render
731
811
  end
732
812
 
733
813
  # Returns a file upload input tag tailored for accessing a specified attribute (identified by +method+) on an object
@@ -737,18 +817,29 @@ module ActionView
737
817
  #
738
818
  # Using this method inside a +form_for+ block will set the enclosing form's encoding to <tt>multipart/form-data</tt>.
739
819
  #
820
+ # ==== Options
821
+ # * Creates standard HTML attributes for the tag.
822
+ # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input.
823
+ # * <tt>:multiple</tt> - If set to true, *in most updated browsers* the user will be allowed to select multiple files.
824
+ # * <tt>:accept</tt> - If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations.
825
+ #
740
826
  # ==== Examples
741
827
  # file_field(:user, :avatar)
742
828
  # # => <input type="file" id="user_avatar" name="user[avatar]" />
743
829
  #
744
- # file_field(:post, :attached, :accept => 'text/html')
830
+ # file_field(:post, :image, :multiple => true)
831
+ # # => <input type="file" id="post_image" name="post[image]" multiple="true" />
832
+ #
833
+ # file_field(:post, :attached, accept: 'text/html')
745
834
  # # => <input accept="text/html" type="file" id="post_attached" name="post[attached]" />
746
835
  #
747
- # file_field(:attachment, :file, :class => 'file_input')
748
- # # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
836
+ # file_field(:post, :image, accept: 'image/png,image/gif,image/jpeg')
837
+ # # => <input type="file" id="post_image" name="post[image]" accept="image/png,image/gif,image/jpeg" />
749
838
  #
839
+ # file_field(:attachment, :file, class: 'file_input')
840
+ # # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
750
841
  def file_field(object_name, method, options = {})
751
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag("file", options.update({:size => nil}))
842
+ Tags::FileField.new(object_name, method, self, options).render
752
843
  end
753
844
 
754
845
  # Returns a textarea opening and closing tag set tailored for accessing a specified attribute (identified by +method+)
@@ -756,27 +847,27 @@ module ActionView
756
847
  # hash with +options+.
757
848
  #
758
849
  # ==== Examples
759
- # text_area(:post, :body, :cols => 20, :rows => 40)
850
+ # text_area(:post, :body, cols: 20, rows: 40)
760
851
  # # => <textarea cols="20" rows="40" id="post_body" name="post[body]">
761
852
  # # #{@post.body}
762
853
  # # </textarea>
763
854
  #
764
- # text_area(:comment, :text, :size => "20x30")
855
+ # text_area(:comment, :text, size: "20x30")
765
856
  # # => <textarea cols="20" rows="30" id="comment_text" name="comment[text]">
766
857
  # # #{@comment.text}
767
858
  # # </textarea>
768
859
  #
769
- # text_area(:application, :notes, :cols => 40, :rows => 15, :class => 'app_input')
860
+ # text_area(:application, :notes, cols: 40, rows: 15, class: 'app_input')
770
861
  # # => <textarea cols="40" rows="15" id="application_notes" name="application[notes]" class="app_input">
771
862
  # # #{@application.notes}
772
863
  # # </textarea>
773
864
  #
774
- # text_area(:entry, :body, :size => "20x20", :disabled => 'disabled')
865
+ # text_area(:entry, :body, size: "20x20", disabled: 'disabled')
775
866
  # # => <textarea cols="20" rows="20" id="entry_body" name="entry[body]" disabled="disabled">
776
867
  # # #{@entry.body}
777
868
  # # </textarea>
778
869
  def text_area(object_name, method, options = {})
779
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_text_area_tag(options)
870
+ Tags::TextArea.new(object_name, method, self, options).render
780
871
  end
781
872
 
782
873
  # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object
@@ -793,7 +884,7 @@ module ActionView
793
884
  # invoice the user unchecks its check box, no +paid+ parameter is sent. So,
794
885
  # any mass-assignment idiom like
795
886
  #
796
- # @invoice.update_attributes(params[:invoice])
887
+ # @invoice.update(params[:invoice])
797
888
  #
798
889
  # wouldn't update the flag.
799
890
  #
@@ -810,7 +901,7 @@ module ActionView
810
901
  # Unfortunately that workaround does not work when the check box goes
811
902
  # within an array-like parameter, as in
812
903
  #
813
- # <%= fields_for "project[invoice_attributes][]", invoice, :index => nil do |form| %>
904
+ # <%= fields_for "project[invoice_attributes][]", invoice, index: nil do |form| %>
814
905
  # <%= form.check_box :paid %>
815
906
  # ...
816
907
  # <% end %>
@@ -822,33 +913,30 @@ module ActionView
822
913
  # In that case it is preferable to either use +check_box_tag+ or to use
823
914
  # hashes instead of arrays.
824
915
  #
825
- # ==== Examples
826
916
  # # Let's say that @post.validated? is 1:
827
917
  # check_box("post", "validated")
828
918
  # # => <input name="post[validated]" type="hidden" value="0" />
829
- # # <input type="checkbox" id="post_validated" name="post[validated]" value="1" />
919
+ # # <input checked="checked" type="checkbox" id="post_validated" name="post[validated]" value="1" />
830
920
  #
831
921
  # # Let's say that @puppy.gooddog is "no":
832
922
  # check_box("puppy", "gooddog", {}, "yes", "no")
833
923
  # # => <input name="puppy[gooddog]" type="hidden" value="no" />
834
924
  # # <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />
835
925
  #
836
- # check_box("eula", "accepted", { :class => 'eula_check' }, "yes", "no")
926
+ # check_box("eula", "accepted", { class: 'eula_check' }, "yes", "no")
837
927
  # # => <input name="eula[accepted]" type="hidden" value="no" />
838
928
  # # <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" />
839
- #
840
929
  def check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0")
841
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_check_box_tag(options, checked_value, unchecked_value)
930
+ Tags::CheckBox.new(object_name, method, self, checked_value, unchecked_value, options).render
842
931
  end
843
932
 
844
933
  # Returns a radio button tag for accessing a specified attribute (identified by +method+) on an object
845
934
  # assigned to the template (identified by +object+). If the current value of +method+ is +tag_value+ the
846
935
  # radio button will be checked.
847
936
  #
848
- # To force the radio button to be checked pass <tt>:checked => true</tt> in the
937
+ # To force the radio button to be checked pass <tt>checked: true</tt> in the
849
938
  # +options+ hash. You may pass HTML options there as well.
850
939
  #
851
- # ==== Examples
852
940
  # # Let's say that @post.category returns "rails":
853
941
  # radio_button("post", "category", "rails")
854
942
  # radio_button("post", "category", "java")
@@ -860,74 +948,170 @@ module ActionView
860
948
  # # => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" />
861
949
  # # <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" />
862
950
  def radio_button(object_name, method, tag_value, options = {})
863
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_radio_button_tag(tag_value, options)
951
+ Tags::RadioButton.new(object_name, method, self, tag_value, options).render
952
+ end
953
+
954
+ # Returns a text_field of type "color".
955
+ #
956
+ # color_field("car", "color")
957
+ # # => <input id="car_color" name="car[color]" type="color" value="#000000" />
958
+ def color_field(object_name, method, options = {})
959
+ Tags::ColorField.new(object_name, method, self, options).render
864
960
  end
865
961
 
866
962
  # Returns an input of type "search" for accessing a specified attribute (identified by +method+) on an object
867
963
  # assigned to the template (identified by +object_name+). Inputs of type "search" may be styled differently by
868
964
  # some browsers.
869
965
  #
870
- # ==== Examples
871
- #
872
966
  # search_field(:user, :name)
873
- # # => <input id="user_name" name="user[name]" size="30" type="search" />
874
- # search_field(:user, :name, :autosave => false)
875
- # # => <input autosave="false" id="user_name" name="user[name]" size="30" type="search" />
876
- # search_field(:user, :name, :results => 3)
877
- # # => <input id="user_name" name="user[name]" results="3" size="30" type="search" />
967
+ # # => <input id="user_name" name="user[name]" type="search" />
968
+ # search_field(:user, :name, autosave: false)
969
+ # # => <input autosave="false" id="user_name" name="user[name]" type="search" />
970
+ # search_field(:user, :name, results: 3)
971
+ # # => <input id="user_name" name="user[name]" results="3" type="search" />
878
972
  # # Assume request.host returns "www.example.com"
879
- # search_field(:user, :name, :autosave => true)
880
- # # => <input autosave="com.example.www" id="user_name" name="user[name]" results="10" size="30" type="search" />
881
- # search_field(:user, :name, :onsearch => true)
882
- # # => <input id="user_name" incremental="true" name="user[name]" onsearch="true" size="30" type="search" />
883
- # search_field(:user, :name, :autosave => false, :onsearch => true)
884
- # # => <input autosave="false" id="user_name" incremental="true" name="user[name]" onsearch="true" size="30" type="search" />
885
- # search_field(:user, :name, :autosave => true, :onsearch => true)
886
- # # => <input autosave="com.example.www" id="user_name" incremental="true" name="user[name]" onsearch="true" results="10" size="30" type="search" />
887
- #
973
+ # search_field(:user, :name, autosave: true)
974
+ # # => <input autosave="com.example.www" id="user_name" name="user[name]" results="10" type="search" />
975
+ # search_field(:user, :name, onsearch: true)
976
+ # # => <input id="user_name" incremental="true" name="user[name]" onsearch="true" type="search" />
977
+ # search_field(:user, :name, autosave: false, onsearch: true)
978
+ # # => <input autosave="false" id="user_name" incremental="true" name="user[name]" onsearch="true" type="search" />
979
+ # search_field(:user, :name, autosave: true, onsearch: true)
980
+ # # => <input autosave="com.example.www" id="user_name" incremental="true" name="user[name]" onsearch="true" results="10" type="search" />
888
981
  def search_field(object_name, method, options = {})
889
- options = options.stringify_keys
890
-
891
- if options["autosave"]
892
- if options["autosave"] == true
893
- options["autosave"] = request.host.split(".").reverse.join(".")
894
- end
895
- options["results"] ||= 10
896
- end
897
-
898
- if options["onsearch"]
899
- options["incremental"] = true unless options.has_key?("incremental")
900
- end
901
-
902
- InstanceTag.new(object_name, method, self, options.delete("object")).to_input_field_tag("search", options)
982
+ Tags::SearchField.new(object_name, method, self, options).render
903
983
  end
904
984
 
905
985
  # Returns a text_field of type "tel".
906
986
  #
907
987
  # telephone_field("user", "phone")
908
- # # => <input id="user_phone" name="user[phone]" size="30" type="tel" />
988
+ # # => <input id="user_phone" name="user[phone]" type="tel" />
909
989
  #
910
990
  def telephone_field(object_name, method, options = {})
911
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag("tel", options)
991
+ Tags::TelField.new(object_name, method, self, options).render
912
992
  end
993
+ # aliases telephone_field
913
994
  alias phone_field telephone_field
914
995
 
996
+ # Returns a text_field of type "date".
997
+ #
998
+ # date_field("user", "born_on")
999
+ # # => <input id="user_born_on" name="user[born_on]" type="date" />
1000
+ #
1001
+ # The default value is generated by trying to call "to_date"
1002
+ # on the object's value, which makes it behave as expected for instances
1003
+ # of DateTime and ActiveSupport::TimeWithZone. You can still override that
1004
+ # by passing the "value" option explicitly, e.g.
1005
+ #
1006
+ # @user.born_on = Date.new(1984, 1, 27)
1007
+ # date_field("user", "born_on", value: "1984-05-12")
1008
+ # # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-05-12" />
1009
+ #
1010
+ def date_field(object_name, method, options = {})
1011
+ Tags::DateField.new(object_name, method, self, options).render
1012
+ end
1013
+
1014
+ # Returns a text_field of type "time".
1015
+ #
1016
+ # The default value is generated by trying to call +strftime+ with "%T.%L"
1017
+ # on the objects's value. It is still possible to override that
1018
+ # by passing the "value" option.
1019
+ #
1020
+ # === Options
1021
+ # * Accepts same options as time_field_tag
1022
+ #
1023
+ # === Example
1024
+ # time_field("task", "started_at")
1025
+ # # => <input id="task_started_at" name="task[started_at]" type="time" />
1026
+ #
1027
+ def time_field(object_name, method, options = {})
1028
+ Tags::TimeField.new(object_name, method, self, options).render
1029
+ end
1030
+
1031
+ # Returns a text_field of type "datetime".
1032
+ #
1033
+ # datetime_field("user", "born_on")
1034
+ # # => <input id="user_born_on" name="user[born_on]" type="datetime" />
1035
+ #
1036
+ # The default value is generated by trying to call +strftime+ with "%Y-%m-%dT%T.%L%z"
1037
+ # on the object's value, which makes it behave as expected for instances
1038
+ # of DateTime and ActiveSupport::TimeWithZone.
1039
+ #
1040
+ # @user.born_on = Date.new(1984, 1, 12)
1041
+ # datetime_field("user", "born_on")
1042
+ # # => <input id="user_born_on" name="user[born_on]" type="datetime" value="1984-01-12T00:00:00.000+0000" />
1043
+ #
1044
+ def datetime_field(object_name, method, options = {})
1045
+ Tags::DatetimeField.new(object_name, method, self, options).render
1046
+ end
1047
+
1048
+ # Returns a text_field of type "datetime-local".
1049
+ #
1050
+ # datetime_local_field("user", "born_on")
1051
+ # # => <input id="user_born_on" name="user[born_on]" type="datetime-local" />
1052
+ #
1053
+ # The default value is generated by trying to call +strftime+ with "%Y-%m-%dT%T"
1054
+ # on the object's value, which makes it behave as expected for instances
1055
+ # of DateTime and ActiveSupport::TimeWithZone.
1056
+ #
1057
+ # @user.born_on = Date.new(1984, 1, 12)
1058
+ # datetime_local_field("user", "born_on")
1059
+ # # => <input id="user_born_on" name="user[born_on]" type="datetime-local" value="1984-01-12T00:00:00" />
1060
+ #
1061
+ def datetime_local_field(object_name, method, options = {})
1062
+ Tags::DatetimeLocalField.new(object_name, method, self, options).render
1063
+ end
1064
+
1065
+ # Returns a text_field of type "month".
1066
+ #
1067
+ # month_field("user", "born_on")
1068
+ # # => <input id="user_born_on" name="user[born_on]" type="month" />
1069
+ #
1070
+ # The default value is generated by trying to call +strftime+ with "%Y-%m"
1071
+ # on the object's value, which makes it behave as expected for instances
1072
+ # of DateTime and ActiveSupport::TimeWithZone.
1073
+ #
1074
+ # @user.born_on = Date.new(1984, 1, 27)
1075
+ # month_field("user", "born_on")
1076
+ # # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-01" />
1077
+ #
1078
+ def month_field(object_name, method, options = {})
1079
+ Tags::MonthField.new(object_name, method, self, options).render
1080
+ end
1081
+
1082
+ # Returns a text_field of type "week".
1083
+ #
1084
+ # week_field("user", "born_on")
1085
+ # # => <input id="user_born_on" name="user[born_on]" type="week" />
1086
+ #
1087
+ # The default value is generated by trying to call +strftime+ with "%Y-W%W"
1088
+ # on the object's value, which makes it behave as expected for instances
1089
+ # of DateTime and ActiveSupport::TimeWithZone.
1090
+ #
1091
+ # @user.born_on = Date.new(1984, 5, 12)
1092
+ # week_field("user", "born_on")
1093
+ # # => <input id="user_born_on" name="user[born_on]" type="date" value="1984-W19" />
1094
+ #
1095
+ def week_field(object_name, method, options = {})
1096
+ Tags::WeekField.new(object_name, method, self, options).render
1097
+ end
1098
+
915
1099
  # Returns a text_field of type "url".
916
1100
  #
917
1101
  # url_field("user", "homepage")
918
- # # => <input id="user_homepage" size="30" name="user[homepage]" type="url" />
1102
+ # # => <input id="user_homepage" name="user[homepage]" type="url" />
919
1103
  #
920
1104
  def url_field(object_name, method, options = {})
921
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag("url", options)
1105
+ Tags::UrlField.new(object_name, method, self, options).render
922
1106
  end
923
1107
 
924
1108
  # Returns a text_field of type "email".
925
1109
  #
926
1110
  # email_field("user", "address")
927
- # # => <input id="user_address" size="30" name="user[address]" type="email" />
1111
+ # # => <input id="user_address" name="user[address]" type="email" />
928
1112
  #
929
1113
  def email_field(object_name, method, options = {})
930
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_input_field_tag("email", options)
1114
+ Tags::EmailField.new(object_name, method, self, options).render
931
1115
  end
932
1116
 
933
1117
  # Returns an input tag of type "number".
@@ -935,7 +1119,7 @@ module ActionView
935
1119
  # ==== Options
936
1120
  # * Accepts same options as number_field_tag
937
1121
  def number_field(object_name, method, options = {})
938
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_number_field_tag("number", options)
1122
+ Tags::NumberField.new(object_name, method, self, options).render
939
1123
  end
940
1124
 
941
1125
  # Returns an input tag of type "range".
@@ -943,23 +1127,23 @@ module ActionView
943
1127
  # ==== Options
944
1128
  # * Accepts same options as range_field_tag
945
1129
  def range_field(object_name, method, options = {})
946
- InstanceTag.new(object_name, method, self, options.delete(:object)).to_number_field_tag("range", options)
1130
+ Tags::RangeField.new(object_name, method, self, options).render
947
1131
  end
948
1132
 
949
1133
  private
950
1134
 
951
- def instantiate_builder(record_name, record_object, options, &block)
1135
+ def instantiate_builder(record_name, record_object, options)
952
1136
  case record_name
953
1137
  when String, Symbol
954
1138
  object = record_object
955
1139
  object_name = record_name
956
1140
  else
957
1141
  object = record_name
958
- object_name = ActiveModel::Naming.param_key(object)
1142
+ object_name = model_name_from_record_or_class(object).param_key
959
1143
  end
960
1144
 
961
1145
  builder = options[:builder] || default_form_builder
962
- builder.new(object_name, object, self, options, block)
1146
+ builder.new(object_name, object, self, options)
963
1147
  end
964
1148
 
965
1149
  def default_form_builder
@@ -968,286 +1152,77 @@ module ActionView
968
1152
  end
969
1153
  end
970
1154
 
971
- class InstanceTag
972
- include Helpers::ActiveModelInstanceTag, Helpers::TagHelper, Helpers::FormTagHelper
973
-
974
- attr_reader :object, :method_name, :object_name
975
-
976
- DEFAULT_FIELD_OPTIONS = { "size" => 30 }
977
- DEFAULT_RADIO_OPTIONS = { }
978
- DEFAULT_TEXT_AREA_OPTIONS = { "cols" => 40, "rows" => 20 }
979
-
980
- def initialize(object_name, method_name, template_object, object = nil)
981
- @object_name, @method_name = object_name.to_s.dup, method_name.to_s.dup
982
- @template_object = template_object
983
-
984
- @object_name.sub!(/\[\]$/,"") || @object_name.sub!(/\[\]\]$/,"]")
985
- @object = retrieve_object(object)
986
- @auto_index = retrieve_autoindex(Regexp.last_match.pre_match) if Regexp.last_match
987
- end
988
-
989
- def to_label_tag(text = nil, options = {}, &block)
990
- options = options.stringify_keys
991
- tag_value = options.delete("value")
992
- name_and_id = options.dup
993
-
994
- if name_and_id["for"]
995
- name_and_id["id"] = name_and_id["for"]
996
- else
997
- name_and_id.delete("id")
998
- end
999
-
1000
- add_default_name_and_id_for_value(tag_value, name_and_id)
1001
- options.delete("index")
1002
- options.delete("namespace")
1003
- options["for"] ||= name_and_id["id"]
1004
-
1005
- if block_given?
1006
- @template_object.label_tag(name_and_id["id"], options, &block)
1007
- else
1008
- content = if text.blank?
1009
- object_name.gsub!(/\[(.*)_attributes\]\[\d\]/, '.\1')
1010
- method_and_value = tag_value.present? ? "#{method_name}.#{tag_value}" : method_name
1011
-
1012
- if object.respond_to?(:to_model)
1013
- key = object.class.model_name.i18n_key
1014
- i18n_default = ["#{key}.#{method_and_value}".to_sym, ""]
1015
- end
1016
-
1017
- i18n_default ||= ""
1018
- I18n.t("#{object_name}.#{method_and_value}", :default => i18n_default, :scope => "helpers.label").presence
1019
- else
1020
- text.to_s
1021
- end
1022
-
1023
- content ||= if object && object.class.respond_to?(:human_attribute_name)
1024
- object.class.human_attribute_name(method_name)
1025
- end
1026
-
1027
- content ||= method_name.humanize
1028
-
1029
- label_tag(name_and_id["id"], content, options)
1030
- end
1031
- end
1032
-
1033
- def to_input_field_tag(field_type, options = {})
1034
- options = options.stringify_keys
1035
- options["size"] = options["maxlength"] || DEFAULT_FIELD_OPTIONS["size"] unless options.key?("size")
1036
- options = DEFAULT_FIELD_OPTIONS.merge(options)
1037
- if field_type == "hidden"
1038
- options.delete("size")
1039
- end
1040
- options["type"] ||= field_type
1041
- options["value"] = options.fetch("value"){ value_before_type_cast(object) } unless field_type == "file"
1042
- options["value"] &&= ERB::Util.html_escape(options["value"])
1043
- add_default_name_and_id(options)
1044
- tag("input", options)
1045
- end
1046
-
1047
- def to_number_field_tag(field_type, options = {})
1048
- options = options.stringify_keys
1049
- options['size'] ||= nil
1050
-
1051
- if range = options.delete("in") || options.delete("within")
1052
- options.update("min" => range.min, "max" => range.max)
1053
- end
1054
- to_input_field_tag(field_type, options)
1055
- end
1056
-
1057
- def to_radio_button_tag(tag_value, options = {})
1058
- options = DEFAULT_RADIO_OPTIONS.merge(options.stringify_keys)
1059
- options["type"] = "radio"
1060
- options["value"] = tag_value
1061
- if options.has_key?("checked")
1062
- cv = options.delete "checked"
1063
- checked = cv == true || cv == "checked"
1064
- else
1065
- checked = self.class.radio_button_checked?(value(object), tag_value)
1066
- end
1067
- options["checked"] = "checked" if checked
1068
- add_default_name_and_id_for_value(tag_value, options)
1069
- tag("input", options)
1070
- end
1071
-
1072
- def to_text_area_tag(options = {})
1073
- options = DEFAULT_TEXT_AREA_OPTIONS.merge(options.stringify_keys)
1074
- add_default_name_and_id(options)
1075
-
1076
- if size = options.delete("size")
1077
- options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split)
1078
- end
1079
-
1080
- content_tag("textarea", options.delete('value') || value_before_type_cast(object), options)
1081
- end
1082
-
1083
- def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
1084
- options = options.stringify_keys
1085
- options["type"] = "checkbox"
1086
- options["value"] = checked_value
1087
- if options.has_key?("checked")
1088
- cv = options.delete "checked"
1089
- checked = cv == true || cv == "checked"
1090
- else
1091
- checked = self.class.check_box_checked?(value(object), checked_value)
1092
- end
1093
- options["checked"] = "checked" if checked
1094
- if options["multiple"]
1095
- add_default_name_and_id_for_value(checked_value, options)
1096
- options.delete("multiple")
1097
- else
1098
- add_default_name_and_id(options)
1099
- end
1100
- hidden = unchecked_value ? tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value, "disabled" => options["disabled"]) : ""
1101
- checkbox = tag("input", options)
1102
- (hidden + checkbox).html_safe
1103
- end
1104
-
1105
- def to_boolean_select_tag(options = {})
1106
- options = options.stringify_keys
1107
- add_default_name_and_id(options)
1108
- value = value(object)
1109
- tag_text = "<select"
1110
- tag_text << tag_options(options)
1111
- tag_text << "><option value=\"false\""
1112
- tag_text << " selected" if value == false
1113
- tag_text << ">False</option><option value=\"true\""
1114
- tag_text << " selected" if value
1115
- tag_text << ">True</option></select>"
1116
- end
1117
-
1118
- def to_content_tag(tag_name, options = {})
1119
- content_tag(tag_name, value(object), options)
1120
- end
1121
-
1122
- def retrieve_object(object)
1123
- if object
1124
- object
1125
- elsif @template_object.instance_variable_defined?("@#{@object_name}")
1126
- @template_object.instance_variable_get("@#{@object_name}")
1127
- end
1128
- rescue NameError
1129
- # As @object_name may contain the nested syntax (item[subobject]) we need to fallback to nil.
1130
- nil
1131
- end
1132
-
1133
- def retrieve_autoindex(pre_match)
1134
- object = self.object || @template_object.instance_variable_get("@#{pre_match}")
1135
- if object && object.respond_to?(:to_param)
1136
- object.to_param
1137
- else
1138
- raise ArgumentError, "object[] naming but object param and @object var don't exist or don't respond to to_param: #{object.inspect}"
1139
- end
1140
- end
1141
-
1142
- def value(object)
1143
- self.class.value(object, @method_name)
1144
- end
1145
-
1146
- def value_before_type_cast(object)
1147
- self.class.value_before_type_cast(object, @method_name)
1148
- end
1149
-
1150
- class << self
1151
- def value(object, method_name)
1152
- object.send method_name if object
1153
- end
1154
-
1155
- def value_before_type_cast(object, method_name)
1156
- unless object.nil?
1157
- object.respond_to?(method_name + "_before_type_cast") ?
1158
- object.send(method_name + "_before_type_cast") :
1159
- object.send(method_name)
1160
- end
1161
- end
1162
-
1163
- def check_box_checked?(value, checked_value)
1164
- case value
1165
- when TrueClass, FalseClass
1166
- value
1167
- when NilClass
1168
- false
1169
- when Integer
1170
- value != 0
1171
- when String
1172
- value == checked_value
1173
- when Array
1174
- value.include?(checked_value)
1175
- else
1176
- value.to_i != 0
1177
- end
1178
- end
1179
-
1180
- def radio_button_checked?(value, checked_value)
1181
- value.to_s == checked_value.to_s
1182
- end
1183
- end
1184
-
1185
- private
1186
- def add_default_name_and_id_for_value(tag_value, options)
1187
- unless tag_value.nil?
1188
- pretty_tag_value = tag_value.to_s.gsub(/\s/, "_").gsub(/[^-\w]/, "").downcase
1189
- specified_id = options["id"]
1190
- add_default_name_and_id(options)
1191
- options["id"] += "_#{pretty_tag_value}" if specified_id.blank? && options["id"].present?
1192
- else
1193
- add_default_name_and_id(options)
1194
- end
1195
- end
1196
-
1197
- def add_default_name_and_id(options)
1198
- if options.has_key?("index")
1199
- options["name"] ||= tag_name_with_index(options["index"], options["multiple"])
1200
- options["id"] = options.fetch("id"){ tag_id_with_index(options["index"]) }
1201
- options.delete("index")
1202
- elsif defined?(@auto_index)
1203
- options["name"] ||= tag_name_with_index(@auto_index, options["multiple"])
1204
- options["id"] = options.fetch("id"){ tag_id_with_index(@auto_index) }
1205
- else
1206
- options["name"] ||= tag_name(options["multiple"])
1207
- options["id"] = options.fetch("id"){ tag_id }
1208
- end
1209
-
1210
- options["id"] = [options.delete('namespace'), options["id"]].compact.join("_").presence
1211
- end
1212
-
1213
- def tag_name(multiple = false)
1214
- "#{@object_name}[#{sanitized_method_name}]#{"[]" if multiple}"
1215
- end
1216
-
1217
- def tag_name_with_index(index, multiple = false)
1218
- "#{@object_name}[#{index}][#{sanitized_method_name}]#{"[]" if multiple}"
1219
- end
1220
-
1221
- def tag_id
1222
- "#{sanitized_object_name}_#{sanitized_method_name}"
1223
- end
1224
-
1225
- def tag_id_with_index(index)
1226
- "#{sanitized_object_name}_#{index}_#{sanitized_method_name}"
1227
- end
1228
-
1229
- def sanitized_object_name
1230
- @sanitized_object_name ||= @object_name.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
1231
- end
1232
-
1233
- def sanitized_method_name
1234
- @sanitized_method_name ||= @method_name.sub(/\?$/,"")
1235
- end
1236
- end
1237
-
1155
+ # A +FormBuilder+ object is associated with a particular model object and
1156
+ # allows you to generate fields associated with the model object. The
1157
+ # +FormBuilder+ object is yielded when using +form_for+ or +fields_for+.
1158
+ # For example:
1159
+ #
1160
+ # <%= form_for @person do |person_form| %>
1161
+ # Name: <%= person_form.text_field :name %>
1162
+ # Admin: <%= person_form.check_box :admin %>
1163
+ # <% end %>
1164
+ #
1165
+ # In the above block, the a +FormBuilder+ object is yielded as the
1166
+ # +person_form+ variable. This allows you to generate the +text_field+
1167
+ # and +check_box+ fields by specifying their eponymous methods, which
1168
+ # modify the underlying template and associates the +@person+ model object
1169
+ # with the form.
1170
+ #
1171
+ # The +FormBuilder+ object can be thought of as serving as a proxy for the
1172
+ # methods in the +FormHelper+ module. This class, however, allows you to
1173
+ # call methods with the model object you are building the form for.
1174
+ #
1175
+ # You can create your own custom FormBuilder templates by subclasses this
1176
+ # class. For example:
1177
+ #
1178
+ # class MyFormBuilder < ActionView::Helpers::FormBuilder
1179
+ # def div_radio_button(method, tag_value, options = {})
1180
+ # @template.content_tag(:div,
1181
+ # @template.radio_button(
1182
+ # @object_name, method, tag_value, objectify_options(options)
1183
+ # )
1184
+ # )
1185
+ # end
1186
+ #
1187
+ # The above code creates a new method +div_radio_button+ which wraps a div
1188
+ # around the a new radio button. Note that when options are passed in, you
1189
+ # must called +objectify_options+ in order for the model object to get
1190
+ # correctly passed to the method. If +objectify_options+ is not called,
1191
+ # then the newly created helper will not be linked back to the model.
1192
+ #
1193
+ # The +div_radio_button+ code from above can now be used as follows:
1194
+ #
1195
+ # <%= form_for @person, :builder => MyFormBuilder do |f| %>
1196
+ # I am a child: <%= f.div_radio_button(:admin, "child") %>
1197
+ # I am an adult: <%= f.div_radio_button(:admin, "adult") %>
1198
+ # <% end -%>
1199
+ #
1200
+ # The standard set of helper methods for form building are located in the
1201
+ # +field_helpers+ class attribute.
1238
1202
  class FormBuilder
1203
+ include ModelNaming
1204
+
1239
1205
  # The methods which wrap a form helper call.
1240
1206
  class_attribute :field_helpers
1241
- self.field_helpers = FormHelper.instance_method_names - %w(form_for convert_to_model)
1207
+ self.field_helpers = [:fields_for, :label, :text_field, :password_field,
1208
+ :hidden_field, :file_field, :text_area, :check_box,
1209
+ :radio_button, :color_field, :search_field,
1210
+ :telephone_field, :phone_field, :date_field,
1211
+ :time_field, :datetime_field, :datetime_local_field,
1212
+ :month_field, :week_field, :url_field, :email_field,
1213
+ :number_field, :range_field]
1242
1214
 
1243
1215
  attr_accessor :object_name, :object, :options
1244
1216
 
1245
- attr_reader :multipart, :parent_builder
1217
+ attr_reader :multipart, :index
1246
1218
  alias :multipart? :multipart
1247
1219
 
1248
1220
  def multipart=(multipart)
1249
1221
  @multipart = multipart
1250
- parent_builder.multipart = multipart if parent_builder
1222
+
1223
+ if parent_builder = @options[:parent_builder]
1224
+ parent_builder.multipart = multipart
1225
+ end
1251
1226
  end
1252
1227
 
1253
1228
  def self._to_partial_path
@@ -1262,10 +1237,13 @@ module ActionView
1262
1237
  self
1263
1238
  end
1264
1239
 
1265
- def initialize(object_name, object, template, options, proc)
1240
+ def initialize(object_name, object, template, options, block=nil)
1241
+ if block
1242
+ ActiveSupport::Deprecation.warn "Giving a block to FormBuilder is deprecated and has no effect anymore."
1243
+ end
1244
+
1266
1245
  @nested_child_index = {}
1267
- @object_name, @object, @template, @options, @proc = object_name, object, template, options, proc
1268
- @parent_builder = options[:parent_builder]
1246
+ @object_name, @object, @template, @options = object_name, object, template, options
1269
1247
  @default_options = @options ? @options.slice(:index, :namespace) : {}
1270
1248
  if @object_name.to_s.match(/\[\]$/)
1271
1249
  if object ||= @template.instance_variable_get("@#{Regexp.last_match.pre_match}") and object.respond_to?(:to_param)
@@ -1275,9 +1253,10 @@ module ActionView
1275
1253
  end
1276
1254
  end
1277
1255
  @multipart = nil
1256
+ @index = options[:index] || options[:child_index]
1278
1257
  end
1279
1258
 
1280
- (field_helpers - %w(label check_box radio_button fields_for hidden_field file_field)).each do |selector|
1259
+ (field_helpers - [:label, :check_box, :radio_button, :fields_for, :hidden_field, :file_field]).each do |selector|
1281
1260
  class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
1282
1261
  def #{selector}(method, options = {}) # def text_field(method, options = {})
1283
1262
  @template.send( # @template.send(
@@ -1289,50 +1268,456 @@ module ActionView
1289
1268
  RUBY_EVAL
1290
1269
  end
1291
1270
 
1292
- def fields_for(record_name, record_object = nil, fields_options = {}, &block)
1293
- fields_options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options?
1294
- fields_options[:builder] ||= options[:builder]
1295
- fields_options[:parent_builder] = self
1296
- fields_options[:namespace] = fields_options[:parent_builder].options[:namespace]
1297
-
1298
- case record_name
1299
- when String, Symbol
1300
- if nested_attributes_association?(record_name)
1301
- return fields_for_with_nested_attributes(record_name, record_object, fields_options, block)
1302
- end
1303
- else
1304
- record_object = record_name.is_a?(Array) ? record_name.last : record_name
1305
- record_name = ActiveModel::Naming.param_key(record_object)
1306
- end
1307
-
1271
+ # Creates a scope around a specific model object like form_for, but
1272
+ # doesn't create the form tags themselves. This makes fields_for suitable
1273
+ # for specifying additional model objects in the same form.
1274
+ #
1275
+ # Although the usage and purpose of +field_for+ is similar to +form_for+'s,
1276
+ # its method signature is slightly different. Like +form_for+, it yields
1277
+ # a FormBuilder object associated with a particular model object to a block,
1278
+ # and within the block allows methods to be called on the builder to
1279
+ # generate fields associated with the model object. Fields may reflect
1280
+ # a model object in two ways - how they are named (hence how submitted
1281
+ # values appear within the +params+ hash in the controller) and what
1282
+ # default values are shown when the form the fields appear in is first
1283
+ # displayed. In order for both of these features to be specified independently,
1284
+ # both an object name (represented by either a symbol or string) and the
1285
+ # object itself can be passed to the method separately -
1286
+ #
1287
+ # <%= form_for @person do |person_form| %>
1288
+ # First name: <%= person_form.text_field :first_name %>
1289
+ # Last name : <%= person_form.text_field :last_name %>
1290
+ #
1291
+ # <%= fields_for :permission, @person.permission do |permission_fields| %>
1292
+ # Admin? : <%= permission_fields.check_box :admin %>
1293
+ # <% end %>
1294
+ #
1295
+ # <%= person_form.submit %>
1296
+ # <% end %>
1297
+ #
1298
+ # In this case, the checkbox field will be represented by an HTML +input+
1299
+ # tag with the +name+ attribute <tt>permission[admin]</tt>, and the submitted
1300
+ # value will appear in the controller as <tt>params[:permission][:admin]</tt>.
1301
+ # If <tt>@person.permission</tt> is an existing record with an attribute
1302
+ # +admin+, the initial state of the checkbox when first displayed will
1303
+ # reflect the value of <tt>@person.permission.admin</tt>.
1304
+ #
1305
+ # Often this can be simplified by passing just the name of the model
1306
+ # object to +fields_for+ -
1307
+ #
1308
+ # <%= fields_for :permission do |permission_fields| %>
1309
+ # Admin?: <%= permission_fields.check_box :admin %>
1310
+ # <% end %>
1311
+ #
1312
+ # ...in which case, if <tt>:permission</tt> also happens to be the name of an
1313
+ # instance variable <tt>@permission</tt>, the initial state of the input
1314
+ # field will reflect the value of that variable's attribute <tt>@permission.admin</tt>.
1315
+ #
1316
+ # Alternatively, you can pass just the model object itself (if the first
1317
+ # argument isn't a string or symbol +fields_for+ will realize that the
1318
+ # name has been omitted) -
1319
+ #
1320
+ # <%= fields_for @person.permission do |permission_fields| %>
1321
+ # Admin?: <%= permission_fields.check_box :admin %>
1322
+ # <% end %>
1323
+ #
1324
+ # and +fields_for+ will derive the required name of the field from the
1325
+ # _class_ of the model object, e.g. if <tt>@person.permission</tt>, is
1326
+ # of class +Permission+, the field will still be named <tt>permission[admin]</tt>.
1327
+ #
1328
+ # Note: This also works for the methods in FormOptionHelper and
1329
+ # DateHelper that are designed to work with an object as base, like
1330
+ # FormOptionHelper#collection_select and DateHelper#datetime_select.
1331
+ #
1332
+ # === Nested Attributes Examples
1333
+ #
1334
+ # When the object belonging to the current scope has a nested attribute
1335
+ # writer for a certain attribute, fields_for will yield a new scope
1336
+ # for that attribute. This allows you to create forms that set or change
1337
+ # the attributes of a parent object and its associations in one go.
1338
+ #
1339
+ # Nested attribute writers are normal setter methods named after an
1340
+ # association. The most common way of defining these writers is either
1341
+ # with +accepts_nested_attributes_for+ in a model definition or by
1342
+ # defining a method with the proper name. For example: the attribute
1343
+ # writer for the association <tt>:address</tt> is called
1344
+ # <tt>address_attributes=</tt>.
1345
+ #
1346
+ # Whether a one-to-one or one-to-many style form builder will be yielded
1347
+ # depends on whether the normal reader method returns a _single_ object
1348
+ # or an _array_ of objects.
1349
+ #
1350
+ # ==== One-to-one
1351
+ #
1352
+ # Consider a Person class which returns a _single_ Address from the
1353
+ # <tt>address</tt> reader method and responds to the
1354
+ # <tt>address_attributes=</tt> writer method:
1355
+ #
1356
+ # class Person
1357
+ # def address
1358
+ # @address
1359
+ # end
1360
+ #
1361
+ # def address_attributes=(attributes)
1362
+ # # Process the attributes hash
1363
+ # end
1364
+ # end
1365
+ #
1366
+ # This model can now be used with a nested fields_for, like so:
1367
+ #
1368
+ # <%= form_for @person do |person_form| %>
1369
+ # ...
1370
+ # <%= person_form.fields_for :address do |address_fields| %>
1371
+ # Street : <%= address_fields.text_field :street %>
1372
+ # Zip code: <%= address_fields.text_field :zip_code %>
1373
+ # <% end %>
1374
+ # ...
1375
+ # <% end %>
1376
+ #
1377
+ # When address is already an association on a Person you can use
1378
+ # +accepts_nested_attributes_for+ to define the writer method for you:
1379
+ #
1380
+ # class Person < ActiveRecord::Base
1381
+ # has_one :address
1382
+ # accepts_nested_attributes_for :address
1383
+ # end
1384
+ #
1385
+ # If you want to destroy the associated model through the form, you have
1386
+ # to enable it first using the <tt>:allow_destroy</tt> option for
1387
+ # +accepts_nested_attributes_for+:
1388
+ #
1389
+ # class Person < ActiveRecord::Base
1390
+ # has_one :address
1391
+ # accepts_nested_attributes_for :address, allow_destroy: true
1392
+ # end
1393
+ #
1394
+ # Now, when you use a form element with the <tt>_destroy</tt> parameter,
1395
+ # with a value that evaluates to +true+, you will destroy the associated
1396
+ # model (eg. 1, '1', true, or 'true'):
1397
+ #
1398
+ # <%= form_for @person do |person_form| %>
1399
+ # ...
1400
+ # <%= person_form.fields_for :address do |address_fields| %>
1401
+ # ...
1402
+ # Delete: <%= address_fields.check_box :_destroy %>
1403
+ # <% end %>
1404
+ # ...
1405
+ # <% end %>
1406
+ #
1407
+ # ==== One-to-many
1408
+ #
1409
+ # Consider a Person class which returns an _array_ of Project instances
1410
+ # from the <tt>projects</tt> reader method and responds to the
1411
+ # <tt>projects_attributes=</tt> writer method:
1412
+ #
1413
+ # class Person
1414
+ # def projects
1415
+ # [@project1, @project2]
1416
+ # end
1417
+ #
1418
+ # def projects_attributes=(attributes)
1419
+ # # Process the attributes hash
1420
+ # end
1421
+ # end
1422
+ #
1423
+ # Note that the <tt>projects_attributes=</tt> writer method is in fact
1424
+ # required for fields_for to correctly identify <tt>:projects</tt> as a
1425
+ # collection, and the correct indices to be set in the form markup.
1426
+ #
1427
+ # When projects is already an association on Person you can use
1428
+ # +accepts_nested_attributes_for+ to define the writer method for you:
1429
+ #
1430
+ # class Person < ActiveRecord::Base
1431
+ # has_many :projects
1432
+ # accepts_nested_attributes_for :projects
1433
+ # end
1434
+ #
1435
+ # This model can now be used with a nested fields_for. The block given to
1436
+ # the nested fields_for call will be repeated for each instance in the
1437
+ # collection:
1438
+ #
1439
+ # <%= form_for @person do |person_form| %>
1440
+ # ...
1441
+ # <%= person_form.fields_for :projects do |project_fields| %>
1442
+ # <% if project_fields.object.active? %>
1443
+ # Name: <%= project_fields.text_field :name %>
1444
+ # <% end %>
1445
+ # <% end %>
1446
+ # ...
1447
+ # <% end %>
1448
+ #
1449
+ # It's also possible to specify the instance to be used:
1450
+ #
1451
+ # <%= form_for @person do |person_form| %>
1452
+ # ...
1453
+ # <% @person.projects.each do |project| %>
1454
+ # <% if project.active? %>
1455
+ # <%= person_form.fields_for :projects, project do |project_fields| %>
1456
+ # Name: <%= project_fields.text_field :name %>
1457
+ # <% end %>
1458
+ # <% end %>
1459
+ # <% end %>
1460
+ # ...
1461
+ # <% end %>
1462
+ #
1463
+ # Or a collection to be used:
1464
+ #
1465
+ # <%= form_for @person do |person_form| %>
1466
+ # ...
1467
+ # <%= person_form.fields_for :projects, @active_projects do |project_fields| %>
1468
+ # Name: <%= project_fields.text_field :name %>
1469
+ # <% end %>
1470
+ # ...
1471
+ # <% end %>
1472
+ #
1473
+ # If you want to destroy any of the associated models through the
1474
+ # form, you have to enable it first using the <tt>:allow_destroy</tt>
1475
+ # option for +accepts_nested_attributes_for+:
1476
+ #
1477
+ # class Person < ActiveRecord::Base
1478
+ # has_many :projects
1479
+ # accepts_nested_attributes_for :projects, allow_destroy: true
1480
+ # end
1481
+ #
1482
+ # This will allow you to specify which models to destroy in the
1483
+ # attributes hash by adding a form element for the <tt>_destroy</tt>
1484
+ # parameter with a value that evaluates to +true+
1485
+ # (eg. 1, '1', true, or 'true'):
1486
+ #
1487
+ # <%= form_for @person do |person_form| %>
1488
+ # ...
1489
+ # <%= person_form.fields_for :projects do |project_fields| %>
1490
+ # Delete: <%= project_fields.check_box :_destroy %>
1491
+ # <% end %>
1492
+ # ...
1493
+ # <% end %>
1494
+ #
1495
+ # When a collection is used you might want to know the index of each
1496
+ # object into the array. For this purpose, the <tt>index</tt> method
1497
+ # is available in the FormBuilder object.
1498
+ #
1499
+ # <%= form_for @person do |person_form| %>
1500
+ # ...
1501
+ # <%= person_form.fields_for :projects do |project_fields| %>
1502
+ # Project #<%= project_fields.index %>
1503
+ # ...
1504
+ # <% end %>
1505
+ # ...
1506
+ # <% end %>
1507
+ #
1508
+ # Note that fields_for will automatically generate a hidden field
1509
+ # to store the ID of the record. There are circumstances where this
1510
+ # hidden field is not needed and you can pass <tt>hidden_field_id: false</tt>
1511
+ # to prevent fields_for from rendering it automatically.
1512
+ def fields_for(record_name, record_object = nil, fields_options = {}, &block)
1513
+ fields_options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options?
1514
+ fields_options[:builder] ||= options[:builder]
1515
+ fields_options[:namespace] = options[:namespace]
1516
+ fields_options[:parent_builder] = self
1517
+
1518
+ case record_name
1519
+ when String, Symbol
1520
+ if nested_attributes_association?(record_name)
1521
+ return fields_for_with_nested_attributes(record_name, record_object, fields_options, block)
1522
+ end
1523
+ else
1524
+ record_object = record_name.is_a?(Array) ? record_name.last : record_name
1525
+ record_name = model_name_from_record_or_class(record_object).param_key
1526
+ end
1527
+
1308
1528
  index = if options.has_key?(:index)
1309
- "[#{options[:index]}]"
1529
+ options[:index]
1310
1530
  elsif defined?(@auto_index)
1311
1531
  self.object_name = @object_name.to_s.sub(/\[\]$/,"")
1312
- "[#{@auto_index}]"
1532
+ @auto_index
1313
1533
  end
1314
- record_name = "#{object_name}#{index}[#{record_name}]"
1534
+
1535
+ record_name = index ? "#{object_name}[#{index}][#{record_name}]" : "#{object_name}[#{record_name}]"
1536
+ fields_options[:child_index] = index
1315
1537
 
1316
1538
  @template.fields_for(record_name, record_object, fields_options, &block)
1317
1539
  end
1318
1540
 
1541
+ # Returns a label tag tailored for labelling an input field for a specified attribute (identified by +method+) on an object
1542
+ # assigned to the template (identified by +object+). The text of label will default to the attribute name unless a translation
1543
+ # is found in the current I18n locale (through helpers.label.<modelname>.<attribute>) or you specify it explicitly.
1544
+ # Additional options on the label tag can be passed as a hash with +options+. These options will be tagged
1545
+ # onto the HTML as an HTML element attribute as in the example shown, except for the <tt>:value</tt> option, which is designed to
1546
+ # target labels for radio_button tags (where the value is used in the ID of the input tag).
1547
+ #
1548
+ # ==== Examples
1549
+ # label(:post, :title)
1550
+ # # => <label for="post_title">Title</label>
1551
+ #
1552
+ # You can localize your labels based on model and attribute names.
1553
+ # For example you can define the following in your locale (e.g. en.yml)
1554
+ #
1555
+ # helpers:
1556
+ # label:
1557
+ # post:
1558
+ # body: "Write your entire text here"
1559
+ #
1560
+ # Which then will result in
1561
+ #
1562
+ # label(:post, :body)
1563
+ # # => <label for="post_body">Write your entire text here</label>
1564
+ #
1565
+ # Localization can also be based purely on the translation of the attribute-name
1566
+ # (if you are using ActiveRecord):
1567
+ #
1568
+ # activerecord:
1569
+ # attributes:
1570
+ # post:
1571
+ # cost: "Total cost"
1572
+ #
1573
+ # label(:post, :cost)
1574
+ # # => <label for="post_cost">Total cost</label>
1575
+ #
1576
+ # label(:post, :title, "A short title")
1577
+ # # => <label for="post_title">A short title</label>
1578
+ #
1579
+ # label(:post, :title, "A short title", class: "title_label")
1580
+ # # => <label for="post_title" class="title_label">A short title</label>
1581
+ #
1582
+ # label(:post, :privacy, "Public Post", value: "public")
1583
+ # # => <label for="post_privacy_public">Public Post</label>
1584
+ #
1585
+ # label(:post, :terms) do
1586
+ # 'Accept <a href="/terms">Terms</a>.'.html_safe
1587
+ # end
1319
1588
  def label(method, text = nil, options = {}, &block)
1320
1589
  @template.label(@object_name, method, text, objectify_options(options), &block)
1321
1590
  end
1322
1591
 
1592
+ # Returns a checkbox tag tailored for accessing a specified attribute (identified by +method+) on an object
1593
+ # assigned to the template (identified by +object+). This object must be an instance object (@object) and not a local object.
1594
+ # It's intended that +method+ returns an integer and if that integer is above zero, then the checkbox is checked.
1595
+ # Additional options on the input tag can be passed as a hash with +options+. The +checked_value+ defaults to 1
1596
+ # while the default +unchecked_value+ is set to 0 which is convenient for boolean values.
1597
+ #
1598
+ # ==== Gotcha
1599
+ #
1600
+ # The HTML specification says unchecked check boxes are not successful, and
1601
+ # thus web browsers do not send them. Unfortunately this introduces a gotcha:
1602
+ # if an +Invoice+ model has a +paid+ flag, and in the form that edits a paid
1603
+ # invoice the user unchecks its check box, no +paid+ parameter is sent. So,
1604
+ # any mass-assignment idiom like
1605
+ #
1606
+ # @invoice.update(params[:invoice])
1607
+ #
1608
+ # wouldn't update the flag.
1609
+ #
1610
+ # To prevent this the helper generates an auxiliary hidden field before
1611
+ # the very check box. The hidden field has the same name and its
1612
+ # attributes mimic an unchecked check box.
1613
+ #
1614
+ # This way, the client either sends only the hidden field (representing
1615
+ # the check box is unchecked), or both fields. Since the HTML specification
1616
+ # says key/value pairs have to be sent in the same order they appear in the
1617
+ # form, and parameters extraction gets the last occurrence of any repeated
1618
+ # key in the query string, that works for ordinary forms.
1619
+ #
1620
+ # Unfortunately that workaround does not work when the check box goes
1621
+ # within an array-like parameter, as in
1622
+ #
1623
+ # <%= fields_for "project[invoice_attributes][]", invoice, index: nil do |form| %>
1624
+ # <%= form.check_box :paid %>
1625
+ # ...
1626
+ # <% end %>
1627
+ #
1628
+ # because parameter name repetition is precisely what Rails seeks to distinguish
1629
+ # the elements of the array. For each item with a checked check box you
1630
+ # get an extra ghost item with only that attribute, assigned to "0".
1631
+ #
1632
+ # In that case it is preferable to either use +check_box_tag+ or to use
1633
+ # hashes instead of arrays.
1634
+ #
1635
+ # # Let's say that @post.validated? is 1:
1636
+ # check_box("post", "validated")
1637
+ # # => <input name="post[validated]" type="hidden" value="0" />
1638
+ # # <input checked="checked" type="checkbox" id="post_validated" name="post[validated]" value="1" />
1639
+ #
1640
+ # # Let's say that @puppy.gooddog is "no":
1641
+ # check_box("puppy", "gooddog", {}, "yes", "no")
1642
+ # # => <input name="puppy[gooddog]" type="hidden" value="no" />
1643
+ # # <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog]" value="yes" />
1644
+ #
1645
+ # check_box("eula", "accepted", { class: 'eula_check' }, "yes", "no")
1646
+ # # => <input name="eula[accepted]" type="hidden" value="no" />
1647
+ # # <input type="checkbox" class="eula_check" id="eula_accepted" name="eula[accepted]" value="yes" />
1323
1648
  def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
1324
1649
  @template.check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value)
1325
1650
  end
1326
1651
 
1652
+ # Returns a radio button tag for accessing a specified attribute (identified by +method+) on an object
1653
+ # assigned to the template (identified by +object+). If the current value of +method+ is +tag_value+ the
1654
+ # radio button will be checked.
1655
+ #
1656
+ # To force the radio button to be checked pass <tt>checked: true</tt> in the
1657
+ # +options+ hash. You may pass HTML options there as well.
1658
+ #
1659
+ # # Let's say that @post.category returns "rails":
1660
+ # radio_button("post", "category", "rails")
1661
+ # radio_button("post", "category", "java")
1662
+ # # => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" />
1663
+ # # <input type="radio" id="post_category_java" name="post[category]" value="java" />
1664
+ #
1665
+ # radio_button("user", "receive_newsletter", "yes")
1666
+ # radio_button("user", "receive_newsletter", "no")
1667
+ # # => <input type="radio" id="user_receive_newsletter_yes" name="user[receive_newsletter]" value="yes" />
1668
+ # # <input type="radio" id="user_receive_newsletter_no" name="user[receive_newsletter]" value="no" checked="checked" />
1327
1669
  def radio_button(method, tag_value, options = {})
1328
1670
  @template.radio_button(@object_name, method, tag_value, objectify_options(options))
1329
1671
  end
1330
1672
 
1673
+ # Returns a hidden input tag tailored for accessing a specified attribute (identified by +method+) on an object
1674
+ # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
1675
+ # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
1676
+ # shown.
1677
+ #
1678
+ # ==== Examples
1679
+ # hidden_field(:signup, :pass_confirm)
1680
+ # # => <input type="hidden" id="signup_pass_confirm" name="signup[pass_confirm]" value="#{@signup.pass_confirm}" />
1681
+ #
1682
+ # hidden_field(:post, :tag_list)
1683
+ # # => <input type="hidden" id="post_tag_list" name="post[tag_list]" value="#{@post.tag_list}" />
1684
+ #
1685
+ # hidden_field(:user, :token)
1686
+ # # => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" />
1687
+ #
1331
1688
  def hidden_field(method, options = {})
1332
1689
  @emitted_hidden_id = true if method == :id
1333
1690
  @template.hidden_field(@object_name, method, objectify_options(options))
1334
1691
  end
1335
1692
 
1693
+ # Returns a file upload input tag tailored for accessing a specified attribute (identified by +method+) on an object
1694
+ # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
1695
+ # hash with +options+. These options will be tagged onto the HTML as an HTML element attribute as in the example
1696
+ # shown.
1697
+ #
1698
+ # Using this method inside a +form_for+ block will set the enclosing form's encoding to <tt>multipart/form-data</tt>.
1699
+ #
1700
+ # ==== Options
1701
+ # * Creates standard HTML attributes for the tag.
1702
+ # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input.
1703
+ # * <tt>:multiple</tt> - If set to true, *in most updated browsers* the user will be allowed to select multiple files.
1704
+ # * <tt>:accept</tt> - If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations.
1705
+ #
1706
+ # ==== Examples
1707
+ # file_field(:user, :avatar)
1708
+ # # => <input type="file" id="user_avatar" name="user[avatar]" />
1709
+ #
1710
+ # file_field(:post, :image, :multiple => true)
1711
+ # # => <input type="file" id="post_image" name="post[image]" multiple="true" />
1712
+ #
1713
+ # file_field(:post, :attached, accept: 'text/html')
1714
+ # # => <input accept="text/html" type="file" id="post_attached" name="post[attached]" />
1715
+ #
1716
+ # file_field(:post, :image, accept: 'image/png,image/gif,image/jpeg')
1717
+ # # => <input type="file" id="post_image" name="post[image]" accept="image/png,image/gif,image/jpeg" />
1718
+ #
1719
+ # file_field(:attachment, :file, class: 'file_input')
1720
+ # # => <input type="file" id="attachment_file" name="attachment[file]" class="file_input" />
1336
1721
  def file_field(method, options = {})
1337
1722
  self.multipart = true
1338
1723
  @template.file_field(@object_name, method, objectify_options(options))
@@ -1379,14 +1764,14 @@ module ActionView
1379
1764
  # <% end %>
1380
1765
  #
1381
1766
  # In the example above, if @post is a new record, it will use "Create Post" as
1382
- # submit button label, otherwise, it uses "Update Post".
1767
+ # button label, otherwise, it uses "Update Post".
1383
1768
  #
1384
- # Those labels can be customized using I18n, under the helpers.submit key and accept
1385
- # the %{model} as translation interpolation:
1769
+ # Those labels can be customized using I18n, under the helpers.submit key
1770
+ # (the same as submit helper) and accept the %{model} as translation interpolation:
1386
1771
  #
1387
1772
  # en:
1388
1773
  # helpers:
1389
- # button:
1774
+ # submit:
1390
1775
  # create: "Create a %{model}"
1391
1776
  # update: "Confirm changes to %{model}"
1392
1777
  #
@@ -1394,14 +1779,25 @@ module ActionView
1394
1779
  #
1395
1780
  # en:
1396
1781
  # helpers:
1397
- # button:
1782
+ # submit:
1398
1783
  # post:
1399
1784
  # create: "Add %{model}"
1400
1785
  #
1401
- def button(value=nil, options={})
1786
+ # ==== Examples
1787
+ # button("Create a post")
1788
+ # # => <button name='button' type='submit'>Create post</button>
1789
+ #
1790
+ # button do
1791
+ # content_tag(:strong, 'Ask me!')
1792
+ # end
1793
+ # # => <button name='button' type='submit'>
1794
+ # # <strong>Ask me!</strong>
1795
+ # # </button>
1796
+ #
1797
+ def button(value = nil, options = {}, &block)
1402
1798
  value, options = nil, value if value.is_a?(Hash)
1403
1799
  value ||= submit_default_value
1404
- @template.button_tag(value, options)
1800
+ @template.button_tag(value, options, &block)
1405
1801
  end
1406
1802
 
1407
1803
  def emitted_hidden_id?
@@ -1410,7 +1806,7 @@ module ActionView
1410
1806
 
1411
1807
  private
1412
1808
  def objectify_options(options)
1413
- @default_options.merge(options.merge(:object => @object))
1809
+ @default_options.merge(options.merge(object: @object))
1414
1810
  end
1415
1811
 
1416
1812
  def submit_default_value
@@ -1428,7 +1824,7 @@ module ActionView
1428
1824
  defaults << :"helpers.submit.#{key}"
1429
1825
  defaults << "#{key.to_s.humanize} #{model}"
1430
1826
 
1431
- I18n.t(defaults.shift, :model => model, :default => defaults)
1827
+ I18n.t(defaults.shift, model: model, default: defaults)
1432
1828
  end
1433
1829
 
1434
1830
  def nested_attributes_association?(association_name)
@@ -1440,7 +1836,7 @@ module ActionView
1440
1836
  association = convert_to_model(association)
1441
1837
 
1442
1838
  if association.respond_to?(:persisted?)
1443
- association = [association] if @object.send(association_name).is_a?(Array)
1839
+ association = [association] if @object.send(association_name).respond_to?(:to_ary)
1444
1840
  elsif !association.respond_to?(:to_ary)
1445
1841
  association = @object.send(association_name)
1446
1842
  end
@@ -1449,7 +1845,8 @@ module ActionView
1449
1845
  explicit_child_index = options[:child_index]
1450
1846
  output = ActiveSupport::SafeBuffer.new
1451
1847
  association.each do |child|
1452
- output << fields_for_nested_model("#{name}[#{explicit_child_index || nested_child_index(name)}]", child, options, block)
1848
+ options[:child_index] = nested_child_index(name) unless explicit_child_index
1849
+ output << fields_for_nested_model("#{name}[#{options[:child_index]}]", child, options, block)
1453
1850
  end
1454
1851
  output
1455
1852
  elsif association
@@ -1457,30 +1854,27 @@ module ActionView
1457
1854
  end
1458
1855
  end
1459
1856
 
1460
- def fields_for_nested_model(name, object, options, block)
1857
+ def fields_for_nested_model(name, object, fields_options, block)
1461
1858
  object = convert_to_model(object)
1859
+ emit_hidden_id = object.persisted? && fields_options.fetch(:include_id) {
1860
+ options.fetch(:include_id, true)
1861
+ }
1462
1862
 
1463
- parent_include_id = self.options.fetch(:include_id, true)
1464
- include_id = options.fetch(:include_id, parent_include_id)
1465
- options[:hidden_field_id] = object.persisted? && include_id
1466
- @template.fields_for(name, object, options, &block)
1863
+ @template.fields_for(name, object, fields_options) do |f|
1864
+ output = @template.capture(f, &block)
1865
+ output.concat f.hidden_field(:id) if output && emit_hidden_id && !f.emitted_hidden_id?
1866
+ output
1867
+ end
1467
1868
  end
1468
1869
 
1469
1870
  def nested_child_index(name)
1470
1871
  @nested_child_index[name] ||= -1
1471
1872
  @nested_child_index[name] += 1
1472
1873
  end
1473
-
1474
- def convert_to_model(object)
1475
- object.respond_to?(:to_model) ? object.to_model : object
1476
- end
1477
1874
  end
1478
1875
  end
1479
1876
 
1480
1877
  ActiveSupport.on_load(:action_view) do
1481
- class ActionView::Base
1482
- cattr_accessor :default_form_builder
1483
- @@default_form_builder = ::ActionView::Helpers::FormBuilder
1484
- end
1878
+ cattr_accessor(:default_form_builder) { ::ActionView::Helpers::FormBuilder }
1485
1879
  end
1486
1880
  end