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
R
W
Constants
DIR_FORMATTER = "%03X"
 
FILENAME_MAX_SIZE = 228
 
EXCLUDED_DIRS = ['.', '..'].freeze
 
Attributes
[R] cache_path
Class Public methods
new(cache_path, options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 19
def initialize(cache_path, options = nil)
  super(options)
  @cache_path = cache_path.to_s
  extend Strategy::LocalCache
end
Instance Public methods
cleanup(options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 30
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(options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 25
def clear(options = nil)
  root_dirs = Dir.entries(cache_path).reject {|f| (EXCLUDED_DIRS + [".gitkeep"]).include?(f)}
  FileUtils.rm_r(root_dirs.collect{|f| File.join(cache_path, f)})
end
decrement(name, amount = 1, options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 53
def decrement(name, amount = 1, options = nil)
  file_name = key_file_path(namespaced_key(name, options))
  lock_file(file_name) do
    options = merged_options(options)
    if num = read(name, options)
      num = num.to_i - amount
      write(name, num, options)
      num
    else
      nil
    end
  end
end
delete_matched(matcher, options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 67
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(key, options) if key.match(matcher)
    end
  end
end
increment(name, amount = 1, options = nil)
# File activesupport/lib/active_support/cache/file_store.rb, line 39
def increment(name, amount = 1, options = nil)
  file_name = key_file_path(namespaced_key(name, options))
  lock_file(file_name) do
    options = merged_options(options)
    if num = read(name, options)
      num = num.to_i + amount
      write(name, num, options)
      num
    else
      nil
    end
  end
end
Instance Protected methods
delete_entry(key, options)
# File activesupport/lib/active_support/cache/file_store.rb, line 97
def delete_entry(key, options)
  file_name = key_file_path(key)
  if File.exist?(file_name)
    begin
      File.delete(file_name)
      delete_empty_directories(File.dirname(file_name))
      true
    rescue => e
      # Just in case the error was caused by another process deleting the file first.
      raise e if File.exist?(file_name)
      false
    end
  end
end
read_entry(key, options)
# File activesupport/lib/active_support/cache/file_store.rb, line 80
def read_entry(key, options)
  file_name = key_file_path(key)
  if File.exist?(file_name)
    File.open(file_name) { |f| Marshal.load(f) }
  end
rescue => e
  logger.error("FileStoreError (#{e}): #{e.message}") if logger
  nil
end
write_entry(key, entry, options)
# File activesupport/lib/active_support/cache/file_store.rb, line 90
def write_entry(key, entry, options)
  file_name = key_file_path(key)
  ensure_cache_path(File.dirname(file_name))
  File.atomic_write(file_name, cache_path) {|f| Marshal.dump(entry, f)}
  true
end