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

  • 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, MemCacheStore, MemoryStore, UnthreadedFileStore, UnthreadedMemoryStore

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.append_features(base) ⇒ Object

:nodoc:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/action_controller/caching.rb', line 249

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

    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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/action_controller/caching.rb', line 273

def cache_erb_fragment(block, name = {}, options = nil)
  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 = 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: %rpages/d*/notes Ensure you do not specify start and finish in the regex (^$) because the actual filename matched looks like ./cache/filename/path.cache



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/action_controller/caching.rb', line 310

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

#expire_matched_fragments(matcher = /.*/, options = nil) ⇒ Object

Deprecated – just call expire_fragment with a regular expression



327
328
329
 
# File 'lib/action_controller/caching.rb', line 327

def expire_matched_fragments(matcher = /.*/, options = nil) #:nodoc:
  expire_fragment(matcher, options)
end

#fragment_cache_key(name) ⇒ Object 



268
269
270
 
# File 'lib/action_controller/caching.rb', line 268

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

#read_fragment(name, options = nil) ⇒ Object 



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

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 



287
288
289
290
291
292
293
294
295
 
# File 'lib/action_controller/caching.rb', line 287

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