actionpack_csi 2.3.5.p6
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.
- data/CHANGELOG +5184 -0
- data/MIT-LICENSE +21 -0
- data/README +409 -0
- data/RUNNING_UNIT_TESTS +24 -0
- data/Rakefile +160 -0
- data/install.rb +30 -0
- data/lib/action_controller/assertions/dom_assertions.rb +55 -0
- data/lib/action_controller/assertions/model_assertions.rb +21 -0
- data/lib/action_controller/assertions/response_assertions.rb +160 -0
- data/lib/action_controller/assertions/routing_assertions.rb +146 -0
- data/lib/action_controller/assertions/selector_assertions.rb +638 -0
- data/lib/action_controller/assertions/tag_assertions.rb +127 -0
- data/lib/action_controller/base.rb +1423 -0
- data/lib/action_controller/benchmarking.rb +107 -0
- data/lib/action_controller/caching/actions.rb +177 -0
- data/lib/action_controller/caching/fragments.rb +120 -0
- data/lib/action_controller/caching/pages.rb +152 -0
- data/lib/action_controller/caching/sweeper.rb +45 -0
- data/lib/action_controller/caching/sweeping.rb +55 -0
- data/lib/action_controller/caching.rb +71 -0
- data/lib/action_controller/cgi_ext/cookie.rb +112 -0
- data/lib/action_controller/cgi_ext/query_extension.rb +22 -0
- data/lib/action_controller/cgi_ext/stdinput.rb +24 -0
- data/lib/action_controller/cgi_ext.rb +15 -0
- data/lib/action_controller/cgi_process.rb +77 -0
- data/lib/action_controller/cookies.rb +95 -0
- data/lib/action_controller/dispatcher.rb +133 -0
- data/lib/action_controller/failsafe.rb +86 -0
- data/lib/action_controller/filters.rb +680 -0
- data/lib/action_controller/flash.rb +171 -0
- data/lib/action_controller/headers.rb +33 -0
- data/lib/action_controller/helpers.rb +225 -0
- data/lib/action_controller/http_authentication.rb +309 -0
- data/lib/action_controller/integration.rb +692 -0
- data/lib/action_controller/layout.rb +286 -0
- data/lib/action_controller/middleware_stack.rb +119 -0
- data/lib/action_controller/middlewares.rb +14 -0
- data/lib/action_controller/mime_responds.rb +193 -0
- data/lib/action_controller/mime_type.rb +212 -0
- data/lib/action_controller/mime_types.rb +21 -0
- data/lib/action_controller/params_parser.rb +77 -0
- data/lib/action_controller/performance_test.rb +15 -0
- data/lib/action_controller/polymorphic_routes.rb +189 -0
- data/lib/action_controller/rack_lint_patch.rb +36 -0
- data/lib/action_controller/record_identifier.rb +104 -0
- data/lib/action_controller/reloader.rb +54 -0
- data/lib/action_controller/request.rb +493 -0
- data/lib/action_controller/request_forgery_protection.rb +113 -0
- data/lib/action_controller/rescue.rb +183 -0
- data/lib/action_controller/resources.rb +682 -0
- data/lib/action_controller/response.rb +239 -0
- data/lib/action_controller/routing/builder.rb +197 -0
- data/lib/action_controller/routing/optimisations.rb +130 -0
- data/lib/action_controller/routing/recognition_optimisation.rb +167 -0
- data/lib/action_controller/routing/route.rb +265 -0
- data/lib/action_controller/routing/route_set.rb +502 -0
- data/lib/action_controller/routing/routing_ext.rb +49 -0
- data/lib/action_controller/routing/segments.rb +343 -0
- data/lib/action_controller/routing.rb +388 -0
- data/lib/action_controller/session/abstract_store.rb +181 -0
- data/lib/action_controller/session/cookie_store.rb +221 -0
- data/lib/action_controller/session/mem_cache_store.rb +51 -0
- data/lib/action_controller/session_management.rb +54 -0
- data/lib/action_controller/status_codes.rb +88 -0
- data/lib/action_controller/streaming.rb +181 -0
- data/lib/action_controller/string_coercion.rb +29 -0
- data/lib/action_controller/templates/rescues/_request_and_response.erb +24 -0
- data/lib/action_controller/templates/rescues/_trace.erb +26 -0
- data/lib/action_controller/templates/rescues/diagnostics.erb +11 -0
- data/lib/action_controller/templates/rescues/layout.erb +29 -0
- data/lib/action_controller/templates/rescues/missing_template.erb +2 -0
- data/lib/action_controller/templates/rescues/routing_error.erb +10 -0
- data/lib/action_controller/templates/rescues/template_error.erb +21 -0
- data/lib/action_controller/templates/rescues/unknown_action.erb +2 -0
- data/lib/action_controller/test_case.rb +209 -0
- data/lib/action_controller/test_process.rb +580 -0
- data/lib/action_controller/translation.rb +13 -0
- data/lib/action_controller/uploaded_file.rb +44 -0
- data/lib/action_controller/url_rewriter.rb +216 -0
- data/lib/action_controller/vendor/html-scanner/html/document.rb +68 -0
- data/lib/action_controller/vendor/html-scanner/html/node.rb +537 -0
- data/lib/action_controller/vendor/html-scanner/html/sanitizer.rb +173 -0
- data/lib/action_controller/vendor/html-scanner/html/selector.rb +828 -0
- data/lib/action_controller/vendor/html-scanner/html/tokenizer.rb +105 -0
- data/lib/action_controller/vendor/html-scanner/html/version.rb +11 -0
- data/lib/action_controller/vendor/html-scanner.rb +16 -0
- data/lib/action_controller/verification.rb +130 -0
- data/lib/action_controller.rb +113 -0
- data/lib/action_pack/version.rb +9 -0
- data/lib/action_pack.rb +24 -0
- data/lib/action_view/base.rb +362 -0
- data/lib/action_view/erb/util.rb +44 -0
- data/lib/action_view/helpers/active_record_helper.rb +305 -0
- data/lib/action_view/helpers/asset_tag_helper.rb +694 -0
- data/lib/action_view/helpers/atom_feed_helper.rb +198 -0
- data/lib/action_view/helpers/benchmark_helper.rb +54 -0
- data/lib/action_view/helpers/cache_helper.rb +39 -0
- data/lib/action_view/helpers/capture_helper.rb +136 -0
- data/lib/action_view/helpers/date_helper.rb +988 -0
- data/lib/action_view/helpers/debug_helper.rb +38 -0
- data/lib/action_view/helpers/form_helper.rb +1074 -0
- data/lib/action_view/helpers/form_options_helper.rb +600 -0
- data/lib/action_view/helpers/form_tag_helper.rb +487 -0
- data/lib/action_view/helpers/javascript_helper.rb +208 -0
- data/lib/action_view/helpers/number_helper.rb +308 -0
- data/lib/action_view/helpers/prototype_helper.rb +1305 -0
- data/lib/action_view/helpers/raw_output_helper.rb +9 -0
- data/lib/action_view/helpers/record_identification_helper.rb +20 -0
- data/lib/action_view/helpers/record_tag_helper.rb +58 -0
- data/lib/action_view/helpers/sanitize_helper.rb +259 -0
- data/lib/action_view/helpers/scriptaculous_helper.rb +226 -0
- data/lib/action_view/helpers/tag_helper.rb +150 -0
- data/lib/action_view/helpers/text_helper.rb +587 -0
- data/lib/action_view/helpers/translation_helper.rb +39 -0
- data/lib/action_view/helpers/url_helper.rb +639 -0
- data/lib/action_view/helpers.rb +59 -0
- data/lib/action_view/inline_template.rb +19 -0
- data/lib/action_view/locale/en.yml +117 -0
- data/lib/action_view/partials.rb +240 -0
- data/lib/action_view/paths.rb +69 -0
- data/lib/action_view/reloadable_template.rb +117 -0
- data/lib/action_view/renderable.rb +95 -0
- data/lib/action_view/renderable_partial.rb +47 -0
- data/lib/action_view/safe_buffer.rb +28 -0
- data/lib/action_view/template.rb +252 -0
- data/lib/action_view/template_error.rb +99 -0
- data/lib/action_view/template_handler.rb +34 -0
- data/lib/action_view/template_handlers/builder.rb +17 -0
- data/lib/action_view/template_handlers/erb.rb +22 -0
- data/lib/action_view/template_handlers/rjs.rb +13 -0
- data/lib/action_view/template_handlers.rb +48 -0
- data/lib/action_view/test_case.rb +162 -0
- data/lib/action_view.rb +58 -0
- data/lib/actionpack.rb +2 -0
- data/test/abstract_unit.rb +61 -0
- data/test/active_record_unit.rb +104 -0
- data/test/activerecord/active_record_store_test.rb +174 -0
- data/test/activerecord/render_partial_with_record_identification_test.rb +188 -0
- data/test/adv_attr_test.rb +20 -0
- data/test/controller/action_pack_assertions_test.rb +543 -0
- data/test/controller/addresses_render_test.rb +37 -0
- data/test/controller/assert_select_test.rb +734 -0
- data/test/controller/base_test.rb +217 -0
- data/test/controller/benchmark_test.rb +32 -0
- data/test/controller/caching_test.rb +729 -0
- data/test/controller/capture_test.rb +66 -0
- data/test/controller/content_type_test.rb +168 -0
- data/test/controller/controller_fixtures/app/controllers/admin/user_controller.rb +0 -0
- data/test/controller/controller_fixtures/app/controllers/user_controller.rb +0 -0
- data/test/controller/controller_fixtures/vendor/plugins/bad_plugin/lib/plugin_controller.rb +0 -0
- data/test/controller/cookie_test.rb +134 -0
- data/test/controller/deprecation/deprecated_base_methods_test.rb +32 -0
- data/test/controller/dispatcher_test.rb +144 -0
- data/test/controller/dom_assertions_test.rb +53 -0
- data/test/controller/failsafe_test.rb +60 -0
- data/test/controller/fake_controllers.rb +33 -0
- data/test/controller/fake_models.rb +19 -0
- data/test/controller/filter_params_test.rb +52 -0
- data/test/controller/filters_test.rb +885 -0
- data/test/controller/flash_test.rb +147 -0
- data/test/controller/header_test.rb +14 -0
- data/test/controller/helper_test.rb +224 -0
- data/test/controller/html-scanner/cdata_node_test.rb +15 -0
- data/test/controller/html-scanner/document_test.rb +148 -0
- data/test/controller/html-scanner/node_test.rb +89 -0
- data/test/controller/html-scanner/sanitizer_test.rb +274 -0
- data/test/controller/html-scanner/tag_node_test.rb +238 -0
- data/test/controller/html-scanner/text_node_test.rb +50 -0
- data/test/controller/html-scanner/tokenizer_test.rb +131 -0
- data/test/controller/http_basic_authentication_test.rb +113 -0
- data/test/controller/http_digest_authentication_test.rb +254 -0
- data/test/controller/integration_test.rb +483 -0
- data/test/controller/layout_test.rb +215 -0
- data/test/controller/logging_test.rb +46 -0
- data/test/controller/middleware_stack_test.rb +90 -0
- data/test/controller/mime_responds_test.rb +536 -0
- data/test/controller/mime_type_test.rb +93 -0
- data/test/controller/polymorphic_routes_test.rb +297 -0
- data/test/controller/rack_test.rb +311 -0
- data/test/controller/record_identifier_test.rb +139 -0
- data/test/controller/redirect_test.rb +285 -0
- data/test/controller/reloader_test.rb +124 -0
- data/test/controller/render_test.rb +1762 -0
- data/test/controller/request/json_params_parsing_test.rb +65 -0
- data/test/controller/request/multipart_params_parsing_test.rb +162 -0
- data/test/controller/request/query_string_parsing_test.rb +120 -0
- data/test/controller/request/test_request_test.rb +35 -0
- data/test/controller/request/url_encoded_params_parsing_test.rb +146 -0
- data/test/controller/request/xml_params_parsing_test.rb +103 -0
- data/test/controller/request_forgery_protection_test.rb +265 -0
- data/test/controller/request_test.rb +395 -0
- data/test/controller/rescue_test.rb +536 -0
- data/test/controller/resources_test.rb +1393 -0
- data/test/controller/routing_test.rb +2591 -0
- data/test/controller/selector_test.rb +628 -0
- data/test/controller/send_file_test.rb +171 -0
- data/test/controller/session/cookie_store_test.rb +216 -0
- data/test/controller/session/mem_cache_store_test.rb +127 -0
- data/test/controller/session/test_session_test.rb +58 -0
- data/test/controller/test_test.rb +700 -0
- data/test/controller/translation_test.rb +26 -0
- data/test/controller/url_rewriter_test.rb +385 -0
- data/test/controller/verification_test.rb +270 -0
- data/test/controller/view_paths_test.rb +141 -0
- data/test/controller/webservice_test.rb +273 -0
- data/test/fixtures/_top_level_partial.html.erb +1 -0
- data/test/fixtures/_top_level_partial_only.erb +1 -0
- data/test/fixtures/addresses/list.erb +1 -0
- data/test/fixtures/alternate_helpers/foo_helper.rb +3 -0
- data/test/fixtures/bad_customers/_bad_customer.html.erb +1 -0
- data/test/fixtures/companies.yml +24 -0
- data/test/fixtures/company.rb +10 -0
- data/test/fixtures/content_type/render_default_content_types_for_respond_to.rhtml +1 -0
- data/test/fixtures/content_type/render_default_for_rhtml.rhtml +1 -0
- data/test/fixtures/content_type/render_default_for_rjs.rjs +1 -0
- data/test/fixtures/content_type/render_default_for_rxml.rxml +1 -0
- data/test/fixtures/customers/_customer.html.erb +1 -0
- data/test/fixtures/db_definitions/sqlite.sql +49 -0
- data/test/fixtures/developer.rb +9 -0
- data/test/fixtures/developers/_developer.erb +1 -0
- data/test/fixtures/developers.yml +21 -0
- data/test/fixtures/developers_projects.yml +13 -0
- data/test/fixtures/failsafe/500.html +1 -0
- data/test/fixtures/fun/games/_game.erb +1 -0
- data/test/fixtures/fun/games/hello_world.erb +1 -0
- data/test/fixtures/fun/serious/games/_game.erb +1 -0
- data/test/fixtures/functional_caching/_partial.erb +3 -0
- data/test/fixtures/functional_caching/formatted_fragment_cached.html.erb +3 -0
- data/test/fixtures/functional_caching/formatted_fragment_cached.js.rjs +6 -0
- data/test/fixtures/functional_caching/formatted_fragment_cached.xml.builder +5 -0
- data/test/fixtures/functional_caching/fragment_cached.html.erb +2 -0
- data/test/fixtures/functional_caching/html_fragment_cached_with_partial.html.erb +1 -0
- data/test/fixtures/functional_caching/inline_fragment_cached.html.erb +2 -0
- data/test/fixtures/functional_caching/js_fragment_cached_with_partial.js.rjs +1 -0
- data/test/fixtures/good_customers/_good_customer.html.erb +1 -0
- data/test/fixtures/helpers/abc_helper.rb +5 -0
- data/test/fixtures/helpers/fun/games_helper.rb +3 -0
- data/test/fixtures/helpers/fun/pdf_helper.rb +3 -0
- data/test/fixtures/layout_tests/abs_path_layout.rhtml +1 -0
- data/test/fixtures/layout_tests/alt/hello.rhtml +1 -0
- data/test/fixtures/layout_tests/alt/layouts/alt.rhtml +0 -0
- data/test/fixtures/layout_tests/layouts/controller_name_space/nested.rhtml +1 -0
- data/test/fixtures/layout_tests/layouts/item.rhtml +1 -0
- data/test/fixtures/layout_tests/layouts/layout_test.rhtml +1 -0
- data/test/fixtures/layout_tests/layouts/multiple_extensions.html.erb +1 -0
- data/test/fixtures/layout_tests/layouts/third_party_template_library.mab +1 -0
- data/test/fixtures/layout_tests/views/hello.rhtml +1 -0
- data/test/fixtures/layouts/_column.html.erb +2 -0
- data/test/fixtures/layouts/block_with_layout.erb +3 -0
- data/test/fixtures/layouts/builder.builder +3 -0
- data/test/fixtures/layouts/default_html.html.erb +1 -0
- data/test/fixtures/layouts/partial_with_layout.erb +3 -0
- data/test/fixtures/layouts/standard.erb +1 -0
- data/test/fixtures/layouts/talk_from_action.erb +2 -0
- data/test/fixtures/layouts/xhr.html.erb +2 -0
- data/test/fixtures/layouts/yield.erb +2 -0
- data/test/fixtures/mascot.rb +3 -0
- data/test/fixtures/mascots/_mascot.html.erb +1 -0
- data/test/fixtures/mascots.yml +4 -0
- data/test/fixtures/multipart/binary_file +0 -0
- data/test/fixtures/multipart/boundary_problem_file +10 -0
- data/test/fixtures/multipart/bracketed_param +5 -0
- data/test/fixtures/multipart/empty +10 -0
- data/test/fixtures/multipart/hello.txt +1 -0
- data/test/fixtures/multipart/large_text_file +10 -0
- data/test/fixtures/multipart/mixed_files +0 -0
- data/test/fixtures/multipart/mona_lisa.jpg +0 -0
- data/test/fixtures/multipart/none +9 -0
- data/test/fixtures/multipart/single_parameter +5 -0
- data/test/fixtures/multipart/text_file +10 -0
- data/test/fixtures/override/test/hello_world.erb +1 -0
- data/test/fixtures/override2/layouts/test/sub.erb +1 -0
- data/test/fixtures/post_test/layouts/post.html.erb +1 -0
- data/test/fixtures/post_test/layouts/super_post.iphone.erb +1 -0
- data/test/fixtures/post_test/post/index.html.erb +1 -0
- data/test/fixtures/post_test/post/index.iphone.erb +1 -0
- data/test/fixtures/post_test/super_post/index.html.erb +1 -0
- data/test/fixtures/post_test/super_post/index.iphone.erb +1 -0
- data/test/fixtures/project.rb +3 -0
- data/test/fixtures/projects/_project.erb +1 -0
- data/test/fixtures/projects.yml +7 -0
- data/test/fixtures/public/404.html +1 -0
- data/test/fixtures/public/500.da.html +1 -0
- data/test/fixtures/public/500.html +1 -0
- data/test/fixtures/public/absolute/test.css +23 -0
- data/test/fixtures/public/absolute/test.js +63 -0
- data/test/fixtures/public/images/rails.png +0 -0
- data/test/fixtures/public/javascripts/application.js +1 -0
- data/test/fixtures/public/javascripts/bank.js +1 -0
- data/test/fixtures/public/javascripts/controls.js +1 -0
- data/test/fixtures/public/javascripts/dragdrop.js +1 -0
- data/test/fixtures/public/javascripts/effects.js +1 -0
- data/test/fixtures/public/javascripts/prototype.js +1 -0
- data/test/fixtures/public/javascripts/robber.js +1 -0
- data/test/fixtures/public/javascripts/subdir/subdir.js +1 -0
- data/test/fixtures/public/javascripts/version.1.0.js +1 -0
- data/test/fixtures/public/stylesheets/bank.css +1 -0
- data/test/fixtures/public/stylesheets/robber.css +1 -0
- data/test/fixtures/public/stylesheets/subdir/subdir.css +1 -0
- data/test/fixtures/public/stylesheets/version.1.0.css +1 -0
- data/test/fixtures/quiz/questions/_question.html.erb +1 -0
- data/test/fixtures/replies/_reply.erb +1 -0
- data/test/fixtures/replies.yml +15 -0
- data/test/fixtures/reply.rb +7 -0
- data/test/fixtures/respond_to/all_types_with_layout.html.erb +1 -0
- data/test/fixtures/respond_to/all_types_with_layout.js.rjs +1 -0
- data/test/fixtures/respond_to/custom_constant_handling_without_block.mobile.erb +1 -0
- data/test/fixtures/respond_to/iphone_with_html_response_type.html.erb +1 -0
- data/test/fixtures/respond_to/iphone_with_html_response_type.iphone.erb +1 -0
- data/test/fixtures/respond_to/layouts/missing.html.erb +1 -0
- data/test/fixtures/respond_to/layouts/standard.html.erb +1 -0
- data/test/fixtures/respond_to/layouts/standard.iphone.erb +1 -0
- data/test/fixtures/respond_to/using_defaults.html.erb +1 -0
- data/test/fixtures/respond_to/using_defaults.js.rjs +1 -0
- data/test/fixtures/respond_to/using_defaults.xml.builder +1 -0
- data/test/fixtures/respond_to/using_defaults_with_type_list.html.erb +1 -0
- data/test/fixtures/respond_to/using_defaults_with_type_list.js.rjs +1 -0
- data/test/fixtures/respond_to/using_defaults_with_type_list.xml.builder +1 -0
- data/test/fixtures/scope/test/modgreet.erb +1 -0
- data/test/fixtures/shared.html.erb +1 -0
- data/test/fixtures/symlink_parent/symlinked_layout.erb +5 -0
- data/test/fixtures/test/_counter.html.erb +1 -0
- data/test/fixtures/test/_customer.erb +1 -0
- data/test/fixtures/test/_customer_counter.erb +1 -0
- data/test/fixtures/test/_customer_greeting.erb +1 -0
- data/test/fixtures/test/_customer_with_var.erb +1 -0
- data/test/fixtures/test/_form.erb +1 -0
- data/test/fixtures/test/_from_helper.erb +1 -0
- data/test/fixtures/test/_hash_greeting.erb +1 -0
- data/test/fixtures/test/_hash_object.erb +2 -0
- data/test/fixtures/test/_hello.builder +1 -0
- data/test/fixtures/test/_labelling_form.erb +1 -0
- data/test/fixtures/test/_layout_for_block_with_args.html.erb +3 -0
- data/test/fixtures/test/_layout_for_partial.html.erb +3 -0
- data/test/fixtures/test/_local_inspector.html.erb +1 -0
- data/test/fixtures/test/_one.html.erb +1 -0
- data/test/fixtures/test/_partial.erb +1 -0
- data/test/fixtures/test/_partial.html.erb +1 -0
- data/test/fixtures/test/_partial.js.erb +1 -0
- data/test/fixtures/test/_partial_for_use_in_layout.html.erb +1 -0
- data/test/fixtures/test/_partial_only.erb +1 -0
- data/test/fixtures/test/_partial_with_only_html_version.html.erb +1 -0
- data/test/fixtures/test/_person.erb +2 -0
- data/test/fixtures/test/_raise.html.erb +1 -0
- data/test/fixtures/test/_two.html.erb +1 -0
- data/test/fixtures/test/action_talk_to_layout.erb +2 -0
- data/test/fixtures/test/calling_partial_with_layout.html.erb +1 -0
- data/test/fixtures/test/capturing.erb +4 -0
- data/test/fixtures/test/content_for.erb +2 -0
- data/test/fixtures/test/content_for_concatenated.erb +3 -0
- data/test/fixtures/test/content_for_with_parameter.erb +2 -0
- data/test/fixtures/test/delete_with_js.rjs +2 -0
- data/test/fixtures/test/dont_pick_me +1 -0
- data/test/fixtures/test/dot.directory/render_file_with_ivar.erb +1 -0
- data/test/fixtures/test/enum_rjs_test.rjs +6 -0
- data/test/fixtures/test/formatted_html_erb.html.erb +1 -0
- data/test/fixtures/test/formatted_xml_erb.builder +1 -0
- data/test/fixtures/test/formatted_xml_erb.html.erb +1 -0
- data/test/fixtures/test/formatted_xml_erb.xml.erb +1 -0
- data/test/fixtures/test/greeting.erb +1 -0
- data/test/fixtures/test/greeting.js.rjs +1 -0
- data/test/fixtures/test/hello.builder +4 -0
- data/test/fixtures/test/hello_world.da.html.erb +1 -0
- data/test/fixtures/test/hello_world.erb +1 -0
- data/test/fixtures/test/hello_world.erb~ +1 -0
- data/test/fixtures/test/hello_world.pt-BR.html.erb +1 -0
- data/test/fixtures/test/hello_world_container.builder +3 -0
- data/test/fixtures/test/hello_world_from_rxml.builder +4 -0
- data/test/fixtures/test/hello_world_with_layout_false.erb +1 -0
- data/test/fixtures/test/hello_xml_world.builder +11 -0
- data/test/fixtures/test/hyphen-ated.erb +1 -0
- data/test/fixtures/test/implicit_content_type.atom.builder +2 -0
- data/test/fixtures/test/list.erb +1 -0
- data/test/fixtures/test/malformed/malformed.en.html.erb~ +1 -0
- data/test/fixtures/test/malformed/malformed.erb~ +1 -0
- data/test/fixtures/test/malformed/malformed.html.erb~ +1 -0
- data/test/fixtures/test/nested_layout.erb +3 -0
- data/test/fixtures/test/non_erb_block_content_for.builder +4 -0
- data/test/fixtures/test/potential_conflicts.erb +4 -0
- data/test/fixtures/test/render_explicit_html_template.js.rjs +1 -0
- data/test/fixtures/test/render_file_from_template.html.erb +1 -0
- data/test/fixtures/test/render_file_with_ivar.erb +1 -0
- data/test/fixtures/test/render_file_with_locals.erb +1 -0
- data/test/fixtures/test/render_implicit_html_template.js.rjs +1 -0
- data/test/fixtures/test/render_implicit_html_template_from_xhr_request.da.html.erb +1 -0
- data/test/fixtures/test/render_implicit_html_template_from_xhr_request.html.erb +1 -0
- data/test/fixtures/test/render_implicit_js_template_without_layout.js.erb +1 -0
- data/test/fixtures/test/render_to_string_test.erb +1 -0
- data/test/fixtures/test/sub_template_raise.html.erb +1 -0
- data/test/fixtures/test/template.erb +1 -0
- data/test/fixtures/test/update_element_with_capture.erb +9 -0
- data/test/fixtures/test/using_layout_around_block.html.erb +1 -0
- data/test/fixtures/test/using_layout_around_block_with_args.html.erb +1 -0
- data/test/fixtures/test/utf8.html.erb +2 -0
- data/test/fixtures/topic.rb +3 -0
- data/test/fixtures/topics/_topic.html.erb +1 -0
- data/test/fixtures/topics.yml +22 -0
- data/test/template/active_record_helper_i18n_test.rb +44 -0
- data/test/template/active_record_helper_test.rb +302 -0
- data/test/template/asset_tag_helper_test.rb +771 -0
- data/test/template/atom_feed_helper_test.rb +315 -0
- data/test/template/benchmark_helper_test.rb +86 -0
- data/test/template/compiled_templates_test.rb +204 -0
- data/test/template/date_helper_i18n_test.rb +121 -0
- data/test/template/date_helper_test.rb +2485 -0
- data/test/template/erb_util_test.rb +24 -0
- data/test/template/form_helper_test.rb +1393 -0
- data/test/template/form_options_helper_i18n_test.rb +27 -0
- data/test/template/form_options_helper_test.rb +807 -0
- data/test/template/form_tag_helper_test.rb +344 -0
- data/test/template/javascript_helper_test.rb +106 -0
- data/test/template/number_helper_i18n_test.rb +69 -0
- data/test/template/number_helper_test.rb +132 -0
- data/test/template/prototype_helper_test.rb +639 -0
- data/test/template/raw_output_helper_test.rb +21 -0
- data/test/template/record_tag_helper_test.rb +58 -0
- data/test/template/render_test.rb +290 -0
- data/test/template/sanitize_helper_test.rb +57 -0
- data/test/template/scriptaculous_helper_test.rb +90 -0
- data/test/template/tag_helper_test.rb +98 -0
- data/test/template/template_test.rb +32 -0
- data/test/template/test_test.rb +54 -0
- data/test/template/text_helper_test.rb +543 -0
- data/test/template/translation_helper_test.rb +32 -0
- data/test/template/url_helper_test.rb +622 -0
- data/test/testing_sandbox.rb +15 -0
- data/test/view/safe_buffer_test.rb +36 -0
- data/test/view/test_case_test.rb +176 -0
- metadata +531 -0
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
require 'benchmark'
|
|
2
|
+
|
|
3
|
+
module ActionController #:nodoc:
|
|
4
|
+
# The benchmarking module times the performance of actions and reports to the logger. If the Active Record
|
|
5
|
+
# package has been included, a separate timing section for database calls will be added as well.
|
|
6
|
+
module Benchmarking #:nodoc:
|
|
7
|
+
def self.included(base)
|
|
8
|
+
base.extend(ClassMethods)
|
|
9
|
+
|
|
10
|
+
base.class_eval do
|
|
11
|
+
alias_method_chain :perform_action, :benchmark
|
|
12
|
+
alias_method_chain :render, :benchmark
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
module ClassMethods
|
|
17
|
+
# Log and benchmark the workings of a single block and silence whatever logging that may have happened inside it
|
|
18
|
+
# (unless <tt>use_silence</tt> is set to false).
|
|
19
|
+
#
|
|
20
|
+
# The benchmark is only recorded if the current level of the logger matches the <tt>log_level</tt>, which makes it
|
|
21
|
+
# easy to include benchmarking statements in production software that will remain inexpensive because the benchmark
|
|
22
|
+
# will only be conducted if the log level is low enough.
|
|
23
|
+
def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
|
|
24
|
+
if logger && logger.level == log_level
|
|
25
|
+
result = nil
|
|
26
|
+
ms = Benchmark.ms { result = use_silence ? silence { yield } : yield }
|
|
27
|
+
logger.add(log_level, "#{title} (#{('%.1f' % ms)}ms)")
|
|
28
|
+
result
|
|
29
|
+
else
|
|
30
|
+
yield
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Silences the logger for the duration of the block.
|
|
35
|
+
def silence
|
|
36
|
+
old_logger_level, logger.level = logger.level, Logger::ERROR if logger
|
|
37
|
+
yield
|
|
38
|
+
ensure
|
|
39
|
+
logger.level = old_logger_level if logger
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
protected
|
|
44
|
+
def render_with_benchmark(options = nil, extra_options = {}, &block)
|
|
45
|
+
if logger
|
|
46
|
+
if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
|
|
47
|
+
db_runtime = ActiveRecord::Base.connection.reset_runtime
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
render_output = nil
|
|
51
|
+
@view_runtime = Benchmark.ms { render_output = render_without_benchmark(options, extra_options, &block) }
|
|
52
|
+
|
|
53
|
+
if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
|
|
54
|
+
@db_rt_before_render = db_runtime
|
|
55
|
+
@db_rt_after_render = ActiveRecord::Base.connection.reset_runtime
|
|
56
|
+
@view_runtime -= @db_rt_after_render
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
render_output
|
|
60
|
+
else
|
|
61
|
+
render_without_benchmark(options, extra_options, &block)
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
private
|
|
66
|
+
def perform_action_with_benchmark
|
|
67
|
+
if logger
|
|
68
|
+
ms = [Benchmark.ms { perform_action_without_benchmark }, 0.01].max
|
|
69
|
+
logging_view = defined?(@view_runtime)
|
|
70
|
+
logging_active_record = Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
|
|
71
|
+
|
|
72
|
+
log_message = 'Completed in %.0fms' % ms
|
|
73
|
+
|
|
74
|
+
if logging_view || logging_active_record
|
|
75
|
+
log_message << " ("
|
|
76
|
+
log_message << view_runtime if logging_view
|
|
77
|
+
|
|
78
|
+
if logging_active_record
|
|
79
|
+
log_message << ", " if logging_view
|
|
80
|
+
log_message << active_record_runtime + ")"
|
|
81
|
+
else
|
|
82
|
+
")"
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
log_message << " | #{response.status}"
|
|
87
|
+
log_message << " [#{complete_request_uri rescue "unknown"}]"
|
|
88
|
+
|
|
89
|
+
logger.info(log_message)
|
|
90
|
+
response.headers["X-Runtime"] = "%.0f" % ms
|
|
91
|
+
else
|
|
92
|
+
perform_action_without_benchmark
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
def view_runtime
|
|
97
|
+
"View: %.0f" % @view_runtime
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
def active_record_runtime
|
|
101
|
+
db_runtime = ActiveRecord::Base.connection.reset_runtime
|
|
102
|
+
db_runtime += @db_rt_before_render if @db_rt_before_render
|
|
103
|
+
db_runtime += @db_rt_after_render if @db_rt_after_render
|
|
104
|
+
"DB: %.0f" % db_runtime
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
end
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
require 'set'
|
|
2
|
+
|
|
3
|
+
module ActionController #:nodoc:
|
|
4
|
+
module Caching
|
|
5
|
+
# Action caching is similar to page caching by the fact that the entire output of the response is cached, but unlike page caching,
|
|
6
|
+
# every request still goes through the Action Pack. The key benefit of this is that filters are run before the cache is served, which
|
|
7
|
+
# allows for authentication and other restrictions on whether someone is allowed to see the cache. Example:
|
|
8
|
+
#
|
|
9
|
+
# class ListsController < ApplicationController
|
|
10
|
+
# before_filter :authenticate, :except => :public
|
|
11
|
+
# caches_page :public
|
|
12
|
+
# caches_action :index, :show, :feed
|
|
13
|
+
# end
|
|
14
|
+
#
|
|
15
|
+
# In this example, the public action doesn't require authentication, so it's possible to use the faster page caching method. But both the
|
|
16
|
+
# show and feed action are to be shielded behind the authenticate filter, so we need to implement those as action caches.
|
|
17
|
+
#
|
|
18
|
+
# Action caching internally uses the fragment caching and an around filter to do the job. The fragment cache is named according to both
|
|
19
|
+
# the current host and the path. So a page that is accessed at http://david.somewhere.com/lists/show/1 will result in a fragment named
|
|
20
|
+
# "david.somewhere.com/lists/show/1". This allows the cacher to differentiate between "david.somewhere.com/lists/" and
|
|
21
|
+
# "jamis.somewhere.com/lists/" -- which is a helpful way of assisting the subdomain-as-account-key pattern.
|
|
22
|
+
#
|
|
23
|
+
# Different representations of the same resource, e.g. <tt>http://david.somewhere.com/lists</tt> and <tt>http://david.somewhere.com/lists.xml</tt>
|
|
24
|
+
# are treated like separate requests and so are cached separately. Keep in mind when expiring an action cache that <tt>:action => 'lists'</tt> is not the same
|
|
25
|
+
# as <tt>:action => 'list', :format => :xml</tt>.
|
|
26
|
+
#
|
|
27
|
+
# You can set modify the default action cache path by passing a :cache_path option. This will be passed directly to ActionCachePath.path_for. This is handy
|
|
28
|
+
# for actions with multiple possible routes that should be cached differently. If a block is given, it is called with the current controller instance.
|
|
29
|
+
#
|
|
30
|
+
# And you can also use :if (or :unless) to pass a Proc that specifies when the action should be cached.
|
|
31
|
+
#
|
|
32
|
+
# Finally, if you are using memcached, you can also pass :expires_in.
|
|
33
|
+
#
|
|
34
|
+
# class ListsController < ApplicationController
|
|
35
|
+
# before_filter :authenticate, :except => :public
|
|
36
|
+
# caches_page :public
|
|
37
|
+
# caches_action :index, :if => Proc.new { |c| !c.request.format.json? } # cache if is not a JSON request
|
|
38
|
+
# caches_action :show, :cache_path => { :project => 1 }, :expires_in => 1.hour
|
|
39
|
+
# caches_action :feed, :cache_path => Proc.new { |controller|
|
|
40
|
+
# controller.params[:user_id] ?
|
|
41
|
+
# controller.send(:user_list_url, controller.params[:user_id], controller.params[:id]) :
|
|
42
|
+
# controller.send(:list_url, controller.params[:id]) }
|
|
43
|
+
# end
|
|
44
|
+
#
|
|
45
|
+
# If you pass :layout => false, it will only cache your action content. It is useful when your layout has dynamic information.
|
|
46
|
+
#
|
|
47
|
+
module Actions
|
|
48
|
+
def self.included(base) #:nodoc:
|
|
49
|
+
base.extend(ClassMethods)
|
|
50
|
+
base.class_eval do
|
|
51
|
+
attr_accessor :rendered_action_cache, :action_cache_path
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
module ClassMethods
|
|
56
|
+
# Declares that +actions+ should be cached.
|
|
57
|
+
# See ActionController::Caching::Actions for details.
|
|
58
|
+
def caches_action(*actions)
|
|
59
|
+
return unless cache_configured?
|
|
60
|
+
options = actions.extract_options!
|
|
61
|
+
filter_options = { :only => actions, :if => options.delete(:if), :unless => options.delete(:unless) }
|
|
62
|
+
|
|
63
|
+
cache_filter = ActionCacheFilter.new(:layout => options.delete(:layout), :cache_path => options.delete(:cache_path), :store_options => options)
|
|
64
|
+
around_filter(filter_options) do |controller, action|
|
|
65
|
+
cache_filter.filter(controller, action)
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
protected
|
|
71
|
+
def expire_action(options = {})
|
|
72
|
+
return unless cache_configured?
|
|
73
|
+
|
|
74
|
+
if options[:action].is_a?(Array)
|
|
75
|
+
options[:action].dup.each do |action|
|
|
76
|
+
expire_fragment(ActionCachePath.path_for(self, options.merge({ :action => action }), false))
|
|
77
|
+
end
|
|
78
|
+
else
|
|
79
|
+
expire_fragment(ActionCachePath.path_for(self, options, false))
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
class ActionCacheFilter #:nodoc:
|
|
84
|
+
def initialize(options, &block)
|
|
85
|
+
@options = options
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
def filter(controller, action)
|
|
89
|
+
should_continue = before(controller)
|
|
90
|
+
action.call if should_continue
|
|
91
|
+
after(controller)
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
def before(controller)
|
|
95
|
+
cache_path = ActionCachePath.new(controller, path_options_for(controller, @options.slice(:cache_path)))
|
|
96
|
+
if cache = controller.read_fragment(cache_path.path, @options[:store_options])
|
|
97
|
+
controller.rendered_action_cache = true
|
|
98
|
+
set_content_type!(controller, cache_path.extension)
|
|
99
|
+
options = { :text => cache }
|
|
100
|
+
options.merge!(:layout => true) if cache_layout?
|
|
101
|
+
controller.__send__(:render, options)
|
|
102
|
+
false
|
|
103
|
+
else
|
|
104
|
+
controller.action_cache_path = cache_path
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
def after(controller)
|
|
109
|
+
return if controller.rendered_action_cache || !caching_allowed(controller)
|
|
110
|
+
action_content = cache_layout? ? content_for_layout(controller) : controller.response.body
|
|
111
|
+
controller.write_fragment(controller.action_cache_path.path, action_content, @options[:store_options])
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
private
|
|
115
|
+
def set_content_type!(controller, extension)
|
|
116
|
+
controller.response.content_type = Mime::Type.lookup_by_extension(extension).to_s if extension
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
def path_options_for(controller, options)
|
|
120
|
+
((path_options = options[:cache_path]).respond_to?(:call) ? path_options.call(controller) : path_options) || {}
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
def caching_allowed(controller)
|
|
124
|
+
controller.request.get? && controller.response.status.to_i == 200
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
def cache_layout?
|
|
128
|
+
@options[:layout] == false
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
def content_for_layout(controller)
|
|
132
|
+
controller.response.layout && controller.response.template.instance_variable_get('@cached_content_for_layout')
|
|
133
|
+
end
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
class ActionCachePath
|
|
137
|
+
attr_reader :path, :extension
|
|
138
|
+
|
|
139
|
+
class << self
|
|
140
|
+
def path_for(controller, options, infer_extension = true)
|
|
141
|
+
new(controller, options, infer_extension).path
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# When true, infer_extension will look up the cache path extension from the request's path & format.
|
|
146
|
+
# This is desirable when reading and writing the cache, but not when expiring the cache -
|
|
147
|
+
# expire_action should expire the same files regardless of the request format.
|
|
148
|
+
def initialize(controller, options = {}, infer_extension = true)
|
|
149
|
+
if infer_extension
|
|
150
|
+
extract_extension(controller.request)
|
|
151
|
+
options = options.reverse_merge(:format => @extension) if options.is_a?(Hash)
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
path = controller.url_for(options).split('://').last
|
|
155
|
+
normalize!(path)
|
|
156
|
+
add_extension!(path, @extension)
|
|
157
|
+
@path = URI.unescape(path)
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
private
|
|
161
|
+
def normalize!(path)
|
|
162
|
+
path << 'index' if path[-1] == ?/
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
def add_extension!(path, extension)
|
|
166
|
+
path << ".#{extension}" if extension and !path.ends_with?(extension)
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
def extract_extension(request)
|
|
170
|
+
# Don't want just what comes after the last '.' to accommodate multi part extensions
|
|
171
|
+
# such as tar.gz.
|
|
172
|
+
@extension = request.path[/^[^.]+\.(.+)$/, 1] || request.cache_format
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
module ActionController #:nodoc:
|
|
2
|
+
module Caching
|
|
3
|
+
# Fragment caching is used for caching various blocks within templates without caching the entire action as a whole. This is useful when
|
|
4
|
+
# certain elements of an action change frequently or depend on complicated state while other parts rarely change or can be shared amongst multiple
|
|
5
|
+
# parties. The caching is done using the cache helper available in the Action View. A template with caching might look something like:
|
|
6
|
+
#
|
|
7
|
+
# <b>Hello <%= @name %></b>
|
|
8
|
+
# <% cache do %>
|
|
9
|
+
# All the topics in the system:
|
|
10
|
+
# <%= render :partial => "topic", :collection => Topic.find(:all) %>
|
|
11
|
+
# <% end %>
|
|
12
|
+
#
|
|
13
|
+
# This cache will bind to the name of the action that called it, so if this code was part of the view for the topics/list action, you would
|
|
14
|
+
# be able to invalidate it using <tt>expire_fragment(:controller => "topics", :action => "list")</tt>.
|
|
15
|
+
#
|
|
16
|
+
# This default behavior is of limited use if you need to cache multiple fragments per action or if the action itself is cached using
|
|
17
|
+
# <tt>caches_action</tt>, so we also have the option to qualify the name of the cached fragment with something like:
|
|
18
|
+
#
|
|
19
|
+
# <% cache(:action => "list", :action_suffix => "all_topics") do %>
|
|
20
|
+
#
|
|
21
|
+
# That would result in a name such as "/topics/list/all_topics", avoiding conflicts with the action cache and with any fragments that use a
|
|
22
|
+
# different suffix. Note that the URL doesn't have to really exist or be callable - the url_for system is just used to generate unique
|
|
23
|
+
# cache names that we can refer to when we need to expire the cache.
|
|
24
|
+
#
|
|
25
|
+
# The expiration call for this example is:
|
|
26
|
+
#
|
|
27
|
+
# expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics")
|
|
28
|
+
module Fragments
|
|
29
|
+
# Given a key (as described in <tt>expire_fragment</tt>), returns a key suitable for use in reading,
|
|
30
|
+
# writing, or expiring a cached fragment. If the key is a hash, the generated key is the return
|
|
31
|
+
# value of url_for on that hash (without the protocol). All keys are prefixed with "views/" and uses
|
|
32
|
+
# ActiveSupport::Cache.expand_cache_key for the expansion.
|
|
33
|
+
def fragment_cache_key(key)
|
|
34
|
+
ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, :views)
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def fragment_for(buffer, name = {}, options = nil, &block) #:nodoc:
|
|
38
|
+
if perform_caching
|
|
39
|
+
if cache = read_fragment(name, options)
|
|
40
|
+
buffer.concat(cache)
|
|
41
|
+
else
|
|
42
|
+
pos = buffer.length
|
|
43
|
+
block.call
|
|
44
|
+
write_fragment(name, buffer[pos..-1], options)
|
|
45
|
+
end
|
|
46
|
+
else
|
|
47
|
+
block.call
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Writes <tt>content</tt> to the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
|
|
52
|
+
def write_fragment(key, content, options = nil)
|
|
53
|
+
return content unless cache_configured?
|
|
54
|
+
|
|
55
|
+
key = fragment_cache_key(key)
|
|
56
|
+
|
|
57
|
+
self.class.benchmark "Cached fragment miss: #{key}" do
|
|
58
|
+
cache_store.write(key, content, options)
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
content
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# Reads a cached fragment from the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
|
|
65
|
+
def read_fragment(key, options = nil)
|
|
66
|
+
return unless cache_configured?
|
|
67
|
+
|
|
68
|
+
key = fragment_cache_key(key)
|
|
69
|
+
|
|
70
|
+
self.class.benchmark "Cached fragment hit: #{key}" do
|
|
71
|
+
cache_store.read(key, options)
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Check if a cached fragment from the location signified by <tt>key</tt> exists (see <tt>expire_fragment</tt> for acceptable formats)
|
|
76
|
+
def fragment_exist?(key, options = nil)
|
|
77
|
+
return unless cache_configured?
|
|
78
|
+
|
|
79
|
+
key = fragment_cache_key(key)
|
|
80
|
+
|
|
81
|
+
self.class.benchmark "Cached fragment exists?: #{key}" do
|
|
82
|
+
cache_store.exist?(key, options)
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Removes fragments from the cache.
|
|
87
|
+
#
|
|
88
|
+
# +key+ can take one of three forms:
|
|
89
|
+
# * String - This would normally take the form of a path, like
|
|
90
|
+
# <tt>"pages/45/notes"</tt>.
|
|
91
|
+
# * Hash - Treated as an implicit call to +url_for+, like
|
|
92
|
+
# <tt>{:controller => "pages", :action => "notes", :id => 45}</tt>
|
|
93
|
+
# * Regexp - Will remove any fragment that matches, so
|
|
94
|
+
# <tt>%r{pages/\d*/notes}</tt> might remove all notes. Make sure you
|
|
95
|
+
# don't use anchors in the regex (<tt>^</tt> or <tt>$</tt>) because
|
|
96
|
+
# the actual filename matched looks like
|
|
97
|
+
# <tt>./cache/filename/path.cache</tt>. Note: Regexp expiration is
|
|
98
|
+
# only supported on caches that can iterate over all keys (unlike
|
|
99
|
+
# memcached).
|
|
100
|
+
#
|
|
101
|
+
# +options+ is passed through to the cache store's <tt>delete</tt>
|
|
102
|
+
# method (or <tt>delete_matched</tt>, for Regexp keys.)
|
|
103
|
+
def expire_fragment(key, options = nil)
|
|
104
|
+
return unless cache_configured?
|
|
105
|
+
|
|
106
|
+
key = key.is_a?(Regexp) ? key : fragment_cache_key(key)
|
|
107
|
+
|
|
108
|
+
if key.is_a?(Regexp)
|
|
109
|
+
self.class.benchmark "Expired fragments matching: #{key.source}" do
|
|
110
|
+
cache_store.delete_matched(key, options)
|
|
111
|
+
end
|
|
112
|
+
else
|
|
113
|
+
self.class.benchmark "Expired fragment: #{key}" do
|
|
114
|
+
cache_store.delete(key, options)
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
end
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
require 'fileutils'
|
|
2
|
+
require 'uri'
|
|
3
|
+
|
|
4
|
+
module ActionController #:nodoc:
|
|
5
|
+
module Caching
|
|
6
|
+
# Page caching is an approach to caching where the entire action output of is stored as a HTML file that the web server
|
|
7
|
+
# can serve without going through Action Pack. This is the fastest way to cache your content as opposed to going dynamically
|
|
8
|
+
# through the process of generating the content. Unfortunately, this incredible speed-up is only available to stateless pages
|
|
9
|
+
# where all visitors are treated the same. Content management systems -- including weblogs and wikis -- have many pages that are
|
|
10
|
+
# a great fit for this approach, but account-based systems where people log in and manipulate their own data are often less
|
|
11
|
+
# likely candidates.
|
|
12
|
+
#
|
|
13
|
+
# Specifying which actions to cache is done through the <tt>caches_page</tt> class method:
|
|
14
|
+
#
|
|
15
|
+
# class WeblogController < ActionController::Base
|
|
16
|
+
# caches_page :show, :new
|
|
17
|
+
# end
|
|
18
|
+
#
|
|
19
|
+
# This will generate cache files such as <tt>weblog/show/5.html</tt> and <tt>weblog/new.html</tt>,
|
|
20
|
+
# which match the URLs used to trigger the dynamic generation. This is how the web server is able
|
|
21
|
+
# pick up a cache file when it exists and otherwise let the request pass on to Action Pack to generate it.
|
|
22
|
+
#
|
|
23
|
+
# Expiration of the cache is handled by deleting the cached file, which results in a lazy regeneration approach where the cache
|
|
24
|
+
# is not restored before another hit is made against it. The API for doing so mimics the options from +url_for+ and friends:
|
|
25
|
+
#
|
|
26
|
+
# class WeblogController < ActionController::Base
|
|
27
|
+
# def update
|
|
28
|
+
# List.update(params[:list][:id], params[:list])
|
|
29
|
+
# expire_page :action => "show", :id => params[:list][:id]
|
|
30
|
+
# redirect_to :action => "show", :id => params[:list][:id]
|
|
31
|
+
# end
|
|
32
|
+
# end
|
|
33
|
+
#
|
|
34
|
+
# Additionally, you can expire caches using Sweepers that act on changes in the model to determine when a cache is supposed to be
|
|
35
|
+
# expired.
|
|
36
|
+
module Pages
|
|
37
|
+
def self.included(base) #:nodoc:
|
|
38
|
+
base.extend(ClassMethods)
|
|
39
|
+
base.class_eval do
|
|
40
|
+
@@page_cache_directory = defined?(Rails.public_path) ? Rails.public_path : ""
|
|
41
|
+
##
|
|
42
|
+
# :singleton-method:
|
|
43
|
+
# The cache directory should be the document root for the web server and is set using <tt>Base.page_cache_directory = "/document/root"</tt>.
|
|
44
|
+
# For Rails, this directory has already been set to Rails.public_path (which is usually set to <tt>RAILS_ROOT + "/public"</tt>). Changing
|
|
45
|
+
# this setting can be useful to avoid naming conflicts with files in <tt>public/</tt>, but doing so will likely require configuring your
|
|
46
|
+
# web server to look in the new location for cached files.
|
|
47
|
+
cattr_accessor :page_cache_directory
|
|
48
|
+
|
|
49
|
+
@@page_cache_extension = '.html'
|
|
50
|
+
##
|
|
51
|
+
# :singleton-method:
|
|
52
|
+
# Most Rails requests do not have an extension, such as <tt>/weblog/new</tt>. In these cases, the page caching mechanism will add one in
|
|
53
|
+
# order to make it easy for the cached files to be picked up properly by the web server. By default, this cache extension is <tt>.html</tt>.
|
|
54
|
+
# If you want something else, like <tt>.php</tt> or <tt>.shtml</tt>, just set Base.page_cache_extension. In cases where a request already has an
|
|
55
|
+
# extension, such as <tt>.xml</tt> or <tt>.rss</tt>, page caching will not add an extension. This allows it to work well with RESTful apps.
|
|
56
|
+
cattr_accessor :page_cache_extension
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
module ClassMethods
|
|
61
|
+
# Expires the page that was cached with the +path+ as a key. Example:
|
|
62
|
+
# expire_page "/lists/show"
|
|
63
|
+
def expire_page(path)
|
|
64
|
+
return unless perform_caching
|
|
65
|
+
|
|
66
|
+
benchmark "Expired page: #{page_cache_file(path)}" do
|
|
67
|
+
File.delete(page_cache_path(path)) if File.exist?(page_cache_path(path))
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# Manually cache the +content+ in the key determined by +path+. Example:
|
|
72
|
+
# cache_page "I'm the cached content", "/lists/show"
|
|
73
|
+
def cache_page(content, path)
|
|
74
|
+
return unless perform_caching
|
|
75
|
+
|
|
76
|
+
benchmark "Cached page: #{page_cache_file(path)}" do
|
|
77
|
+
FileUtils.makedirs(File.dirname(page_cache_path(path)))
|
|
78
|
+
File.open(page_cache_path(path), "wb+") { |f| f.write(content) }
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Caches the +actions+ using the page-caching approach that'll store the cache in a path within the page_cache_directory that
|
|
83
|
+
# matches the triggering url.
|
|
84
|
+
#
|
|
85
|
+
# Usage:
|
|
86
|
+
#
|
|
87
|
+
# # cache the index action
|
|
88
|
+
# caches_page :index
|
|
89
|
+
#
|
|
90
|
+
# # cache the index action except for JSON requests
|
|
91
|
+
# caches_page :index, :if => Proc.new { |c| !c.request.format.json? }
|
|
92
|
+
def caches_page(*actions)
|
|
93
|
+
return unless perform_caching
|
|
94
|
+
options = actions.extract_options!
|
|
95
|
+
after_filter({:only => actions}.merge(options)) { |c| c.cache_page }
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
private
|
|
99
|
+
def page_cache_file(path)
|
|
100
|
+
name = (path.empty? || path == "/") ? "/index" : URI.unescape(path.chomp('/'))
|
|
101
|
+
name << page_cache_extension unless (name.split('/').last || name).include? '.'
|
|
102
|
+
return name
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
def page_cache_path(path)
|
|
106
|
+
page_cache_directory + page_cache_file(path)
|
|
107
|
+
end
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Expires the page that was cached with the +options+ as a key. Example:
|
|
111
|
+
# expire_page :controller => "lists", :action => "show"
|
|
112
|
+
def expire_page(options = {})
|
|
113
|
+
return unless perform_caching
|
|
114
|
+
|
|
115
|
+
if options.is_a?(Hash)
|
|
116
|
+
if options[:action].is_a?(Array)
|
|
117
|
+
options[:action].dup.each do |action|
|
|
118
|
+
self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :action => action)))
|
|
119
|
+
end
|
|
120
|
+
else
|
|
121
|
+
self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true)))
|
|
122
|
+
end
|
|
123
|
+
else
|
|
124
|
+
self.class.expire_page(options)
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Manually cache the +content+ in the key determined by +options+. If no content is provided, the contents of response.body is used
|
|
129
|
+
# If no options are provided, the requested url is used. Example:
|
|
130
|
+
# cache_page "I'm the cached content", :controller => "lists", :action => "show"
|
|
131
|
+
def cache_page(content = nil, options = nil)
|
|
132
|
+
return unless perform_caching && caching_allowed
|
|
133
|
+
|
|
134
|
+
path = case options
|
|
135
|
+
when Hash
|
|
136
|
+
url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :format => params[:format]))
|
|
137
|
+
when String
|
|
138
|
+
options
|
|
139
|
+
else
|
|
140
|
+
request.path
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
self.class.cache_page(content || response.body, path)
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
private
|
|
147
|
+
def caching_allowed
|
|
148
|
+
request.get? && response.status.to_i == 200
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
end
|
|
152
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
require 'active_record'
|
|
2
|
+
|
|
3
|
+
module ActionController #:nodoc:
|
|
4
|
+
module Caching
|
|
5
|
+
class Sweeper < ActiveRecord::Observer #:nodoc:
|
|
6
|
+
attr_accessor :controller
|
|
7
|
+
|
|
8
|
+
def before(controller)
|
|
9
|
+
self.controller = controller
|
|
10
|
+
callback(:before) if controller.perform_caching
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
def after(controller)
|
|
14
|
+
callback(:after) if controller.perform_caching
|
|
15
|
+
# Clean up, so that the controller can be collected after this request
|
|
16
|
+
self.controller = nil
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
protected
|
|
20
|
+
# gets the action cache path for the given options.
|
|
21
|
+
def action_path_for(options)
|
|
22
|
+
ActionController::Caching::Actions::ActionCachePath.path_for(controller, options)
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# Retrieve instance variables set in the controller.
|
|
26
|
+
def assigns(key)
|
|
27
|
+
controller.instance_variable_get("@#{key}")
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
private
|
|
31
|
+
def callback(timing)
|
|
32
|
+
controller_callback_method_name = "#{timing}_#{controller.controller_name.underscore}"
|
|
33
|
+
action_callback_method_name = "#{controller_callback_method_name}_#{controller.action_name}"
|
|
34
|
+
|
|
35
|
+
__send__(controller_callback_method_name) if respond_to?(controller_callback_method_name, true)
|
|
36
|
+
__send__(action_callback_method_name) if respond_to?(action_callback_method_name, true)
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
def method_missing(method, *arguments, &block)
|
|
40
|
+
return if @controller.nil?
|
|
41
|
+
@controller.__send__(method, *arguments, &block)
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
module ActionController #:nodoc:
|
|
2
|
+
module Caching
|
|
3
|
+
# Sweepers are the terminators of the caching world and responsible for expiring caches when model objects change.
|
|
4
|
+
# They do this by being half-observers, half-filters and implementing callbacks for both roles. A Sweeper example:
|
|
5
|
+
#
|
|
6
|
+
# class ListSweeper < ActionController::Caching::Sweeper
|
|
7
|
+
# observe List, Item
|
|
8
|
+
#
|
|
9
|
+
# def after_save(record)
|
|
10
|
+
# list = record.is_a?(List) ? record : record.list
|
|
11
|
+
# expire_page(:controller => "lists", :action => %w( show public feed ), :id => list.id)
|
|
12
|
+
# expire_action(:controller => "lists", :action => "all")
|
|
13
|
+
# list.shares.each { |share| expire_page(:controller => "lists", :action => "show", :id => share.url_key) }
|
|
14
|
+
# end
|
|
15
|
+
# end
|
|
16
|
+
#
|
|
17
|
+
# The sweeper is assigned in the controllers that wish to have its job performed using the <tt>cache_sweeper</tt> class method:
|
|
18
|
+
#
|
|
19
|
+
# class ListsController < ApplicationController
|
|
20
|
+
# caches_action :index, :show, :public, :feed
|
|
21
|
+
# cache_sweeper :list_sweeper, :only => [ :edit, :destroy, :share ]
|
|
22
|
+
# end
|
|
23
|
+
#
|
|
24
|
+
# In the example above, four actions are cached and three actions are responsible for expiring those caches.
|
|
25
|
+
#
|
|
26
|
+
# You can also name an explicit class in the declaration of a sweeper, which is needed if the sweeper is in a module:
|
|
27
|
+
#
|
|
28
|
+
# class ListsController < ApplicationController
|
|
29
|
+
# caches_action :index, :show, :public, :feed
|
|
30
|
+
# cache_sweeper OpenBar::Sweeper, :only => [ :edit, :destroy, :share ]
|
|
31
|
+
# end
|
|
32
|
+
module Sweeping
|
|
33
|
+
def self.included(base) #:nodoc:
|
|
34
|
+
base.extend(ClassMethods)
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
module ClassMethods #:nodoc:
|
|
38
|
+
def cache_sweeper(*sweepers)
|
|
39
|
+
configuration = sweepers.extract_options!
|
|
40
|
+
|
|
41
|
+
sweepers.each do |sweeper|
|
|
42
|
+
ActiveRecord::Base.observers << sweeper if defined?(ActiveRecord) and defined?(ActiveRecord::Base)
|
|
43
|
+
sweeper_instance = (sweeper.is_a?(Symbol) ? Object.const_get(sweeper.to_s.classify) : sweeper).instance
|
|
44
|
+
|
|
45
|
+
if sweeper_instance.is_a?(Sweeper)
|
|
46
|
+
around_filter(sweeper_instance, :only => configuration[:only])
|
|
47
|
+
else
|
|
48
|
+
after_filter(sweeper_instance, :only => configuration[:only])
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|