Class: Gemirro::Cache

Inherits:
Object
  • Object
show all
Defined in:
lib/gemirro/cache.rb

Overview

The Cache class contains all method to store marshal informations into files.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ Cache

Initialize cache root path

Parameters:

  • path (String) 


19
20
21
22
 
# File 'lib/gemirro/cache.rb', line 19

def initialize(path)
  @root_path = path
  create_root_path
end

Instance Attribute Details

#root_path ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/gemirro/cache.rb', line 11

class Cache
  attr_reader :root_path

  ##
  # Initialize cache root path
  #
  # @param [String] path
  #
  def initialize(path)
    @root_path = path
    create_root_path
  end

  ##
  # Create root path
  #
  def create_root_path
    FileUtils.mkdir_p(@root_path)
  end

  ##
  # Flush cache directory
  #
  def flush
    FileUtils.rm_rf(@root_path)
    create_root_path
  end

  ##
  # Flush key
  #
  # @param [String] key
  #
  def flush_key(key)
    path = key_path(key2hash(key))
    FileUtils.rm_f(path)
  end

  ##
  # Cache data
  #
  # @param [String] key
  #
  # @return [Mixed]
  #
  def cache(key)
    key_hash = key2hash(key)
    read(key_hash) || (write(key_hash, yield) if block_given?)
  end

  private

  ##
  # Convert key to hash
  #
  # @param [String] key
  #
  # @return [String]
  #
  def key2hash(key)
    Digest::MD5.hexdigest(key)
  end

  ##
  # Path from key hash
  #
  # @param [String] key_hash
  #
  # @return [String]
  #
  def key_path(key_hash)
    File.join(@root_path, key_hash)
  end

  ##
  # Read cache
  #
  # @param [String] key_hash
  #
  # @return [Mixed]
  #
  def read(key_hash)
    path = key_path(key_hash)
    Marshal.load(File.open(path)) if File.exist?(path)
  end

  ##
  # write cache
  #
  # @param [String] key_hash
  # @param [Mixed] value
  #
  # @return [Mixed]
  #
  def write(key_hash, value)
    return value if value.nil? || value.empty?

    File.open(key_path(key_hash), 'wb') do |f|
      Marshal.dump(value, f)
    end

    value
  end
end

Instance Method Details

#cache(key) ⇒ Mixed

Cache data

Parameters:

  • key (String)

Returns:

  • (Mixed) 


56
57
58
59
 
# File 'lib/gemirro/cache.rb', line 56

def cache(key)
  key_hash = key2hash(key)
  read(key_hash) || (write(key_hash, yield) if block_given?)
end

#create_root_path ⇒ Object

Create root path



27
28
29
 
# File 'lib/gemirro/cache.rb', line 27

def create_root_path
  FileUtils.mkdir_p(@root_path)
end

#flush ⇒ Object

Flush cache directory



34
35
36
37
 
# File 'lib/gemirro/cache.rb', line 34

def flush
  FileUtils.rm_rf(@root_path)
  create_root_path
end

#flush_key(key) ⇒ Object

Flush key

Parameters:

  • key (String) 


44
45
46
47
 
# File 'lib/gemirro/cache.rb', line 44

def flush_key(key)
  path = key_path(key2hash(key))
  FileUtils.rm_f(path)
end