Class: Cachetastic::Cache
- Inherits:
-
Object
- Object
- Cachetastic::Cache
- Includes:
- Singleton
- Defined in:
- lib/cachetastic/cache.rb,
lib/cachetastic/store_object.rb
Overview
When creating a new ‘Cache’ this class should be extended. Once extended you’ll only need to override just the methods that are different for your cache.
class MyAwesomeCache < Cachetastic::Cache
end
MyAwesomeCache.set(1, "One")
MyAwesomeCache.get(1) # => "One"
MyAwesomeCache.update(1, "One!!")
MyAwesomeCache.get(1) # => "One!!"
MyAwesomeCache.delete(1)
MyAwesomeCache.get(1) # => nil
class MyAwesomeCache < Cachetastic::Cache
def get(key)
super(key) do
set(key, key * 10)
end
end
end
MyAwesomeCache.set(1, "One")
MyAwesomeCache.get(1) # => "One"
MyAwesomeCache.delete(1)
MyAwesomeCache.get(1) # => 10
Defined Under Namespace
Classes: StoreObject
Class Method Summary collapse
Instance Method Summary collapse
-
#adapter ⇒ Object
Returns the underlying Cachetastic::Adapters::Base for this cache.
-
#cache_klass ⇒ Object
:nodoc:.
-
#clear_adapter! ⇒ Object
Clears the adapter so it can be redefined.
-
#delete(key) ⇒ Object
Deletes an object from the cache.
-
#expire_all ⇒ Object
Expires all objects for this cache.
-
#get(key, &block) ⇒ Object
Returns an object from the cache for a given key.
-
#logger ⇒ Object
Returns the Cachetastic::Logger for this cache.
-
#set(key, value, expiry_time = nil) ⇒ Object
Set a particular object info the cache for the given key.
-
#to_configatron(*args) ⇒ Object
:nodoc:.
Class Method Details
.method_missing(sym, *args, &block) ⇒ Object
34 35 36 |
# File 'lib/cachetastic/cache.rb', line 34 def method_missing(sym, *args, &block) self.instance.send(sym, *args, &block) end |
Instance Method Details
#adapter ⇒ Object
Returns the underlying Cachetastic::Adapters::Base for this cache.
92 93 94 95 96 97 |
# File 'lib/cachetastic/cache.rb', line 92 def adapter unless @_adapter && @_adapter.valid? @_adapter = Cachetastic::Adapters.build(cache_klass) end @_adapter end |
#cache_klass ⇒ Object
:nodoc:
105 106 107 |
# File 'lib/cachetastic/cache.rb', line 105 def cache_klass # :nodoc: self.class end |
#clear_adapter! ⇒ Object
Clears the adapter so it can be redefined. This is useful if you have reconfigured the cache to use a different adapater, or different settings.
101 102 103 |
# File 'lib/cachetastic/cache.rb', line 101 def clear_adapter! @_adapter = nil end |
#delete(key) ⇒ Object
Deletes an object from the cache.
72 73 74 75 76 77 78 79 |
# File 'lib/cachetastic/cache.rb', line 72 def delete(key) do_with_logging(:delete, key) do retryable do self.adapter.delete(key) nil end end end |
#expire_all ⇒ Object
Expires all objects for this cache.
82 83 84 85 86 87 88 89 |
# File 'lib/cachetastic/cache.rb', line 82 def expire_all do_with_logging(:expire_all, nil) do retryable do self.adapter.expire_all nil end end end |
#get(key, &block) ⇒ Object
Returns an object from the cache for a given key. If the object comes back as nil and a block is given that block will be run and the results of the block will be returned. This can be used to JIT caches, just make sure in the block to call the set method because the results of the block are not automatically cached.
46 47 48 49 50 51 52 53 |
# File 'lib/cachetastic/cache.rb', line 46 def get(key, &block) do_with_logging(:get, key) do retryable do val = self.adapter.get(key) handle_store_object(key, adapter.unmarshal(val), &block) end end end |
#logger ⇒ Object
Returns the Cachetastic::Logger for this cache.
110 111 112 113 114 115 |
# File 'lib/cachetastic/cache.rb', line 110 def logger unless @_logger @_logger = Cachetastic::Logger.new(adapter.logger) end @_logger end |
#set(key, value, expiry_time = nil) ⇒ Object
Set a particular object info the cache for the given key.
An optional third parameter sets the expiry time for the object in the cache. If no expiry_time is passed in then the default expiry_time that has been configured will be used.
If there is an the expiry_swing setting is configured it will be +/- to the expiry time.
63 64 65 66 67 68 69 |
# File 'lib/cachetastic/cache.rb', line 63 def set(key, value, expiry_time = nil) do_with_logging(:set, key) do retryable do self.adapter.set(key, value, calculate_expiry_time(expiry_time)) end end end |
#to_configatron(*args) ⇒ Object
:nodoc:
117 118 119 |
# File 'lib/cachetastic/cache.rb', line 117 def to_configatron(*args) # :nodoc: self.class.to_configatron(*args) end |