Class: CacheStoreContract

Inherits:

Object

show all

Overview

This class is used to define the contract that CacheStore implementations must adhere to.

#exist?(key) ⇒ Boolean

This method is called to check if a value exists within this cache store for a specific key.
#get(key, expires_in = 0, &block) ⇒ Object

This method is called to get a value from this cache store by it’s unique key.
#initialize(namespace = '') ⇒ CacheStoreContract constructor

A new instance of CacheStoreContract.
#remove(key) ⇒ Object

This method is called to remove a value from this cache store by it’s unique key.
#set(key, value, expires_in = 0) ⇒ Object

This method is called to set a value within this cache store by it’s key.

Returns a new instance of CacheStoreContract.



6
7
8

# File 'lib/cache_store.rb', line 6

def initialize(namespace = '')
  @namespace = namespace
end

This method is called to check if a value exists within this cache store for a specific key.

Parameters:

This (String) —

is the unique key to reference the value to check for within this cache store.

Returns:



38
39
40

# File 'lib/cache_store.rb', line 38

def exist?(key)

end

This method is called to get a value from this cache store by it’s unique key.

Parameters:

This (String) —

is the unique key to reference the value to fetch from within this cache store.
This (Integer) —

is the number of seconds from the current time that this value should expire. (This is used in conjunction with the block to hydrate the cache key if it is empty.)
This (Block) —

block is provided to hydrate this cache store with the value for the request key when it is not found.



24
25
26

# File 'lib/cache_store.rb', line 24

def get(key, expires_in = 0, &block)

end

This method is called to remove a value from this cache store by it’s unique key.

Parameters:

This (String) —

is the unique key to reference the value to remove from this cache store.



31
32
33

# File 'lib/cache_store.rb', line 31

def remove(key)

end

This method is called to set a value within this cache store by it’s key.

Parameters:

This (String) —

is the unique key to reference the value being set within this cache store.
This (Object) —

is the value to set within this cache store.
This (Integer) —

is the number of seconds from the current time that this value should expire.



15
16
17

# File 'lib/cache_store.rb', line 15

def set(key, value, expires_in = 0)

end