Module: ActionController::Caching::Actions

Defined in:
lib/action_controller/caching.rb

Overview

Action caching is similar to page caching by the fact that the entire output of the response is cached, but unlike page caching, every request still goes through the Action Pack. The key benefit of this is that filters are run before the cache is served, which allows for authentication and other restrictions on whether someone is allowed to see the cache. Example:

class ListsController < ApplicationController
  before_filter :authenticate, :except => :public
  caches_page   :public
  caches_action :show, :feed
end

In this example, the public action doesn’t require authentication, so it’s possible to use the faster page caching method. But both the show and feed action are to be shielded behind the authenticate filter, so we need to implement those as action caches.

Action caching internally uses the fragment caching and an around filter to do the job. The fragment cache is named according to both the current host and the path. So a page that is accessed at david.somewhere.com/lists/show/1 will result in a fragment named “david.somewhere.com/lists/show/1”. This allows the cacher to differentiate between “david.somewhere.com/lists/” and “jamis.somewhere.com/lists/” – which is a helpful way of assisting the subdomain-as-account-key pattern.

Different representations of the same resource, e.g. http://david.somewhere.com/lists and http://david.somewhere.com/lists.xml are treated like separate requests and so are cached separately. Keep in mind when expiring an action cache that :action => 'lists' is not the same as :action => 'list', :format => :xml.

You can set modify the default action cache path by passing a :cache_path option. This will be passed directly to ActionCachePath.path_for. This is handy for actions with multiple possible routes that should be cached differently. If a block is given, it is called with the current controller instance.

class ListsController < ApplicationController
  before_filter :authenticate, :except => :public
  caches_page   :public
  caches_action :show, :cache_path => { :project => 1 }
  caches_action :show, :cache_path => Proc.new { |controller| 
    controller.params[:user_id] ? 
      controller.send(:user_list_url, c.params[:user_id], c.params[:id]) :
      controller.send(:list_url, c.params[:id]) }
end

Defined Under Namespace

Modules: ClassMethods Classes: ActionCacheFilter, ActionCachePath

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



196
197
198
199
200
201
202
 
# File 'lib/action_controller/caching.rb', line 196

def self.included(base) #:nodoc:
  base.extend(ClassMethods)
    base.class_eval do
      attr_accessor :rendered_action_cache, :action_cache_path
      alias_method_chain :protected_instance_variables, :action_caching
    end
end

Instance Method Details

#expire_action(options = {}) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/action_controller/caching.rb', line 217

def expire_action(options = {})
  return unless perform_caching
  if options[:action].is_a?(Array)
    options[:action].dup.each do |action|
      expire_fragment(ActionCachePath.path_for(self, options.merge({ :action => action })))
    end
  else
    expire_fragment(ActionCachePath.path_for(self, options))
  end
end

#protected_instance_variables_with_action_caching ⇒ Object 



213
214
215
 
# File 'lib/action_controller/caching.rb', line 213

def protected_instance_variables_with_action_caching
  protected_instance_variables_without_action_caching + %w(@action_cache_path)
end