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
- FILENAME_MAX_SIZE
- FILEPATH_MAX_SIZE
- GITKEEP_FILES
Attributes
Public Class Methods
# File activesupport/lib/active_support/cache/file_store.rb, line 21 def initialize(cache_path, **options) super(options) @cache_path = cache_path.to_s end
ActiveSupport::Cache::Store::new
# File activesupport/lib/active_support/cache/file_store.rb, line 27 def self.supports_cache_versioning? true end
Advertise cache versioning support.
Public Instance Methods
# File activesupport/lib/active_support/cache/file_store.rb, line 41 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
Preemptively iterates through all stored keys and removes the ones which have expired.
# File activesupport/lib/active_support/cache/file_store.rb, line 34 def clear(options = nil) root_dirs = (Dir.children(cache_path) - GITKEEP_FILES) FileUtils.rm_r(root_dirs.collect { |f| File.join(cache_path, f) }) rescue Errno::ENOENT, Errno::ENOTEMPTY end
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 57 def decrement(name, amount = 1, options = nil) modify_value(name, -amount, options) end
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 61 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
# File activesupport/lib/active_support/cache/file_store.rb, line 51 def increment(name, amount = 1, options = nil) modify_value(name, amount, options) end
Increments an already existing integer value that is stored in the cache. If the key is not found nothing is done.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.