Module: Homebrew::API::Internal Private

Extended by:
Cachable
Defined in:
api/internal.rb

Overview

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

Helper functions for using the JSON internal API.

Class Method Summary collapse

Methods included from Cachable

cache, clear_cache

Class Method Details

.cached_cask_json_file_path ⇒ Pathname

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:



48
49
50
 
# File 'api/internal.rb', line 48

def self.cached_cask_json_file_path
  HOMEBREW_CACHE_API/cask_endpoint
end

.cached_formula_json_file_path ⇒ Pathname

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:



43
44
45
 
# File 'api/internal.rb', line 43

def self.cached_formula_json_file_path
  HOMEBREW_CACHE_API/formula_endpoint
end

.cask_endpoint ⇒ String

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:



23
24
25
 
# File 'api/internal.rb', line 23

def self.cask_endpoint
  "internal/cask.#{SimulateSystem.current_tag}.jws.json"
end

.cask_hashes ⇒ Hash{String => Hash{String => 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.

Returns:



166
167
168
169
170
171
172
173
 
# File 'api/internal.rb', line 166

def self.cask_hashes
  unless cache.key?("cask_hashes")
    updated = download_and_cache_cask_data!
    write_cask_names(regenerate: updated)
  end

  cache["cask_hashes"]
end

.cask_renames ⇒ Hash{String => String}

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:



176
177
178
179
180
181
182
183
 
# File 'api/internal.rb', line 176

def self.cask_renames
  unless cache.key?("cask_renames")
    updated = download_and_cache_cask_data!
    write_cask_names(regenerate: updated)
  end

  cache["cask_renames"]
end

.cask_tap_migrations ⇒ Hash{String => String}

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:



186
187
188
189
190
191
192
193
 
# File 'api/internal.rb', line 186

def self.cask_tap_migrations
  unless cache.key?("cask_tap_migrations")
    updated = download_and_cache_cask_data!
    write_cask_names(regenerate: updated)
  end

  cache["cask_tap_migrations"]
end

.fetch_cask_api!(download_queue: Homebrew.default_download_queue, stale_seconds: nil, enqueue: false) ⇒ Array<(Hash{String => T.untyped}, 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.

Parameters:

  • download_queue (Homebrew::DownloadQueue) (defaults to: Homebrew.default_download_queue)
  • stale_seconds (Integer, nil) (defaults to: nil)
  • enqueue (Boolean) (defaults to: false)

Returns:



67
68
69
70
71
72
 
# File 'api/internal.rb', line 67

def self.fetch_cask_api!(download_queue: Homebrew.default_download_queue, stale_seconds: nil,
                         enqueue: false)
  json_contents, updated = Homebrew::API.fetch_json_api_file(cask_endpoint, stale_seconds:, download_queue:,
                                                             enqueue:)
  [T.cast(json_contents, T::Hash[String, T.untyped]), updated]
end

.fetch_formula_api!(download_queue: Homebrew.default_download_queue, stale_seconds: nil, enqueue: false) ⇒ Array<(Hash{String => T.untyped}, 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.

Parameters:

  • download_queue (Homebrew::DownloadQueue) (defaults to: Homebrew.default_download_queue)
  • stale_seconds (Integer, nil) (defaults to: nil)
  • enqueue (Boolean) (defaults to: false)

Returns:



56
57
58
59
60
61
 
# File 'api/internal.rb', line 56

def self.fetch_formula_api!(download_queue: Homebrew.default_download_queue, stale_seconds: nil,
                            enqueue: false)
  json_contents, updated = Homebrew::API.fetch_json_api_file(formula_endpoint, stale_seconds:, download_queue:,
                                                             enqueue:)
  [T.cast(json_contents, T::Hash[String, T.untyped]), updated]
end

.formula_aliases ⇒ Hash{String => String}

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:



126
127
128
129
130
131
132
133
 
# File 'api/internal.rb', line 126

def self.formula_aliases
  unless cache.key?("formula_aliases")
    updated = download_and_cache_formula_data!
    write_formula_names_and_aliases(regenerate: updated)
  end

  cache["formula_aliases"]
end

.formula_endpoint ⇒ String

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:



18
19
20
 
# File 'api/internal.rb', line 18

def self.formula_endpoint
  "internal/formula.#{SimulateSystem.current_tag}.jws.json"
end

.formula_hashes ⇒ Hash{String => Hash{String => 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.

Returns:



116
117
118
119
120
121
122
123
 
# File 'api/internal.rb', line 116

def self.formula_hashes
  unless cache.key?("formula_hashes")
    updated = download_and_cache_formula_data!
    write_formula_names_and_aliases(regenerate: updated)
  end

  cache["formula_hashes"]
end

.formula_renames ⇒ Hash{String => String}

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:



136
137
138
139
140
141
142
143
 
# File 'api/internal.rb', line 136

def self.formula_renames
  unless cache.key?("formula_renames")
    updated = download_and_cache_formula_data!
    write_formula_names_and_aliases(regenerate: updated)
  end

  cache["formula_renames"]
end

.formula_struct(name) ⇒ Homebrew::API::FormulaStruct

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.

Parameters:

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'api/internal.rb', line 28

def self.formula_struct(name)
  return cache["formula_structs"][name] if cache.key?("formula_structs") && cache["formula_structs"].key?(name)

  hash = formula_hashes[name]
  raise "No formula found for #{name}" unless hash

  struct = Homebrew::API::FormulaStruct.deserialize(hash, bottle_tag: SimulateSystem.current_tag)

  cache["formula_structs"] ||= {}
  cache["formula_structs"][name] = struct

  struct
end

.formula_tap_git_head ⇒ String

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:



156
157
158
159
160
161
162
163
 
# File 'api/internal.rb', line 156

def self.formula_tap_git_head
  unless cache.key?("formula_tap_git_head")
    updated = download_and_cache_formula_data!
    write_formula_names_and_aliases(regenerate: updated)
  end

  cache["formula_tap_git_head"]
end

.formula_tap_migrations ⇒ Hash{String => String}

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:



146
147
148
149
150
151
152
153
 
# File 'api/internal.rb', line 146

def self.formula_tap_migrations
  unless cache.key?("formula_tap_migrations")
    updated = download_and_cache_formula_data!
    write_formula_names_and_aliases(regenerate: updated)
  end

  cache["formula_tap_migrations"]
end

.write_cask_names(regenerate: false) ⇒ 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.

Parameters:

  • regenerate (Boolean) (defaults to: false) 


109
110
111
112
113
 
# File 'api/internal.rb', line 109

def self.write_cask_names(regenerate: false)
  download_and_cache_cask_data! unless cache.key?("cask_hashes")

  Homebrew::API.write_names_file!(cask_hashes.keys, "cask", regenerate:)
end

.write_formula_names_and_aliases(regenerate: false) ⇒ 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.

Parameters:

  • regenerate (Boolean) (defaults to: false) 


101
102
103
104
105
106
 
# File 'api/internal.rb', line 101

def self.write_formula_names_and_aliases(regenerate: false)
  download_and_cache_formula_data! unless cache.key?("formula_hashes")

  Homebrew::API.write_names_file!(formula_hashes.keys, "formula", regenerate:)
  Homebrew::API.write_aliases_file!(formula_aliases, "formula", regenerate:)
end