class ActiveSupport::Cache::FileStore

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.

Constants

DIR_FORMATTER
EXCLUDED_DIRS
FILENAME_MAX_SIZE
FILEPATH_MAX_SIZE
GITKEEP_FILES

Attributes

cache_path[R]

Public Class Methods

new(cache_path, options = nil) click to toggle source

Calls superclass method ActiveSupport::Cache::Store.new

# File lib/active_support/cache/file_store.rb, line 23
def initialize(cache_path, options = nil)
  super(options)
  @cache_path = cache_path.to_s
end

Public Instance Methods

cleanup(options = nil) click to toggle source

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

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

clear(options = nil) click to toggle source

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 lib/active_support/cache/file_store.rb, line 31
def clear(options = 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) click to toggle source

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

# File 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) click to toggle source

# File 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) click to toggle source

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

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