| Module | Cachetastic::Cacheable::ClassAndInstanceMethods |
| In: |
lib/cachetastic/cacheable.rb
|
Returns the Cachetastic::Caches::Base object associated with the object. If a cache hasn‘t been defined the one will be created on the fly. The cache for the object is expected to be defined as: Cachetastic::Cacheable::{CLASS_NAME_HERE}Cache
Example:
class Person
include Cachetastic::Cacheable
attr_accessor :name
def cachetastic_key
self.name
end
end
Person.cache_class # => Cachetastic::Cacheable::PersonCache
# File lib/cachetastic/cacheable.rb, line 39
39: def cache_class
40: n = self.class.name
41: n = self.name if n == "Class"
42: # puts "n: #{n}"
43: c_name = "Cachetastic::Cacheable::#{n}Cache"
44: unless Cachetastic::Cacheable.const_defined?("#{n}Cache")
45: # puts "we need to create a cache for: #{c_name}"
46: eval %{
47: class #{c_name} < Cachetastic::Caches::Base
48: end
49: }
50: end
51: c_name.constantize
52: end
How much did I want to call this method cache?? It originally was that, but in Rails 2.0 they decided to use that name, so I had to rename this method. This method will attempt to get an object from the cache for a given key. If the object is nil and a block is given the block will be run, and the results of the block will be automatically cached.
Example:
class Person
include Cachetastic::Cacheable
attr_accessor :name
def cachetastic_key
self.name
end
def always_the_same(x,y)
cacher("always_the_same") do
x + y
end
end
end
Person.new.always_the_same(1,2) # => 3
Person.new.always_the_same(2,2) # => 3
Person.new.always_the_same(3,3) # => 3
Person.cacher("always_the_same") # => 3
Person.get_from_cache("always_the_same") # => 3
Cachetastic::Cacheable::PersonCache.get("always_the_same") # => 3
Person.cacher("say_hi") {"Hi There"} # => "Hi There"
Person.get_from_cache("say_hi") # => "Hi There"
Cachetastic::Cacheable::PersonCache.get("say_hi") # => "Hi There"
# File lib/cachetastic/cacheable.rb, line 84
84: def cacher(key, expiry = 0)
85: cache_class.get(key) do
86: if block_given?
87: res = yield
88: cache_class.set(key, res, expiry)
89: end
90: end
91: end
Expires the entire cache associated with this objects‘s cache.
Example:
class Person
include Cachetastic::Cacheable
attr_accessor :name
def cachetastic_key
self.name
end
end
Person.set_into_cache(1, "one")
Person.get_from_cache(1) # => "one"
Person.expire_all
Person.get_from_cache(1) # => nil
Person.set_into_cache(1, "one")
Person.get_from_cache(1) # => "one"
Cachetastic::Cacheable::PersonCache.expire_all
Person.get_from_cache(1) # => nil
# File lib/cachetastic/cacheable.rb, line 112
112: def expire_all
113: cache_class.expire_all
114: end