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)

230

Instance Attribute Summary collapse

Attributes inherited from Store

#options, #silence

Instance Method Summary collapse

Methods inherited from Store

#delete, #exist?, #fetch, instrument, instrument=, #mute, #read, #read_multi, #silence!, #write

Constructor Details

#initialize(cache_path, options = nil) ⇒ FileStore

Returns a new instance of FileStore.

[View source]

18
19
20
21
22
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 18

def initialize(cache_path, options = nil)
  super(options)
  @cache_path = cache_path.to_s
  extend Strategy::LocalCache
end

Instance Attribute Details

#cache_path ⇒ Object (readonly)

Returns the value of attribute cache_path


13
14
15
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 13

def cache_path
  @cache_path
end

Instance Method Details

#cleanup(options = nil) ⇒ Object

[View source]

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

def cleanup(options = nil)
  options = merged_options(options)
  each_key(options) do |key|
    entry = read_entry(key, options)
    delete_entry(key, options) if entry && entry.expired?
  end
end

#clear(options = nil) ⇒ Object

[View source]

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

def clear(options = nil)
  root_dirs = Dir.entries(cache_path).reject{|f| f.in?(['.', '..'])}
  FileUtils.rm_r(root_dirs.collect{|f| File.join(cache_path, f)})
end

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

[View source]

51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 51

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

[View source]

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

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

[View source]

37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'activesupport/lib/active_support/cache/file_store.rb', line 37

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