2007-01-22 14:43:50 +01:00
|
|
|
require 'fileutils'
|
2007-02-09 09:04:31 +01:00
|
|
|
require 'uri'
|
2007-10-15 19:16:54 +02:00
|
|
|
require 'set'
|
2007-01-22 14:43:50 +01:00
|
|
|
|
|
|
|
module ActionController #:nodoc:
|
|
|
|
# Caching is a cheap way of speeding up slow applications by keeping the result of calculations, renderings, and database calls
|
|
|
|
# around for subsequent requests. Action Controller affords you three approaches in varying levels of granularity: Page, Action, Fragment.
|
|
|
|
#
|
|
|
|
# You can read more about each approach and the sweeping assistance by clicking the modules below.
|
|
|
|
#
|
|
|
|
# Note: To turn off all caching and sweeping, set Base.perform_caching = false.
|
2008-05-18 06:22:34 +02:00
|
|
|
#
|
|
|
|
#
|
|
|
|
# == Caching stores
|
|
|
|
#
|
|
|
|
# All the caching stores from ActiveSupport::Cache is available to be used as backends for Action Controller caching. This setting only
|
|
|
|
# affects action and fragment caching as page caching is always written to disk.
|
|
|
|
#
|
|
|
|
# Configuration examples (MemoryStore is the default):
|
|
|
|
#
|
|
|
|
# ActionController::Base.cache_store = :memory_store
|
|
|
|
# ActionController::Base.cache_store = :file_store, "/path/to/cache/directory"
|
|
|
|
# ActionController::Base.cache_store = :drb_store, "druby://localhost:9192"
|
|
|
|
# ActionController::Base.cache_store = :mem_cache_store, "localhost"
|
|
|
|
# ActionController::Base.cache_store = MyOwnStore.new("parameter")
|
2007-01-22 14:43:50 +01:00
|
|
|
module Caching
|
2009-02-04 21:26:08 +01:00
|
|
|
autoload :Actions, 'action_controller/caching/actions'
|
|
|
|
autoload :Fragments, 'action_controller/caching/fragments'
|
|
|
|
autoload :Pages, 'action_controller/caching/pages'
|
2009-08-04 17:16:03 +02:00
|
|
|
autoload :Sweeper, 'action_controller/caching/sweeper'
|
2009-02-04 21:26:08 +01:00
|
|
|
autoload :Sweeping, 'action_controller/caching/sweeping'
|
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
def self.included(base) #:nodoc:
|
|
|
|
base.class_eval do
|
2008-05-18 06:22:34 +02:00
|
|
|
@@cache_store = nil
|
|
|
|
cattr_reader :cache_store
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# Defines the storage option for cached fragments
|
|
|
|
def self.cache_store=(store_option)
|
|
|
|
@@cache_store = ActiveSupport::Cache.lookup_store(store_option)
|
2007-12-21 08:48:59 +01:00
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
include Pages, Actions, Fragments
|
2009-02-04 21:26:08 +01:00
|
|
|
include Sweeping if defined?(ActiveRecord)
|
2008-05-18 06:22:34 +02:00
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
@@perform_caching = true
|
|
|
|
cattr_accessor :perform_caching
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
def self.cache_configured?
|
|
|
|
perform_caching && cache_store
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
protected
|
|
|
|
# Convenience accessor
|
|
|
|
def cache(key, options = {}, &block)
|
|
|
|
if cache_configured?
|
|
|
|
cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
|
2007-01-22 14:43:50 +01:00
|
|
|
else
|
2008-05-18 06:22:34 +02:00
|
|
|
yield
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-02-04 21:26:08 +01:00
|
|
|
private
|
2008-05-18 06:22:34 +02:00
|
|
|
def cache_configured?
|
|
|
|
self.class.cache_configured?
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
2009-02-04 21:26:08 +01:00
|
|
|
end
|