Class: Moneta::Adapters::File

Inherits:
Object
  • Object
show all
Includes:
Defaults
Defined in:
lib/moneta/adapters/file.rb

Overview

Filesystem backend

Instance Method Summary collapse

Methods included from Defaults

#[], #[]=, #close, #decrement, #features, #fetch, #fetch_values, included, #merge!, #slice, #supports?, #update, #values_at

Methods included from OptionSupport

#expires, #prefix, #raw, #with

Constructor Details

#initialize(options = {}) ⇒ File

Returns a new instance of File.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :dir (String) —

    Directory where files will be stored

Raises:

  • (ArgumentError) 


14
15
16
17
18
 
# File 'lib/moneta/adapters/file.rb', line 14

def initialize(options = {})
  raise ArgumentError, 'Option :dir is required' unless @dir = options[:dir]
  FileUtils.mkpath(@dir)
  raise "#{@dir} is not a directory" unless ::File.directory?(@dir)
end

Instance Method Details

#clear(options = {}) ⇒ void

This method returns an undefined value.

Clear all keys in this store

Parameters:

  • options (Hash) (defaults to: {}) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/moneta/adapters/file.rb', line 65

def clear(options = {})
  temp_dir = "#{@dir}-#{$PROCESS_ID}-#{Thread.current.object_id}"
  ::File.rename(@dir, temp_dir)
  FileUtils.mkpath(@dir)
  self
rescue Errno::ENOENT
  self
ensure
  FileUtils.rm_rf(temp_dir)
end

#create(key, value, options = {}) ⇒ Boolean

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Atomically sets a key to value if it’s not set.

Parameters:

  • key (Object)
  • value (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Update expiration time (See Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

Returns:

  • (Boolean) —

    key was set



97
98
99
100
101
102
103
104
 
# File 'lib/moneta/adapters/file.rb', line 97

def create(key, value, options = {})
  path = store_path(key)
  FileUtils.mkpath(::File.dirname(path))
  # Call native java.io.File#createNewFile
  return false unless ::Java::JavaIo::File.new(path).createNewFile
  ::File.open(path, 'wb+') { |f| f.write(value) }
  true
end

#delete(key, options = {}) ⇒ Object

Delete the key from the store and return the current value

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    current value



56
57
58
59
60
61
62
 
# File 'lib/moneta/adapters/file.rb', line 56

def delete(key, options = {})
  value = load(key, options)
  ::File.unlink(store_path(key))
  value
rescue Errno::ENOENT
  nil
end

#each_key ⇒ Enumerator #each_key {|key| ... } ⇒ self

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Calls block once for each key in store, passing the key as a parameter. If no block is given, an enumerator is returned instead.

Overloads:

  • #each_key ⇒ Enumerator

    Returns An all-the-keys enumerator.

    Returns:

    • (Enumerator) —

      An all-the-keys enumerator

  • #each_key {|key| ... } ⇒ self

    Yield Parameters:

    • key (Object) —

      Each key is yielded to the supplied block

    Returns:

    • (self) 


26
27
28
29
30
31
32
33
 
# File 'lib/moneta/adapters/file.rb', line 26

def each_key(&block)
  entries = ::Dir.entries(@dir).reject { |k| ::File.directory?(::File.join(@dir, k)) }

  return enum_for(:each_key) { ::Dir.entries(@dir).length - 2 } unless block_given?

  entries.each { |k| yield(k) }
  self
end

#increment(key, amount = 1, options = {}) ⇒ Object

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Atomically increment integer value with key

This method also accepts negative amounts.

Parameters:

  • key (Object)
  • amount (Integer) (defaults to: 1)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    value from store



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/moneta/adapters/file.rb', line 77

def increment(key, amount = 1, options = {})
  path = store_path(key)
  FileUtils.mkpath(::File.dirname(path))
  ::File.open(path, ::File::RDWR | ::File::CREAT) do |f|
    Thread.pass until f.flock(::File::LOCK_EX)
    content = f.read
    amount += Integer(content) unless content.empty?
    content = amount.to_s
    f.binmode
    f.pos = 0
    f.write(content)
    f.truncate(content.bytesize)
    amount
  end
end

#key?(key, options = {}) ⇒ Boolean

Exists the value with key

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Update expiration time (See Expires)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/moneta/adapters/file.rb', line 21

def key?(key, options = {})
  ::File.exist?(store_path(key))
end

#load(key, options = {}) ⇒ Object

Fetch value with key. Return nil if the key doesn’t exist

Parameters:

  • key (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Update expiration time (See Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • :sync (Boolean) —

    Synchronized load (Cache reloads from adapter, Daybreak syncs with file)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • (Object) —

    value



36
37
38
39
40
 
# File 'lib/moneta/adapters/file.rb', line 36

def load(key, options = {})
  ::File.read(store_path(key), mode: 'rb')
rescue Errno::ENOENT
  nil
end

#store(key, value, options = {}) ⇒ Object

Store value with key

Parameters:

  • key (Object)
  • value (Object)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :expires (Integer) —

    Set expiration time (See Expires)

  • :raw (Boolean) —

    Raw access without value transformation (See Transformer)

  • :prefix (String) —

    Prefix key (See Transformer)

  • Other (Object) —

    options as defined by the adapters or middleware

Returns:

  • value



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/moneta/adapters/file.rb', line 43

def store(key, value, options = {})
  temp_file = ::File.join(@dir, "value-#{$PROCESS_ID}-#{Thread.current.object_id}")
  path = store_path(key)
  FileUtils.mkpath(::File.dirname(path))
  ::File.open(temp_file, 'wb') { |f| f.write(value) }
  ::File.rename(temp_file, path)
  value
rescue
  File.unlink(temp_file) rescue nil
  raise
end