actionpack-rack-upgrade-2 2.3.15

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 (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 +495 -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 +120 -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 +597 -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,61 @@
1
+ module ActionView #:nodoc:
2
+ module Helpers #:nodoc:
3
+ autoload :ActiveRecordHelper, 'action_view/helpers/active_record_helper'
4
+ autoload :AssetTagHelper, 'action_view/helpers/asset_tag_helper'
5
+ autoload :AtomFeedHelper, 'action_view/helpers/atom_feed_helper'
6
+ autoload :BenchmarkHelper, 'action_view/helpers/benchmark_helper'
7
+ autoload :CacheHelper, 'action_view/helpers/cache_helper'
8
+ autoload :CaptureHelper, 'action_view/helpers/capture_helper'
9
+ autoload :CsrfHelper, 'action_view/helpers/csrf_helper'
10
+ autoload :DateHelper, 'action_view/helpers/date_helper'
11
+ autoload :DebugHelper, 'action_view/helpers/debug_helper'
12
+ autoload :FormHelper, 'action_view/helpers/form_helper'
13
+ autoload :FormOptionsHelper, 'action_view/helpers/form_options_helper'
14
+ autoload :FormTagHelper, 'action_view/helpers/form_tag_helper'
15
+ autoload :JavaScriptHelper, 'action_view/helpers/javascript_helper'
16
+ autoload :NumberHelper, 'action_view/helpers/number_helper'
17
+ autoload :PrototypeHelper, 'action_view/helpers/prototype_helper'
18
+ autoload :RawOutputHelper, 'action_view/helpers/raw_output_helper'
19
+ autoload :RecordIdentificationHelper, 'action_view/helpers/record_identification_helper'
20
+ autoload :RecordTagHelper, 'action_view/helpers/record_tag_helper'
21
+ autoload :SanitizeHelper, 'action_view/helpers/sanitize_helper'
22
+ autoload :ScriptaculousHelper, 'action_view/helpers/scriptaculous_helper'
23
+ autoload :TagHelper, 'action_view/helpers/tag_helper'
24
+ autoload :TextHelper, 'action_view/helpers/text_helper'
25
+ autoload :TranslationHelper, 'action_view/helpers/translation_helper'
26
+ autoload :UrlHelper, 'action_view/helpers/url_helper'
27
+
28
+ def self.included(base)
29
+ base.extend(ClassMethods)
30
+ end
31
+
32
+ module ClassMethods
33
+ include SanitizeHelper::ClassMethods
34
+ end
35
+
36
+ include ActiveRecordHelper
37
+ include AssetTagHelper
38
+ include AtomFeedHelper
39
+ include BenchmarkHelper
40
+ include CacheHelper
41
+ include CaptureHelper
42
+ include CsrfHelper
43
+ include DateHelper
44
+ include DebugHelper
45
+ include FormHelper
46
+ include FormOptionsHelper
47
+ include FormTagHelper
48
+ include JavaScriptHelper
49
+ include NumberHelper
50
+ include PrototypeHelper
51
+ include RawOutputHelper
52
+ include RecordIdentificationHelper
53
+ include RecordTagHelper
54
+ include SanitizeHelper
55
+ include ScriptaculousHelper
56
+ include TagHelper
57
+ include TextHelper
58
+ include TranslationHelper
59
+ include UrlHelper
60
+ end
61
+ end
@@ -0,0 +1,305 @@
1
+ require 'cgi'
2
+ require 'action_view/helpers/form_helper'
3
+
4
+ module ActionView
5
+ class Base
6
+ @@field_error_proc = Proc.new{ |html_tag, instance| "<div class=\"fieldWithErrors\">#{html_tag}</div>".html_safe }
7
+ cattr_accessor :field_error_proc
8
+ end
9
+
10
+ module Helpers
11
+ # The Active Record Helper makes it easier to create forms for records kept in instance variables. The most far-reaching is the +form+
12
+ # method that creates a complete form for all the basic content types of the record (not associations or aggregations, though). This
13
+ # is a great way of making the record quickly available for editing, but likely to prove lackluster for a complicated real-world form.
14
+ # In that case, it's better to use the +input+ method and the specialized +form+ methods in link:classes/ActionView/Helpers/FormHelper.html
15
+ module ActiveRecordHelper
16
+ # Returns a default input tag for the type of object returned by the method. For example, if <tt>@post</tt>
17
+ # has an attribute +title+ mapped to a +VARCHAR+ column that holds "Hello World":
18
+ #
19
+ # input("post", "title")
20
+ # # => <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
21
+ def input(record_name, method, options = {})
22
+ InstanceTag.new(record_name, method, self).to_tag(options)
23
+ end
24
+
25
+ # Returns an entire form with all needed input tags for a specified Active Record object. For example, if <tt>@post</tt>
26
+ # has attributes named +title+ of type +VARCHAR+ and +body+ of type +TEXT+ then
27
+ #
28
+ # form("post")
29
+ #
30
+ # would yield a form like the following (modulus formatting):
31
+ #
32
+ # <form action='/posts/create' method='post'>
33
+ # <p>
34
+ # <label for="post_title">Title</label><br />
35
+ # <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
36
+ # </p>
37
+ # <p>
38
+ # <label for="post_body">Body</label><br />
39
+ # <textarea cols="40" id="post_body" name="post[body]" rows="20"></textarea>
40
+ # </p>
41
+ # <input name="commit" type="submit" value="Create" />
42
+ # </form>
43
+ #
44
+ # It's possible to specialize the form builder by using a different action name and by supplying another
45
+ # block renderer. For example, if <tt>@entry</tt> has an attribute +message+ of type +VARCHAR+ then
46
+ #
47
+ # form("entry",
48
+ # :action => "sign",
49
+ # :input_block => Proc.new { |record, column|
50
+ # "#{column.human_name}: #{input(record, column.name)}<br />"
51
+ # })
52
+ #
53
+ # would yield a form like the following (modulus formatting):
54
+ #
55
+ # <form action="/entries/sign" method="post">
56
+ # Message:
57
+ # <input id="entry_message" name="entry[message]" size="30" type="text" /><br />
58
+ # <input name="commit" type="submit" value="Sign" />
59
+ # </form>
60
+ #
61
+ # It's also possible to add additional content to the form by giving it a block, such as:
62
+ #
63
+ # form("entry", :action => "sign") do |form|
64
+ # form << content_tag("b", "Department")
65
+ # form << collection_select("department", "id", @departments, "id", "name")
66
+ # end
67
+ #
68
+ # The following options are available:
69
+ #
70
+ # * <tt>:action</tt> - The action used when submitting the form (default: +create+ if a new record, otherwise +update+).
71
+ # * <tt>:input_block</tt> - Specialize the output using a different block, see above.
72
+ # * <tt>:method</tt> - The method used when submitting the form (default: +post+).
73
+ # * <tt>:multipart</tt> - Whether to change the enctype of the form to "multipart/form-data", used when uploading a file (default: +false+).
74
+ # * <tt>:submit_value</tt> - The text of the submit button (default: "Create" if a new record, otherwise "Update").
75
+ def form(record_name, options = {})
76
+ record = instance_variable_get("@#{record_name}")
77
+
78
+ options = options.symbolize_keys
79
+ options[:action] ||= record.new_record? ? "create" : "update"
80
+ action = url_for(:action => options[:action], :id => record)
81
+
82
+ submit_value = options[:submit_value] || options[:action].gsub(/[^\w]/, '').capitalize
83
+
84
+ contents = form_tag({:action => action}, :method =>(options[:method] || 'post'), :enctype => options[:multipart] ? 'multipart/form-data': nil)
85
+ contents.safe_concat hidden_field(record_name, :id) unless record.new_record?
86
+ contents.safe_concat all_input_tags(record, record_name, options)
87
+ yield contents if block_given?
88
+ contents.safe_concat submit_tag(submit_value)
89
+ contents.safe_concat '</form>'
90
+ end
91
+
92
+ # Returns a string containing the error message attached to the +method+ on the +object+ if one exists.
93
+ # This error message is wrapped in a <tt>DIV</tt> tag, which can be extended to include a <tt>:prepend_text</tt>
94
+ # and/or <tt>:append_text</tt> (to properly explain the error), and a <tt>:css_class</tt> to style it
95
+ # accordingly. +object+ should either be the name of an instance variable or the actual object. The method can be
96
+ # passed in either as a string or a symbol.
97
+ # As an example, let's say you have a model <tt>@post</tt> that has an error message on the +title+ attribute:
98
+ #
99
+ # <%= error_message_on "post", "title" %>
100
+ # # => <div class="formError">can't be empty</div>
101
+ #
102
+ # <%= error_message_on @post, :title %>
103
+ # # => <div class="formError">can't be empty</div>
104
+ #
105
+ # <%= error_message_on "post", "title",
106
+ # :prepend_text => "Title simply ",
107
+ # :append_text => " (or it won't work).",
108
+ # :css_class => "inputError" %>
109
+ def error_message_on(object, method, *args)
110
+ options = args.extract_options!
111
+ unless args.empty?
112
+ ActiveSupport::Deprecation.warn('error_message_on takes an option hash instead of separate ' +
113
+ 'prepend_text, append_text, and css_class arguments', caller)
114
+
115
+ options[:prepend_text] = args[0] || ''
116
+ options[:append_text] = args[1] || ''
117
+ options[:css_class] = args[2] || 'formError'
118
+ end
119
+ options.reverse_merge!(:prepend_text => '', :append_text => '', :css_class => 'formError')
120
+
121
+ if (obj = (object.respond_to?(:errors) ? object : instance_variable_get("@#{object}"))) &&
122
+ (errors = obj.errors.on(method))
123
+ content_tag("div",
124
+ "#{options[:prepend_text]}#{ERB::Util.html_escape(errors.is_a?(Array) ? errors.first : errors)}#{options[:append_text]}".html_safe,
125
+ :class => options[:css_class]
126
+ )
127
+ else
128
+ ''
129
+ end
130
+ end
131
+
132
+ # Returns a string with a <tt>DIV</tt> containing all of the error messages for the objects located as instance variables by the names
133
+ # given. If more than one object is specified, the errors for the objects are displayed in the order that the object names are
134
+ # provided.
135
+ #
136
+ # This <tt>DIV</tt> can be tailored by the following options:
137
+ #
138
+ # * <tt>:header_tag</tt> - Used for the header of the error div (default: "h2").
139
+ # * <tt>:id</tt> - The id of the error div (default: "errorExplanation").
140
+ # * <tt>:class</tt> - The class of the error div (default: "errorExplanation").
141
+ # * <tt>:object</tt> - The object (or array of objects) for which to display errors,
142
+ # if you need to escape the instance variable convention.
143
+ # * <tt>:object_name</tt> - The object name to use in the header, or any text that you prefer.
144
+ # If <tt>:object_name</tt> is not set, the name of the first object will be used.
145
+ # * <tt>:header_message</tt> - The message in the header of the error div. Pass +nil+
146
+ # or an empty string to avoid the header message altogether. (Default: "X errors
147
+ # prohibited this object from being saved").
148
+ # * <tt>:message</tt> - The explanation message after the header message and before
149
+ # the error list. Pass +nil+ or an empty string to avoid the explanation message
150
+ # altogether. (Default: "There were problems with the following fields:").
151
+ #
152
+ # To specify the display for one object, you simply provide its name as a parameter.
153
+ # For example, for the <tt>@user</tt> model:
154
+ #
155
+ # error_messages_for 'user'
156
+ #
157
+ # To specify more than one object, you simply list them; optionally, you can add an extra <tt>:object_name</tt> parameter, which
158
+ # will be the name used in the header message:
159
+ #
160
+ # error_messages_for 'user_common', 'user', :object_name => 'user'
161
+ #
162
+ # If the objects cannot be located as instance variables, you can add an extra <tt>:object</tt> parameter which gives the actual
163
+ # object (or array of objects to use):
164
+ #
165
+ # error_messages_for 'user', :object => @question.user
166
+ #
167
+ # NOTE: This is a pre-packaged presentation of the errors with embedded strings and a certain HTML structure. If what
168
+ # you need is significantly different from the default presentation, it makes plenty of sense to access the <tt>object.errors</tt>
169
+ # instance yourself and set it up. View the source of this method to see how easy it is.
170
+ def error_messages_for(*params)
171
+ options = params.extract_options!.symbolize_keys
172
+
173
+ if object = options.delete(:object)
174
+ objects = Array.wrap(object)
175
+ else
176
+ objects = params.collect {|object_name| instance_variable_get("@#{object_name}") }.compact
177
+ end
178
+
179
+ count = objects.inject(0) {|sum, object| sum + object.errors.count }
180
+ unless count.zero?
181
+ html = {}
182
+ [:id, :class].each do |key|
183
+ if options.include?(key)
184
+ value = options[key]
185
+ html[key] = value unless value.blank?
186
+ else
187
+ html[key] = 'errorExplanation'
188
+ end
189
+ end
190
+ options[:object_name] ||= params.first
191
+
192
+ I18n.with_options :locale => options[:locale], :scope => [:activerecord, :errors, :template] do |locale|
193
+ header_message = if options.include?(:header_message)
194
+ options[:header_message]
195
+ else
196
+ object_name = options[:object_name].to_s
197
+ object_name = I18n.t(object_name, :default => object_name.gsub('_', ' '), :scope => [:activerecord, :models], :count => 1)
198
+ locale.t :header, :count => count, :model => object_name
199
+ end
200
+ message = options.include?(:message) ? options[:message] : locale.t(:body)
201
+ error_messages = objects.sum {|object| object.errors.full_messages.map {|msg| content_tag(:li, ERB::Util.html_escape(msg)) } }.join.html_safe
202
+
203
+ contents = ''
204
+ contents << content_tag(options[:header_tag] || :h2, header_message) unless header_message.blank?
205
+ contents << content_tag(:p, message) unless message.blank?
206
+ contents << content_tag(:ul, error_messages)
207
+
208
+ content_tag(:div, contents.html_safe, html)
209
+ end
210
+ else
211
+ ''
212
+ end
213
+ end
214
+
215
+ private
216
+ def all_input_tags(record, record_name, options)
217
+ input_block = options[:input_block] || default_input_block
218
+ record.class.content_columns.collect{ |column| input_block.call(record_name, column) }.join("\n")
219
+ end
220
+
221
+ def default_input_block
222
+ Proc.new { |record, column| %(<p><label for="#{record}_#{column.name}">#{column.human_name}</label><br />#{input(record, column.name)}</p>) }
223
+ end
224
+ end
225
+
226
+ class InstanceTag #:nodoc:
227
+ def to_tag(options = {})
228
+ case column_type
229
+ when :string
230
+ field_type = @method_name.include?("password") ? "password" : "text"
231
+ to_input_field_tag(field_type, options)
232
+ when :text
233
+ to_text_area_tag(options)
234
+ when :integer, :float, :decimal
235
+ to_input_field_tag("text", options)
236
+ when :date
237
+ to_date_select_tag(options)
238
+ when :datetime, :timestamp
239
+ to_datetime_select_tag(options)
240
+ when :time
241
+ to_time_select_tag(options)
242
+ when :boolean
243
+ to_boolean_select_tag(options)
244
+ end
245
+ end
246
+
247
+ alias_method :tag_without_error_wrapping, :tag
248
+ def tag(name, options)
249
+ if object.respond_to?(:errors) && object.errors.respond_to?(:on)
250
+ error_wrapping(tag_without_error_wrapping(name, options), object.errors.on(@method_name))
251
+ else
252
+ tag_without_error_wrapping(name, options)
253
+ end
254
+ end
255
+
256
+ alias_method :content_tag_without_error_wrapping, :content_tag
257
+ def content_tag(name, value, options)
258
+ if object.respond_to?(:errors) && object.errors.respond_to?(:on)
259
+ error_wrapping(content_tag_without_error_wrapping(name, value, options), object.errors.on(@method_name))
260
+ else
261
+ content_tag_without_error_wrapping(name, value, options)
262
+ end
263
+ end
264
+
265
+ alias_method :to_date_select_tag_without_error_wrapping, :to_date_select_tag
266
+ def to_date_select_tag(options = {}, html_options = {})
267
+ if object.respond_to?(:errors) && object.errors.respond_to?(:on)
268
+ error_wrapping(to_date_select_tag_without_error_wrapping(options, html_options), object.errors.on(@method_name))
269
+ else
270
+ to_date_select_tag_without_error_wrapping(options, html_options)
271
+ end
272
+ end
273
+
274
+ alias_method :to_datetime_select_tag_without_error_wrapping, :to_datetime_select_tag
275
+ def to_datetime_select_tag(options = {}, html_options = {})
276
+ if object.respond_to?(:errors) && object.errors.respond_to?(:on)
277
+ error_wrapping(to_datetime_select_tag_without_error_wrapping(options, html_options), object.errors.on(@method_name))
278
+ else
279
+ to_datetime_select_tag_without_error_wrapping(options, html_options)
280
+ end
281
+ end
282
+
283
+ alias_method :to_time_select_tag_without_error_wrapping, :to_time_select_tag
284
+ def to_time_select_tag(options = {}, html_options = {})
285
+ if object.respond_to?(:errors) && object.errors.respond_to?(:on)
286
+ error_wrapping(to_time_select_tag_without_error_wrapping(options, html_options), object.errors.on(@method_name))
287
+ else
288
+ to_time_select_tag_without_error_wrapping(options, html_options)
289
+ end
290
+ end
291
+
292
+ def error_wrapping(html_tag, has_error)
293
+ has_error ? Base.field_error_proc.call(html_tag, self) : html_tag
294
+ end
295
+
296
+ def error_message
297
+ object.errors.on(@method_name)
298
+ end
299
+
300
+ def column_type
301
+ object.send(:column_for_attribute, @method_name).type
302
+ end
303
+ end
304
+ end
305
+ end
@@ -0,0 +1,695 @@
1
+ require 'cgi'
2
+ require 'action_view/helpers/url_helper'
3
+ require 'action_view/helpers/tag_helper'
4
+ require 'thread'
5
+
6
+ module ActionView
7
+ module Helpers #:nodoc:
8
+ # This module provides methods for generating HTML that links views to assets such
9
+ # as images, javascripts, stylesheets, and feeds. These methods do not verify
10
+ # the assets exist before linking to them:
11
+ #
12
+ # image_tag("rails.png")
13
+ # # => <img alt="Rails src="/images/rails.png?1230601161" />
14
+ # stylesheet_link_tag("application")
15
+ # # => <link href="/stylesheets/application.css?1232285206" media="screen" rel="stylesheet" type="text/css" />
16
+ #
17
+ # === Using asset hosts
18
+ #
19
+ # By default, Rails links to these assets on the current host in the public
20
+ # folder, but you can direct Rails to link to assets from a dedicated asset
21
+ # server by setting ActionController::Base.asset_host in the application
22
+ # configuration, typically in <tt>config/environments/production.rb</tt>.
23
+ # For example, you'd define <tt>assets.example.com</tt> to be your asset
24
+ # host this way:
25
+ #
26
+ # ActionController::Base.asset_host = "assets.example.com"
27
+ #
28
+ # Helpers take that into account:
29
+ #
30
+ # image_tag("rails.png")
31
+ # # => <img alt="Rails" src="http://assets.example.com/images/rails.png?1230601161" />
32
+ # stylesheet_link_tag("application")
33
+ # # => <link href="http://assets.example.com/stylesheets/application.css?1232285206" media="screen" rel="stylesheet" type="text/css" />
34
+ #
35
+ # Browsers typically open at most two simultaneous connections to a single
36
+ # host, which means your assets often have to wait for other assets to finish
37
+ # downloading. You can alleviate this by using a <tt>%d</tt> wildcard in the
38
+ # +asset_host+. For example, "assets%d.example.com". If that wildcard is
39
+ # present Rails distributes asset requests among the corresponding four hosts
40
+ # "assets0.example.com", ..., "assets3.example.com". With this trick browsers
41
+ # will open eight simultaneous connections rather than two.
42
+ #
43
+ # image_tag("rails.png")
44
+ # # => <img alt="Rails" src="http://assets0.example.com/images/rails.png?1230601161" />
45
+ # stylesheet_link_tag("application")
46
+ # # => <link href="http://assets2.example.com/stylesheets/application.css?1232285206" media="screen" rel="stylesheet" type="text/css" />
47
+ #
48
+ # To do this, you can either setup four actual hosts, or you can use wildcard
49
+ # DNS to CNAME the wildcard to a single asset host. You can read more about
50
+ # setting up your DNS CNAME records from your ISP.
51
+ #
52
+ # Note: This is purely a browser performance optimization and is not meant
53
+ # for server load balancing. See http://www.die.net/musings/page_load_time/
54
+ # for background.
55
+ #
56
+ # Alternatively, you can exert more control over the asset host by setting
57
+ # +asset_host+ to a proc like this:
58
+ #
59
+ # ActionController::Base.asset_host = Proc.new { |source|
60
+ # "http://assets#{rand(2) + 1}.example.com"
61
+ # }
62
+ # image_tag("rails.png")
63
+ # # => <img alt="Rails" src="http://assets0.example.com/images/rails.png?1230601161" />
64
+ # stylesheet_link_tag("application")
65
+ # # => <link href="http://assets1.example.com/stylesheets/application.css?1232285206" media="screen" rel="stylesheet" type="text/css" />
66
+ #
67
+ # The example above generates "http://assets1.example.com" and
68
+ # "http://assets2.example.com" randomly. This option is useful for example if
69
+ # you need fewer/more than four hosts, custom host names, etc.
70
+ #
71
+ # As you see the proc takes a +source+ parameter. That's a string with the
72
+ # absolute path of the asset with any extensions and timestamps in place,
73
+ # for example "/images/rails.png?1230601161".
74
+ #
75
+ # ActionController::Base.asset_host = Proc.new { |source|
76
+ # if source.starts_with?('/images')
77
+ # "http://images.example.com"
78
+ # else
79
+ # "http://assets.example.com"
80
+ # end
81
+ # }
82
+ # image_tag("rails.png")
83
+ # # => <img alt="Rails" src="http://images.example.com/images/rails.png?1230601161" />
84
+ # stylesheet_link_tag("application")
85
+ # # => <link href="http://assets.example.com/stylesheets/application.css?1232285206" media="screen" rel="stylesheet" type="text/css" />
86
+ #
87
+ # Alternatively you may ask for a second parameter +request+. That one is
88
+ # particularly useful for serving assets from an SSL-protected page. The
89
+ # example proc below disables asset hosting for HTTPS connections, while
90
+ # still sending assets for plain HTTP requests from asset hosts. If you don't
91
+ # have SSL certificates for each of the asset hosts this technique allows you
92
+ # to avoid warnings in the client about mixed media.
93
+ #
94
+ # ActionController::Base.asset_host = Proc.new { |source, request|
95
+ # if request.ssl?
96
+ # "#{request.protocol}#{request.host_with_port}"
97
+ # else
98
+ # "#{request.protocol}assets.example.com"
99
+ # end
100
+ # }
101
+ #
102
+ # You can also implement a custom asset host object that responds to +call+
103
+ # and takes either one or two parameters just like the proc.
104
+ #
105
+ # config.action_controller.asset_host = AssetHostingWithMinimumSsl.new(
106
+ # "http://asset%d.example.com", "https://asset1.example.com"
107
+ # )
108
+ #
109
+ # === Using asset timestamps
110
+ #
111
+ # By default, Rails appends asset's timestamps to all asset paths. This allows
112
+ # you to set a cache-expiration date for the asset far into the future, but
113
+ # still be able to instantly invalidate it by simply updating the file (and
114
+ # hence updating the timestamp, which then updates the URL as the timestamp
115
+ # is part of that, which in turn busts the cache).
116
+ #
117
+ # It's the responsibility of the web server you use to set the far-future
118
+ # expiration date on cache assets that you need to take advantage of this
119
+ # feature. Here's an example for Apache:
120
+ #
121
+ # # Asset Expiration
122
+ # ExpiresActive On
123
+ # <FilesMatch "\.(ico|gif|jpe?g|png|js|css)$">
124
+ # ExpiresDefault "access plus 1 year"
125
+ # </FilesMatch>
126
+ #
127
+ # Also note that in order for this to work, all your application servers must
128
+ # return the same timestamps. This means that they must have their clocks
129
+ # synchronized. If one of them drifts out of sync, you'll see different
130
+ # timestamps at random and the cache won't work. In that case the browser
131
+ # will request the same assets over and over again even thought they didn't
132
+ # change. You can use something like Live HTTP Headers for Firefox to verify
133
+ # that the cache is indeed working.
134
+ module AssetTagHelper
135
+ ASSETS_DIR = defined?(Rails.public_path) ? Rails.public_path : "public"
136
+ JAVASCRIPTS_DIR = "#{ASSETS_DIR}/javascripts"
137
+ STYLESHEETS_DIR = "#{ASSETS_DIR}/stylesheets"
138
+ JAVASCRIPT_DEFAULT_SOURCES = ['prototype', 'effects', 'dragdrop', 'controls'].freeze unless const_defined?(:JAVASCRIPT_DEFAULT_SOURCES)
139
+
140
+ # Returns a link tag that browsers and news readers can use to auto-detect
141
+ # an RSS or ATOM feed. The +type+ can either be <tt>:rss</tt> (default) or
142
+ # <tt>:atom</tt>. Control the link options in url_for format using the
143
+ # +url_options+. You can modify the LINK tag itself in +tag_options+.
144
+ #
145
+ # ==== Options
146
+ # * <tt>:rel</tt> - Specify the relation of this link, defaults to "alternate"
147
+ # * <tt>:type</tt> - Override the auto-generated mime type
148
+ # * <tt>:title</tt> - Specify the title of the link, defaults to the +type+
149
+ #
150
+ # ==== Examples
151
+ # auto_discovery_link_tag # =>
152
+ # <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/controller/action" />
153
+ # auto_discovery_link_tag(:atom) # =>
154
+ # <link rel="alternate" type="application/atom+xml" title="ATOM" href="http://www.currenthost.com/controller/action" />
155
+ # auto_discovery_link_tag(:rss, {:action => "feed"}) # =>
156
+ # <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/controller/feed" />
157
+ # auto_discovery_link_tag(:rss, {:action => "feed"}, {:title => "My RSS"}) # =>
158
+ # <link rel="alternate" type="application/rss+xml" title="My RSS" href="http://www.currenthost.com/controller/feed" />
159
+ # auto_discovery_link_tag(:rss, {:controller => "news", :action => "feed"}) # =>
160
+ # <link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.currenthost.com/news/feed" />
161
+ # auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", {:title => "Example RSS"}) # =>
162
+ # <link rel="alternate" type="application/rss+xml" title="Example RSS" href="http://www.example.com/feed" />
163
+ def auto_discovery_link_tag(type = :rss, url_options = {}, tag_options = {})
164
+ tag(
165
+ "link",
166
+ "rel" => tag_options[:rel] || "alternate",
167
+ "type" => tag_options[:type] || Mime::Type.lookup_by_extension(type.to_s).to_s,
168
+ "title" => tag_options[:title] || type.to_s.upcase,
169
+ "href" => url_options.is_a?(Hash) ? url_for(url_options.merge(:only_path => false)) : url_options
170
+ )
171
+ end
172
+
173
+ # Computes the path to a javascript asset in the public javascripts directory.
174
+ # If the +source+ filename has no extension, .js will be appended.
175
+ # Full paths from the document root will be passed through.
176
+ # Used internally by javascript_include_tag to build the script path.
177
+ #
178
+ # ==== Examples
179
+ # javascript_path "xmlhr" # => /javascripts/xmlhr.js
180
+ # javascript_path "dir/xmlhr.js" # => /javascripts/dir/xmlhr.js
181
+ # javascript_path "/dir/xmlhr" # => /dir/xmlhr.js
182
+ # javascript_path "http://www.railsapplication.com/js/xmlhr" # => http://www.railsapplication.com/js/xmlhr.js
183
+ # javascript_path "http://www.railsapplication.com/js/xmlhr.js" # => http://www.railsapplication.com/js/xmlhr.js
184
+ def javascript_path(source)
185
+ compute_public_path(source, 'javascripts', 'js')
186
+ end
187
+ alias_method :path_to_javascript, :javascript_path # aliased to avoid conflicts with a javascript_path named route
188
+
189
+ # Returns an html script tag for each of the +sources+ provided. You
190
+ # can pass in the filename (.js extension is optional) of javascript files
191
+ # that exist in your public/javascripts directory for inclusion into the
192
+ # current page or you can pass the full path relative to your document
193
+ # root. To include the Prototype and Scriptaculous javascript libraries in
194
+ # your application, pass <tt>:defaults</tt> as the source. When using
195
+ # <tt>:defaults</tt>, if an application.js file exists in your public
196
+ # javascripts directory, it will be included as well. You can modify the
197
+ # html attributes of the script tag by passing a hash as the last argument.
198
+ #
199
+ # ==== Examples
200
+ # javascript_include_tag "xmlhr" # =>
201
+ # <script type="text/javascript" src="/javascripts/xmlhr.js"></script>
202
+ #
203
+ # javascript_include_tag "xmlhr.js" # =>
204
+ # <script type="text/javascript" src="/javascripts/xmlhr.js"></script>
205
+ #
206
+ # javascript_include_tag "common.javascript", "/elsewhere/cools" # =>
207
+ # <script type="text/javascript" src="/javascripts/common.javascript"></script>
208
+ # <script type="text/javascript" src="/elsewhere/cools.js"></script>
209
+ #
210
+ # javascript_include_tag "http://www.railsapplication.com/xmlhr" # =>
211
+ # <script type="text/javascript" src="http://www.railsapplication.com/xmlhr.js"></script>
212
+ #
213
+ # javascript_include_tag "http://www.railsapplication.com/xmlhr.js" # =>
214
+ # <script type="text/javascript" src="http://www.railsapplication.com/xmlhr.js"></script>
215
+ #
216
+ # javascript_include_tag :defaults # =>
217
+ # <script type="text/javascript" src="/javascripts/prototype.js"></script>
218
+ # <script type="text/javascript" src="/javascripts/effects.js"></script>
219
+ # ...
220
+ # <script type="text/javascript" src="/javascripts/application.js"></script>
221
+ #
222
+ # * = The application.js file is only referenced if it exists
223
+ #
224
+ # Though it's not really recommended practice, if you need to extend the default JavaScript set for any reason
225
+ # (e.g., you're going to be using a certain .js file in every action), then take a look at the register_javascript_include_default method.
226
+ #
227
+ # You can also include all javascripts in the javascripts directory using <tt>:all</tt> as the source:
228
+ #
229
+ # javascript_include_tag :all # =>
230
+ # <script type="text/javascript" src="/javascripts/prototype.js"></script>
231
+ # <script type="text/javascript" src="/javascripts/effects.js"></script>
232
+ # ...
233
+ # <script type="text/javascript" src="/javascripts/application.js"></script>
234
+ # <script type="text/javascript" src="/javascripts/shop.js"></script>
235
+ # <script type="text/javascript" src="/javascripts/checkout.js"></script>
236
+ #
237
+ # Note that the default javascript files will be included first. So Prototype and Scriptaculous are available to
238
+ # all subsequently included files.
239
+ #
240
+ # If you want Rails to search in all the subdirectories under javascripts, you should explicitly set <tt>:recursive</tt>:
241
+ #
242
+ # javascript_include_tag :all, :recursive => true
243
+ #
244
+ # == Caching multiple javascripts into one
245
+ #
246
+ # You can also cache multiple javascripts into one file, which requires less HTTP connections to download and can better be
247
+ # compressed by gzip (leading to faster transfers). Caching will only happen if ActionController::Base.perform_caching
248
+ # is set to <tt>true</tt> (which is the case by default for the Rails production environment, but not for the development
249
+ # environment).
250
+ #
251
+ # ==== Examples
252
+ # javascript_include_tag :all, :cache => true # when ActionController::Base.perform_caching is false =>
253
+ # <script type="text/javascript" src="/javascripts/prototype.js"></script>
254
+ # <script type="text/javascript" src="/javascripts/effects.js"></script>
255
+ # ...
256
+ # <script type="text/javascript" src="/javascripts/application.js"></script>
257
+ # <script type="text/javascript" src="/javascripts/shop.js"></script>
258
+ # <script type="text/javascript" src="/javascripts/checkout.js"></script>
259
+ #
260
+ # javascript_include_tag :all, :cache => true # when ActionController::Base.perform_caching is true =>
261
+ # <script type="text/javascript" src="/javascripts/all.js"></script>
262
+ #
263
+ # javascript_include_tag "prototype", "cart", "checkout", :cache => "shop" # when ActionController::Base.perform_caching is false =>
264
+ # <script type="text/javascript" src="/javascripts/prototype.js"></script>
265
+ # <script type="text/javascript" src="/javascripts/cart.js"></script>
266
+ # <script type="text/javascript" src="/javascripts/checkout.js"></script>
267
+ #
268
+ # javascript_include_tag "prototype", "cart", "checkout", :cache => "shop" # when ActionController::Base.perform_caching is true =>
269
+ # <script type="text/javascript" src="/javascripts/shop.js"></script>
270
+ #
271
+ # The <tt>:recursive</tt> option is also available for caching:
272
+ #
273
+ # javascript_include_tag :all, :cache => true, :recursive => true
274
+ def javascript_include_tag(*sources)
275
+ options = sources.extract_options!.stringify_keys
276
+ concat = options.delete("concat")
277
+ cache = concat || options.delete("cache")
278
+ recursive = options.delete("recursive")
279
+
280
+ if concat || (ActionController::Base.perform_caching && cache)
281
+ joined_javascript_name = (cache == true ? "all" : cache) + ".js"
282
+ joined_javascript_path = File.join(joined_javascript_name[/^#{File::SEPARATOR}/] ? ASSETS_DIR : JAVASCRIPTS_DIR, joined_javascript_name)
283
+
284
+ unless ActionController::Base.perform_caching && File.exists?(joined_javascript_path)
285
+ write_asset_file_contents(joined_javascript_path, compute_javascript_paths(sources, recursive))
286
+ end
287
+ javascript_src_tag(joined_javascript_name, options)
288
+ else
289
+ expand_javascript_sources(sources, recursive).collect { |source| javascript_src_tag(source, options) }.join("\n").html_safe
290
+ end
291
+ end
292
+
293
+ @@javascript_expansions = { :defaults => JAVASCRIPT_DEFAULT_SOURCES.dup }
294
+
295
+ # Register one or more javascript files to be included when <tt>symbol</tt>
296
+ # is passed to <tt>javascript_include_tag</tt>. This method is typically intended
297
+ # to be called from plugin initialization to register javascript files
298
+ # that the plugin installed in <tt>public/javascripts</tt>.
299
+ #
300
+ # ActionView::Helpers::AssetTagHelper.register_javascript_expansion :monkey => ["head", "body", "tail"]
301
+ #
302
+ # javascript_include_tag :monkey # =>
303
+ # <script type="text/javascript" src="/javascripts/head.js"></script>
304
+ # <script type="text/javascript" src="/javascripts/body.js"></script>
305
+ # <script type="text/javascript" src="/javascripts/tail.js"></script>
306
+ def self.register_javascript_expansion(expansions)
307
+ @@javascript_expansions.merge!(expansions)
308
+ end
309
+
310
+ @@stylesheet_expansions = {}
311
+
312
+ # Register one or more stylesheet files to be included when <tt>symbol</tt>
313
+ # is passed to <tt>stylesheet_link_tag</tt>. This method is typically intended
314
+ # to be called from plugin initialization to register stylesheet files
315
+ # that the plugin installed in <tt>public/stylesheets</tt>.
316
+ #
317
+ # ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion :monkey => ["head", "body", "tail"]
318
+ #
319
+ # stylesheet_link_tag :monkey # =>
320
+ # <link href="/stylesheets/head.css" media="screen" rel="stylesheet" type="text/css" />
321
+ # <link href="/stylesheets/body.css" media="screen" rel="stylesheet" type="text/css" />
322
+ # <link href="/stylesheets/tail.css" media="screen" rel="stylesheet" type="text/css" />
323
+ def self.register_stylesheet_expansion(expansions)
324
+ @@stylesheet_expansions.merge!(expansions)
325
+ end
326
+
327
+ # Register one or more additional JavaScript files to be included when
328
+ # <tt>javascript_include_tag :defaults</tt> is called. This method is
329
+ # typically intended to be called from plugin initialization to register additional
330
+ # .js files that the plugin installed in <tt>public/javascripts</tt>.
331
+ def self.register_javascript_include_default(*sources)
332
+ @@javascript_expansions[:defaults].concat(sources)
333
+ end
334
+
335
+ def self.reset_javascript_include_default #:nodoc:
336
+ @@javascript_expansions[:defaults] = JAVASCRIPT_DEFAULT_SOURCES.dup
337
+ end
338
+
339
+ # Computes the path to a stylesheet asset in the public stylesheets directory.
340
+ # If the +source+ filename has no extension, <tt>.css</tt> will be appended.
341
+ # Full paths from the document root will be passed through.
342
+ # Used internally by +stylesheet_link_tag+ to build the stylesheet path.
343
+ #
344
+ # ==== Examples
345
+ # stylesheet_path "style" # => /stylesheets/style.css
346
+ # stylesheet_path "dir/style.css" # => /stylesheets/dir/style.css
347
+ # stylesheet_path "/dir/style.css" # => /dir/style.css
348
+ # stylesheet_path "http://www.railsapplication.com/css/style" # => http://www.railsapplication.com/css/style.css
349
+ # stylesheet_path "http://www.railsapplication.com/css/style.js" # => http://www.railsapplication.com/css/style.css
350
+ def stylesheet_path(source)
351
+ compute_public_path(source, 'stylesheets', 'css')
352
+ end
353
+ alias_method :path_to_stylesheet, :stylesheet_path # aliased to avoid conflicts with a stylesheet_path named route
354
+
355
+ # Returns a stylesheet link tag for the sources specified as arguments. If
356
+ # you don't specify an extension, <tt>.css</tt> will be appended automatically.
357
+ # You can modify the link attributes by passing a hash as the last argument.
358
+ #
359
+ # ==== Examples
360
+ # stylesheet_link_tag "style" # =>
361
+ # <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
362
+ #
363
+ # stylesheet_link_tag "style.css" # =>
364
+ # <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
365
+ #
366
+ # stylesheet_link_tag "http://www.railsapplication.com/style.css" # =>
367
+ # <link href="http://www.railsapplication.com/style.css" media="screen" rel="stylesheet" type="text/css" />
368
+ #
369
+ # stylesheet_link_tag "style", :media => "all" # =>
370
+ # <link href="/stylesheets/style.css" media="all" rel="stylesheet" type="text/css" />
371
+ #
372
+ # stylesheet_link_tag "style", :media => "print" # =>
373
+ # <link href="/stylesheets/style.css" media="print" rel="stylesheet" type="text/css" />
374
+ #
375
+ # stylesheet_link_tag "random.styles", "/css/stylish" # =>
376
+ # <link href="/stylesheets/random.styles" media="screen" rel="stylesheet" type="text/css" />
377
+ # <link href="/css/stylish.css" media="screen" rel="stylesheet" type="text/css" />
378
+ #
379
+ # You can also include all styles in the stylesheets directory using <tt>:all</tt> as the source:
380
+ #
381
+ # stylesheet_link_tag :all # =>
382
+ # <link href="/stylesheets/style1.css" media="screen" rel="stylesheet" type="text/css" />
383
+ # <link href="/stylesheets/styleB.css" media="screen" rel="stylesheet" type="text/css" />
384
+ # <link href="/stylesheets/styleX2.css" media="screen" rel="stylesheet" type="text/css" />
385
+ #
386
+ # If you want Rails to search in all the subdirectories under stylesheets, you should explicitly set <tt>:recursive</tt>:
387
+ #
388
+ # stylesheet_link_tag :all, :recursive => true
389
+ #
390
+ # == Caching multiple stylesheets into one
391
+ #
392
+ # You can also cache multiple stylesheets into one file, which requires less HTTP connections and can better be
393
+ # compressed by gzip (leading to faster transfers). Caching will only happen if ActionController::Base.perform_caching
394
+ # is set to true (which is the case by default for the Rails production environment, but not for the development
395
+ # environment). Examples:
396
+ #
397
+ # ==== Examples
398
+ # stylesheet_link_tag :all, :cache => true # when ActionController::Base.perform_caching is false =>
399
+ # <link href="/stylesheets/style1.css" media="screen" rel="stylesheet" type="text/css" />
400
+ # <link href="/stylesheets/styleB.css" media="screen" rel="stylesheet" type="text/css" />
401
+ # <link href="/stylesheets/styleX2.css" media="screen" rel="stylesheet" type="text/css" />
402
+ #
403
+ # stylesheet_link_tag :all, :cache => true # when ActionController::Base.perform_caching is true =>
404
+ # <link href="/stylesheets/all.css" media="screen" rel="stylesheet" type="text/css" />
405
+ #
406
+ # stylesheet_link_tag "shop", "cart", "checkout", :cache => "payment" # when ActionController::Base.perform_caching is false =>
407
+ # <link href="/stylesheets/shop.css" media="screen" rel="stylesheet" type="text/css" />
408
+ # <link href="/stylesheets/cart.css" media="screen" rel="stylesheet" type="text/css" />
409
+ # <link href="/stylesheets/checkout.css" media="screen" rel="stylesheet" type="text/css" />
410
+ #
411
+ # stylesheet_link_tag "shop", "cart", "checkout", :cache => "payment" # when ActionController::Base.perform_caching is true =>
412
+ # <link href="/stylesheets/payment.css" media="screen" rel="stylesheet" type="text/css" />
413
+ #
414
+ # The <tt>:recursive</tt> option is also available for caching:
415
+ #
416
+ # stylesheet_link_tag :all, :cache => true, :recursive => true
417
+ #
418
+ # To force concatenation (even in development mode) set <tt>:concat</tt> to true. This is useful if
419
+ # you have too many stylesheets for IE to load.
420
+ #
421
+ # stylesheet_link_tag :all, :concat => true
422
+ #
423
+ def stylesheet_link_tag(*sources)
424
+ options = sources.extract_options!.stringify_keys
425
+ concat = options.delete("concat")
426
+ cache = concat || options.delete("cache")
427
+ recursive = options.delete("recursive")
428
+
429
+ if concat || (ActionController::Base.perform_caching && cache)
430
+ joined_stylesheet_name = (cache == true ? "all" : cache) + ".css"
431
+ joined_stylesheet_path = File.join(joined_stylesheet_name[/^#{File::SEPARATOR}/] ? ASSETS_DIR : STYLESHEETS_DIR, joined_stylesheet_name)
432
+
433
+ unless ActionController::Base.perform_caching && File.exists?(joined_stylesheet_path)
434
+ write_asset_file_contents(joined_stylesheet_path, compute_stylesheet_paths(sources, recursive))
435
+ end
436
+ stylesheet_tag(joined_stylesheet_name, options)
437
+ else
438
+ expand_stylesheet_sources(sources, recursive).collect { |source| stylesheet_tag(source, options) }.join("\n").html_safe
439
+ end
440
+ end
441
+
442
+ # Computes the path to an image asset in the public images directory.
443
+ # Full paths from the document root will be passed through.
444
+ # Used internally by +image_tag+ to build the image path.
445
+ #
446
+ # ==== Examples
447
+ # image_path("edit") # => /images/edit
448
+ # image_path("edit.png") # => /images/edit.png
449
+ # image_path("icons/edit.png") # => /images/icons/edit.png
450
+ # image_path("/icons/edit.png") # => /icons/edit.png
451
+ # image_path("http://www.railsapplication.com/img/edit.png") # => http://www.railsapplication.com/img/edit.png
452
+ def image_path(source)
453
+ compute_public_path(source, 'images')
454
+ end
455
+ alias_method :path_to_image, :image_path # aliased to avoid conflicts with an image_path named route
456
+
457
+ # Returns an html image tag for the +source+. The +source+ can be a full
458
+ # path or a file that exists in your public images directory.
459
+ #
460
+ # ==== Options
461
+ # You can add HTML attributes using the +options+. The +options+ supports
462
+ # three additional keys for convenience and conformance:
463
+ #
464
+ # * <tt>:alt</tt> - If no alt text is given, the file name part of the
465
+ # +source+ is used (capitalized and without the extension)
466
+ # * <tt>:size</tt> - Supplied as "{Width}x{Height}", so "30x45" becomes
467
+ # width="30" and height="45". <tt>:size</tt> will be ignored if the
468
+ # value is not in the correct format.
469
+ # * <tt>:mouseover</tt> - Set an alternate image to be used when the onmouseover
470
+ # event is fired, and sets the original image to be replaced onmouseout.
471
+ # This can be used to implement an easy image toggle that fires on onmouseover.
472
+ #
473
+ # ==== Examples
474
+ # image_tag("icon") # =>
475
+ # <img src="/images/icon" alt="Icon" />
476
+ # image_tag("icon.png") # =>
477
+ # <img src="/images/icon.png" alt="Icon" />
478
+ # image_tag("icon.png", :size => "16x10", :alt => "Edit Entry") # =>
479
+ # <img src="/images/icon.png" width="16" height="10" alt="Edit Entry" />
480
+ # image_tag("/icons/icon.gif", :size => "16x16") # =>
481
+ # <img src="/icons/icon.gif" width="16" height="16" alt="Icon" />
482
+ # image_tag("/icons/icon.gif", :height => '32', :width => '32') # =>
483
+ # <img alt="Icon" height="32" src="/icons/icon.gif" width="32" />
484
+ # image_tag("/icons/icon.gif", :class => "menu_icon") # =>
485
+ # <img alt="Icon" class="menu_icon" src="/icons/icon.gif" />
486
+ # image_tag("mouse.png", :mouseover => "/images/mouse_over.png") # =>
487
+ # <img src="/images/mouse.png" onmouseover="this.src='/images/mouse_over.png'" onmouseout="this.src='/images/mouse.png'" alt="Mouse" />
488
+ # image_tag("mouse.png", :mouseover => image_path("mouse_over.png")) # =>
489
+ # <img src="/images/mouse.png" onmouseover="this.src='/images/mouse_over.png'" onmouseout="this.src='/images/mouse.png'" alt="Mouse" />
490
+ def image_tag(source, options = {})
491
+ options.symbolize_keys!
492
+
493
+ options[:src] = path_to_image(source)
494
+ options[:alt] ||= File.basename(options[:src], '.*').split('.').first.to_s.capitalize
495
+
496
+ if size = options.delete(:size)
497
+ options[:width], options[:height] = size.split("x") if size =~ %r{^\d+x\d+$}
498
+ end
499
+
500
+ if mouseover = options.delete(:mouseover)
501
+ options[:onmouseover] = "this.src='#{image_path(mouseover)}'"
502
+ options[:onmouseout] = "this.src='#{image_path(options[:src])}'"
503
+ end
504
+
505
+ tag("img", options)
506
+ end
507
+
508
+ def self.cache_asset_timestamps
509
+ @@cache_asset_timestamps
510
+ end
511
+
512
+ # You can enable or disable the asset tag timestamps cache.
513
+ # With the cache enabled, the asset tag helper methods will make fewer
514
+ # expense file system calls. However this prevents you from modifying
515
+ # any asset files while the server is running.
516
+ #
517
+ # ActionView::Helpers::AssetTagHelper.cache_asset_timestamps = false
518
+ def self.cache_asset_timestamps=(value)
519
+ @@cache_asset_timestamps = value
520
+ end
521
+
522
+ @@cache_asset_timestamps = true
523
+
524
+ private
525
+ # Add the the extension +ext+ if not present. Return full URLs otherwise untouched.
526
+ # Prefix with <tt>/dir/</tt> if lacking a leading +/+. Account for relative URL
527
+ # roots. Rewrite the asset path for cache-busting asset ids. Include
528
+ # asset host, if configured, with the correct request protocol.
529
+ def compute_public_path(source, dir, ext = nil, include_host = true)
530
+ has_request = @controller.respond_to?(:request)
531
+
532
+ source_ext = File.extname(source)[1..-1]
533
+ if ext && (source_ext.blank? || (ext != source_ext && File.exist?(File.join(ASSETS_DIR, dir, "#{source}.#{ext}"))))
534
+ source += ".#{ext}"
535
+ end
536
+
537
+ unless source =~ %r{^[-a-z]+://}
538
+ source = "/#{dir}/#{source}" unless source[0] == ?/
539
+
540
+ source = rewrite_asset_path(source)
541
+
542
+ if has_request && include_host
543
+ unless source =~ %r{^#{ActionController::Base.relative_url_root}/}
544
+ source = "#{ActionController::Base.relative_url_root}#{source}"
545
+ end
546
+ end
547
+ end
548
+
549
+ if include_host && source !~ %r{^[-a-z]+://}
550
+ host = compute_asset_host(source)
551
+
552
+ if has_request && !host.blank? && host !~ %r{^[-a-z]+://}
553
+ host = "#{@controller.request.protocol}#{host}"
554
+ end
555
+
556
+ "#{host}#{source}"
557
+ else
558
+ source
559
+ end
560
+ end
561
+
562
+ # Pick an asset host for this source. Returns +nil+ if no host is set,
563
+ # the host if no wildcard is set, the host interpolated with the
564
+ # numbers 0-3 if it contains <tt>%d</tt> (the number is the source hash mod 4),
565
+ # or the value returned from invoking the proc if it's a proc or the value from
566
+ # invoking call if it's an object responding to call.
567
+ def compute_asset_host(source)
568
+ if host = ActionController::Base.asset_host
569
+ if host.is_a?(Proc) || host.respond_to?(:call)
570
+ case host.is_a?(Proc) ? host.arity : host.method(:call).arity
571
+ when 2
572
+ request = @controller.respond_to?(:request) && @controller.request
573
+ host.call(source, request)
574
+ else
575
+ host.call(source)
576
+ end
577
+ else
578
+ (host =~ /%d/) ? host % (source.hash % 4) : host
579
+ end
580
+ end
581
+ end
582
+
583
+ @@asset_timestamps_cache = {}
584
+ @@asset_timestamps_cache_guard = Mutex.new
585
+
586
+ # Use the RAILS_ASSET_ID environment variable or the source's
587
+ # modification time as its cache-busting asset id.
588
+ def rails_asset_id(source)
589
+ if asset_id = ENV["RAILS_ASSET_ID"]
590
+ asset_id
591
+ else
592
+ if @@cache_asset_timestamps && (asset_id = @@asset_timestamps_cache[source])
593
+ asset_id
594
+ else
595
+ path = File.join(ASSETS_DIR, source)
596
+ asset_id = File.exist?(path) ? File.mtime(path).to_i.to_s : ''
597
+
598
+ if @@cache_asset_timestamps
599
+ @@asset_timestamps_cache_guard.synchronize do
600
+ @@asset_timestamps_cache[source] = asset_id
601
+ end
602
+ end
603
+
604
+ asset_id
605
+ end
606
+ end
607
+ end
608
+
609
+ # Break out the asset path rewrite in case plugins wish to put the asset id
610
+ # someplace other than the query string.
611
+ def rewrite_asset_path(source)
612
+ asset_id = rails_asset_id(source)
613
+ if asset_id.blank?
614
+ source
615
+ else
616
+ source + "?#{asset_id}"
617
+ end
618
+ end
619
+
620
+ def javascript_src_tag(source, options)
621
+ content_tag("script", "", { "type" => Mime::JS, "src" => path_to_javascript(source) }.merge(options))
622
+ end
623
+
624
+ def stylesheet_tag(source, options)
625
+ tag("link", { "rel" => "stylesheet", "type" => Mime::CSS, "media" => "screen", "href" => html_escape(path_to_stylesheet(source)) }.merge(options), false, false)
626
+ end
627
+
628
+ def compute_javascript_paths(*args)
629
+ expand_javascript_sources(*args).collect { |source| compute_public_path(source, 'javascripts', 'js', false) }
630
+ end
631
+
632
+ def compute_stylesheet_paths(*args)
633
+ expand_stylesheet_sources(*args).collect { |source| compute_public_path(source, 'stylesheets', 'css', false) }
634
+ end
635
+
636
+ def expand_javascript_sources(sources, recursive = false)
637
+ if sources.include?(:all)
638
+ all_javascript_files = collect_asset_files(JAVASCRIPTS_DIR, ('**' if recursive), '*.js')
639
+ ((determine_source(:defaults, @@javascript_expansions).dup & all_javascript_files) + all_javascript_files).uniq
640
+ else
641
+ expanded_sources = sources.collect do |source|
642
+ determine_source(source, @@javascript_expansions)
643
+ end.flatten
644
+ expanded_sources << "application" if sources.include?(:defaults) && File.exist?(File.join(JAVASCRIPTS_DIR, "application.js"))
645
+ expanded_sources
646
+ end
647
+ end
648
+
649
+ def expand_stylesheet_sources(sources, recursive)
650
+ if sources.first == :all
651
+ collect_asset_files(STYLESHEETS_DIR, ('**' if recursive), '*.css')
652
+ else
653
+ sources.collect do |source|
654
+ determine_source(source, @@stylesheet_expansions)
655
+ end.flatten
656
+ end
657
+ end
658
+
659
+ def determine_source(source, collection)
660
+ case source
661
+ when Symbol
662
+ collection[source] || raise(ArgumentError, "No expansion found for #{source.inspect}")
663
+ else
664
+ source
665
+ end
666
+ end
667
+
668
+ def join_asset_file_contents(paths)
669
+ paths.collect { |path| File.read(asset_file_path(path)) }.join("\n\n")
670
+ end
671
+
672
+ def write_asset_file_contents(joined_asset_path, asset_paths)
673
+ FileUtils.mkdir_p(File.dirname(joined_asset_path))
674
+ File.open(joined_asset_path, "w+") { |cache| cache.write(join_asset_file_contents(asset_paths)) }
675
+
676
+ # Set mtime to the latest of the combined files to allow for
677
+ # consistent ETag without a shared filesystem.
678
+ mt = asset_paths.map { |p| File.mtime(asset_file_path(p)) }.max
679
+ File.utime(mt, mt, joined_asset_path)
680
+ end
681
+
682
+ def asset_file_path(path)
683
+ File.join(ASSETS_DIR, path.split('?').first)
684
+ end
685
+
686
+ def collect_asset_files(*path)
687
+ dir = path.first
688
+
689
+ Dir[File.join(*path.compact)].collect do |file|
690
+ file[-(file.size - dir.size - 1)..-1].sub(/\.\w+$/, '')
691
+ end.sort
692
+ end
693
+ end
694
+ end
695
+ end