Class Index [+]

Quicksearch

ActiveSupport::Cache

See ActiveSupport::Cache::Store for documentation.

Constants

UNIVERSAL_OPTIONS

These options mean something to all cache implementations. Individual cache implementations may support additional options.

Public Class Methods

expand_cache_key(key, namespace = nil) click to toggle source
    # File lib/active_support/cache.rb, line 77
77:       def expand_cache_key(key, namespace = nil)
78:         expanded_cache_key = namespace ? "#{namespace}/" : ""
79: 
80:         if prefix = ENV["RAILS_CACHE_ID"] || ENV["RAILS_APP_VERSION"]
81:           expanded_cache_key << "#{prefix}/"
82:         end
83: 
84:         expanded_cache_key << retrieve_cache_key(key)
85:         expanded_cache_key
86:       end
lookup_store(*store_option) click to toggle source

Creates a new CacheStore object according to the given options.

If no arguments are passed to this method, then a new ActiveSupport::Cache::MemoryStore object will be returned.

If you pass a Symbol as the first argument, then a corresponding cache store class under the ActiveSupport::Cache namespace will be created. For example:

  ActiveSupport::Cache.lookup_store(:memory_store)
  # => returns a new ActiveSupport::Cache::MemoryStore object

  ActiveSupport::Cache.lookup_store(:mem_cache_store)
  # => returns a new ActiveSupport::Cache::MemCacheStore object

Any additional arguments will be passed to the corresponding cache store class’s constructor:

  ActiveSupport::Cache.lookup_store(:file_store, "/tmp/cache")
  # => same as: ActiveSupport::Cache::FileStore.new("/tmp/cache")

If the first argument is not a Symbol, then it will simply be returned:

  ActiveSupport::Cache.lookup_store(MyOwnCacheStore.new)
  # => returns MyOwnCacheStore.new
    # File lib/active_support/cache.rb, line 55
55:       def lookup_store(*store_option)
56:         store, *parameters = *Array.wrap(store_option).flatten
57: 
58:         case store
59:         when Symbol
60:           store_class_name = store.to_s.camelize
61:           store_class =
62:             begin
63:               require "active_support/cache/#{store}"
64:             rescue LoadError => e
65:               raise "Could not find cache store adapter for #{store} (#{e})"
66:             else
67:               ActiveSupport::Cache.const_get(store_class_name)
68:             end
69:           store_class.new(*parameters)
70:         when nil
71:           ActiveSupport::Cache::MemoryStore.new
72:         else
73:           store
74:         end
75:       end

Private Class Methods

retrieve_cache_key(key) click to toggle source
    # File lib/active_support/cache.rb, line 90
90:       def retrieve_cache_key(key)
91:         case
92:         when key.respond_to?(:cache_key) then key.cache_key
93:         when key.is_a?(Array)            then key.map { |element| retrieve_cache_key(element) }.to_param
94:         else                                  key.to_param
95:         end.to_s
96:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.