Class: FileCache

Inherits:
Cache show all
Defined in:
lib/libcache/file_cache.rb

Instance Attribute Summary

Attributes inherited from Cache

#expiry_time, #max_size, #refresh, #store

Instance Method Summary collapse

Methods inherited from Cache

#check_refresh, #exists?, #get_size, #has_refresh?

Constructor Details

#initialize ⇒ FileCache

Returns a new instance of FileCache.



7
8
9
 
# File 'lib/libcache/file_cache.rb', line 7

def initialize
  super
end

Instance Method Details

#create_store ⇒ Object

Initializes the cache store along with the keys store. Raises an exception if the store path is not supplied.



12
13
14
15
16
17
18
 
# File 'lib/libcache/file_cache.rb', line 12

def create_store
  @cache = Hash.new
  @keys = Hash.new
  if store == nil
    raise 'Store path is missing!'
  end
end

#get(key) ⇒ Object

Gets the object that corresponds with the key that is read from the filesystem

Parameters:

  • key (String) —

    The key value used to identify an object in the cache

Returns:

  • (Object) —

    The object that corresponds with the key



42
43
44
45
46
47
48
 
# File 'lib/libcache/file_cache.rb', line 42

def get(key)
  check_refresh(key)
  if(@keys[key]) == nil
    return nil
  end
  return Marshal.load(File.read(File.join(store, @keys[key])))
end

#invalidate(key) ⇒ Object

Deletes a key-value pair from the cache and store directory

Parameters:

  • key (String) —

    The key value used to identify an object in the cache



52
53
54
55
56
 
# File 'lib/libcache/file_cache.rb', line 52

def invalidate(key)
  super
  File.delete(File.join(store, @keys[key]))
  @keys.delete key
end

#invalidate_all ⇒ Object

Clears all items in the cache and the cached files in the store directory



59
60
61
62
63
64
 
# File 'lib/libcache/file_cache.rb', line 59

def invalidate_all
  super
  Dir.foreach(store) do |f|
    File.delete(File.join(store, f)) if f != '.' && f != '..'
  end
end

#put(key, value) ⇒ Object

Places an object inside the cache, and by extension, into the filesystem. Handles max size eviction. Raises an InvalidKey exception if the key is not formatted properly.

Parameters:

  • key (String) —

    The key value used to identify an object in the cache

  • value (Object) —

    The object to be placed in the cache

Raises:

  • (InvalidKey) 


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/libcache/file_cache.rb', line 23

def put(key, value)
  raise InvalidKey unless key.is_a? String
  raise InvalidKey unless key =~ /\A[a-zA-Z0-9_-]+\z/
  @keys[key] = @keys.size.to_s
  File.open(File.join(store, @keys[key]), 'w') do |f|
    f.write(Marshal.dump(value))
  end
  @cache[key] = value
  if expiry_time != nil
    @scheduler.in expiry_time, :blocking => true do
      invalidate key
    end
  end
  check_expiration(key)
end