edge badge

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.

Methods
C
D
I
N
Constants
DIR_FORMATTER = "%03X"
 
FILENAME_MAX_SIZE = 228
 
FILEPATH_MAX_SIZE = 900
 
EXCLUDED_DIRS = [".", ".."].freeze
 
GITKEEP_FILES = [".gitkeep", ".keep"].freeze
 
Attributes
[R] cache_path
Class Public methods
new(cache_path, options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 22
def initialize(cache_path, options = nil)
  super(options)
  @cache_path = cache_path.to_s
end
Instance Public methods
cleanup(options = nil)

Preemptively iterates through all stored keys and removes the ones which have expired.

# File activesupport/lib/active_support/cache/file_store.rb, line 37
def cleanup(options = nil)
  options = merged_options(options)
  search_dir(cache_path) do |fname|
    key = file_path_key(fname)
    entry = read_entry(key, options)
    delete_entry(key, options) if entry && entry.expired?
  end
end
clear()

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.

# File activesupport/lib/active_support/cache/file_store.rb, line 30
def clear
  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)

Decrements an already existing integer value that is stored in the cache. If the key is not found nothing is done.

# File activesupport/lib/active_support/cache/file_store.rb, line 54
def decrement(name, amount = 1, options = nil)
  modify_value(name, -amount, options)
end
delete_matched(matcher, options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 58
def delete_matched(matcher, options = nil)
  options = merged_options(options)
  instrument(:delete_matched, matcher.inspect) do
    matcher = key_matcher(matcher, options)
    search_dir(cache_path) do |path|
      key = file_path_key(path)
      delete_entry(path, options) if key.match(matcher)
    end
  end
end
increment(name, amount = 1, options = nil)

Increments an already existing integer value that is stored in the cache. If the key is not found nothing is done.

# File activesupport/lib/active_support/cache/file_store.rb, line 48
def increment(name, amount = 1, options = nil)
  modify_value(name, amount, options)
end