2005-01-08 18:32:11 -05:00
|
|
|
require 'fileutils'
|
2006-08-08 17:21:04 -04:00
|
|
|
require 'uri'
|
2007-05-27 03:38:09 -04:00
|
|
|
require 'set'
|
2005-01-08 18:32:11 -05:00
|
|
|
|
|
|
|
module ActionController #:nodoc:
|
2009-10-29 00:37:29 -04:00
|
|
|
# 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.
|
2005-01-15 17:16:41 -05:00
|
|
|
#
|
2009-10-29 00:37:29 -04:00
|
|
|
# You can read more about each approach and the sweeping assistance by clicking the
|
|
|
|
# modules below.
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
2009-10-29 00:37:29 -04:00
|
|
|
# Note: To turn off all caching and sweeping, set
|
|
|
|
# config.action_controller.perform_caching = false.
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
|
|
|
# == Caching stores
|
|
|
|
#
|
2009-10-29 00:37:29 -04:00
|
|
|
# All the caching stores from ActiveSupport::Cache are 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.
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
|
|
|
# Configuration examples (MemoryStore is the default):
|
|
|
|
#
|
2009-10-29 00:37:29 -04:00
|
|
|
# config.action_controller.cache_store = :memory_store
|
|
|
|
# config.action_controller.cache_store = :file_store, "/path/to/cache/directory"
|
|
|
|
# config.action_controller.cache_store = :drb_store, "druby://localhost:9192"
|
|
|
|
# config.action_controller.cache_store = :mem_cache_store, "localhost"
|
2009-11-01 10:46:12 -05:00
|
|
|
# config.action_controller.cache_store = :mem_cache_store, Memcached::Rails.new("localhost:11211")
|
2009-10-29 00:37:29 -04:00
|
|
|
# config.action_controller.cache_store = MyOwnStore.new("parameter")
|
2005-01-11 17:03:27 -05:00
|
|
|
module Caching
|
2009-05-28 12:35:36 -04:00
|
|
|
extend ActiveSupport::Concern
|
2009-12-02 23:01:01 -05:00
|
|
|
extend ActiveSupport::Autoload
|
2009-05-19 21:02:03 -04:00
|
|
|
|
2009-12-22 18:27:37 -05:00
|
|
|
eager_autoload do
|
|
|
|
autoload :Actions
|
|
|
|
autoload :Fragments
|
|
|
|
autoload :Pages
|
|
|
|
autoload :Sweeper, 'action_controller/caching/sweeping'
|
|
|
|
autoload :Sweeping, 'action_controller/caching/sweeping'
|
|
|
|
end
|
2008-11-23 17:35:13 -05:00
|
|
|
|
2009-05-19 21:02:03 -04:00
|
|
|
included do
|
|
|
|
@@cache_store = nil
|
|
|
|
cattr_reader :cache_store
|
2007-09-17 02:15:58 -04:00
|
|
|
|
2009-05-19 21:02:03 -04:00
|
|
|
# Defines the storage option for cached fragments
|
|
|
|
def self.cache_store=(store_option)
|
|
|
|
@@cache_store = ActiveSupport::Cache.lookup_store(store_option)
|
|
|
|
end
|
2007-09-17 02:15:58 -04:00
|
|
|
|
2009-05-19 21:02:03 -04:00
|
|
|
include Pages, Actions, Fragments
|
|
|
|
include Sweeping if defined?(ActiveRecord)
|
2008-01-03 16:05:12 -05:00
|
|
|
|
2009-05-19 21:02:03 -04:00
|
|
|
@@perform_caching = true
|
|
|
|
cattr_accessor :perform_caching
|
2009-10-29 00:37:29 -04:00
|
|
|
end
|
2005-01-08 18:32:11 -05:00
|
|
|
|
2009-10-29 00:37:29 -04:00
|
|
|
module ClassMethods
|
|
|
|
def cache_configured?
|
2009-05-19 21:02:03 -04:00
|
|
|
perform_caching && cache_store
|
2005-01-08 18:32:11 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-10-28 16:53:34 -04:00
|
|
|
def caching_allowed?
|
|
|
|
request.get? && response.status == 200
|
|
|
|
end
|
2005-01-10 13:20:58 -05:00
|
|
|
|
2009-10-28 16:53:34 -04:00
|
|
|
protected
|
|
|
|
# Convenience accessor
|
|
|
|
def cache(key, options = {}, &block)
|
|
|
|
if cache_configured?
|
|
|
|
cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
|
|
|
|
else
|
|
|
|
yield
|
2005-01-10 13:20:58 -05:00
|
|
|
end
|
2009-10-28 16:53:34 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
def cache_configured?
|
|
|
|
self.class.cache_configured?
|
|
|
|
end
|
2005-01-08 18:32:11 -05:00
|
|
|
end
|
2008-11-23 17:35:13 -05:00
|
|
|
end
|