Module: ActionController::Caching::Fragments

Defined in:
lib/action_controller/caching.rb

Overview

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 parties. The caching is doing using the cache helper available in the Action View. A template with caching might look something like:

<b>Hello <%= @name %></b>
<% cache do %>
  All the topics in the system:
  <%= render_collection_of_partials "topic", Topic.find_all %>
<% end %>

This cache will bind to the name of action that called it. So you would be able to invalidate it using expire_fragment(:controller => "topics", :action => "list") – if that was the controller/action used. This is not too helpful if you need to cache multiple fragments per action or if the action itself is cached using caches_action. So instead we should qualify the name of the action used with something like:

<% cache(:action => "list", :action_suffix => "all_topics") do %>

That would result in a name such as “/topics/list/all_topics”, which wouldn’t conflict with any action cache and neither with another fragment using a different suffix. Note that the URL doesn’t have to really exist or be callable. We’re just using the url_for system to generate unique cache names that we can refer to later for expirations. The expiration call for this example would be expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics").

Fragment stores

In order to use the fragment caching, you need to designate where the caches should be stored. This is done by assigning a fragment store of which there are four different kinds:

  • FileStore: Keeps the fragments on disk in the cache_path, which works well for all types of environments and share the fragments for all the web server processes running off the same application directory.

  • MemoryStore: Keeps the fragments in memory, which is fine for WEBrick and for FCGI (if you don’t care that each FCGI process holds its own fragment store). It’s not suitable for CGI as the process is thrown away at the end of each request. It can potentially also take up a lot of memory since each process keeps all the caches in memory.

  • DRbStore: Keeps the fragments in the memory of a separate, shared DRb process. This works for all environments and only keeps one cache around for all processes, but requires that you run and manage a separate DRb process.

  • MemCachedStore: Works like DRbStore, but uses Danga’s MemCached instead.

Configuration examples (MemoryStore is the default):

ActionController::Base.fragment_cache_store = 
  ActionController::Caching::Fragments::MemoryStore.new

ActionController::Base.fragment_cache_store = 
  ActionController::Caching::Fragments::FileStore.new("/path/to/cache/directory")

ActionController::Base.fragment_cache_store = 
  ActionController::Caching::Fragments::DRbStore.new("druby://localhost:9192")

ActionController::Base.fragment_cache_store = 
  ActionController::Caching::Fragments::FileStore.new("localhost")

Defined Under Namespace

Classes: DRbStore, FileStore, MemCacheStore, MemoryStore

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.append_features(base) ⇒ Object

:nodoc:



251
252
253
254
255
256
257
 
# File 'lib/action_controller/caching.rb', line 251

def self.append_features(base) #:nodoc:
  super
  base.class_eval do
    @@fragment_cache_store = MemoryStore.new
    cattr_accessor :fragment_cache_store
  end
end

Instance Method Details

#cache_base_url ⇒ Object 



259
260
261
 
# File 'lib/action_controller/caching.rb', line 259

def cache_base_url
  @@cache_base_url ||= url_for(:controller => '')
end

#cache_erb_fragment(block, name = {}, options = {}) ⇒ Object

Called by CacheHelper#cache



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/action_controller/caching.rb', line 269

def cache_erb_fragment(block, name = {}, options = {})
  unless perform_caching then block.call; return end
  
  buffer = eval("_erbout", block.binding)

  if cache = read_fragment(name, options)
    buffer.concat(cache)
  else
    pos = buffer.length
    block.call
    write_fragment(name, buffer[pos..-1], options)
  end
end

#expire_fragment(name, options = {}) ⇒ Object 



300
301
302
303
304
 
# File 'lib/action_controller/caching.rb', line 300

def expire_fragment(name, options = {})
  key = fragment_cache_key(name)
  fragment_cache_store.delete(key, options)
  logger.info "Expired fragment: #{key}" unless logger.nil?
end

#expire_matched_fragments(re = Regexp.new('/.*/'), options = {}) ⇒ Object 



306
307
308
309
310
 
# File 'lib/action_controller/caching.rb', line 306

def expire_matched_fragments(re=Regexp.new('/.*/'), options = {})
  rp = cache_base_url.split("://").last
  fragment_cache_store.delete_matched(re, { :root_path => rp })
  logger.info "Expired all fragments matching: #{rp}#{re.source}" unless logger.nil?
end

#fragment_cache_key(name) ⇒ Object 



263
264
265
266
 
# File 'lib/action_controller/caching.rb', line 263

def fragment_cache_key(name)
  key = name.is_a?(Hash) ? url_for(name) : cache_base_url + name
  key.split("://").last
end

#read_fragment(name, options = {}) ⇒ Object 



290
291
292
293
294
295
296
297
298
 
# File 'lib/action_controller/caching.rb', line 290

def read_fragment(name, options = {})
  key = fragment_cache_key(name)
  if cache = fragment_cache_store.read(key, options)
    logger.info "Fragment hit: #{key}" unless logger.nil?
    cache
  else
    false
  end
end

#write_fragment(name, content, options = {}) ⇒ Object 



283
284
285
286
287
288
 
# File 'lib/action_controller/caching.rb', line 283

def write_fragment(name, content, options = {})
  key = fragment_cache_key(name)
  fragment_cache_store.write(key, content, options)
  logger.info "Cached fragment: #{key}" unless logger.nil?
  content
end