Class: ChefStash::Cache

Inherits:
Object
  • Object
show all
Defined in:
lib/chef_stash.rb

Overview

Chef Key/value stash cache hash objects store.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Cache

Initializes a new Chef Key/value stash cache hash objects store.



62
63
64
65
 
# File 'lib/chef_stash.rb', line 62

def initialize(params = {})
  params = { store: params } unless params.is_a? Hash
  @store = params.fetch(:store) { ChefStash::DEFAULT_STORE.new }
end

Instance Attribute Details

#:store(: store) ⇒ ChefStash (readonly)

Returns The Chef Key/value stash cache hash objects store.

Returns:

  • (ChefStash) —

    The Chef Key/value stash cache hash objects store.



58
 
# File 'lib/chef_stash.rb', line 58

attr_reader :store

#store ⇒ Hash (readonly)

Returns of the mem stash cache hash store.

Returns:

  • (Hash) —

    of the mem stash cache hash store



58
59
60
 
# File 'lib/chef_stash.rb', line 58

def store
  @store
end

Instance Method Details

#[](key = nil) ⇒ Hash, ...

Retrieves the value for a given key, if nothing is set, returns KeyError

Parameters:

  • key (Symbol, String) (defaults to: nil) —

    representing the key

Returns:

  • (Hash, Array, String) —

    value for key

Raises:

  • (KeyError) —

    if no such key found



76
77
78
79
80
 
# File 'lib/chef_stash.rb', line 76

def [](key = nil)
  key ||= ChefStash.caller_name
  fail KeyError, 'Key not cached' unless include? key.to_sym
  @store[key.to_sym]
end

#cache(key = nil, &code) ⇒ Hash, ...

Retrieves the value for a given key, if nothing is set, run the code, cache the result, and return it

Parameters:

  • key (Symbol, String) (defaults to: nil) —

    representing the key

  • block (&block) —

    that returns the value to set (optional)

Returns:

  • (Hash, Array, String) —

    value for key



90
91
92
93
 
# File 'lib/chef_stash.rb', line 90

def cache(key = nil, &code)
  key ||= ChefStash.caller_name
  @store[key.to_sym] ||= code.call
end

#clear!(key = nil) ⇒ Object

Clear the whole stash store or the value of a key

clear.

Parameters:

  • key (Symbol, String) (defaults to: nil) —

    (optional) representing the key to

Returns:

  • nothing.



113
114
115
 
# File 'lib/chef_stash.rb', line 113

def clear!(key = nil)
  key.nil? ? @store.clear : @store.delete(key)
end

#include?(key = nil) ⇒ TrueClass, FalseClass

return a boolean indicating presence of the given key in the store

Parameters:

  • key (Symbol, String) (defaults to: nil) —

    a string or symbol representing the key

Returns:

  • (TrueClass, FalseClass) 


101
102
103
104
 
# File 'lib/chef_stash.rb', line 101

def include?(key = nil)
  key ||= ChefStash.caller_name
  @store.include? key.to_sym
end

#size ⇒ Fixnum

return the size of the store as an integer

Returns:

  • (Fixnum) 


121
122
123
 
# File 'lib/chef_stash.rb', line 121

def size
  @store.size
end