Class: CacheStoreDatabase Private

Inherits:
Object show all
Defined in:
cache_store.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

CacheStoreDatabase acts as an interface to a persistent storage mechanism residing in the HOMEBREW_CACHE.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Creates a CacheStoreDatabase.

Parameters:



54
55
56
57
 
# File 'cache_store.rb', line 54

def initialize(type)
  @type = T.let(type, Symbol)
  @dirty = T.let(false, T.nilable(T::Boolean))
end

Class Method Details

.use(type, &_blk) {|CacheStoreDatabase| ... } ⇒ T.type_parameter(:U)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Yields the cache store database. Closes the database after use if it has been loaded.

Parameters:

Yields:

Returns:

  • (T.type_parameter(:U)) 


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'cache_store.rb', line 24

def self.use(type, &_blk)
  @db_type_reference_hash ||= T.let({}, T.nilable(T::Hash[T.untyped, T.untyped]))
  @db_type_reference_hash[type] ||= {}
  type_ref = @db_type_reference_hash[type]

  type_ref[:count] ||= 0
  type_ref[:count]  += 1

  type_ref[:db] ||= CacheStoreDatabase.new(type)

  return_value = yield(type_ref[:db])
  if type_ref[:count].positive?
    type_ref[:count] -= 1
  else
    type_ref[:count] = 0
  end

  if type_ref[:count].zero?
    type_ref[:db].write_if_dirty!
    type_ref.delete(:db)
  end

  return_value
end

Instance Method Details

#clear! ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Deletes all content from the underlying database (if it already exists).



85
86
87
88
89
90
 
# File 'cache_store.rb', line 85

def clear!
  return unless created?

  dirty!
  db.clear
end

#created? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns true if the cache file has been created for the given @type.

Returns:

  • (Boolean) 


105
106
107
 
# File 'cache_store.rb', line 105

def created?
  cache_path.exist?
end

#delete(key) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Deletes a value from the underlying database (if it already exists).

Parameters:

  • key (T.anything) 


76
77
78
79
80
81
 
# File 'cache_store.rb', line 76

def delete(key)
  return unless created?

  dirty!
  db.delete(key)
end

#each_key(&block) ⇒ Hash{T.untyped => T.untyped}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Performs a each_key on the underlying database.

Parameters:

  • block (T.proc.params(arg0: T.untyped).returns(BasicObject))

Returns:

  • (Hash{T.untyped => T.untyped}) 


139
140
141
 
# File 'cache_store.rb', line 139

def each_key(&block)
  db.each_key(&block)
end

#empty? ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns true if the cache is empty.

Returns:

  • (Boolean) 


131
132
133
 
# File 'cache_store.rb', line 131

def empty?
  db.empty?
end

#get(key) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Gets a value from the underlying database (if it already exists).

Parameters:

  • key (T.anything)

Returns:

  • (T.untyped) 


68
69
70
71
72
 
# File 'cache_store.rb', line 68

def get(key)
  return unless created?

  db[key]
end

#mtime ⇒ Time?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns the modification time of the cache file (if it already exists).

Returns:



113
114
115
116
117
 
# File 'cache_store.rb', line 113

def mtime
  return unless created?

  cache_path.mtime
end

#select(&block) ⇒ Hash{T.untyped => T.untyped}

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Performs a select on the underlying database.

Parameters:

  • block (T.proc.params(arg0: T.untyped, arg1: T.untyped).returns(BasicObject))

Returns:

  • (Hash{T.untyped => T.untyped}) 


123
124
125
 
# File 'cache_store.rb', line 123

def select(&block)
  db.select(&block)
end

#set(key, value) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Sets a value in the underlying database (and creates it if necessary).

Parameters:

  • key (T.anything)
  • value (T.anything) 


61
62
63
64
 
# File 'cache_store.rb', line 61

def set(key, value)
  dirty!
  db[key] = value
end

#write_if_dirty! ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Closes the underlying database (if it is created and open).



94
95
96
97
98
99
 
# File 'cache_store.rb', line 94

def write_if_dirty!
  return unless dirty?

  cache_path.dirname.mkpath
  cache_path.atomic_write(JSON.dump(@db))
end