Class: ThreadSafe::Cache

Inherits:
ConcurrentCacheBackend
  • Object
show all
Defined in:
lib/thread_safe/cache.rb

Constant Summary collapse

KEY_ERROR =

there is no KeyError in 1.8 mode

defined?(KeyError) ? KeyError : IndexError

Instance Method Summary collapse

Constructor Details

#initialize(options = nil, &block) ⇒ Cache

Returns a new instance of Cache.



23
24
25
26
27
28
29
30
31
32
# File 'lib/thread_safe/cache.rb', line 23

def initialize(options = nil, &block)
  if options.kind_of?(::Hash)
    validate_options_hash!(options)
  else
    options = nil
  end

  super(options)
  @default_proc = block
end

Instance Method Details

#[](key) ⇒ Object



34
35
36
37
38
39
40
41
42
# File 'lib/thread_safe/cache.rb', line 34

def [](key)
  if value = super
    value
  elsif @default_proc && !key?(key)
    @default_proc.call(self, key)
  else
    value
  end
end

#each_keyObject



84
85
86
# File 'lib/thread_safe/cache.rb', line 84

def each_key
  each_pair {|k, v| yield k}
end

#each_valueObject



88
89
90
# File 'lib/thread_safe/cache.rb', line 88

def each_value
  each_pair {|k, v| yield v}
end

#empty?Boolean

Returns:

  • (Boolean)


92
93
94
95
# File 'lib/thread_safe/cache.rb', line 92

def empty?
  each_pair {|k, v| return false}
  true
end

#fetch(key, default_value = NULL) ⇒ Object



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

def fetch(key, default_value = NULL)
  if NULL != (value = get_or_default(key, NULL))
    value
  elsif block_given?
    yield key
  elsif NULL != default_value
    default_value
  else
    raise KEY_ERROR, 'key not found'
  end
end

#keysObject



72
73
74
75
76
# File 'lib/thread_safe/cache.rb', line 72

def keys
  arr = []
  each_pair {|k, v| arr << k}
  arr
end

#marshal_dumpObject

Raises:

  • (TypeError)


103
104
105
106
107
108
# File 'lib/thread_safe/cache.rb', line 103

def marshal_dump
  raise TypeError, "can't dump hash with default proc" if @default_proc
  h = {}
  each_pair {|k, v| h[k] = v}
  h
end

#marshal_load(hash) ⇒ Object



110
111
112
113
# File 'lib/thread_safe/cache.rb', line 110

def marshal_load(hash)
  initialize
  populate_from(hash)
end

#put_if_absent(key, value) ⇒ Object



56
57
58
59
60
61
62
63
# File 'lib/thread_safe/cache.rb', line 56

def put_if_absent(key, value)
  computed = false
  result = compute_if_absent(key) do
    computed = true
    value
  end
  computed ? nil : result
end

#sizeObject



97
98
99
100
101
# File 'lib/thread_safe/cache.rb', line 97

def size
  count = 0
  each_pair {|k, v| count += 1}
  count
end

#value?(value) ⇒ Boolean

Returns:

  • (Boolean)


65
66
67
68
69
70
# File 'lib/thread_safe/cache.rb', line 65

def value?(value)
  each_value do |v|
    return true if value.equal?(v)
  end
  false
end

#valuesObject



78
79
80
81
82
# File 'lib/thread_safe/cache.rb', line 78

def values
  arr = []
  each_pair {|k, v| arr << v}
  arr
end