класс ActiveSupport::Cache::FileStore

Родитель:: ActiveSupport::Cache::Store

Реализация кэша, хранящего данные в файловой системе.

FileStore реализует стратегию Strategy::LocalCache, которая реализует кэш в памяти внутри блока.

Константы

DIR_FORMATTER
EXCLUDED_DIRS
FILENAME_MAX_SIZE

Атрибуты

cache_path[R]

Публичные методы класса

new(cache_path, options = nil) Показать исходный код

Вызывает метод родительского класса ActiveSupport::Cache::Store.new

# 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

Публичные методы экземпляра

cleanup(options = nil) Показать исходный код

Проводит предварительную итерацию по всем сохранённым ключам и удаляет истекшие.

# File activesupport/lib/active_support/cache/file_store.rb, line 34
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) Показать исходный код

Удаляет все элементы из кэша. В данном случае удаляются все записи в указанном каталоге хранилища кэша, кроме .gitkeep. Будьте внимательны с каталогом, указанным в файле конфигурации при использовании FileStore, так как всё в этом каталоге будет удалено.

# File activesupport/lib/active_support/cache/file_store.rb, line 28
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 51
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 55
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 45
def increment(name, amount = 1, options = nil)
  modify_value(name, amount, options)
end

Защищённые методы экземпляра

delete_entry(key, options) Показать исходный код

# File activesupport/lib/active_support/cache/file_store.rb, line 86
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 68
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 78
def write_entry(key, entry, options)
  file_name = key_file_path(key)
  return false if options[:unless_exist] && File.exist?(file_name)
  ensure_cache_path(File.dirname(file_name))
  File.atomic_write(file_name, cache_path) {|f| Marshal.dump(entry, f)}
  true
end