Class: Card::Cache

Inherits:
Object
  • Object
show all
Extended by:
Prepopulate
Defined in:
lib/card/cache.rb,
lib/card/cache/temporary.rb,
lib/card/cache/persistent.rb,
lib/card/cache/prepopulate.rb

Overview

The Cache class manages and integrates Temporary and Persistent caching. The Temporary cache is typically process- and request- specific and is often "ahead" of the database; the Persistent cache is typically shared across processes and tends to stay true to the database.

Any ruby Class can declare and/or retrieve its own cache as follows:

Card::Cache[MyClass]

Typically speaking, mod developers do not need to use the Cache classes directly, because caching is automatically handled by Card#fetch

Defined Under Namespace

Modules: Prepopulate Classes: Persistent, Temporary

Constant Summary collapse

@@cache_by_class = 
{}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Prepopulate

restore

Constructor Details

#initialize(opts = {}) ⇒ Cache

Cache#new initializes a Temporary/soft cache, and -- if a :store opt is provided -- a Persistent/hard cache

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :store (Rails::Cache)
  • :class (Constant) 


131
132
133
134
135
136
 
# File 'lib/card/cache.rb', line 131

def initialize opts={}
  @klass = opts[:class]
  cache_by_class[@klass] = self
  @hard = Persistent.new opts if opts[:store]
  @soft = Temporary.new
end

Instance Attribute Details

#hard ⇒ Object (readonly)

Returns the value of attribute hard.



124
125
126
 
# File 'lib/card/cache.rb', line 124

def hard
  @hard
end

#soft ⇒ Object (readonly)

Returns the value of attribute soft.



124
125
126
 
# File 'lib/card/cache.rb', line 124

def soft
  @soft
end

Class Method Details

.[](klass) ⇒ {Card::Cache}

create a new cache for the ruby class provided

Parameters:

  • klass (Class)

Returns:



32
33
34
35
36
37
 
# File 'lib/card/cache.rb', line 32

def [] klass
  raise "nil klass" if klass.nil?

  cache_type = persistent_cache || nil
  cache_by_class[klass] ||= new class: klass, store: cache_type
end

.obj_to_key(obj) ⇒ String

generate a cache key from an object

Parameters:

  • obj (Object)

Returns:

  • (String) 


112
113
114
115
116
117
118
119
120
121
 
# File 'lib/card/cache.rb', line 112

def obj_to_key obj
  case obj
  when Hash
    obj.sort.map { |key, value| "#{key}=>(#{obj_to_key(value)})" } * ","
  when Array
    obj.map { |value| obj_to_key(value) }
  else
    obj.to_s
  end
end

.persistent_cache ⇒ Object 



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/card/cache.rb', line 39

def persistent_cache
  return @persistent_cache unless @persistent_cache.nil?

  @persistent_cache =
    case
    when ENV["NO_RAILS_CACHE"]          then false
    when Cardio.config.persistent_cache then Cardio.cache
    else                                     false
    end
end

.renew ⇒ Object

clear the temporary caches and ensure we're using the latest stamp on the persistent caches.



52
53
54
55
56
57
58
 
# File 'lib/card/cache.rb', line 52

def renew
  renew_persistent
  cache_by_class.each_value do |cache|
    cache.soft.reset
    cache.hard&.renew
  end
end

.renew_persistent ⇒ Object 



60
61
62
 
# File 'lib/card/cache.rb', line 60

def renew_persistent
  Card::Cache::Persistent.renew if persistent_cache
end

.reset ⇒ Object

reset standard cached for all classes



65
66
67
68
 
# File 'lib/card/cache.rb', line 65

def reset
  reset_hard
  reset_soft
end

.reset_all ⇒ Object

reset all caches for all classes



71
72
73
74
75
 
# File 'lib/card/cache.rb', line 71

def reset_all
  reset_hard
  reset_soft
  reset_other
end

.reset_global ⇒ Object

completely wipe out all caches, often including the Persistent cache of other decks using the same mechanism. Generally prefer reset_all

See Also:



81
82
83
84
85
86
87
 
# File 'lib/card/cache.rb', line 81

def reset_global
  cache_by_class.each_value do |cache|
    cache.soft.reset
    cache.hard&.annihilate
  end
  reset_other
end

.reset_hard ⇒ Object

reset the Persistent cache for all classes



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

def reset_hard
  Card::Cache::Persistent.reset if persistent_cache
  cache_by_class.each_value do |cache|
    cache.hard&.reset
  end
end

.reset_other ⇒ Object

reset Codename cache and delete tmp files (the non-standard caches)



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

def reset_other
  Card::Codename.reset_cache
  Cardio.delete_tmp_files!
end

.reset_soft ⇒ Object

reset the Temporary cache for all classes



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

def reset_soft
  cache_by_class.each_value { |cache| cache.soft.reset }
end

Instance Method Details

#delete(key) ⇒ Object

delete specific cache entries by key

Parameters:

  • key (String) 


163
164
165
166
 
# File 'lib/card/cache.rb', line 163

def delete key
  @hard&.delete key
  @soft.delete key
end

#exist?(key) ⇒ true/false

test for the existence of the key in either cache

Returns:

  • (true/false) 


176
177
178
 
# File 'lib/card/cache.rb', line 176

def exist? key
  @soft.exist?(key) || (@hard&.exist?(key))
end

#fetch(key, &block) ⇒ Object

read and (if not there yet) write

Parameters:

  • key (String) 


155
156
157
158
159
 
# File 'lib/card/cache.rb', line 155

def fetch key, &block
  @soft.fetch(key) do
    @hard ? @hard.fetch(key, &block) : yield
  end
end

#read(key) ⇒ Object

read cache value (and write to soft cache if missing)

Parameters:

  • key (String) 


140
141
142
143
 
# File 'lib/card/cache.rb', line 140

def read key
  @soft.read(key) ||
    (@hard && (ret = @hard.read(key)) && @soft.write(key, ret))
end

#reset ⇒ Object

reset both caches (for a given Card::Cache instance)



169
170
171
172
 
# File 'lib/card/cache.rb', line 169

def reset
  @hard&.reset
  @soft.reset
end

#write(key, value) ⇒ Object

write to hard (where applicable) and soft cache

Parameters:

  • key (String)
  • value 


148
149
150
151
 
# File 'lib/card/cache.rb', line 148

def write key, value
  @hard&.write key, value
  @soft.write key, value
end