Class: AnyCache::Adapters::ActiveSupportMemCacheStore Private

Inherits:
Basic
  • Object
show all
Defined in:
lib/any_cache/adapters/active_support_mem_cache_store.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Since:

  • 0.2.0

Constant Summary collapse

READ_MULTI_EMPTY_KEYS_SET =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Returns:

  • (Array)

Since:

  • 0.3.0

[].freeze
NO_EXPIRATION_TTL =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Returns:

  • (NilClass)

Since:

  • 0.2.0

nil
DEAD_TTL =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Returns:

  • (Integer)

Since:

  • 0.2.0

0
DEFAULT_INCR_DECR_AMOUNT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Returns:

  • (Integer)

Since:

  • 0.2.0

1
INITIAL_DECREMNETED_VALUE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Returns:

  • (Integer)

Since:

  • 0.2.0

0

Instance Attribute Summary

Attributes inherited from Basic

#driver

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Basic

#clear, #delete, #initialize

Constructor Details

This class inherits a constructor from AnyCache::Adapters::Basic

Class Method Details

.supported_driver?(driver) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • driver (Object)

Returns:

  • (Boolean)

Since:

  • 0.2.0



15
16
17
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 15

def supported_driver?(driver)
  AnyCache::Drivers::ActiveSupportMemCacheStore.supported_source?(driver)
end

Instance Method Details

#decrement(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options) ⇒ Integer, Float

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • amount (Integer) (defaults to: DEFAULT_INCR_DECR_AMOUNT)
  • expires_in (Hash) —

    a customizable set of options

Returns:

  • (Integer, Float)

Since:

  • 0.2.0



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 169

def decrement(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
  expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)

  unless exist?(key)
    # NOTE: Dalli::Client can't decrement:
    #   - non-raw values;
    #   - values lower than zero;
    #   - empty entries;
    write(key, INITIAL_DECREMNETED_VALUE, expires_in: expires_in) && INITIAL_DECREMNETED_VALUE
  else
    driver.decrement(key, amount).tap do
      expire(key, expires_in: expires_in) if expires_in
    end
  end
end

#delete_matched(pattern, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • pattern (String, Regexp)
  • options (Hash)

Since:

  • 0.3.0



139
140
141
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 139

def delete_matched(pattern, **options)
  # TODO: make it real >:]
end

#exist?(key, **options) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • options (Hash)

Returns:

  • (Boolean)

Since:

  • 0.2.0



214
215
216
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 214

def exist?(key, **options)
  driver.exist?(key)
end

#expire(key, expires_in: DEAD_TTL) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • key (String)
  • expires_in (Hash) (defaults to: DEAD_TTL) —

    a customizable set of options

Options Hash (expires_in:):

  • (Integer)

Since:

  • 0.2.0



191
192
193
194
195
196
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 191

def expire(key, expires_in: DEAD_TTL)
  read(key).tap do |value|
    is_alive = expires_in ? expires_in.positive? : false
    is_alive ? write(key, value, expires_in: expires_in) : delete(key)
  end
end

#fetch(key, **options, &fallback) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • expires_in (Hash) —

    a customizable set of options

  • force (Hash) —

    a customizable set of options

Returns:

  • (Object)

Since:

  • 0.2.0



112
113
114
115
116
117
118
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 112

def fetch(key, **options, &fallback)
  force_rewrite = options.fetch(:force, false)
  force_rewrite = force_rewrite.call(key) if force_rewrite.respond_to?(:call)
  expires_in    = options.fetch(:expires_in, NO_EXPIRATION_TTL)

  driver.fetch(key, force: force_rewrite, expires_in: expires_in, &fallback)
end

#fetch_multi(*keys, **options, &fallback) ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • keys (Array<String>)
  • options (Hash)
  • fallback (Proc)

Returns:

  • (Hash)

Since:

  • 0.3.0



127
128
129
130
131
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 127

def fetch_multi(*keys, **options, &fallback)
  keys.each_with_object({}) do |key, dataset|
    dataset[key] = fetch(key, **options, &fallback)
  end
end

#increment(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options) ⇒ Integer, Float

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • amount (Integer) (defaults to: DEFAULT_INCR_DECR_AMOUNT)

Returns:

  • (Integer, Float)

Since:

  • 0.2.0



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 150

def increment(key, amount = DEFAULT_INCR_DECR_AMOUNT, **options)
  expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)

  unless exist?(key)
    write(key, amount, expires_in: expires_in) && amount
  else
    driver.increment(key, amount).tap do
      expire(key, expires_in: expires_in) if expires_in
    end
  end
end

#persist(key, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • key (String)
  • options (Hash)

Since:

  • 0.2.0



204
205
206
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 204

def persist(key, **options)
  read(key).tap { |value| write(key, value) }
end

#read(key, **options) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • options (Hash)

Returns:

  • (Object)

Since:

  • 0.2.0



59
60
61
62
63
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 59

def read(key, **options)
  raw = options.fetch(:raw, true)

  driver.read(key, raw: raw)
end

#read_multi(*keys, **options) ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • keys (Array<String>)
  • options (Hash)

Returns:

  • (Hash)

Since:

  • 0.3.0



71
72
73
74
75
76
77
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 71

def read_multi(*keys, **options)
  raw = options.fetch(:raw, true)

  driver.read_multi(*keys, raw: raw).tap do |entries|
    entries.merge!(Hash[(keys - entries.keys).zip(READ_MULTI_EMPTY_KEYS_SET)])
  end
end

#write(key, value, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • key (String)
  • value (Object)
  • expires_in (Hash) —

    a customizable set of options

Since:

  • 0.2.0



86
87
88
89
90
91
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 86

def write(key, value, **options)
  expires_in = options.fetch(:expires_in, NO_EXPIRATION_TTL)
  raw = options.fetch(:raw, true)

  driver.write(key, value, expires_in: expires_in, raw: raw)
end

#write_multi(entries, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • entries (Hash)
  • options (Hash)

Since:

  • 0.3.0



99
100
101
102
103
 
# File 'lib/any_cache/adapters/active_support_mem_cache_store.rb', line 99

def write_multi(entries, **options)
  raw = options.fetch(:raw, true)

  driver.write_multi(entries, expires_in: NO_EXPIRATION_TTL, raw: raw)
end