actionpack-2.3.17-rack-upgrade 2.3.17

Sign up to get free protection for your applications and to get access to all the features.
Files changed (441) hide show
  1. data/CHANGELOG +5250 -0
  2. data/MIT-LICENSE +21 -0
  3. data/README +409 -0
  4. data/RUNNING_UNIT_TESTS +24 -0
  5. data/Rakefile +158 -0
  6. data/install.rb +30 -0
  7. data/lib/action_controller.rb +113 -0
  8. data/lib/action_controller/assertions/dom_assertions.rb +55 -0
  9. data/lib/action_controller/assertions/model_assertions.rb +21 -0
  10. data/lib/action_controller/assertions/response_assertions.rb +169 -0
  11. data/lib/action_controller/assertions/routing_assertions.rb +146 -0
  12. data/lib/action_controller/assertions/selector_assertions.rb +638 -0
  13. data/lib/action_controller/assertions/tag_assertions.rb +127 -0
  14. data/lib/action_controller/base.rb +1425 -0
  15. data/lib/action_controller/benchmarking.rb +107 -0
  16. data/lib/action_controller/caching.rb +71 -0
  17. data/lib/action_controller/caching/actions.rb +177 -0
  18. data/lib/action_controller/caching/fragments.rb +120 -0
  19. data/lib/action_controller/caching/pages.rb +152 -0
  20. data/lib/action_controller/caching/sweeper.rb +45 -0
  21. data/lib/action_controller/caching/sweeping.rb +55 -0
  22. data/lib/action_controller/cgi_ext.rb +15 -0
  23. data/lib/action_controller/cgi_ext/cookie.rb +112 -0
  24. data/lib/action_controller/cgi_ext/query_extension.rb +22 -0
  25. data/lib/action_controller/cgi_ext/stdinput.rb +24 -0
  26. data/lib/action_controller/cgi_process.rb +77 -0
  27. data/lib/action_controller/cookies.rb +197 -0
  28. data/lib/action_controller/dispatcher.rb +133 -0
  29. data/lib/action_controller/failsafe.rb +87 -0
  30. data/lib/action_controller/filters.rb +680 -0
  31. data/lib/action_controller/flash.rb +213 -0
  32. data/lib/action_controller/headers.rb +33 -0
  33. data/lib/action_controller/helpers.rb +225 -0
  34. data/lib/action_controller/http_authentication.rb +309 -0
  35. data/lib/action_controller/integration.rb +708 -0
  36. data/lib/action_controller/layout.rb +286 -0
  37. data/lib/action_controller/middleware_stack.rb +119 -0
  38. data/lib/action_controller/middlewares.rb +14 -0
  39. data/lib/action_controller/mime_responds.rb +193 -0
  40. data/lib/action_controller/mime_type.rb +212 -0
  41. data/lib/action_controller/mime_types.rb +21 -0
  42. data/lib/action_controller/params_parser.rb +77 -0
  43. data/lib/action_controller/performance_test.rb +15 -0
  44. data/lib/action_controller/polymorphic_routes.rb +189 -0
  45. data/lib/action_controller/rack_lint_patch.rb +36 -0
  46. data/lib/action_controller/record_identifier.rb +104 -0
  47. data/lib/action_controller/reloader.rb +54 -0
  48. data/lib/action_controller/request.rb +518 -0
  49. data/lib/action_controller/request_forgery_protection.rb +116 -0
  50. data/lib/action_controller/rescue.rb +183 -0
  51. data/lib/action_controller/resources.rb +682 -0
  52. data/lib/action_controller/response.rb +237 -0
  53. data/lib/action_controller/routing.rb +388 -0
  54. data/lib/action_controller/routing/builder.rb +197 -0
  55. data/lib/action_controller/routing/optimisations.rb +130 -0
  56. data/lib/action_controller/routing/recognition_optimisation.rb +167 -0
  57. data/lib/action_controller/routing/route.rb +265 -0
  58. data/lib/action_controller/routing/route_set.rb +503 -0
  59. data/lib/action_controller/routing/routing_ext.rb +49 -0
  60. data/lib/action_controller/routing/segments.rb +343 -0
  61. data/lib/action_controller/session/abstract_store.rb +276 -0
  62. data/lib/action_controller/session/cookie_store.rb +240 -0
  63. data/lib/action_controller/session/mem_cache_store.rb +60 -0
  64. data/lib/action_controller/session_management.rb +54 -0
  65. data/lib/action_controller/status_codes.rb +88 -0
  66. data/lib/action_controller/streaming.rb +181 -0
  67. data/lib/action_controller/string_coercion.rb +29 -0
  68. data/lib/action_controller/templates/rescues/_request_and_response.erb +24 -0
  69. data/lib/action_controller/templates/rescues/_trace.erb +26 -0
  70. data/lib/action_controller/templates/rescues/diagnostics.erb +11 -0
  71. data/lib/action_controller/templates/rescues/layout.erb +29 -0
  72. data/lib/action_controller/templates/rescues/missing_template.erb +2 -0
  73. data/lib/action_controller/templates/rescues/routing_error.erb +10 -0
  74. data/lib/action_controller/templates/rescues/template_error.erb +21 -0
  75. data/lib/action_controller/templates/rescues/unknown_action.erb +2 -0
  76. data/lib/action_controller/test_case.rb +209 -0
  77. data/lib/action_controller/test_process.rb +580 -0
  78. data/lib/action_controller/translation.rb +13 -0
  79. data/lib/action_controller/uploaded_file.rb +44 -0
  80. data/lib/action_controller/url_rewriter.rb +229 -0
  81. data/lib/action_controller/vendor/html-scanner.rb +16 -0
  82. data/lib/action_controller/vendor/html-scanner/html/document.rb +68 -0
  83. data/lib/action_controller/vendor/html-scanner/html/node.rb +537 -0
  84. data/lib/action_controller/vendor/html-scanner/html/sanitizer.rb +173 -0
  85. data/lib/action_controller/vendor/html-scanner/html/selector.rb +828 -0
  86. data/lib/action_controller/vendor/html-scanner/html/tokenizer.rb +105 -0
  87. data/lib/action_controller/vendor/html-scanner/html/version.rb +11 -0
  88. data/lib/action_controller/verification.rb +130 -0
  89. data/lib/action_pack.rb +24 -0
  90. data/lib/action_pack/version.rb +9 -0
  91. data/lib/action_view.rb +58 -0
  92. data/lib/action_view/base.rb +362 -0
  93. data/lib/action_view/helpers.rb +61 -0
  94. data/lib/action_view/helpers/active_record_helper.rb +305 -0
  95. data/lib/action_view/helpers/asset_tag_helper.rb +695 -0
  96. data/lib/action_view/helpers/atom_feed_helper.rb +198 -0
  97. data/lib/action_view/helpers/benchmark_helper.rb +54 -0
  98. data/lib/action_view/helpers/cache_helper.rb +39 -0
  99. data/lib/action_view/helpers/capture_helper.rb +136 -0
  100. data/lib/action_view/helpers/csrf_helper.rb +14 -0
  101. data/lib/action_view/helpers/date_helper.rb +989 -0
  102. data/lib/action_view/helpers/debug_helper.rb +38 -0
  103. data/lib/action_view/helpers/form_helper.rb +1118 -0
  104. data/lib/action_view/helpers/form_options_helper.rb +599 -0
  105. data/lib/action_view/helpers/form_tag_helper.rb +490 -0
  106. data/lib/action_view/helpers/javascript_helper.rb +208 -0
  107. data/lib/action_view/helpers/number_helper.rb +308 -0
  108. data/lib/action_view/helpers/prototype_helper.rb +1305 -0
  109. data/lib/action_view/helpers/raw_output_helper.rb +9 -0
  110. data/lib/action_view/helpers/record_identification_helper.rb +20 -0
  111. data/lib/action_view/helpers/record_tag_helper.rb +58 -0
  112. data/lib/action_view/helpers/sanitize_helper.rb +251 -0
  113. data/lib/action_view/helpers/scriptaculous_helper.rb +226 -0
  114. data/lib/action_view/helpers/tag_helper.rb +151 -0
  115. data/lib/action_view/helpers/text_helper.rb +597 -0
  116. data/lib/action_view/helpers/translation_helper.rb +67 -0
  117. data/lib/action_view/helpers/url_helper.rb +637 -0
  118. data/lib/action_view/inline_template.rb +19 -0
  119. data/lib/action_view/locale/en.yml +117 -0
  120. data/lib/action_view/partials.rb +241 -0
  121. data/lib/action_view/paths.rb +77 -0
  122. data/lib/action_view/reloadable_template.rb +117 -0
  123. data/lib/action_view/renderable.rb +109 -0
  124. data/lib/action_view/renderable_partial.rb +53 -0
  125. data/lib/action_view/template.rb +252 -0
  126. data/lib/action_view/template_error.rb +99 -0
  127. data/lib/action_view/template_handler.rb +34 -0
  128. data/lib/action_view/template_handlers.rb +48 -0
  129. data/lib/action_view/template_handlers/builder.rb +17 -0
  130. data/lib/action_view/template_handlers/erb.rb +25 -0
  131. data/lib/action_view/template_handlers/rjs.rb +13 -0
  132. data/lib/action_view/test_case.rb +162 -0
  133. data/lib/actionpack.rb +2 -0
  134. data/test/abstract_unit.rb +78 -0
  135. data/test/active_record_unit.rb +104 -0
  136. data/test/activerecord/active_record_store_test.rb +221 -0
  137. data/test/activerecord/render_partial_with_record_identification_test.rb +188 -0
  138. data/test/adv_attr_test.rb +20 -0
  139. data/test/controller/action_pack_assertions_test.rb +545 -0
  140. data/test/controller/addresses_render_test.rb +37 -0
  141. data/test/controller/assert_select_test.rb +735 -0
  142. data/test/controller/base_test.rb +217 -0
  143. data/test/controller/benchmark_test.rb +32 -0
  144. data/test/controller/caching_test.rb +743 -0
  145. data/test/controller/capture_test.rb +66 -0
  146. data/test/controller/content_type_test.rb +178 -0
  147. data/test/controller/controller_fixtures/app/controllers/admin/user_controller.rb +0 -0
  148. data/test/controller/controller_fixtures/app/controllers/user_controller.rb +0 -0
  149. data/test/controller/controller_fixtures/vendor/plugins/bad_plugin/lib/plugin_controller.rb +0 -0
  150. data/test/controller/cookie_test.rb +208 -0
  151. data/test/controller/deprecation/deprecated_base_methods_test.rb +32 -0
  152. data/test/controller/dispatcher_test.rb +144 -0
  153. data/test/controller/dom_assertions_test.rb +53 -0
  154. data/test/controller/failsafe_test.rb +60 -0
  155. data/test/controller/fake_controllers.rb +33 -0
  156. data/test/controller/fake_models.rb +19 -0
  157. data/test/controller/filter_params_test.rb +52 -0
  158. data/test/controller/filters_test.rb +885 -0
  159. data/test/controller/flash_test.rb +174 -0
  160. data/test/controller/header_test.rb +14 -0
  161. data/test/controller/helper_test.rb +224 -0
  162. data/test/controller/html-scanner/cdata_node_test.rb +15 -0
  163. data/test/controller/html-scanner/document_test.rb +148 -0
  164. data/test/controller/html-scanner/node_test.rb +89 -0
  165. data/test/controller/html-scanner/sanitizer_test.rb +281 -0
  166. data/test/controller/html-scanner/tag_node_test.rb +238 -0
  167. data/test/controller/html-scanner/text_node_test.rb +50 -0
  168. data/test/controller/html-scanner/tokenizer_test.rb +131 -0
  169. data/test/controller/http_basic_authentication_test.rb +113 -0
  170. data/test/controller/http_digest_authentication_test.rb +254 -0
  171. data/test/controller/integration_test.rb +526 -0
  172. data/test/controller/layout_test.rb +215 -0
  173. data/test/controller/localized_templates_test.rb +24 -0
  174. data/test/controller/logging_test.rb +46 -0
  175. data/test/controller/middleware_stack_test.rb +90 -0
  176. data/test/controller/mime_responds_test.rb +536 -0
  177. data/test/controller/mime_type_test.rb +93 -0
  178. data/test/controller/output_escaping_test.rb +19 -0
  179. data/test/controller/polymorphic_routes_test.rb +297 -0
  180. data/test/controller/rack_test.rb +308 -0
  181. data/test/controller/record_identifier_test.rb +139 -0
  182. data/test/controller/redirect_test.rb +285 -0
  183. data/test/controller/reloader_test.rb +125 -0
  184. data/test/controller/render_test.rb +1783 -0
  185. data/test/controller/request/json_params_parsing_test.rb +65 -0
  186. data/test/controller/request/multipart_params_parsing_test.rb +177 -0
  187. data/test/controller/request/query_string_parsing_test.rb +129 -0
  188. data/test/controller/request/test_request_test.rb +35 -0
  189. data/test/controller/request/url_encoded_params_parsing_test.rb +146 -0
  190. data/test/controller/request/xml_params_parsing_test.rb +103 -0
  191. data/test/controller/request_forgery_protection_test.rb +233 -0
  192. data/test/controller/request_test.rb +398 -0
  193. data/test/controller/rescue_test.rb +541 -0
  194. data/test/controller/resources_test.rb +1393 -0
  195. data/test/controller/routing_test.rb +2592 -0
  196. data/test/controller/selector_test.rb +628 -0
  197. data/test/controller/send_file_test.rb +171 -0
  198. data/test/controller/session/abstract_store_test.rb +64 -0
  199. data/test/controller/session/cookie_store_test.rb +354 -0
  200. data/test/controller/session/mem_cache_store_test.rb +187 -0
  201. data/test/controller/session/test_session_test.rb +58 -0
  202. data/test/controller/test_test.rb +700 -0
  203. data/test/controller/translation_test.rb +26 -0
  204. data/test/controller/url_rewriter_test.rb +395 -0
  205. data/test/controller/verification_test.rb +270 -0
  206. data/test/controller/view_paths_test.rb +141 -0
  207. data/test/controller/webservice_test.rb +273 -0
  208. data/test/fixtures/_top_level_partial.html.erb +1 -0
  209. data/test/fixtures/_top_level_partial_only.erb +1 -0
  210. data/test/fixtures/addresses/list.erb +1 -0
  211. data/test/fixtures/alternate_helpers/foo_helper.rb +3 -0
  212. data/test/fixtures/bad_customers/_bad_customer.html.erb +1 -0
  213. data/test/fixtures/companies.yml +24 -0
  214. data/test/fixtures/company.rb +10 -0
  215. data/test/fixtures/content_type/render_default_content_types_for_respond_to.rhtml +1 -0
  216. data/test/fixtures/content_type/render_default_for_rhtml.rhtml +1 -0
  217. data/test/fixtures/content_type/render_default_for_rjs.rjs +1 -0
  218. data/test/fixtures/content_type/render_default_for_rxml.rxml +1 -0
  219. data/test/fixtures/customers/_customer.html.erb +1 -0
  220. data/test/fixtures/db_definitions/sqlite.sql +49 -0
  221. data/test/fixtures/developer.rb +9 -0
  222. data/test/fixtures/developers.yml +21 -0
  223. data/test/fixtures/developers/_developer.erb +1 -0
  224. data/test/fixtures/developers_projects.yml +13 -0
  225. data/test/fixtures/failsafe/500.html +1 -0
  226. data/test/fixtures/fun/games/_game.erb +1 -0
  227. data/test/fixtures/fun/games/hello_world.erb +1 -0
  228. data/test/fixtures/fun/serious/games/_game.erb +1 -0
  229. data/test/fixtures/functional_caching/_partial.erb +3 -0
  230. data/test/fixtures/functional_caching/formatted_fragment_cached.html.erb +3 -0
  231. data/test/fixtures/functional_caching/formatted_fragment_cached.js.rjs +6 -0
  232. data/test/fixtures/functional_caching/formatted_fragment_cached.xml.builder +5 -0
  233. data/test/fixtures/functional_caching/fragment_cached.html.erb +2 -0
  234. data/test/fixtures/functional_caching/html_fragment_cached_with_partial.html.erb +1 -0
  235. data/test/fixtures/functional_caching/inline_fragment_cached.html.erb +2 -0
  236. data/test/fixtures/functional_caching/js_fragment_cached_with_partial.js.rjs +1 -0
  237. data/test/fixtures/good_customers/_good_customer.html.erb +1 -0
  238. data/test/fixtures/helpers/abc_helper.rb +5 -0
  239. data/test/fixtures/helpers/fun/games_helper.rb +3 -0
  240. data/test/fixtures/helpers/fun/pdf_helper.rb +3 -0
  241. data/test/fixtures/layout_tests/abs_path_layout.rhtml +1 -0
  242. data/test/fixtures/layout_tests/alt/hello.rhtml +1 -0
  243. data/test/fixtures/layout_tests/alt/layouts/alt.rhtml +0 -0
  244. data/test/fixtures/layout_tests/layouts/controller_name_space/nested.rhtml +1 -0
  245. data/test/fixtures/layout_tests/layouts/item.rhtml +1 -0
  246. data/test/fixtures/layout_tests/layouts/layout_test.rhtml +1 -0
  247. data/test/fixtures/layout_tests/layouts/multiple_extensions.html.erb +1 -0
  248. data/test/fixtures/layout_tests/layouts/third_party_template_library.mab +1 -0
  249. data/test/fixtures/layout_tests/views/hello.rhtml +1 -0
  250. data/test/fixtures/layouts/_column.html.erb +2 -0
  251. data/test/fixtures/layouts/block_with_layout.erb +3 -0
  252. data/test/fixtures/layouts/builder.builder +3 -0
  253. data/test/fixtures/layouts/default_html.html.erb +1 -0
  254. data/test/fixtures/layouts/partial_with_layout.erb +3 -0
  255. data/test/fixtures/layouts/standard.erb +1 -0
  256. data/test/fixtures/layouts/talk_from_action.erb +2 -0
  257. data/test/fixtures/layouts/xhr.html.erb +2 -0
  258. data/test/fixtures/layouts/yield.erb +2 -0
  259. data/test/fixtures/localized/hello_world.de.html +1 -0
  260. data/test/fixtures/localized/hello_world.en.html +1 -0
  261. data/test/fixtures/mascot.rb +3 -0
  262. data/test/fixtures/mascots.yml +4 -0
  263. data/test/fixtures/mascots/_mascot.html.erb +1 -0
  264. data/test/fixtures/multipart/binary_file +0 -0
  265. data/test/fixtures/multipart/boundary_problem_file +10 -0
  266. data/test/fixtures/multipart/bracketed_param +5 -0
  267. data/test/fixtures/multipart/empty +10 -0
  268. data/test/fixtures/multipart/hello.txt +1 -0
  269. data/test/fixtures/multipart/large_text_file +10 -0
  270. data/test/fixtures/multipart/mixed_files +0 -0
  271. data/test/fixtures/multipart/mona_lisa.jpg +0 -0
  272. data/test/fixtures/multipart/none +9 -0
  273. data/test/fixtures/multipart/single_parameter +5 -0
  274. data/test/fixtures/multipart/text_file +10 -0
  275. data/test/fixtures/override/test/hello_world.erb +1 -0
  276. data/test/fixtures/override2/layouts/test/sub.erb +1 -0
  277. data/test/fixtures/post_test/layouts/post.html.erb +1 -0
  278. data/test/fixtures/post_test/layouts/super_post.iphone.erb +1 -0
  279. data/test/fixtures/post_test/post/index.html.erb +1 -0
  280. data/test/fixtures/post_test/post/index.iphone.erb +1 -0
  281. data/test/fixtures/post_test/super_post/index.html.erb +1 -0
  282. data/test/fixtures/post_test/super_post/index.iphone.erb +1 -0
  283. data/test/fixtures/project.rb +3 -0
  284. data/test/fixtures/projects.yml +7 -0
  285. data/test/fixtures/projects/_project.erb +1 -0
  286. data/test/fixtures/public/404.html +1 -0
  287. data/test/fixtures/public/500.da.html +1 -0
  288. data/test/fixtures/public/500.html +1 -0
  289. data/test/fixtures/public/absolute/test.css +23 -0
  290. data/test/fixtures/public/absolute/test.js +63 -0
  291. data/test/fixtures/public/images/rails.png +0 -0
  292. data/test/fixtures/public/javascripts/application.js +1 -0
  293. data/test/fixtures/public/javascripts/bank.js +1 -0
  294. data/test/fixtures/public/javascripts/controls.js +1 -0
  295. data/test/fixtures/public/javascripts/dragdrop.js +1 -0
  296. data/test/fixtures/public/javascripts/effects.js +1 -0
  297. data/test/fixtures/public/javascripts/prototype.js +1 -0
  298. data/test/fixtures/public/javascripts/robber.js +1 -0
  299. data/test/fixtures/public/javascripts/subdir/subdir.js +1 -0
  300. data/test/fixtures/public/javascripts/version.1.0.js +1 -0
  301. data/test/fixtures/public/stylesheets/bank.css +1 -0
  302. data/test/fixtures/public/stylesheets/robber.css +1 -0
  303. data/test/fixtures/public/stylesheets/subdir/subdir.css +1 -0
  304. data/test/fixtures/public/stylesheets/version.1.0.css +1 -0
  305. data/test/fixtures/quiz/questions/_question.html.erb +1 -0
  306. data/test/fixtures/replies.yml +15 -0
  307. data/test/fixtures/replies/_reply.erb +1 -0
  308. data/test/fixtures/reply.rb +7 -0
  309. data/test/fixtures/respond_to/all_types_with_layout.html.erb +1 -0
  310. data/test/fixtures/respond_to/all_types_with_layout.js.rjs +1 -0
  311. data/test/fixtures/respond_to/custom_constant_handling_without_block.mobile.erb +1 -0
  312. data/test/fixtures/respond_to/iphone_with_html_response_type.html.erb +1 -0
  313. data/test/fixtures/respond_to/iphone_with_html_response_type.iphone.erb +1 -0
  314. data/test/fixtures/respond_to/layouts/missing.html.erb +1 -0
  315. data/test/fixtures/respond_to/layouts/standard.html.erb +1 -0
  316. data/test/fixtures/respond_to/layouts/standard.iphone.erb +1 -0
  317. data/test/fixtures/respond_to/using_defaults.html.erb +1 -0
  318. data/test/fixtures/respond_to/using_defaults.js.rjs +1 -0
  319. data/test/fixtures/respond_to/using_defaults.xml.builder +1 -0
  320. data/test/fixtures/respond_to/using_defaults_with_type_list.html.erb +1 -0
  321. data/test/fixtures/respond_to/using_defaults_with_type_list.js.rjs +1 -0
  322. data/test/fixtures/respond_to/using_defaults_with_type_list.xml.builder +1 -0
  323. data/test/fixtures/scope/test/modgreet.erb +1 -0
  324. data/test/fixtures/session_autoload_test/session_autoload_test/foo.rb +10 -0
  325. data/test/fixtures/shared.html.erb +1 -0
  326. data/test/fixtures/symlink_parent/symlinked_layout.erb +5 -0
  327. data/test/fixtures/test/_counter.html.erb +1 -0
  328. data/test/fixtures/test/_customer.erb +1 -0
  329. data/test/fixtures/test/_customer_counter.erb +1 -0
  330. data/test/fixtures/test/_customer_counter_with_as.erb +1 -0
  331. data/test/fixtures/test/_customer_greeting.erb +1 -0
  332. data/test/fixtures/test/_customer_with_var.erb +1 -0
  333. data/test/fixtures/test/_form.erb +1 -0
  334. data/test/fixtures/test/_from_helper.erb +1 -0
  335. data/test/fixtures/test/_hash_greeting.erb +1 -0
  336. data/test/fixtures/test/_hash_object.erb +2 -0
  337. data/test/fixtures/test/_hello.builder +1 -0
  338. data/test/fixtures/test/_labelling_form.erb +1 -0
  339. data/test/fixtures/test/_layout_for_block_with_args.html.erb +3 -0
  340. data/test/fixtures/test/_layout_for_partial.html.erb +3 -0
  341. data/test/fixtures/test/_local_inspector.html.erb +1 -0
  342. data/test/fixtures/test/_one.html.erb +1 -0
  343. data/test/fixtures/test/_partial.erb +1 -0
  344. data/test/fixtures/test/_partial.html.erb +1 -0
  345. data/test/fixtures/test/_partial.js.erb +1 -0
  346. data/test/fixtures/test/_partial_for_use_in_layout.html.erb +1 -0
  347. data/test/fixtures/test/_partial_only.erb +1 -0
  348. data/test/fixtures/test/_partial_with_only_html_version.html.erb +1 -0
  349. data/test/fixtures/test/_person.erb +2 -0
  350. data/test/fixtures/test/_raise.html.erb +1 -0
  351. data/test/fixtures/test/_two.html.erb +1 -0
  352. data/test/fixtures/test/_utf8_partial.html.erb +1 -0
  353. data/test/fixtures/test/_utf8_partial_magic.html.erb +2 -0
  354. data/test/fixtures/test/action_talk_to_layout.erb +2 -0
  355. data/test/fixtures/test/array_translation.erb +1 -0
  356. data/test/fixtures/test/calling_partial_with_layout.html.erb +1 -0
  357. data/test/fixtures/test/capturing.erb +4 -0
  358. data/test/fixtures/test/content_for.erb +2 -0
  359. data/test/fixtures/test/content_for_concatenated.erb +3 -0
  360. data/test/fixtures/test/content_for_with_parameter.erb +2 -0
  361. data/test/fixtures/test/delete_with_js.rjs +2 -0
  362. data/test/fixtures/test/dont_pick_me +1 -0
  363. data/test/fixtures/test/dot.directory/render_file_with_ivar.erb +1 -0
  364. data/test/fixtures/test/enum_rjs_test.rjs +6 -0
  365. data/test/fixtures/test/formatted_html_erb.html.erb +1 -0
  366. data/test/fixtures/test/formatted_xml_erb.builder +1 -0
  367. data/test/fixtures/test/formatted_xml_erb.html.erb +1 -0
  368. data/test/fixtures/test/formatted_xml_erb.xml.erb +1 -0
  369. data/test/fixtures/test/greeting.erb +1 -0
  370. data/test/fixtures/test/greeting.js.rjs +1 -0
  371. data/test/fixtures/test/hello.builder +4 -0
  372. data/test/fixtures/test/hello_world.da.html.erb +1 -0
  373. data/test/fixtures/test/hello_world.erb +1 -0
  374. data/test/fixtures/test/hello_world.erb~ +1 -0
  375. data/test/fixtures/test/hello_world.pt-BR.html.erb +1 -0
  376. data/test/fixtures/test/hello_world_container.builder +3 -0
  377. data/test/fixtures/test/hello_world_from_rxml.builder +4 -0
  378. data/test/fixtures/test/hello_world_with_layout_false.erb +1 -0
  379. data/test/fixtures/test/hello_xml_world.builder +11 -0
  380. data/test/fixtures/test/hyphen-ated.erb +1 -0
  381. data/test/fixtures/test/implicit_content_type.atom.builder +2 -0
  382. data/test/fixtures/test/list.erb +1 -0
  383. data/test/fixtures/test/malformed/malformed.en.html.erb~ +1 -0
  384. data/test/fixtures/test/malformed/malformed.erb~ +1 -0
  385. data/test/fixtures/test/malformed/malformed.html.erb~ +1 -0
  386. data/test/fixtures/test/nested_layout.erb +3 -0
  387. data/test/fixtures/test/non_erb_block_content_for.builder +4 -0
  388. data/test/fixtures/test/potential_conflicts.erb +4 -0
  389. data/test/fixtures/test/render_explicit_html_template.js.rjs +1 -0
  390. data/test/fixtures/test/render_file_from_template.html.erb +1 -0
  391. data/test/fixtures/test/render_file_with_ivar.erb +1 -0
  392. data/test/fixtures/test/render_file_with_locals.erb +1 -0
  393. data/test/fixtures/test/render_implicit_html_template.js.rjs +1 -0
  394. data/test/fixtures/test/render_implicit_html_template_from_xhr_request.da.html.erb +1 -0
  395. data/test/fixtures/test/render_implicit_html_template_from_xhr_request.html.erb +1 -0
  396. data/test/fixtures/test/render_implicit_js_template_without_layout.js.erb +1 -0
  397. data/test/fixtures/test/render_to_string_test.erb +1 -0
  398. data/test/fixtures/test/scoped_array_translation.erb +1 -0
  399. data/test/fixtures/test/sub_template_raise.html.erb +1 -0
  400. data/test/fixtures/test/template.erb +1 -0
  401. data/test/fixtures/test/translation.erb +1 -0
  402. data/test/fixtures/test/update_element_with_capture.erb +9 -0
  403. data/test/fixtures/test/using_layout_around_block.html.erb +1 -0
  404. data/test/fixtures/test/using_layout_around_block_with_args.html.erb +1 -0
  405. data/test/fixtures/test/utf8.html.erb +4 -0
  406. data/test/fixtures/test/utf8_magic.html.erb +5 -0
  407. data/test/fixtures/test/utf8_magic_with_bare_partial.html.erb +5 -0
  408. data/test/fixtures/topic.rb +3 -0
  409. data/test/fixtures/topics.yml +22 -0
  410. data/test/fixtures/topics/_topic.html.erb +1 -0
  411. data/test/template/active_record_helper_i18n_test.rb +51 -0
  412. data/test/template/active_record_helper_test.rb +302 -0
  413. data/test/template/asset_tag_helper_test.rb +770 -0
  414. data/test/template/atom_feed_helper_test.rb +315 -0
  415. data/test/template/benchmark_helper_test.rb +86 -0
  416. data/test/template/compiled_templates_test.rb +204 -0
  417. data/test/template/date_helper_i18n_test.rb +121 -0
  418. data/test/template/date_helper_test.rb +2603 -0
  419. data/test/template/erb_util_test.rb +36 -0
  420. data/test/template/form_helper_test.rb +1447 -0
  421. data/test/template/form_options_helper_i18n_test.rb +27 -0
  422. data/test/template/form_options_helper_test.rb +811 -0
  423. data/test/template/form_tag_helper_test.rb +356 -0
  424. data/test/template/javascript_helper_test.rb +106 -0
  425. data/test/template/number_helper_i18n_test.rb +69 -0
  426. data/test/template/number_helper_test.rb +132 -0
  427. data/test/template/prototype_helper_test.rb +639 -0
  428. data/test/template/raw_output_helper_test.rb +21 -0
  429. data/test/template/record_tag_helper_test.rb +58 -0
  430. data/test/template/render_test.rb +329 -0
  431. data/test/template/sanitize_helper_test.rb +57 -0
  432. data/test/template/scriptaculous_helper_test.rb +90 -0
  433. data/test/template/tag_helper_test.rb +98 -0
  434. data/test/template/template_test.rb +32 -0
  435. data/test/template/test_test.rb +54 -0
  436. data/test/template/text_helper_test.rb +601 -0
  437. data/test/template/translation_helper_test.rb +95 -0
  438. data/test/template/url_helper_test.rb +641 -0
  439. data/test/testing_sandbox.rb +15 -0
  440. data/test/view/test_case_test.rb +176 -0
  441. metadata +519 -0
@@ -0,0 +1,198 @@
1
+ require 'set'
2
+
3
+ # Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ERb or any other
4
+ # template languages).
5
+ module ActionView
6
+ module Helpers #:nodoc:
7
+ module AtomFeedHelper
8
+ # Full usage example:
9
+ #
10
+ # config/routes.rb:
11
+ # ActionController::Routing::Routes.draw do |map|
12
+ # map.resources :posts
13
+ # map.root :controller => "posts"
14
+ # end
15
+ #
16
+ # app/controllers/posts_controller.rb:
17
+ # class PostsController < ApplicationController::Base
18
+ # # GET /posts.html
19
+ # # GET /posts.atom
20
+ # def index
21
+ # @posts = Post.find(:all)
22
+ #
23
+ # respond_to do |format|
24
+ # format.html
25
+ # format.atom
26
+ # end
27
+ # end
28
+ # end
29
+ #
30
+ # app/views/posts/index.atom.builder:
31
+ # atom_feed do |feed|
32
+ # feed.title("My great blog!")
33
+ # feed.updated(@posts.first.created_at)
34
+ #
35
+ # for post in @posts
36
+ # feed.entry(post) do |entry|
37
+ # entry.title(post.title)
38
+ # entry.content(post.body, :type => 'html')
39
+ #
40
+ # entry.author do |author|
41
+ # author.name("DHH")
42
+ # end
43
+ # end
44
+ # end
45
+ # end
46
+ #
47
+ # The options for atom_feed are:
48
+ #
49
+ # * <tt>:language</tt>: Defaults to "en-US".
50
+ # * <tt>:root_url</tt>: The HTML alternative that this feed is doubling for. Defaults to / on the current host.
51
+ # * <tt>:url</tt>: The URL for this feed. Defaults to the current URL.
52
+ # * <tt>:id</tt>: The id for this feed. Defaults to "tag:#{request.host},#{options[:schema_date]}:#{request.request_uri.split(".")[0]}"
53
+ # * <tt>:schema_date</tt>: The date at which the tag scheme for the feed was first used. A good default is the year you
54
+ # created the feed. See http://feedvalidator.org/docs/error/InvalidTAG.html for more information. If not specified,
55
+ # 2005 is used (as an "I don't care" value).
56
+ # * <tt>:instruct</tt>: Hash of XML processing instructions in the form {target => {attribute => value, }} or {target => [{attribute => value, }, ]}
57
+ #
58
+ # Other namespaces can be added to the root element:
59
+ #
60
+ # app/views/posts/index.atom.builder:
61
+ # atom_feed({'xmlns:app' => 'http://www.w3.org/2007/app',
62
+ # 'xmlns:openSearch' => 'http://a9.com/-/spec/opensearch/1.1/'}) do |feed|
63
+ # feed.title("My great blog!")
64
+ # feed.updated((@posts.first.created_at))
65
+ # feed.tag!(openSearch:totalResults, 10)
66
+ #
67
+ # for post in @posts
68
+ # feed.entry(post) do |entry|
69
+ # entry.title(post.title)
70
+ # entry.content(post.body, :type => 'html')
71
+ # entry.tag!('app:edited', Time.now)
72
+ #
73
+ # entry.author do |author|
74
+ # author.name("DHH")
75
+ # end
76
+ # end
77
+ # end
78
+ # end
79
+ #
80
+ # The Atom spec defines five elements (content rights title subtitle
81
+ # summary) which may directly contain xhtml content if :type => 'xhtml'
82
+ # is specified as an attribute. If so, this helper will take care of
83
+ # the enclosing div and xhtml namespace declaration. Example usage:
84
+ #
85
+ # entry.summary :type => 'xhtml' do |xhtml|
86
+ # xhtml.p pluralize(order.line_items.count, "line item")
87
+ # xhtml.p "Shipped to #{order.address}"
88
+ # xhtml.p "Paid by #{order.pay_type}"
89
+ # end
90
+ #
91
+ #
92
+ # atom_feed yields an AtomFeedBuilder instance. Nested elements yield
93
+ # an AtomBuilder instance.
94
+ def atom_feed(options = {}, &block)
95
+ if options[:schema_date]
96
+ options[:schema_date] = options[:schema_date].strftime("%Y-%m-%d") if options[:schema_date].respond_to?(:strftime)
97
+ else
98
+ options[:schema_date] = "2005" # The Atom spec copyright date
99
+ end
100
+
101
+ xml = options.delete(:xml) || eval("xml", block.binding)
102
+ xml.instruct!
103
+ if options[:instruct]
104
+ options[:instruct].each do |target,attrs|
105
+ if attrs.respond_to?(:keys)
106
+ xml.instruct!(target, attrs)
107
+ elsif attrs.respond_to?(:each)
108
+ attrs.each { |attr_group| xml.instruct!(target, attr_group) }
109
+ end
110
+ end
111
+ end
112
+
113
+ feed_opts = {"xml:lang" => options[:language] || "en-US", "xmlns" => 'http://www.w3.org/2005/Atom'}
114
+ feed_opts.merge!(options).reject!{|k,v| !k.to_s.match(/^xml/)}
115
+
116
+ xml.feed(feed_opts) do
117
+ xml.id(options[:id] || "tag:#{request.host},#{options[:schema_date]}:#{request.request_uri.split(".")[0]}")
118
+ xml.link(:rel => 'alternate', :type => 'text/html', :href => options[:root_url] || (request.protocol + request.host_with_port))
119
+ xml.link(:rel => 'self', :type => 'application/atom+xml', :href => options[:url] || request.url)
120
+
121
+ yield AtomFeedBuilder.new(xml, self, options)
122
+ end
123
+ end
124
+
125
+ class AtomBuilder
126
+ XHTML_TAG_NAMES = %w(content rights title subtitle summary).to_set
127
+
128
+ def initialize(xml)
129
+ @xml = xml
130
+ end
131
+
132
+ private
133
+ # Delegate to xml builder, first wrapping the element in a xhtml
134
+ # namespaced div element if the method and arguments indicate
135
+ # that an xhtml_block? is desired.
136
+ def method_missing(method, *arguments, &block)
137
+ if xhtml_block?(method, arguments)
138
+ @xml.__send__(method, *arguments) do
139
+ @xml.div(:xmlns => 'http://www.w3.org/1999/xhtml') do |xhtml|
140
+ block.call(xhtml)
141
+ end
142
+ end
143
+ else
144
+ @xml.__send__(method, *arguments, &block)
145
+ end
146
+ end
147
+
148
+ # True if the method name matches one of the five elements defined
149
+ # in the Atom spec as potentially containing XHTML content and
150
+ # if :type => 'xhtml' is, in fact, specified.
151
+ def xhtml_block?(method, arguments)
152
+ if XHTML_TAG_NAMES.include?(method.to_s)
153
+ last = arguments.last
154
+ last.is_a?(Hash) && last[:type].to_s == 'xhtml'
155
+ end
156
+ end
157
+ end
158
+
159
+ class AtomFeedBuilder < AtomBuilder
160
+ def initialize(xml, view, feed_options = {})
161
+ @xml, @view, @feed_options = xml, view, feed_options
162
+ end
163
+
164
+ # Accepts a Date or Time object and inserts it in the proper format. If nil is passed, current time in UTC is used.
165
+ def updated(date_or_time = nil)
166
+ @xml.updated((date_or_time || Time.now.utc).xmlschema)
167
+ end
168
+
169
+ # Creates an entry tag for a specific record and prefills the id using class and id.
170
+ #
171
+ # Options:
172
+ #
173
+ # * <tt>:published</tt>: Time first published. Defaults to the created_at attribute on the record if one such exists.
174
+ # * <tt>:updated</tt>: Time of update. Defaults to the updated_at attribute on the record if one such exists.
175
+ # * <tt>:url</tt>: The URL for this entry. Defaults to the polymorphic_url for the record.
176
+ # * <tt>:id</tt>: The ID for this entry. Defaults to "tag:#{@view.request.host},#{@feed_options[:schema_date]}:#{record.class}/#{record.id}"
177
+ def entry(record, options = {})
178
+ @xml.entry do
179
+ @xml.id(options[:id] || "tag:#{@view.request.host},#{@feed_options[:schema_date]}:#{record.class}/#{record.id}")
180
+
181
+ if options[:published] || (record.respond_to?(:created_at) && record.created_at)
182
+ @xml.published((options[:published] || record.created_at).xmlschema)
183
+ end
184
+
185
+ if options[:updated] || (record.respond_to?(:updated_at) && record.updated_at)
186
+ @xml.updated((options[:updated] || record.updated_at).xmlschema)
187
+ end
188
+
189
+ @xml.link(:rel => 'alternate', :type => 'text/html', :href => options[:url] || @view.polymorphic_url(record))
190
+
191
+ yield AtomBuilder.new(@xml)
192
+ end
193
+ end
194
+ end
195
+
196
+ end
197
+ end
198
+ end
@@ -0,0 +1,54 @@
1
+ require 'benchmark'
2
+
3
+ module ActionView
4
+ module Helpers
5
+ # This helper offers a method to measure the execution time of a block
6
+ # in a template.
7
+ module BenchmarkHelper
8
+ # Allows you to measure the execution time of a block
9
+ # in a template and records the result to the log. Wrap this block around
10
+ # expensive operations or possible bottlenecks to get a time reading
11
+ # for the operation. For example, let's say you thought your file
12
+ # processing method was taking too long; you could wrap it in a benchmark block.
13
+ #
14
+ # <% benchmark "Process data files" do %>
15
+ # <%= expensive_files_operation %>
16
+ # <% end %>
17
+ #
18
+ # That would add something like "Process data files (345.2ms)" to the log,
19
+ # which you can then use to compare timings when optimizing your code.
20
+ #
21
+ # You may give an optional logger level as the :level option.
22
+ # (:debug, :info, :warn, :error); the default value is :info.
23
+ #
24
+ # <% benchmark "Low-level files", :level => :debug do %>
25
+ # <%= lowlevel_files_operation %>
26
+ # <% end %>
27
+ #
28
+ # Finally, you can pass true as the third argument to silence all log activity
29
+ # inside the block. This is great for boiling down a noisy block to just a single statement:
30
+ #
31
+ # <% benchmark "Process data files", :level => :info, :silence => true do %>
32
+ # <%= expensive_and_chatty_files_operation %>
33
+ # <% end %>
34
+ def benchmark(message = "Benchmarking", options = {})
35
+ if controller.logger
36
+ if options.is_a?(Symbol)
37
+ ActiveSupport::Deprecation.warn("use benchmark('#{message}', :level => :#{options}) instead", caller)
38
+ options = { :level => options, :silence => false }
39
+ else
40
+ options.assert_valid_keys(:level, :silence)
41
+ options[:level] ||= :info
42
+ end
43
+
44
+ result = nil
45
+ ms = Benchmark.ms { result = options[:silence] ? controller.logger.silence { yield } : yield }
46
+ controller.logger.send(options[:level], '%s (%.1fms)' % [ message, ms ])
47
+ result
48
+ else
49
+ yield
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,39 @@
1
+ module ActionView
2
+ module Helpers
3
+ # This helper to exposes a method for caching of view fragments.
4
+ # See ActionController::Caching::Fragments for usage instructions.
5
+ module CacheHelper
6
+ # A method for caching fragments of a view rather than an entire
7
+ # action or page. This technique is useful caching pieces like
8
+ # menus, lists of news topics, static HTML fragments, and so on.
9
+ # This method takes a block that contains the content you wish
10
+ # to cache. See ActionController::Caching::Fragments for more
11
+ # information.
12
+ #
13
+ # ==== Examples
14
+ # If you wanted to cache a navigation menu, you could do the
15
+ # following.
16
+ #
17
+ # <% cache do %>
18
+ # <%= render :partial => "menu" %>
19
+ # <% end %>
20
+ #
21
+ # You can also cache static content...
22
+ #
23
+ # <% cache do %>
24
+ # <p>Hello users! Welcome to our website!</p>
25
+ # <% end %>
26
+ #
27
+ # ...and static content mixed with RHTML content.
28
+ #
29
+ # <% cache do %>
30
+ # Topics:
31
+ # <%= render :partial => "topics", :collection => @topic_list %>
32
+ # <i>Topics listed alphabetically</i>
33
+ # <% end %>
34
+ def cache(name = {}, options = nil, &block)
35
+ @controller.fragment_for(output_buffer, name, options, &block)
36
+ end
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,136 @@
1
+ module ActionView
2
+ module Helpers
3
+ # CaptureHelper exposes methods to let you extract generated markup which
4
+ # can be used in other parts of a template or layout file.
5
+ # It provides a method to capture blocks into variables through capture and
6
+ # a way to capture a block of markup for use in a layout through content_for.
7
+ module CaptureHelper
8
+ # The capture method allows you to extract part of a template into a
9
+ # variable. You can then use this variable anywhere in your templates or layout.
10
+ #
11
+ # ==== Examples
12
+ # The capture method can be used in ERb templates...
13
+ #
14
+ # <% @greeting = capture do %>
15
+ # Welcome to my shiny new web page! The date and time is
16
+ # <%= Time.now %>
17
+ # <% end %>
18
+ #
19
+ # ...and Builder (RXML) templates.
20
+ #
21
+ # @timestamp = capture do
22
+ # "The current timestamp is #{Time.now}."
23
+ # end
24
+ #
25
+ # You can then use that variable anywhere else. For example:
26
+ #
27
+ # <html>
28
+ # <head><title><%= @greeting %></title></head>
29
+ # <body>
30
+ # <b><%= @greeting %></b>
31
+ # </body></html>
32
+ #
33
+ def capture(*args, &block)
34
+ # Return captured buffer in erb.
35
+ if block_called_from_erb?(block)
36
+ with_output_buffer { block.call(*args) }
37
+ else
38
+ # Return block result otherwise, but protect buffer also.
39
+ with_output_buffer { return block.call(*args) }
40
+ end
41
+ end
42
+
43
+ # Calling content_for stores a block of markup in an identifier for later use.
44
+ # You can make subsequent calls to the stored content in other templates or the layout
45
+ # by passing the identifier as an argument to <tt>yield</tt>.
46
+ #
47
+ # ==== Examples
48
+ #
49
+ # <% content_for :not_authorized do %>
50
+ # alert('You are not authorized to do that!')
51
+ # <% end %>
52
+ #
53
+ # You can then use <tt>yield :not_authorized</tt> anywhere in your templates.
54
+ #
55
+ # <%= yield :not_authorized if current_user.nil? %>
56
+ #
57
+ # You can also use this syntax alongside an existing call to <tt>yield</tt> in a layout. For example:
58
+ #
59
+ # <%# This is the layout %>
60
+ # <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
61
+ # <head>
62
+ # <title>My Website</title>
63
+ # <%= yield :script %>
64
+ # </head>
65
+ # <body>
66
+ # <%= yield %>
67
+ # </body>
68
+ # </html>
69
+ #
70
+ # And now, we'll create a view that has a content_for call that
71
+ # creates the <tt>script</tt> identifier.
72
+ #
73
+ # <%# This is our view %>
74
+ # Please login!
75
+ #
76
+ # <% content_for :script do %>
77
+ # <script type="text/javascript">alert('You are not authorized to view this page!')</script>
78
+ # <% end %>
79
+ #
80
+ # Then, in another view, you could to do something like this:
81
+ #
82
+ # <%= link_to_remote 'Logout', :action => 'logout' %>
83
+ #
84
+ # <% content_for :script do %>
85
+ # <%= javascript_include_tag :defaults %>
86
+ # <% end %>
87
+ #
88
+ # That will place <script> tags for Prototype, Scriptaculous, and application.js (if it exists)
89
+ # on the page; this technique is useful if you'll only be using these scripts in a few views.
90
+ #
91
+ # Note that content_for concatenates the blocks it is given for a particular
92
+ # identifier in order. For example:
93
+ #
94
+ # <% content_for :navigation do %>
95
+ # <li><%= link_to 'Home', :action => 'index' %></li>
96
+ # <% end %>
97
+ #
98
+ # <%# Add some other content, or use a different template: %>
99
+ #
100
+ # <% content_for :navigation do %>
101
+ # <li><%= link_to 'Login', :action => 'login' %></li>
102
+ # <% end %>
103
+ #
104
+ # Then, in another template or layout, this code would render both links in order:
105
+ #
106
+ # <ul><%= yield :navigation %></ul>
107
+ #
108
+ # Lastly, simple content can be passed as a parameter:
109
+ #
110
+ # <% content_for :script, javascript_include_tag(:defaults) %>
111
+ #
112
+ # WARNING: content_for is ignored in caches. So you shouldn't use it
113
+ # for elements that will be fragment cached.
114
+ #
115
+ # The deprecated way of accessing a content_for block is to use an instance variable
116
+ # named <tt>@content_for_#{name_of_the_content_block}</tt>. The preferred usage is now
117
+ # <tt><%= yield :footer %></tt>.
118
+ def content_for(name, content = nil, &block)
119
+ ivar = "@content_for_#{name}"
120
+ content = capture(&block) if block_given?
121
+ instance_variable_set(ivar, "#{instance_variable_get(ivar)}#{content}".html_safe)
122
+ nil
123
+ end
124
+
125
+ # Use an alternate output buffer for the duration of the block.
126
+ # Defaults to a new empty string.
127
+ def with_output_buffer(buf = '') #:nodoc:
128
+ self.output_buffer, old_buffer = buf, output_buffer
129
+ yield
130
+ output_buffer
131
+ ensure
132
+ self.output_buffer = old_buffer
133
+ end
134
+ end
135
+ end
136
+ end
@@ -0,0 +1,14 @@
1
+ module ActionView
2
+ # = Action View CSRF Helper
3
+ module Helpers
4
+ module CsrfHelper
5
+ # Returns a meta tag with the cross-site request forgery protection token
6
+ # for forms to use. Place this in your head.
7
+ def csrf_meta_tag
8
+ if protect_against_forgery?
9
+ %(<meta name="csrf-param" content="#{h(request_forgery_protection_token)}"/>\n<meta name="csrf-token" content="#{h(form_authenticity_token)}"/>).html_safe
10
+ end
11
+ end
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,989 @@
1
+ require "date"
2
+ require 'action_view/helpers/tag_helper'
3
+ require 'active_support/core_ext/hash/slice'
4
+
5
+ module ActionView
6
+ module Helpers
7
+ # The Date Helper primarily creates select/option tags for different kinds of dates and date elements. All of the
8
+ # select-type methods share a number of common options that are as follows:
9
+ #
10
+ # * <tt>:prefix</tt> - overwrites the default prefix of "date" used for the select names. So specifying "birthday"
11
+ # would give birthday[month] instead of date[month] if passed to the select_month method.
12
+ # * <tt>:include_blank</tt> - set to true if it should be possible to set an empty date.
13
+ # * <tt>:discard_type</tt> - set to true if you want to discard the type part of the select name. If set to true,
14
+ # the select_month method would use simply "date" (which can be overwritten using <tt>:prefix</tt>) instead of
15
+ # "date[month]".
16
+ module DateHelper
17
+ # Reports the approximate distance in time between two Time or Date objects or integers as seconds.
18
+ # Set <tt>include_seconds</tt> to true if you want more detailed approximations when distance < 1 min, 29 secs
19
+ # Distances are reported based on the following table:
20
+ #
21
+ # 0 <-> 29 secs # => less than a minute
22
+ # 30 secs <-> 1 min, 29 secs # => 1 minute
23
+ # 1 min, 30 secs <-> 44 mins, 29 secs # => [2..44] minutes
24
+ # 44 mins, 30 secs <-> 89 mins, 29 secs # => about 1 hour
25
+ # 89 mins, 29 secs <-> 23 hrs, 59 mins, 29 secs # => about [2..24] hours
26
+ # 23 hrs, 59 mins, 29 secs <-> 47 hrs, 59 mins, 29 secs # => 1 day
27
+ # 47 hrs, 59 mins, 29 secs <-> 29 days, 23 hrs, 59 mins, 29 secs # => [2..29] days
28
+ # 29 days, 23 hrs, 59 mins, 30 secs <-> 59 days, 23 hrs, 59 mins, 29 secs # => about 1 month
29
+ # 59 days, 23 hrs, 59 mins, 30 secs <-> 1 yr minus 1 sec # => [2..12] months
30
+ # 1 yr <-> 1 yr, 3 months # => about 1 year
31
+ # 1 yr, 3 months <-> 1 yr, 9 months # => over 1 year
32
+ # 1 yr, 9 months <-> 2 yr minus 1 sec # => almost 2 years
33
+ # 2 yrs <-> max time or date # => (same rules as 1 yr)
34
+ #
35
+ # With <tt>include_seconds</tt> = true and the difference < 1 minute 29 seconds:
36
+ # 0-4 secs # => less than 5 seconds
37
+ # 5-9 secs # => less than 10 seconds
38
+ # 10-19 secs # => less than 20 seconds
39
+ # 20-39 secs # => half a minute
40
+ # 40-59 secs # => less than a minute
41
+ # 60-89 secs # => 1 minute
42
+ #
43
+ # ==== Examples
44
+ # from_time = Time.now
45
+ # distance_of_time_in_words(from_time, from_time + 50.minutes) # => about 1 hour
46
+ # distance_of_time_in_words(from_time, 50.minutes.from_now) # => about 1 hour
47
+ # distance_of_time_in_words(from_time, from_time + 15.seconds) # => less than a minute
48
+ # distance_of_time_in_words(from_time, from_time + 15.seconds, true) # => less than 20 seconds
49
+ # distance_of_time_in_words(from_time, 3.years.from_now) # => about 3 years
50
+ # distance_of_time_in_words(from_time, from_time + 60.hours) # => about 3 days
51
+ # distance_of_time_in_words(from_time, from_time + 45.seconds, true) # => less than a minute
52
+ # distance_of_time_in_words(from_time, from_time - 45.seconds, true) # => less than a minute
53
+ # distance_of_time_in_words(from_time, 76.seconds.from_now) # => 1 minute
54
+ # distance_of_time_in_words(from_time, from_time + 1.year + 3.days) # => about 1 year
55
+ # distance_of_time_in_words(from_time, from_time + 3.years + 6.months) # => over 3 years
56
+ # distance_of_time_in_words(from_time, from_time + 4.years + 9.days + 30.minutes + 5.seconds) # => about 4 years
57
+ #
58
+ # to_time = Time.now + 6.years + 19.days
59
+ # distance_of_time_in_words(from_time, to_time, true) # => about 6 years
60
+ # distance_of_time_in_words(to_time, from_time, true) # => about 6 years
61
+ # distance_of_time_in_words(Time.now, Time.now) # => less than a minute
62
+ #
63
+ def distance_of_time_in_words(from_time, to_time = 0, include_seconds = false, options = {})
64
+ from_time = from_time.to_time if from_time.respond_to?(:to_time)
65
+ to_time = to_time.to_time if to_time.respond_to?(:to_time)
66
+ distance_in_minutes = (((to_time - from_time).abs)/60).round
67
+ distance_in_seconds = ((to_time - from_time).abs).round
68
+
69
+ I18n.with_options :locale => options[:locale], :scope => :'datetime.distance_in_words' do |locale|
70
+ case distance_in_minutes
71
+ when 0..1
72
+ return distance_in_minutes == 0 ?
73
+ locale.t(:less_than_x_minutes, :count => 1) :
74
+ locale.t(:x_minutes, :count => distance_in_minutes) unless include_seconds
75
+
76
+ case distance_in_seconds
77
+ when 0..4 then locale.t :less_than_x_seconds, :count => 5
78
+ when 5..9 then locale.t :less_than_x_seconds, :count => 10
79
+ when 10..19 then locale.t :less_than_x_seconds, :count => 20
80
+ when 20..39 then locale.t :half_a_minute
81
+ when 40..59 then locale.t :less_than_x_minutes, :count => 1
82
+ else locale.t :x_minutes, :count => 1
83
+ end
84
+
85
+ when 2..44 then locale.t :x_minutes, :count => distance_in_minutes
86
+ when 45..89 then locale.t :about_x_hours, :count => 1
87
+ when 90..1439 then locale.t :about_x_hours, :count => (distance_in_minutes.to_f / 60.0).round
88
+ when 1440..2529 then locale.t :x_days, :count => 1
89
+ when 2530..43199 then locale.t :x_days, :count => (distance_in_minutes.to_f / 1440.0).round
90
+ when 43200..86399 then locale.t :about_x_months, :count => 1
91
+ when 86400..525599 then locale.t :x_months, :count => (distance_in_minutes.to_f / 43200.0).round
92
+ else
93
+ distance_in_years = distance_in_minutes / 525600
94
+ minute_offset_for_leap_year = (distance_in_years / 4) * 1440
95
+ remainder = ((distance_in_minutes - minute_offset_for_leap_year) % 525600)
96
+ if remainder < 131400
97
+ locale.t(:about_x_years, :count => distance_in_years)
98
+ elsif remainder < 394200
99
+ locale.t(:over_x_years, :count => distance_in_years)
100
+ else
101
+ locale.t(:almost_x_years, :count => distance_in_years + 1)
102
+ end
103
+ end
104
+ end
105
+ end
106
+
107
+ # Like distance_of_time_in_words, but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>.
108
+ #
109
+ # ==== Examples
110
+ # time_ago_in_words(3.minutes.from_now) # => 3 minutes
111
+ # time_ago_in_words(Time.now - 15.hours) # => 15 hours
112
+ # time_ago_in_words(Time.now) # => less than a minute
113
+ #
114
+ # from_time = Time.now - 3.days - 14.minutes - 25.seconds # => 3 days
115
+ def time_ago_in_words(from_time, include_seconds = false)
116
+ distance_of_time_in_words(from_time, Time.now, include_seconds)
117
+ end
118
+
119
+ alias_method :distance_of_time_in_words_to_now, :time_ago_in_words
120
+
121
+ # Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based
122
+ # attribute (identified by +method+) on an object assigned to the template (identified by +object+). You can
123
+ # the output in the +options+ hash.
124
+ #
125
+ # ==== Options
126
+ # * <tt>:use_month_numbers</tt> - Set to true if you want to use month numbers rather than month names (e.g.
127
+ # "2" instead of "February").
128
+ # * <tt>:use_short_month</tt> - Set to true if you want to use the abbreviated month name instead of the full
129
+ # name (e.g. "Feb" instead of "February").
130
+ # * <tt>:add_month_number</tt> - Set to true if you want to show both, the month's number and name (e.g.
131
+ # "2 - February" instead of "February").
132
+ # * <tt>:use_month_names</tt> - Set to an array with 12 month names if you want to customize month names.
133
+ # Note: You can also use Rails' new i18n functionality for this.
134
+ # * <tt>:date_separator</tt> - Specifies a string to separate the date fields. Default is "" (i.e. nothing).
135
+ # * <tt>:start_year</tt> - Set the start year for the year select. Default is <tt>Time.now.year - 5</tt>.
136
+ # * <tt>:end_year</tt> - Set the end year for the year select. Default is <tt>Time.now.year + 5</tt>.
137
+ # * <tt>:discard_day</tt> - Set to true if you don't want to show a day select. This includes the day
138
+ # as a hidden field instead of showing a select field. Also note that this implicitly sets the day to be the
139
+ # first of the given month in order to not create invalid dates like 31 February.
140
+ # * <tt>:discard_month</tt> - Set to true if you don't want to show a month select. This includes the month
141
+ # as a hidden field instead of showing a select field. Also note that this implicitly sets :discard_day to true.
142
+ # * <tt>:discard_year</tt> - Set to true if you don't want to show a year select. This includes the year
143
+ # as a hidden field instead of showing a select field.
144
+ # * <tt>:order</tt> - Set to an array containing <tt>:day</tt>, <tt>:month</tt> and <tt>:year</tt> do
145
+ # customize the order in which the select fields are shown. If you leave out any of the symbols, the respective
146
+ # select will not be shown (like when you set <tt>:discard_xxx => true</tt>. Defaults to the order defined in
147
+ # the respective locale (e.g. [:year, :month, :day] in the en locale that ships with Rails).
148
+ # * <tt>:include_blank</tt> - Include a blank option in every select field so it's possible to set empty
149
+ # dates.
150
+ # * <tt>:default</tt> - Set a default date if the affected date isn't set or is nil.
151
+ # * <tt>:disabled</tt> - Set to true if you want show the select fields as disabled.
152
+ # * <tt>:prompt</tt> - Set to true (for a generic prompt), a prompt string or a hash of prompt strings
153
+ # for <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>, <tt>:hour</tt>, <tt>:minute</tt> and <tt>:second</tt>.
154
+ # Setting this option prepends a select option with a generic prompt (Day, Month, Year, Hour, Minute, Seconds)
155
+ # or the given prompt string.
156
+ #
157
+ # If anything is passed in the +html_options+ hash it will be applied to every select tag in the set.
158
+ #
159
+ # NOTE: Discarded selects will default to 1. So if no month select is available, January will be assumed.
160
+ #
161
+ # ==== Examples
162
+ # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
163
+ # date_select("post", "written_on")
164
+ #
165
+ # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
166
+ # # with the year in the year drop down box starting at 1995.
167
+ # date_select("post", "written_on", :start_year => 1995)
168
+ #
169
+ # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute,
170
+ # # with the year in the year drop down box starting at 1995, numbers used for months instead of words,
171
+ # # and without a day select box.
172
+ # date_select("post", "written_on", :start_year => 1995, :use_month_numbers => true,
173
+ # :discard_day => true, :include_blank => true)
174
+ #
175
+ # # Generates a date select that when POSTed is stored in the post variable, in the written_on attribute
176
+ # # with the fields ordered as day, month, year rather than month, day, year.
177
+ # date_select("post", "written_on", :order => [:day, :month, :year])
178
+ #
179
+ # # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
180
+ # # lacking a year field.
181
+ # date_select("user", "birthday", :order => [:month, :day])
182
+ #
183
+ # # Generates a date select that when POSTed is stored in the user variable, in the birthday attribute
184
+ # # which is initially set to the date 3 days from the current date
185
+ # date_select("post", "written_on", :default => 3.days.from_now)
186
+ #
187
+ # # Generates a date select that when POSTed is stored in the credit_card variable, in the bill_due attribute
188
+ # # that will have a default day of 20.
189
+ # date_select("credit_card", "bill_due", :default => { :day => 20 })
190
+ #
191
+ # # Generates a date select with custom prompts
192
+ # date_select("post", "written_on", :prompt => { :day => 'Select day', :month => 'Select month', :year => 'Select year' })
193
+ #
194
+ # The selects are prepared for multi-parameter assignment to an Active Record object.
195
+ #
196
+ # Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that
197
+ # all month choices are valid.
198
+ def date_select(object_name, method, options = {}, html_options = {})
199
+ InstanceTag.new(object_name, method, self, options.delete(:object)).to_date_select_tag(options, html_options)
200
+ end
201
+
202
+ # Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a
203
+ # specified time-based attribute (identified by +method+) on an object assigned to the template (identified by
204
+ # +object+). You can include the seconds with <tt>:include_seconds</tt>.
205
+ #
206
+ # This method will also generate 3 input hidden tags, for the actual year, month and day unless the option
207
+ # <tt>:ignore_date</tt> is set to +true+.
208
+ #
209
+ # If anything is passed in the html_options hash it will be applied to every select tag in the set.
210
+ #
211
+ # ==== Examples
212
+ # # Creates a time select tag that, when POSTed, will be stored in the post variable in the sunrise attribute
213
+ # time_select("post", "sunrise")
214
+ #
215
+ # # Creates a time select tag that, when POSTed, will be stored in the order variable in the submitted
216
+ # # attribute
217
+ # time_select("order", "submitted")
218
+ #
219
+ # # Creates a time select tag that, when POSTed, will be stored in the mail variable in the sent_at attribute
220
+ # time_select("mail", "sent_at")
221
+ #
222
+ # # Creates a time select tag with a seconds field that, when POSTed, will be stored in the post variables in
223
+ # # the sunrise attribute.
224
+ # time_select("post", "start_time", :include_seconds => true)
225
+ #
226
+ # # Creates a time select tag with a seconds field that, when POSTed, will be stored in the entry variables in
227
+ # # the submission_time attribute.
228
+ # time_select("entry", "submission_time", :include_seconds => true)
229
+ #
230
+ # # You can set the :minute_step to 15 which will give you: 00, 15, 30 and 45.
231
+ # time_select 'game', 'game_time', {:minute_step => 15}
232
+ #
233
+ # # Creates a time select tag with a custom prompt. Use :prompt => true for generic prompts.
234
+ # time_select("post", "written_on", :prompt => {:hour => 'Choose hour', :minute => 'Choose minute', :second => 'Choose seconds'})
235
+ # time_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
236
+ # time_select("post", "written_on", :prompt => true) # generic prompts for all
237
+ #
238
+ # The selects are prepared for multi-parameter assignment to an Active Record object.
239
+ #
240
+ # Note: If the day is not included as an option but the month is, the day will be set to the 1st to ensure that
241
+ # all month choices are valid.
242
+ def time_select(object_name, method, options = {}, html_options = {})
243
+ InstanceTag.new(object_name, method, self, options.delete(:object)).to_time_select_tag(options, html_options)
244
+ end
245
+
246
+ # Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a
247
+ # specified datetime-based attribute (identified by +method+) on an object assigned to the template (identified
248
+ # by +object+). Examples:
249
+ #
250
+ # If anything is passed in the html_options hash it will be applied to every select tag in the set.
251
+ #
252
+ # ==== Examples
253
+ # # Generates a datetime select that, when POSTed, will be stored in the post variable in the written_on
254
+ # # attribute
255
+ # datetime_select("post", "written_on")
256
+ #
257
+ # # Generates a datetime select with a year select that starts at 1995 that, when POSTed, will be stored in the
258
+ # # post variable in the written_on attribute.
259
+ # datetime_select("post", "written_on", :start_year => 1995)
260
+ #
261
+ # # Generates a datetime select with a default value of 3 days from the current time that, when POSTed, will
262
+ # # be stored in the trip variable in the departing attribute.
263
+ # datetime_select("trip", "departing", :default => 3.days.from_now)
264
+ #
265
+ # # Generates a datetime select that discards the type that, when POSTed, will be stored in the post variable
266
+ # # as the written_on attribute.
267
+ # datetime_select("post", "written_on", :discard_type => true)
268
+ #
269
+ # # Generates a datetime select with a custom prompt. Use :prompt=>true for generic prompts.
270
+ # datetime_select("post", "written_on", :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
271
+ # datetime_select("post", "written_on", :prompt => {:hour => true}) # generic prompt for hours
272
+ # datetime_select("post", "written_on", :prompt => true) # generic prompts for all
273
+ #
274
+ # The selects are prepared for multi-parameter assignment to an Active Record object.
275
+ def datetime_select(object_name, method, options = {}, html_options = {})
276
+ InstanceTag.new(object_name, method, self, options.delete(:object)).to_datetime_select_tag(options, html_options)
277
+ end
278
+
279
+ # Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the
280
+ # +datetime+. It's also possible to explicitly set the order of the tags using the <tt>:order</tt> option with
281
+ # an array of symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not
282
+ # supply a Symbol, it will be appended onto the <tt>:order</tt> passed in. You can also add
283
+ # <tt>:date_separator</tt>, <tt>:datetime_separator</tt> and <tt>:time_separator</tt> keys to the +options+ to
284
+ # control visual display of the elements.
285
+ #
286
+ # If anything is passed in the html_options hash it will be applied to every select tag in the set.
287
+ #
288
+ # ==== Examples
289
+ # my_date_time = Time.now + 4.days
290
+ #
291
+ # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
292
+ # select_datetime(my_date_time)
293
+ #
294
+ # # Generates a datetime select that defaults to today (no specified datetime)
295
+ # select_datetime()
296
+ #
297
+ # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
298
+ # # with the fields ordered year, month, day rather than month, day, year.
299
+ # select_datetime(my_date_time, :order => [:year, :month, :day])
300
+ #
301
+ # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
302
+ # # with a '/' between each date field.
303
+ # select_datetime(my_date_time, :date_separator => '/')
304
+ #
305
+ # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
306
+ # # with a date fields separated by '/', time fields separated by '' and the date and time fields
307
+ # # separated by a comma (',').
308
+ # select_datetime(my_date_time, :date_separator => '/', :time_separator => '', :datetime_separator => ',')
309
+ #
310
+ # # Generates a datetime select that discards the type of the field and defaults to the datetime in
311
+ # # my_date_time (four days after today)
312
+ # select_datetime(my_date_time, :discard_type => true)
313
+ #
314
+ # # Generates a datetime select that defaults to the datetime in my_date_time (four days after today)
315
+ # # prefixed with 'payday' rather than 'date'
316
+ # select_datetime(my_date_time, :prefix => 'payday')
317
+ #
318
+ # # Generates a datetime select with a custom prompt. Use :prompt=>true for generic prompts.
319
+ # select_datetime(my_date_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
320
+ # select_datetime(my_date_time, :prompt => {:hour => true}) # generic prompt for hours
321
+ # select_datetime(my_date_time, :prompt => true) # generic prompts for all
322
+ #
323
+ def select_datetime(datetime = Time.current, options = {}, html_options = {})
324
+ DateTimeSelector.new(datetime, options, html_options).select_datetime
325
+ end
326
+
327
+ # Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+.
328
+ # It's possible to explicitly set the order of the tags using the <tt>:order</tt> option with an array of
329
+ # symbols <tt>:year</tt>, <tt>:month</tt> and <tt>:day</tt> in the desired order. If you do not supply a Symbol,
330
+ # it will be appended onto the <tt>:order</tt> passed in.
331
+ #
332
+ # If anything is passed in the html_options hash it will be applied to every select tag in the set.
333
+ #
334
+ # ==== Examples
335
+ # my_date = Time.today + 6.days
336
+ #
337
+ # # Generates a date select that defaults to the date in my_date (six days after today)
338
+ # select_date(my_date)
339
+ #
340
+ # # Generates a date select that defaults to today (no specified date)
341
+ # select_date()
342
+ #
343
+ # # Generates a date select that defaults to the date in my_date (six days after today)
344
+ # # with the fields ordered year, month, day rather than month, day, year.
345
+ # select_date(my_date, :order => [:year, :month, :day])
346
+ #
347
+ # # Generates a date select that discards the type of the field and defaults to the date in
348
+ # # my_date (six days after today)
349
+ # select_date(my_date, :discard_type => true)
350
+ #
351
+ # # Generates a date select that defaults to the date in my_date,
352
+ # # which has fields separated by '/'
353
+ # select_date(my_date, :date_separator => '/')
354
+ #
355
+ # # Generates a date select that defaults to the datetime in my_date (six days after today)
356
+ # # prefixed with 'payday' rather than 'date'
357
+ # select_date(my_date, :prefix => 'payday')
358
+ #
359
+ # # Generates a date select with a custom prompt. Use :prompt=>true for generic prompts.
360
+ # select_date(my_date, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
361
+ # select_date(my_date, :prompt => {:hour => true}) # generic prompt for hours
362
+ # select_date(my_date, :prompt => true) # generic prompts for all
363
+ #
364
+ def select_date(date = Date.current, options = {}, html_options = {})
365
+ DateTimeSelector.new(date, options, html_options).select_date
366
+ end
367
+
368
+ # Returns a set of html select-tags (one for hour and minute)
369
+ # You can set <tt>:time_separator</tt> key to format the output, and
370
+ # the <tt>:include_seconds</tt> option to include an input for seconds.
371
+ #
372
+ # If anything is passed in the html_options hash it will be applied to every select tag in the set.
373
+ #
374
+ # ==== Examples
375
+ # my_time = Time.now + 5.days + 7.hours + 3.minutes + 14.seconds
376
+ #
377
+ # # Generates a time select that defaults to the time in my_time
378
+ # select_time(my_time)
379
+ #
380
+ # # Generates a time select that defaults to the current time (no specified time)
381
+ # select_time()
382
+ #
383
+ # # Generates a time select that defaults to the time in my_time,
384
+ # # which has fields separated by ':'
385
+ # select_time(my_time, :time_separator => ':')
386
+ #
387
+ # # Generates a time select that defaults to the time in my_time,
388
+ # # that also includes an input for seconds
389
+ # select_time(my_time, :include_seconds => true)
390
+ #
391
+ # # Generates a time select that defaults to the time in my_time, that has fields
392
+ # # separated by ':' and includes an input for seconds
393
+ # select_time(my_time, :time_separator => ':', :include_seconds => true)
394
+ #
395
+ # # Generates a time select with a custom prompt. Use :prompt=>true for generic prompts.
396
+ # select_time(my_time, :prompt => {:day => 'Choose day', :month => 'Choose month', :year => 'Choose year'})
397
+ # select_time(my_time, :prompt => {:hour => true}) # generic prompt for hours
398
+ # select_time(my_time, :prompt => true) # generic prompts for all
399
+ #
400
+ def select_time(datetime = Time.current, options = {}, html_options = {})
401
+ DateTimeSelector.new(datetime, options, html_options).select_time
402
+ end
403
+
404
+ # Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
405
+ # The <tt>second</tt> can also be substituted for a second number.
406
+ # Override the field name using the <tt>:field_name</tt> option, 'second' by default.
407
+ #
408
+ # ==== Examples
409
+ # my_time = Time.now + 16.minutes
410
+ #
411
+ # # Generates a select field for seconds that defaults to the seconds for the time in my_time
412
+ # select_second(my_time)
413
+ #
414
+ # # Generates a select field for seconds that defaults to the number given
415
+ # select_second(33)
416
+ #
417
+ # # Generates a select field for seconds that defaults to the seconds for the time in my_time
418
+ # # that is named 'interval' rather than 'second'
419
+ # select_second(my_time, :field_name => 'interval')
420
+ #
421
+ # # Generates a select field for seconds with a custom prompt. Use :prompt=>true for a
422
+ # # generic prompt.
423
+ # select_minute(14, :prompt => 'Choose seconds')
424
+ #
425
+ def select_second(datetime, options = {}, html_options = {})
426
+ DateTimeSelector.new(datetime, options, html_options).select_second
427
+ end
428
+
429
+ # Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
430
+ # Also can return a select tag with options by <tt>minute_step</tt> from 0 through 59 with the 00 minute
431
+ # selected. The <tt>minute</tt> can also be substituted for a minute number.
432
+ # Override the field name using the <tt>:field_name</tt> option, 'minute' by default.
433
+ #
434
+ # ==== Examples
435
+ # my_time = Time.now + 6.hours
436
+ #
437
+ # # Generates a select field for minutes that defaults to the minutes for the time in my_time
438
+ # select_minute(my_time)
439
+ #
440
+ # # Generates a select field for minutes that defaults to the number given
441
+ # select_minute(14)
442
+ #
443
+ # # Generates a select field for minutes that defaults to the minutes for the time in my_time
444
+ # # that is named 'stride' rather than 'second'
445
+ # select_minute(my_time, :field_name => 'stride')
446
+ #
447
+ # # Generates a select field for minutes with a custom prompt. Use :prompt=>true for a
448
+ # # generic prompt.
449
+ # select_minute(14, :prompt => 'Choose minutes')
450
+ #
451
+ def select_minute(datetime, options = {}, html_options = {})
452
+ DateTimeSelector.new(datetime, options, html_options).select_minute
453
+ end
454
+
455
+ # Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
456
+ # The <tt>hour</tt> can also be substituted for a hour number.
457
+ # Override the field name using the <tt>:field_name</tt> option, 'hour' by default.
458
+ #
459
+ # ==== Examples
460
+ # my_time = Time.now + 6.hours
461
+ #
462
+ # # Generates a select field for hours that defaults to the hour for the time in my_time
463
+ # select_hour(my_time)
464
+ #
465
+ # # Generates a select field for hours that defaults to the number given
466
+ # select_hour(13)
467
+ #
468
+ # # Generates a select field for hours that defaults to the minutes for the time in my_time
469
+ # # that is named 'stride' rather than 'second'
470
+ # select_hour(my_time, :field_name => 'stride')
471
+ #
472
+ # # Generates a select field for hours with a custom prompt. Use :prompt => true for a
473
+ # # generic prompt.
474
+ # select_hour(13, :prompt =>'Choose hour')
475
+ #
476
+ def select_hour(datetime, options = {}, html_options = {})
477
+ DateTimeSelector.new(datetime, options, html_options).select_hour
478
+ end
479
+
480
+ # Returns a select tag with options for each of the days 1 through 31 with the current day selected.
481
+ # The <tt>date</tt> can also be substituted for a hour number.
482
+ # Override the field name using the <tt>:field_name</tt> option, 'day' by default.
483
+ #
484
+ # ==== Examples
485
+ # my_date = Time.today + 2.days
486
+ #
487
+ # # Generates a select field for days that defaults to the day for the date in my_date
488
+ # select_day(my_time)
489
+ #
490
+ # # Generates a select field for days that defaults to the number given
491
+ # select_day(5)
492
+ #
493
+ # # Generates a select field for days that defaults to the day for the date in my_date
494
+ # # that is named 'due' rather than 'day'
495
+ # select_day(my_time, :field_name => 'due')
496
+ #
497
+ # # Generates a select field for days with a custom prompt. Use :prompt => true for a
498
+ # # generic prompt.
499
+ # select_day(5, :prompt => 'Choose day')
500
+ #
501
+ def select_day(date, options = {}, html_options = {})
502
+ DateTimeSelector.new(date, options, html_options).select_day
503
+ end
504
+
505
+ # Returns a select tag with options for each of the months January through December with the current month
506
+ # selected. The month names are presented as keys (what's shown to the user) and the month numbers (1-12) are
507
+ # used as values (what's submitted to the server). It's also possible to use month numbers for the presentation
508
+ # instead of names -- set the <tt>:use_month_numbers</tt> key in +options+ to true for this to happen. If you
509
+ # want both numbers and names, set the <tt>:add_month_numbers</tt> key in +options+ to true. If you would prefer
510
+ # to show month names as abbreviations, set the <tt>:use_short_month</tt> key in +options+ to true. If you want
511
+ # to use your own month names, set the <tt>:use_month_names</tt> key in +options+ to an array of 12 month names.
512
+ # Override the field name using the <tt>:field_name</tt> option, 'month' by default.
513
+ #
514
+ # ==== Examples
515
+ # # Generates a select field for months that defaults to the current month that
516
+ # # will use keys like "January", "March".
517
+ # select_month(Date.today)
518
+ #
519
+ # # Generates a select field for months that defaults to the current month that
520
+ # # is named "start" rather than "month"
521
+ # select_month(Date.today, :field_name => 'start')
522
+ #
523
+ # # Generates a select field for months that defaults to the current month that
524
+ # # will use keys like "1", "3".
525
+ # select_month(Date.today, :use_month_numbers => true)
526
+ #
527
+ # # Generates a select field for months that defaults to the current month that
528
+ # # will use keys like "1 - January", "3 - March".
529
+ # select_month(Date.today, :add_month_numbers => true)
530
+ #
531
+ # # Generates a select field for months that defaults to the current month that
532
+ # # will use keys like "Jan", "Mar".
533
+ # select_month(Date.today, :use_short_month => true)
534
+ #
535
+ # # Generates a select field for months that defaults to the current month that
536
+ # # will use keys like "Januar", "Marts."
537
+ # select_month(Date.today, :use_month_names => %w(Januar Februar Marts ...))
538
+ #
539
+ # # Generates a select field for months with a custom prompt. Use :prompt => true for a
540
+ # # generic prompt.
541
+ # select_month(14, :prompt => 'Choose month')
542
+ #
543
+ def select_month(date, options = {}, html_options = {})
544
+ DateTimeSelector.new(date, options, html_options).select_month
545
+ end
546
+
547
+ # Returns a select tag with options for each of the five years on each side of the current, which is selected.
548
+ # The five year radius can be changed using the <tt>:start_year</tt> and <tt>:end_year</tt> keys in the
549
+ # +options+. Both ascending and descending year lists are supported by making <tt>:start_year</tt> less than or
550
+ # greater than <tt>:end_year</tt>. The <tt>date</tt> can also be substituted for a year given as a number.
551
+ # Override the field name using the <tt>:field_name</tt> option, 'year' by default.
552
+ #
553
+ # ==== Examples
554
+ # # Generates a select field for years that defaults to the current year that
555
+ # # has ascending year values
556
+ # select_year(Date.today, :start_year => 1992, :end_year => 2007)
557
+ #
558
+ # # Generates a select field for years that defaults to the current year that
559
+ # # is named 'birth' rather than 'year'
560
+ # select_year(Date.today, :field_name => 'birth')
561
+ #
562
+ # # Generates a select field for years that defaults to the current year that
563
+ # # has descending year values
564
+ # select_year(Date.today, :start_year => 2005, :end_year => 1900)
565
+ #
566
+ # # Generates a select field for years that defaults to the year 2006 that
567
+ # # has ascending year values
568
+ # select_year(2006, :start_year => 2000, :end_year => 2010)
569
+ #
570
+ # # Generates a select field for years with a custom prompt. Use :prompt => true for a
571
+ # # generic prompt.
572
+ # select_year(14, :prompt => 'Choose year')
573
+ #
574
+ def select_year(date, options = {}, html_options = {})
575
+ DateTimeSelector.new(date, options, html_options).select_year
576
+ end
577
+ end
578
+
579
+ class DateTimeSelector #:nodoc:
580
+ extend ActiveSupport::Memoizable
581
+ include ActionView::Helpers::TagHelper
582
+
583
+ DEFAULT_PREFIX = 'date'.freeze unless const_defined?('DEFAULT_PREFIX')
584
+ POSITION = {
585
+ :year => 1, :month => 2, :day => 3, :hour => 4, :minute => 5, :second => 6
586
+ }.freeze unless const_defined?('POSITION')
587
+
588
+ def initialize(datetime, options = {}, html_options = {})
589
+ @options = options.dup
590
+ @html_options = html_options.dup
591
+ @datetime = datetime
592
+ end
593
+
594
+ def select_datetime
595
+ # TODO: Remove tag conditional
596
+ # Ideally we could just join select_date and select_date for the tag case
597
+ if @options[:tag] && @options[:ignore_date]
598
+ select_time
599
+ elsif @options[:tag]
600
+ order = date_order.dup
601
+ order -= [:hour, :minute, :second]
602
+
603
+ @options[:discard_year] ||= true unless order.include?(:year)
604
+ @options[:discard_month] ||= true unless order.include?(:month)
605
+ @options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day)
606
+ @options[:discard_minute] ||= true if @options[:discard_hour]
607
+ @options[:discard_second] ||= true unless @options[:include_seconds] && !@options[:discard_minute]
608
+
609
+ # If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
610
+ # valid (otherwise it could be 31 and february wouldn't be a valid date)
611
+ if @datetime && @options[:discard_day] && !@options[:discard_month]
612
+ @datetime = @datetime.change(:day => 1)
613
+ end
614
+
615
+ [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
616
+ order += [:hour, :minute, :second] unless @options[:discard_hour]
617
+
618
+ build_selects_from_types(order)
619
+ else
620
+ "#{select_date}#{@options[:datetime_separator]}#{select_time}".html_safe
621
+ end
622
+ end
623
+
624
+ def select_date
625
+ order = date_order.dup
626
+
627
+ # TODO: Remove tag conditional
628
+ if @options[:tag]
629
+ @options[:discard_hour] = true
630
+ @options[:discard_minute] = true
631
+ @options[:discard_second] = true
632
+
633
+ @options[:discard_year] ||= true unless order.include?(:year)
634
+ @options[:discard_month] ||= true unless order.include?(:month)
635
+ @options[:discard_day] ||= true if @options[:discard_month] || !order.include?(:day)
636
+
637
+ # If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
638
+ # valid (otherwise it could be 31 and february wouldn't be a valid date)
639
+ if @datetime && @options[:discard_day] && !@options[:discard_month]
640
+ @datetime = @datetime.change(:day => 1)
641
+ end
642
+ end
643
+
644
+ [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
645
+
646
+ build_selects_from_types(order)
647
+ end
648
+
649
+ def select_time
650
+ order = []
651
+
652
+ # TODO: Remove tag conditional
653
+ if @options[:tag]
654
+ @options[:discard_month] = true
655
+ @options[:discard_year] = true
656
+ @options[:discard_day] = true
657
+ @options[:discard_second] ||= true unless @options[:include_seconds]
658
+
659
+ order += [:year, :month, :day] unless @options[:ignore_date]
660
+ end
661
+
662
+ order += [:hour, :minute]
663
+ order << :second if @options[:include_seconds]
664
+
665
+ build_selects_from_types(order)
666
+ end
667
+
668
+ def select_second
669
+ if @options[:use_hidden] || @options[:discard_second]
670
+ build_hidden(:second, sec) if @options[:include_seconds]
671
+ else
672
+ build_options_and_select(:second, sec)
673
+ end
674
+ end
675
+
676
+ def select_minute
677
+ if @options[:use_hidden] || @options[:discard_minute]
678
+ build_hidden(:minute, min)
679
+ else
680
+ build_options_and_select(:minute, min, :step => @options[:minute_step])
681
+ end
682
+ end
683
+
684
+ def select_hour
685
+ if @options[:use_hidden] || @options[:discard_hour]
686
+ build_hidden(:hour, hour)
687
+ else
688
+ build_options_and_select(:hour, hour, :end => 23)
689
+ end
690
+ end
691
+
692
+ def select_day
693
+ if @options[:use_hidden] || @options[:discard_day]
694
+ build_hidden(:day, day)
695
+ else
696
+ build_options_and_select(:day, day, :start => 1, :end => 31, :leading_zeros => false)
697
+ end
698
+ end
699
+
700
+ def select_month
701
+ if @options[:use_hidden] || @options[:discard_month]
702
+ build_hidden(:month, month)
703
+ else
704
+ month_options = []
705
+ 1.upto(12) do |month_number|
706
+ options = { :value => month_number }
707
+ options[:selected] = "selected" if month == month_number
708
+ month_options << content_tag(:option, month_name(month_number), options) + "\n"
709
+ end
710
+ build_select(:month, month_options.join)
711
+ end
712
+ end
713
+
714
+ def select_year
715
+ if !@datetime || @datetime == 0
716
+ val = ''
717
+ middle_year = Date.today.year
718
+ else
719
+ val = middle_year = year
720
+ end
721
+
722
+ if @options[:use_hidden] || @options[:discard_year]
723
+ build_hidden(:year, val)
724
+ else
725
+ options = {}
726
+ options[:start] = @options[:start_year] || middle_year - 5
727
+ options[:end] = @options[:end_year] || middle_year + 5
728
+ options[:step] = options[:start] < options[:end] ? 1 : -1
729
+ options[:leading_zeros] = false
730
+
731
+ build_options_and_select(:year, val, options)
732
+ end
733
+ end
734
+
735
+ private
736
+ %w( sec min hour day month year ).each do |method|
737
+ define_method(method) do
738
+ @datetime.kind_of?(Fixnum) ? @datetime : @datetime.send(method) if @datetime
739
+ end
740
+ end
741
+
742
+ # Returns translated month names, but also ensures that a custom month
743
+ # name array has a leading nil element
744
+ def month_names
745
+ month_names = @options[:use_month_names] || translated_month_names
746
+ month_names.unshift(nil) if month_names.size < 13
747
+ month_names
748
+ end
749
+ memoize :month_names
750
+
751
+ # Returns translated month names
752
+ # => [nil, "January", "February", "March",
753
+ # "April", "May", "June", "July",
754
+ # "August", "September", "October",
755
+ # "November", "December"]
756
+ #
757
+ # If :use_short_month option is set
758
+ # => [nil, "Jan", "Feb", "Mar", "Apr", "May", "Jun",
759
+ # "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
760
+ def translated_month_names
761
+ begin
762
+ key = @options[:use_short_month] ? :'date.abbr_month_names' : :'date.month_names'
763
+ I18n.translate(key, :locale => @options[:locale])
764
+ end
765
+ end
766
+
767
+ # Lookup month name for number
768
+ # month_name(1) => "January"
769
+ #
770
+ # If :use_month_numbers option is passed
771
+ # month_name(1) => 1
772
+ #
773
+ # If :add_month_numbers option is passed
774
+ # month_name(1) => "1 - January"
775
+ def month_name(number)
776
+ if @options[:use_month_numbers]
777
+ number
778
+ elsif @options[:add_month_numbers]
779
+ "#{number} - #{month_names[number]}"
780
+ else
781
+ month_names[number]
782
+ end
783
+ end
784
+
785
+ def date_order
786
+ @options[:order] || translated_date_order
787
+ end
788
+ memoize :date_order
789
+
790
+ def translated_date_order
791
+ begin
792
+ I18n.translate(:'date.order', :locale => @options[:locale]) || []
793
+ end
794
+ end
795
+
796
+ # Build full select tag from date type and options
797
+ def build_options_and_select(type, selected, options = {})
798
+ build_select(type, build_options(selected, options))
799
+ end
800
+
801
+ # Build select option html from date value and options
802
+ # build_options(15, :start => 1, :end => 31)
803
+ # => "<option value="1">1</option>
804
+ # <option value=\"2\">2</option>
805
+ # <option value=\"3\">3</option>..."
806
+ def build_options(selected, options = {})
807
+ start = options.delete(:start) || 0
808
+ stop = options.delete(:end) || 59
809
+ step = options.delete(:step) || 1
810
+ leading_zeros = options.delete(:leading_zeros).nil? ? true : false
811
+
812
+ select_options = []
813
+ start.step(stop, step) do |i|
814
+ value = leading_zeros ? sprintf("%02d", i) : i
815
+ tag_options = { :value => value }
816
+ tag_options[:selected] = "selected" if selected == i
817
+ select_options << content_tag(:option, value, tag_options)
818
+ end
819
+ (select_options.join("\n") + "\n").html_safe
820
+ end
821
+
822
+ # Builds select tag from date type and html select options
823
+ # build_select(:month, "<option value="1">January</option>...")
824
+ # => "<select id="post_written_on_2i" name="post[written_on(2i)]">
825
+ # <option value="1">January</option>...
826
+ # </select>"
827
+ def build_select(type, select_options_as_html)
828
+ select_options = {
829
+ :id => input_id_from_type(type),
830
+ :name => input_name_from_type(type)
831
+ }.merge(@html_options)
832
+ select_options.merge!(:disabled => 'disabled') if @options[:disabled]
833
+
834
+ select_html = "\n"
835
+ select_html << content_tag(:option, '', :value => '') + "\n" if @options[:include_blank]
836
+ select_html << prompt_option_tag(type, @options[:prompt]) + "\n" if @options[:prompt]
837
+ select_html << select_options_as_html
838
+
839
+ (content_tag(:select, select_html.html_safe, select_options) + "\n").html_safe
840
+ end
841
+
842
+ # Builds a prompt option tag with supplied options or from default options
843
+ # prompt_option_tag(:month, :prompt => 'Select month')
844
+ # => "<option value="">Select month</option>"
845
+ def prompt_option_tag(type, options)
846
+ default_options = {:year => false, :month => false, :day => false, :hour => false, :minute => false, :second => false}
847
+
848
+ case options
849
+ when Hash
850
+ prompt = default_options.merge(options)[type.to_sym]
851
+ when String
852
+ prompt = options
853
+ else
854
+ prompt = I18n.translate(('datetime.prompts.' + type.to_s).to_sym, :locale => @options[:locale])
855
+ end
856
+
857
+ prompt ? content_tag(:option, prompt, :value => '') : ''
858
+ end
859
+
860
+ # Builds hidden input tag for date part and value
861
+ # build_hidden(:year, 2008)
862
+ # => "<input id="post_written_on_1i" name="post[written_on(1i)]" type="hidden" value="2008" />"
863
+ def build_hidden(type, value)
864
+ (tag(:input, {
865
+ :type => "hidden",
866
+ :id => input_id_from_type(type),
867
+ :name => input_name_from_type(type),
868
+ :value => value
869
+ }.merge(@html_options.slice(:disabled))) + "\n").html_safe
870
+ end
871
+
872
+ # Returns the name attribute for the input tag
873
+ # => post[written_on(1i)]
874
+ def input_name_from_type(type)
875
+ prefix = @options[:prefix] || ActionView::Helpers::DateTimeSelector::DEFAULT_PREFIX
876
+ prefix += "[#{@options[:index]}]" if @options.has_key?(:index)
877
+
878
+ field_name = @options[:field_name] || type
879
+ if @options[:include_position]
880
+ field_name += "(#{ActionView::Helpers::DateTimeSelector::POSITION[type]}i)"
881
+ end
882
+
883
+ @options[:discard_type] ? prefix : "#{prefix}[#{field_name}]"
884
+ end
885
+
886
+ # Returns the id attribute for the input tag
887
+ # => "post_written_on_1i"
888
+ def input_id_from_type(type)
889
+ input_name_from_type(type).gsub(/([\[\(])|(\]\[)/, '_').gsub(/[\]\)]/, '')
890
+ end
891
+
892
+ # Given an ordering of datetime components, create the selection HTML
893
+ # and join them with their appropriate separators.
894
+ def build_selects_from_types(order)
895
+ select = ''
896
+ order.reverse.each do |type|
897
+ separator = separator(type) unless type == order.first # don't add on last field
898
+ select.insert(0, separator.to_s + send("select_#{type}").to_s)
899
+ end
900
+ select.html_safe
901
+ end
902
+
903
+ # Returns the separator for a given datetime component
904
+ def separator(type)
905
+ case type
906
+ when :month, :day
907
+ @options[:date_separator]
908
+ when :hour
909
+ (@options[:discard_year] && @options[:discard_day]) ? "" : @options[:datetime_separator]
910
+ when :minute
911
+ @options[:discard_minute] ? "" : @options[:time_separator]
912
+ when :second
913
+ @options[:include_seconds] ? @options[:time_separator] : ""
914
+ end
915
+ end
916
+ end
917
+
918
+ class InstanceTag #:nodoc:
919
+ def to_date_select_tag(options = {}, html_options = {})
920
+ datetime_selector(options, html_options).select_date.html_safe
921
+ end
922
+
923
+ def to_time_select_tag(options = {}, html_options = {})
924
+ datetime_selector(options, html_options).select_time.html_safe
925
+ end
926
+
927
+ def to_datetime_select_tag(options = {}, html_options = {})
928
+ datetime_selector(options, html_options).select_datetime.html_safe
929
+ end
930
+
931
+ private
932
+ def datetime_selector(options, html_options)
933
+ datetime = value(object) || default_datetime(options)
934
+
935
+ options = options.dup
936
+ options[:field_name] = @method_name
937
+ options[:include_position] = true
938
+ options[:prefix] ||= @object_name
939
+ options[:index] = @auto_index if defined?(@auto_index) && @auto_index && !options.has_key?(:index)
940
+ options[:datetime_separator] ||= ' &mdash; '
941
+ options[:time_separator] ||= ' : '
942
+
943
+ DateTimeSelector.new(datetime, options.merge(:tag => true), html_options)
944
+ end
945
+
946
+ def default_datetime(options)
947
+ return if options[:include_blank] || options[:prompt]
948
+
949
+ case options[:default]
950
+ when nil
951
+ Time.current
952
+ when Date, Time
953
+ options[:default]
954
+ else
955
+ default = options[:default].dup
956
+
957
+ # Rename :minute and :second to :min and :sec
958
+ default[:min] ||= default[:minute]
959
+ default[:sec] ||= default[:second]
960
+
961
+ time = Time.current
962
+
963
+ [:year, :month, :day, :hour, :min, :sec].each do |key|
964
+ default[key] ||= time.send(key)
965
+ end
966
+
967
+ Time.utc_time(
968
+ default[:year], default[:month], default[:day],
969
+ default[:hour], default[:min], default[:sec]
970
+ )
971
+ end
972
+ end
973
+ end
974
+
975
+ class FormBuilder
976
+ def date_select(method, options = {}, html_options = {})
977
+ @template.date_select(@object_name, method, objectify_options(options), html_options)
978
+ end
979
+
980
+ def time_select(method, options = {}, html_options = {})
981
+ @template.time_select(@object_name, method, objectify_options(options), html_options)
982
+ end
983
+
984
+ def datetime_select(method, options = {}, html_options = {})
985
+ @template.datetime_select(@object_name, method, objectify_options(options), html_options)
986
+ end
987
+ end
988
+ end
989
+ end