Class: ActiveSupport::Cache::MemoryStore

Inherits:
Store show all
Defined in:
activesupport/lib/active_support/cache/memory_store.rb

Overview

A cache store implementation which stores everything into memory in the same process. If you're running multiple Ruby on Rails server processes (which is the case if you're using mongrel_cluster or Phusion Passenger), then this means that Rails server process instances won't be able to share cache data with each other and this may not be the most appropriate cache in that scenario.

This cache has a bounded size specified by the :size options to the initializer (default is 32Mb). When the cache exceeds the allotted size, a cleanup will occur which tries to prune the cache down to three quarters of the maximum size by removing the least recently used entries.

MemoryStore is thread-safe.

Instance Attribute Summary

Attributes inherited from Store

#options, #silence

Instance Method Summary collapse

Methods inherited from Store

#delete, #exist?, #fetch, instrument, instrument=, #mute, #read, #read_multi, #silence!, #write

Constructor Details

#initialize(options = nil) ⇒ MemoryStore

Returns a new instance of MemoryStore


19
20
21
22
23
24
25
26
27
28
29
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 19

def initialize(options = nil)
  options ||= {}
  super(options)
  @data = {}
  @key_access = {}
  @max_size = options[:size] || 32.megabytes
  @max_prune_time = options[:max_prune_time] || 2
  @cache_size = 0
  @monitor = Monitor.new
  @pruning = false
end

Instance Method Details

#cleanup(options = nil) ⇒ Object


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

def cleanup(options = nil)
  options = merged_options(options)
  instrument(:cleanup, :size => @data.size) do
    keys = synchronize{ @data.keys }
    keys.each do |key|
      entry = @data[key]
      delete_entry(key, options) if entry && entry.expired?
    end
  end
end

#clear(options = nil) ⇒ Object


31
32
33
34
35
36
37
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 31

def clear(options = nil)
  synchronize do
    @data.clear
    @key_access.clear
    @cache_size = 0
  end
end

#decrement(name, amount = 1, options = nil) ⇒ Object

Decrement an integer value in the cache.


90
91
92
93
94
95
96
97
98
99
100
101
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 90

def decrement(name, amount = 1, options = nil)
  synchronize do
    options = merged_options(options)
    if num = read(name, options)
      num = num.to_i - amount
      write(name, num, options)
      num
    else
      nil
    end
  end
end

#delete_matched(matcher, options = nil) ⇒ Object


103
104
105
106
107
108
109
110
111
112
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 103

def delete_matched(matcher, options = nil)
  options = merged_options(options)
  instrument(:delete_matched, matcher.inspect) do
    matcher = key_matcher(matcher, options)
    keys = synchronize { @data.keys }
    keys.each do |key|
      delete_entry(key, options) if key.match(matcher)
    end
  end
end

#increment(name, amount = 1, options = nil) ⇒ Object

Increment an integer value in the cache.


76
77
78
79
80
81
82
83
84
85
86
87
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 76

def increment(name, amount = 1, options = nil)
  synchronize do
    options = merged_options(options)
    if num = read(name, options)
      num = num.to_i + amount
      write(name, num, options)
      num
    else
      nil
    end
  end
end

#inspectObject

:nodoc:


114
115
116
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 114

def inspect # :nodoc:
  "<##{self.class.name} entries=#{@data.size}, size=#{@cache_size}, options=#{@options.inspect}>"
end

#prune(target_size, max_time = nil) ⇒ Object

To ensure entries fit within the specified memory prune the cache by removing the least recently accessed entries.


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 52

def prune(target_size, max_time = nil)
  return if pruning?
  @pruning = true
  begin
    start_time = Time.now
    cleanup
    instrument(:prune, target_size, :from => @cache_size) do
      keys = synchronize{ @key_access.keys.sort{|a,b| @key_access[a].to_f <=> @key_access[b].to_f} }
      keys.each do |key|
        delete_entry(key, options)
        return if @cache_size <= target_size || (max_time && Time.now - start_time > max_time)
      end
    end
  ensure
    @pruning = false
  end
end

#pruning?Boolean

Returns true if the cache is currently being pruned.

Returns:

  • (Boolean)

71
72
73
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 71

def pruning?
  @pruning
end

#synchronize(&block) ⇒ Object

Synchronize calls to the cache. This should be called wherever the underlying cache implementation is not thread safe.


120
121
122
# File 'activesupport/lib/active_support/cache/memory_store.rb', line 120

def synchronize(&block) # :nodoc:
  @monitor.synchronize(&block)
end