Class: ActiveSupport::Cache::FileStore
- Includes:
- Strategy::LocalCache
- Defined in:
- lib/active_support/cache/file_store.rb
Overview
A cache store implementation which stores everything on the filesystem.
FileStore implements the Strategy::LocalCache strategy which implements an in-memory cache inside of a block.
Constant Summary collapse
- DIR_FORMATTER =
"%03X"
- FILENAME_MAX_SIZE =
max filename size on file system is 255, minus room for timestamp and random characters appended by Tempfile (used by atomic write)
228
- FILEPATH_MAX_SIZE =
max is 1024, plus some room
900
- EXCLUDED_DIRS =
['.', '..'].freeze
- GITKEEP_FILES =
['.gitkeep', '.keep'].freeze
Instance Attribute Summary collapse
-
#cache_path ⇒ Object
readonly
Returns the value of attribute cache_path.
Attributes inherited from Store
Instance Method Summary collapse
-
#cleanup(options = nil) ⇒ Object
Preemptively iterates through all stored keys and removes the ones which have expired.
-
#clear(options = nil) ⇒ Object
Deletes all items from the cache.
-
#decrement(name, amount = 1, options = nil) ⇒ Object
Decrements an already existing integer value that is stored in the cache.
- #delete_matched(matcher, options = nil) ⇒ Object
-
#increment(name, amount = 1, options = nil) ⇒ Object
Increments an already existing integer value that is stored in the cache.
-
#initialize(cache_path, options = nil) ⇒ FileStore
constructor
A new instance of FileStore.
Methods included from Strategy::LocalCache
#middleware, #with_local_cache
Methods inherited from Store
#delete, #exist?, #fetch, #fetch_multi, #mute, #read, #read_multi, #silence!, #write
Constructor Details
#initialize(cache_path, options = nil) ⇒ FileStore
Returns a new instance of FileStore.
22 23 24 25 |
# File 'lib/active_support/cache/file_store.rb', line 22 def initialize(cache_path, = nil) super() @cache_path = cache_path.to_s end |
Instance Attribute Details
#cache_path ⇒ Object (readonly)
Returns the value of attribute cache_path.
14 15 16 |
# File 'lib/active_support/cache/file_store.rb', line 14 def cache_path @cache_path end |
Instance Method Details
#cleanup(options = nil) ⇒ Object
Preemptively iterates through all stored keys and removes the ones which have expired.
37 38 39 40 41 42 43 44 |
# File 'lib/active_support/cache/file_store.rb', line 37 def cleanup( = nil) = () search_dir(cache_path) do |fname| key = file_path_key(fname) entry = read_entry(key, ) delete_entry(key, ) if entry && entry.expired? end end |
#clear(options = nil) ⇒ Object
Deletes all items from the cache. In this case it deletes all the entries in the specified file store directory except for .keep or .gitkeep. Be careful which directory is specified in your config file when using FileStore
because everything in that directory will be deleted.
30 31 32 33 34 |
# File 'lib/active_support/cache/file_store.rb', line 30 def clear( = nil) root_dirs = exclude_from(cache_path, EXCLUDED_DIRS + GITKEEP_FILES) FileUtils.rm_r(root_dirs.collect{|f| File.join(cache_path, f)}) rescue Errno::ENOENT end |
#decrement(name, amount = 1, options = nil) ⇒ Object
Decrements an already existing integer value that is stored in the cache. If the key is not found nothing is done.
54 55 56 |
# File 'lib/active_support/cache/file_store.rb', line 54 def decrement(name, amount = 1, = nil) modify_value(name, -amount, ) end |
#delete_matched(matcher, options = nil) ⇒ Object
58 59 60 61 62 63 64 65 66 67 |
# File 'lib/active_support/cache/file_store.rb', line 58 def delete_matched(matcher, = nil) = () instrument(:delete_matched, matcher.inspect) do matcher = key_matcher(matcher, ) search_dir(cache_path) do |path| key = file_path_key(path) delete_entry(path, ) if key.match(matcher) end end end |
#increment(name, amount = 1, options = nil) ⇒ Object
Increments an already existing integer value that is stored in the cache. If the key is not found nothing is done.
48 49 50 |
# File 'lib/active_support/cache/file_store.rb', line 48 def increment(name, amount = 1, = nil) modify_value(name, amount, ) end |