aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_view/helpers/cache_helper.rb
blob: eb631cf201e602c99d04b3ea63cb1f3fb6ff0982 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
module ActionView
  module Helpers
    # This helper to exposes a method for caching of view fragments.
    # See ActionController::Caching::Fragments for usage instructions.
    module CacheHelper
      # A method for caching fragments of a view rather than an entire
      # action or page.  This technique is useful caching pieces like
      # menus, lists of news topics, static HTML fragments, and so on.
      # This method takes a block that contains the content you wish
      # to cache.  See ActionController::Caching::Fragments for more
      # information.
      #
      # ==== Examples
      # If you wanted to cache a navigation menu, you could do the
      # following.
      #
      #   <% cache do %>
      #     <%= render :partial => "menu" %>
      #   <% end %>
      #
      # You can also cache static content...
      #
      #   <% cache do %>
      #      <p>Hello users!  Welcome to our website!</p>
      #   <% end %>
      #
      # ...and static content mixed with RHTML content.
      #
      #    <% cache do %>
      #      Topics:
      #      <%= render :partial => "topics", :collection => @topic_list %>
      #      <i>Topics listed alphabetically</i>
      #    <% end %>
      def cache(name = {}, options = nil, &block)
        template_extension = first_render[/\.(\w+)$/, 1].to_sym

        case template_extension
        when :erb, :rhtml
          @controller.cache_erb_fragment(block, name, options)
        when :rjs
          @controller.cache_rjs_fragment(block, name, options)
        when :builder, :rxml
          @controller.cache_rxml_fragment(block, name, options)
        else
          # do a last ditch effort for those brave souls using
          # different template engines. This should give plugin
          # writters a simple hook.
          unless @controller.respond_to?("cache_#{template_extension}_fragment")
            raise "fragment caching not supported for #{template_extension} files."
          end

          @controller.send!("cache_#{template_extension}_fragment", block, name, options)
        end
      end
    end
  end
end