Class: ActiveSupport::Cache::MemoryStore

Inherits:
Store show all
Defined in:
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 Phusion Passenger or puma clustered mode), 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.

Unlike other Cache store implementations, MemoryStore does not compress values by default. MemoryStore does not benefit from compression as much as other Store implementations, as it does not send data over a network. However, when compression is enabled, it still pays the full cost of compression in terms of cpu use.

MemoryStore is thread-safe.

Defined Under Namespace

Modules: DupCoder

Constant Summary collapse

DEFAULT_CODER =
DupCoder

Instance Attribute Summary

Attributes inherited from Store

#options, #silence

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Store

#delete, #delete_multi, #exist?, #fetch, #fetch_multi, #mute, #read, #read_multi, #silence!, #write, #write_multi

Constructor Details

#initialize(options = nil) ⇒ MemoryStore

Returns a new instance of MemoryStore.


44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/active_support/cache/memory_store.rb', line 44

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

Class Method Details

.supports_cache_versioning?Boolean

Advertise cache versioning support.

Returns:

  • (Boolean)

58
59
60
# File 'lib/active_support/cache/memory_store.rb', line 58

def self.supports_cache_versioning?
  true
end

Instance Method Details

#cleanup(options = nil) ⇒ Object

Preemptively iterates through all stored keys and removes the ones which have expired.


71
72
73
74
75
76
77
78
79
80
# File 'lib/active_support/cache/memory_store.rb', line 71

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

Delete all data stored in a given cache store.


63
64
65
66
67
68
# File 'lib/active_support/cache/memory_store.rb', line 63

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

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

Decrement an integer value in the cache.


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

def decrement(name, amount = 1, options = nil)
  modify_value(name, -amount, options)
end

#delete_matched(matcher, options = nil) ⇒ Object

Deletes cache entries if the cache key matches a given pattern.


118
119
120
121
122
123
124
125
126
127
# File 'lib/active_support/cache/memory_store.rb', line 118

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.


108
109
110
# File 'lib/active_support/cache/memory_store.rb', line 108

def increment(name, amount = 1, options = nil)
  modify_value(name, amount, options)
end

#inspectObject

:nodoc:


129
130
131
# File 'lib/active_support/cache/memory_store.rb', line 129

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.


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/active_support/cache/memory_store.rb', line 84

def prune(target_size, max_time = nil)
  return if pruning?
  @pruning = true
  begin
    start_time = Concurrent.monotonic_time
    cleanup
    instrument(:prune, target_size, from: @cache_size) do
      keys = synchronize { @data.keys }
      keys.each do |key|
        delete_entry(key, **options)
        return if @cache_size <= target_size || (max_time && Concurrent.monotonic_time - start_time > max_time)
      end
    end
  ensure
    @pruning = false
  end
end

#pruning?Boolean

Returns true if the cache is currently being pruned.

Returns:

  • (Boolean)

103
104
105
# File 'lib/active_support/cache/memory_store.rb', line 103

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.


135
136
137
# File 'lib/active_support/cache/memory_store.rb', line 135

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