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
|
|
|
|
2012-10-03 12:14:28 -04:00
|
|
|
module ActionController
|
2010-08-26 15:58:57 -04:00
|
|
|
# \Caching is a cheap way of speeding up slow applications by keeping the result of
|
2009-10-29 00:37:29 -04:00
|
|
|
# calculations, renderings, and database calls around for subsequent requests.
|
2005-01-15 17:16:41 -05:00
|
|
|
#
|
2012-12-03 18:20:27 -05:00
|
|
|
# You can read more about each approach by clicking the modules below.
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
2012-10-14 19:00:57 -04:00
|
|
|
# Note: To turn off all caching, set
|
2013-07-22 08:13:18 -04:00
|
|
|
# config.action_controller.perform_caching = false
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
2010-08-26 15:58:57 -04:00
|
|
|
# == \Caching stores
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
2009-10-29 00:37:29 -04:00
|
|
|
# All the caching stores from ActiveSupport::Cache are available to be used as backends
|
2012-10-03 12:14:28 -04:00
|
|
|
# for Action Controller caching.
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
2014-08-13 09:26:03 -04:00
|
|
|
# Configuration examples (FileStore is the default):
|
2008-01-03 16:05:12 -05:00
|
|
|
#
|
2009-10-29 00:37:29 -04:00
|
|
|
# config.action_controller.cache_store = :memory_store
|
2012-09-22 20:42:40 -04:00
|
|
|
# config.action_controller.cache_store = :file_store, '/path/to/cache/directory'
|
|
|
|
# config.action_controller.cache_store = :mem_cache_store, 'localhost'
|
|
|
|
# config.action_controller.cache_store = :mem_cache_store, Memcached::Rails.new('localhost:11211')
|
|
|
|
# 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 :Fragments
|
|
|
|
end
|
2008-11-23 17:35:13 -05:00
|
|
|
|
2010-03-04 19:50:57 -05:00
|
|
|
module ConfigMethods
|
|
|
|
def cache_store
|
|
|
|
config.cache_store
|
|
|
|
end
|
2007-09-17 02:15:58 -04:00
|
|
|
|
2010-03-04 19:50:57 -05:00
|
|
|
def cache_store=(store)
|
|
|
|
config.cache_store = ActiveSupport::Cache.lookup_store(store)
|
2009-05-19 21:02:03 -04:00
|
|
|
end
|
2007-09-17 02:15:58 -04:00
|
|
|
|
2012-08-29 12:30:01 -04:00
|
|
|
private
|
|
|
|
def cache_configured?
|
|
|
|
perform_caching && cache_store
|
|
|
|
end
|
2010-03-04 19:50:57 -05:00
|
|
|
end
|
|
|
|
|
2012-06-13 15:14:11 -04:00
|
|
|
include RackDelegation
|
|
|
|
include AbstractController::Callbacks
|
|
|
|
|
2010-03-04 19:50:57 -05:00
|
|
|
include ConfigMethods
|
2012-10-03 12:14:28 -04:00
|
|
|
include Fragments
|
2010-03-04 19:50:57 -05:00
|
|
|
|
|
|
|
included do
|
|
|
|
extend ConfigMethods
|
|
|
|
|
2012-10-03 16:35:19 -04:00
|
|
|
config_accessor :default_static_extension
|
|
|
|
self.default_static_extension ||= '.html'
|
|
|
|
|
2010-04-22 06:00:13 -04:00
|
|
|
config_accessor :perform_caching
|
|
|
|
self.perform_caching = true if perform_caching.nil?
|
2013-01-08 13:20:47 -05:00
|
|
|
|
|
|
|
class_attribute :_view_cache_dependencies
|
|
|
|
self._view_cache_dependencies = []
|
|
|
|
helper_method :view_cache_dependencies if respond_to?(:helper_method)
|
|
|
|
end
|
|
|
|
|
|
|
|
module ClassMethods
|
|
|
|
def view_cache_dependency(&dependency)
|
|
|
|
self._view_cache_dependencies += [dependency]
|
|
|
|
end
|
2009-10-29 00:37:29 -04:00
|
|
|
end
|
2005-01-08 18:32:11 -05:00
|
|
|
|
2013-01-08 13:20:47 -05:00
|
|
|
def view_cache_dependencies
|
2013-01-10 10:34:40 -05:00
|
|
|
self.class._view_cache_dependencies.map { |dep| instance_exec(&dep) }.compact
|
2013-01-08 13:20:47 -05:00
|
|
|
end
|
|
|
|
|
2012-08-29 12:30:17 -04:00
|
|
|
protected
|
2012-09-22 20:42:40 -04:00
|
|
|
# Convenience accessor.
|
2012-08-29 12:30:17 -04:00
|
|
|
def cache(key, options = {}, &block)
|
|
|
|
if cache_configured?
|
|
|
|
cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
|
|
|
|
else
|
|
|
|
yield
|
|
|
|
end
|
2005-01-10 13:20:58 -05:00
|
|
|
end
|
2005-01-08 18:32:11 -05:00
|
|
|
end
|
2008-11-23 17:35:13 -05:00
|
|
|
end
|