Class: Card::Cache::Persistent

Inherits:
Object
  • Object
show all
Extended by:
PersistentClass
Defined in:
lib/card/cache/persistent.rb

Overview

Persistent (or Hard) caches closely mirror the database and are intended to be altered only upon database alterations.

Unlike the database, the persistent cache stores records of records that have been requested but are missing or, in the case of some cards, “virtual”, meaning that they follow known patterns but do not exist in the database.

Most persistent cache implementations cannot store objects with singleton classes, therefore cards generally must have set_modules re-included after retrieval from the persistent cache.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from PersistentClass

new_stamp

Constructor Details

#initialize(opts) ⇒ Persistent

Returns a new instance of Persistent.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :store (Rails::Cache)
  • :class, (ruby Class) —

    typically ActiveRecord descendant

  • :database (String) 


26
27
28
29
30
31
32
 
# File 'lib/card/cache/persistent.rb', line 26

def initialize opts
  @store = opts[:store]
  @file_cache = @store.is_a? ActiveSupport::Cache::FileStore
  @klass = opts[:class]
  @class_key = @klass.to_s.to_name.key
  @database = opts[:database] || Cardio.database
end

Instance Attribute Details

#prefix ⇒ Object

prefix added to cache key to create a system-wide unique key



68
69
70
 
# File 'lib/card/cache/persistent.rb', line 68

def prefix
  @prefix
end

Instance Method Details

#annihilate ⇒ Object

the nuclear option. can affect other applications sharing the same cache engine. keep in mind mutually assured destruction.



51
52
53
 
# File 'lib/card/cache/persistent.rb', line 51

def annihilate
  @store.clear
end

#deep_read(key) ⇒ Object 



98
99
100
101
102
 
# File 'lib/card/cache/persistent.rb', line 98

def deep_read key
  local_cache = @store.send :local_cache
  local_cache&.clear
  read key
end

#delete(key) ⇒ Object 



117
118
119
 
# File 'lib/card/cache/persistent.rb', line 117

def delete key
  @store.delete full_key(key)
end

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/card/cache/persistent.rb', line 121

def exist? key
  @store.exist? full_key(key)
end

#fetch(key, &block) ⇒ Object 



113
114
115
 
# File 'lib/card/cache/persistent.rb', line 113

def fetch key, &block
  @store.fetch full_key(key), &block
end

#full_key(key) ⇒ String

returns prefix/key

Parameters:

  • key (String)

Returns:

  • (String) 


75
76
77
78
79
 
# File 'lib/card/cache/persistent.rb', line 75

def full_key key
  fk = "#{prefix}/#{key}"
  fk.tr! "*", "X" if @file_cache # save for windows fs
  fk
end

#read(key) ⇒ Object 



81
82
83
 
# File 'lib/card/cache/persistent.rb', line 81

def read key
  @store.read full_key(key)
end

#read_attribute(key, attribute) ⇒ Object 



104
105
106
107
 
# File 'lib/card/cache/persistent.rb', line 104

def read_attribute key, attribute
  object = deep_read key
  object.instance_variable_get "@#{attribute}"
end

#renew ⇒ Object

renew insures you’re using the most current cache version by reaffirming the stamp and prefix



36
37
38
39
 
# File 'lib/card/cache/persistent.rb', line 36

def renew
  @stamp = nil
  @prefix = nil
end

#reset ⇒ Object

reset effectively clears the cache by setting a new stamp. However unlike annihilate, it won’t bother other apps using the same cache engine.



43
44
45
46
47
 
# File 'lib/card/cache/persistent.rb', line 43

def reset
  @stamp = self.class.new_stamp
  @prefix = nil
  Cardio.cache.write stamp_key, @stamp
end

#stamp ⇒ Object

the current time stamp. changing this value effectively resets the cache. Note that Cardio.cache is a simple Rails::Cache, not a Card::Cache object.



58
59
60
 
# File 'lib/card/cache/persistent.rb', line 58

def stamp
  @stamp ||= Cardio.cache.fetch(stamp_key) { self.class.new_stamp }
end

#stamp_key ⇒ Object

key for looking up the current stamp



63
64
65
 
# File 'lib/card/cache/persistent.rb', line 63

def stamp_key
  "#{@database}-#{@class_key}-#{self.class.stamp}-stamp"
end

#write(key, value) ⇒ Object 



109
110
111
 
# File 'lib/card/cache/persistent.rb', line 109

def write key, value
  @store.write full_key(key), value
end

#write_attribute(key, attribute, value) ⇒ Object

update an attribute of an object already in the cache

Parameters:

  • key (String)
  • attribute (String, Symbol) 


88
89
90
91
92
93
94
95
96
 
# File 'lib/card/cache/persistent.rb', line 88

def write_attribute key, attribute, value
  return value unless @store

  if (object = deep_read key)
    object.instance_variable_set "@#{attribute}", value
    write key, object
  end
  value
end