Class: AnyCache::Adapters::ActiveSupportRedisCacheStore Private

Inherits:
Basic
  • Object
show all
Defined in:
lib/any_cache/adapters/active_support_redis_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.1.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.1.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.1.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.1.0

1

Instance Attribute Summary

Attributes inherited from Basic

#driver

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Basic

#clear, #delete, #delete_matched, #initialize

Methods included from Dumper::InterfaceAccessMixin

#detransform_pairset, #detransform_value, #transform_pairset, #transform_value

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.1.0



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

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

Instance Method Details

#cleanup(**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:

  • options (Hash)

Since:

  • 0.4.0



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

def cleanup(**options)
  # NOTE: manual removing is not suppored (redis doing this by itself)
end

#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, Float) (defaults to: DEFAULT_INCR_DECR_AMOUNT)
  • expires_in (Hash) —

    a customizable set of options

Returns:

  • (Integer, Float)

Since:

  • 0.1.0



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 161

def decrement(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, raw: true) && -amount
  else
    driver.decrement(key, amount).tap do
      expire(key, expires_in: expires_in) if expires_in
    end
  end
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



205
206
207
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 205

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.1.0



179
180
181
182
183
184
185
186
187
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 179

def expire(key, expires_in: DEAD_TTL)
  # NOTE:
  #   raw is true cuz we want the raw cached value.
  #   this raw value would be cached again if needed.
  read(key, raw: true).tap do |value|
    is_alive = expires_in ? expires_in.positive? : false
    is_alive ? write(key, value, expires_in: expires_in, raw: true) : 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)
  • fallback (Proc)
  • expires_in (Hash) —

    a customizable set of options

  • force (Hash) —

    a customizable set of options

  • raw (Hash) —

    a customizable set of options

Returns:

  • (Object)

Since:

  • 0.2.0



109
110
111
112
113
114
115
116
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 109

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)
  raw           = options.fetch(:raw, false)

  driver.fetch(key, force: force_rewrite, expires_in: expires_in, raw: raw, &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]) —

    eys [Array<string]

  • fallback (Proc)
  • force (Hash) —

    a customizable set of options

Returns:

  • (Hash)

Since:

  • 0.3.0



126
127
128
129
130
131
132
133
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 126

def fetch_multi(*keys, **options, &fallback)
  # NOTE:
  #   use own :fetch_multi implementation cuz original :fetch_multi
  #   doesnt support :force option
  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, Float) (defaults to: DEFAULT_INCR_DECR_AMOUNT)
  • expires_in (Hash) —

    a customizable set of options

Returns:

  • (Integer, Float)

Since:

  • 0.1.0



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 142

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, raw: true) && 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.1.0



195
196
197
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 195

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)
  • raw (Hash) —

    a customizable set of options

Returns:

  • (Object)

Since:

  • 0.1.0



53
54
55
56
57
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 53

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

  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>)
  • raw (Hash) —

    a customizable set of options

Returns:

  • (Hash)

Since:

  • 0.3.0



65
66
67
68
69
70
71
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 65

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

  driver.read_multi(*keys, raw: raw).tap do |res|
    res.merge!(Hash[(keys - res.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

  • raw (Hash) —

    a customizable set of options

Since:

  • 0.1.0



81
82
83
84
85
86
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 81

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

  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)
  • raw (Hash) —

    a customizable set of options

Since:

  • 0.1.0



94
95
96
97
98
 
# File 'lib/any_cache/adapters/active_support_redis_cache_store.rb', line 94

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

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