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 :partial => "topic", :collection => Topic.find(:all) %>
<% end %>

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 expire_fragment(:controller => "topics", :action => "list").

This default behavior is of limited use if you need to cache multiple fragments per action or if the action itself is cached using caches_action, 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 %>

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.

The expiration call for this example is:

expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics")

Fragment stores

By default, cached fragments are stored in memory. The available store options are:

  • FileStore: Keeps the fragments on disk in the cache_path, which works well for all types of environments and allows all processes running from the same application directory to access the cached content.

  • 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.

  • MemCacheStore: Works like DRbStore, but uses Danga’s MemCache instead. Requires the ruby-memcache library: gem install ruby-memcache.

Configuration examples (MemoryStore is the default):

ActionController::Base.fragment_cache_store = :memory_store
ActionController::Base.fragment_cache_store = :file_store, "/path/to/cache/directory"
ActionController::Base.fragment_cache_store = :drb_store, "druby://localhost:9192"
ActionController::Base.fragment_cache_store = :mem_cache_store, "localhost"
ActionController::Base.fragment_cache_store = MyOwnStore.new("parameter")

Defined Under Namespace

Modules: ThreadSafety Classes: DRbStore, FileStore, MemoryStore, UnthreadedFileStore, UnthreadedMemoryStore

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/action_controller/caching.rb', line 348

def self.included(base) #:nodoc:
  base.class_eval do
    @@fragment_cache_store = MemoryStore.new
    cattr_reader :fragment_cache_store

    # Defines the storage option for cached fragments
    def self.fragment_cache_store=(store_option)
      store, *parameters = *([ store_option ].flatten)
      @@fragment_cache_store = if store.is_a?(Symbol)
        store_class_name = (store == :drb_store ? "DRbStore" : store.to_s.camelize)
        store_class = ActionController::Caching::Fragments.const_get(store_class_name)
        store_class.new(*parameters)
      else
        store
      end
    end
  end
end

Instance Method Details

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

Called by CacheHelper#cache



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/action_controller/caching.rb', line 375

def cache_erb_fragment(block, name = {}, options = nil)
  unless perform_caching then block.call; return end

  buffer = eval(ActionView::Base.erb_variable, 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 = nil) ⇒ Object

Name can take one of three forms:

  • String: This would normally take the form of a path like “pages/45/notes”

  • Hash: Is treated as an implicit call to url_for, like { :controller => “pages”, :action => “notes”, :id => 45 }

  • Regexp: Will destroy all the matched fragments, example:

    %r{pages/\d*/notes}

    Ensure you do not specify start and finish in the regex (^$) because the actual filename matched looks like ./cache/filename/path.cache Regexp expiration is only supported on caches that can iterate over all keys (unlike memcached).



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/action_controller/caching.rb', line 419

def expire_fragment(name, options = nil)
  return unless perform_caching

  key = fragment_cache_key(name)

  if key.is_a?(Regexp)
    self.class.benchmark "Expired fragments matching: #{key.source}" do
      fragment_cache_store.delete_matched(key, options)
    end
  else
    self.class.benchmark "Expired fragment: #{key}" do
      fragment_cache_store.delete(key, options)
    end
  end
end

#fragment_cache_key(name) ⇒ Object

Given a name (as described in expire_fragment), returns a key suitable for use in reading, writing, or expiring a cached fragment. If the name is a hash, the generated name is the return value of url_for on that hash (without the protocol).



370
371
372
 
# File 'lib/action_controller/caching.rb', line 370

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

#read_fragment(name, options = nil) ⇒ Object

Reads a cached fragment from the location signified by name (see expire_fragment for acceptable formats)



401
402
403
404
405
406
407
408
 
# File 'lib/action_controller/caching.rb', line 401

def read_fragment(name, options = nil)
  return unless perform_caching

  key = fragment_cache_key(name)
  self.class.benchmark "Fragment read: #{key}" do
    fragment_cache_store.read(key, options)
  end
end

#write_fragment(name, content, options = nil) ⇒ Object

Writes content to the location signified by name (see expire_fragment for acceptable formats)



390
391
392
393
394
395
396
397
398
 
# File 'lib/action_controller/caching.rb', line 390

def write_fragment(name, content, options = nil)
  return unless perform_caching

  key = fragment_cache_key(name)
  self.class.benchmark "Cached fragment: #{key}" do
    fragment_cache_store.write(key, content, options)
  end
  content
end