Class: ActiveSupport::Cache::FileStore

Inherits:
Store show all
Defined in:
activesupport/lib/active_support/cache/file_store.rb

Overview

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.

Constant Summary collapse

DIR_FORMATTER = 
"%03X"
FILENAME_MAX_SIZE =

max filename size on file system is 255, minus room for timestamp and random characters appended by Tempfile (used by atomic write)

228
FILEPATH_MAX_SIZE =

max is 1024, plus some room

900
GITKEEP_FILES = 
[".gitkeep", ".keep"].freeze

Instance Attribute Summary collapse

Attributes inherited from Store

#options, #silence

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Store

#delete, #delete_multi, #exist?, #fetch, #fetch_multi, #mute, #read, #read_multi, #silence!, #write, #write_multi

Constructor Details

#initialize(cache_path, options = nil) ⇒ FileStore

Returns a new instance of FileStore.



23
24
25
26
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 23

def initialize(cache_path, options = nil)
  super(options)
  @cache_path = cache_path.to_s
end

Instance Attribute Details

#cache_path ⇒ Object (readonly)

Returns the value of attribute cache_path



16
17
18
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 16

def cache_path
  @cache_path
end

Class Method Details

.supports_cache_versioning? ⇒ Boolean

Advertise cache versioning support.

Returns:

  • (Boolean) 


29
30
31
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 29

def self.supports_cache_versioning?
  true
end

Instance Method Details

#cleanup(options = nil) ⇒ Object

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



43
44
45
46
47
48
49
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 43

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) ⇒ Object

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.



36
37
38
39
40
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 36

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
end

#decrement(name, amount = 1, options = nil) ⇒ Object

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



59
60
61
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 59

def decrement(name, amount = 1, options = nil)
  modify_value(name, -amount, options)
end

#delete_matched(matcher, options = nil) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 63

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) ⇒ Object

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



53
54
55
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 53

def increment(name, amount = 1, options = nil)
  modify_value(name, amount, options)
end