2008-01-03 16:05:12 -05:00
|
|
|
module ActionController #:nodoc:
|
|
|
|
module Caching
|
|
|
|
# Fragment caching is used for caching various blocks within templates without caching the entire action as a whole. This is useful when
|
|
|
|
# certain elements of an action change frequently or depend on complicated state while other parts rarely change or can be shared amongst multiple
|
2008-07-16 08:00:36 -04:00
|
|
|
# parties. The caching is done using the cache helper available in the Action View. A template with caching might look something like:
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
|
|
|
# <b>Hello <%= @name %></b>
|
|
|
|
# <% cache do %>
|
|
|
|
# All the topics in the system:
|
|
|
|
# <%= render :partial => "topic", :collection => Topic.find(:all) %>
|
|
|
|
# <% end %>
|
|
|
|
#
|
2008-11-22 14:19:11 -05:00
|
|
|
# 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
|
|
|
|
# be able to invalidate it using <tt>expire_fragment(:controller => "topics", :action => "list")</tt>.
|
|
|
|
#
|
|
|
|
# This default behavior is of limited use if you need to cache multiple fragments per action or if the action itself is cached using
|
2008-01-03 16:05:12 -05:00
|
|
|
# <tt>caches_action</tt>, so we also have the option to qualify the name of the cached fragment with something like:
|
|
|
|
#
|
|
|
|
# <% cache(:action => "list", :action_suffix => "all_topics") do %>
|
|
|
|
#
|
2008-11-22 14:19:11 -05:00
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
# cache names that we can refer to when we need to expire the cache.
|
|
|
|
#
|
2008-01-03 16:05:12 -05:00
|
|
|
# The expiration call for this example is:
|
2008-11-22 14:19:11 -05:00
|
|
|
#
|
2008-01-03 16:05:12 -05:00
|
|
|
# expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics")
|
|
|
|
module Fragments
|
2008-11-22 14:19:11 -05:00
|
|
|
# Given a key (as described in <tt>expire_fragment</tt>), returns a key suitable for use in reading,
|
2008-01-03 16:05:12 -05:00
|
|
|
# writing, or expiring a cached fragment. If the key is a hash, the generated key is the return
|
|
|
|
# value of url_for on that hash (without the protocol). All keys are prefixed with "views/" and uses
|
|
|
|
# ActiveSupport::Cache.expand_cache_key for the expansion.
|
|
|
|
def fragment_cache_key(key)
|
|
|
|
ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, :views)
|
|
|
|
end
|
|
|
|
|
2008-07-15 15:41:38 -04:00
|
|
|
def fragment_for(buffer, name = {}, options = nil, &block) #:nodoc:
|
2008-06-24 14:53:49 -04:00
|
|
|
if perform_caching
|
2010-01-10 21:13:43 -05:00
|
|
|
if fragment_exist?(name, options)
|
|
|
|
buffer.safe_concat(read_fragment(name, options))
|
2008-06-24 14:53:49 -04:00
|
|
|
else
|
|
|
|
pos = buffer.length
|
|
|
|
block.call
|
2010-03-11 20:32:26 -05:00
|
|
|
content = buffer[pos..-1]
|
|
|
|
content = content.as_str if content.respond_to?(:as_str)
|
|
|
|
write_fragment(name, content, options)
|
2008-06-24 14:53:49 -04:00
|
|
|
end
|
2008-01-03 16:05:12 -05:00
|
|
|
else
|
|
|
|
block.call
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Writes <tt>content</tt> to the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
|
|
|
|
def write_fragment(key, content, options = nil)
|
2008-11-22 14:19:11 -05:00
|
|
|
return content unless cache_configured?
|
2008-01-03 16:05:12 -05:00
|
|
|
key = fragment_cache_key(key)
|
2009-10-07 10:17:50 -04:00
|
|
|
|
2010-01-03 14:39:42 -05:00
|
|
|
instrument_fragment_cache :write_fragment, key do
|
2008-01-03 16:05:12 -05:00
|
|
|
cache_store.write(key, content, options)
|
|
|
|
end
|
|
|
|
content
|
|
|
|
end
|
|
|
|
|
|
|
|
# Reads a cached fragment from the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
|
|
|
|
def read_fragment(key, options = nil)
|
|
|
|
return unless cache_configured?
|
|
|
|
key = fragment_cache_key(key)
|
2009-10-07 10:17:50 -04:00
|
|
|
|
2010-01-03 14:39:42 -05:00
|
|
|
instrument_fragment_cache :read_fragment, key do
|
2008-01-03 16:05:12 -05:00
|
|
|
cache_store.read(key, options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2008-05-16 13:10:30 -04:00
|
|
|
# Check if a cached fragment from the location signified by <tt>key</tt> exists (see <tt>expire_fragment</tt> for acceptable formats)
|
|
|
|
def fragment_exist?(key, options = nil)
|
|
|
|
return unless cache_configured?
|
|
|
|
key = fragment_cache_key(key)
|
2009-10-07 10:17:50 -04:00
|
|
|
|
2010-01-03 14:39:42 -05:00
|
|
|
instrument_fragment_cache :exist_fragment?, key do
|
2008-05-16 13:10:30 -04:00
|
|
|
cache_store.exist?(key, options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2008-12-06 21:27:53 -05:00
|
|
|
# Removes fragments from the cache.
|
|
|
|
#
|
|
|
|
# +key+ can take one of three forms:
|
|
|
|
# * String - This would normally take the form of a path, like
|
|
|
|
# <tt>"pages/45/notes"</tt>.
|
|
|
|
# * Hash - Treated as an implicit call to +url_for+, like
|
|
|
|
# <tt>{:controller => "pages", :action => "notes", :id => 45}</tt>
|
|
|
|
# * Regexp - Will remove any fragment that matches, so
|
|
|
|
# <tt>%r{pages/\d*/notes}</tt> might remove all notes. Make sure you
|
|
|
|
# don't use anchors in the regex (<tt>^</tt> or <tt>$</tt>) because
|
|
|
|
# the actual filename matched looks like
|
|
|
|
# <tt>./cache/filename/path.cache</tt>. Note: Regexp expiration is
|
|
|
|
# only supported on caches that can iterate over all keys (unlike
|
|
|
|
# memcached).
|
|
|
|
#
|
|
|
|
# +options+ is passed through to the cache store's <tt>delete</tt>
|
|
|
|
# method (or <tt>delete_matched</tt>, for Regexp keys.)
|
2008-01-03 16:05:12 -05:00
|
|
|
def expire_fragment(key, options = nil)
|
|
|
|
return unless cache_configured?
|
2009-09-19 11:31:47 -04:00
|
|
|
key = fragment_cache_key(key) unless key.is_a?(Regexp)
|
|
|
|
message = nil
|
2008-01-03 16:05:12 -05:00
|
|
|
|
2010-01-03 14:39:42 -05:00
|
|
|
instrument_fragment_cache :expire_fragment, key do
|
2009-09-19 11:31:47 -04:00
|
|
|
if key.is_a?(Regexp)
|
2008-01-03 16:05:12 -05:00
|
|
|
cache_store.delete_matched(key, options)
|
2009-09-19 11:31:47 -04:00
|
|
|
else
|
2008-01-03 16:05:12 -05:00
|
|
|
cache_store.delete(key, options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2010-01-03 14:39:42 -05:00
|
|
|
|
|
|
|
def instrument_fragment_cache(name, key)
|
2010-01-03 18:03:56 -05:00
|
|
|
ActiveSupport::Notifications.instrument("action_controller.#{name}", :key => key){ yield }
|
2010-01-03 14:39:42 -05:00
|
|
|
end
|
2008-01-03 16:05:12 -05:00
|
|
|
end
|
|
|
|
end
|
2008-05-16 13:10:30 -04:00
|
|
|
end
|