Module: Homebrew::API::Formula Private

Extended by:
Cacheable, T::Generic
Defined in:
api/formula.rb,
api/formula/formula_struct_generator.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 formula JSON API.

Defined Under Namespace

Modules: FormulaStructGenerator

Constant Summary collapse

Cache =

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

type_template { { fixed: T::Hash[String, T.untyped] } }
DEFAULT_API_FILENAME =

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

"formula.jws.json"

Class Method Summary collapse

Methods included from Cacheable

cache, clear_cache

Class Method Details

.all_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:



172
173
174
175
176
177
178
179
 
# File 'api/formula.rb', line 172

def self.all_aliases
  unless cache.key?("aliases")
    json_updated = download_and_cache_data!
    write_names_and_aliases(regenerate: json_updated)
  end

  cache.fetch("aliases")
end

.all_formulae ⇒ 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:



162
163
164
165
166
167
168
169
 
# File 'api/formula.rb', line 162

def self.all_formulae
  unless cache.key?("formulae")
    json_updated = download_and_cache_data!
    write_names_and_aliases(regenerate: json_updated)
  end

  cache.fetch("formulae")
end

.cached_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:



120
121
122
 
# File 'api/formula.rb', line 120

def self.cached_json_file_path
  HOMEBREW_CACHE_API/DEFAULT_API_FILENAME
end

.fetch_api!(download_queue: nil, stale_seconds: nil, enqueue: false) ⇒ Array<([Array<T.untyped>, 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 (DownloadQueueType) (defaults to: nil)
  • stale_seconds (Integer, nil) (defaults to: nil)
  • enqueue (Boolean) (defaults to: false)

Returns:



128
129
130
 
# File 'api/formula.rb', line 128

def self.fetch_api!(download_queue: nil, stale_seconds: nil, enqueue: false)
  Homebrew::API.fetch_json_api_file DEFAULT_API_FILENAME, stale_seconds:, download_queue:, enqueue:
end

.fetch_tap_migrations!(download_queue: nil, stale_seconds: nil, enqueue: false) ⇒ Array<([Array<T.untyped>, 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 (DownloadQueueType) (defaults to: nil)
  • stale_seconds (Integer, nil) (defaults to: nil)
  • enqueue (Boolean) (defaults to: false)

Returns:



136
137
138
 
# File 'api/formula.rb', line 136

def self.fetch_tap_migrations!(download_queue: nil, stale_seconds: nil, enqueue: false)
  Homebrew::API.fetch_json_api_file "formula_tap_migrations.jws.json", stale_seconds:, download_queue:, enqueue:
end

.source_download(formula, download_queue: nil, enqueue: false) ⇒ Homebrew::API::SourceDownload

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:



87
88
89
90
 
# File 'api/formula.rb', line 87

def self.source_download(formula, download_queue: nil, enqueue: false)
  path = formula.ruby_source_path || "Formula/#{formula.name}.rb"
  source_download_path(formula, path, checksum: formula.ruby_source_checksum, download_queue:, enqueue:)
end

.source_download_formula(formula) ⇒ ::Formula

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:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'api/formula.rb', line 93

def self.source_download_formula(formula)
  download = source_download(formula)

  unless download.symlink_location.exist?
    raise CannotInstallFormulaError,
          "#{formula.full_name} source code not found at #{download.symlink_location}. " \
          "Try `rm -rf $(brew --cache)/api-source` and retrying."
  end

  source_formula = Formulary.from_path(download.symlink_location,
                                       formula.active_spec_sym,
                                       alias_path: formula.alias_path,
                                       flags:      formula.class.build_flags)

  source_formula.resources.each do |resource|
    resource.patches.grep(LocalPatch) do |patch|
      source_download_path(formula, patch.file.to_s)
    end
  end
  source_formula.patchlist.grep(LocalPatch) do |patch|
    source_download_path(formula, patch.file.to_s)
  end

  source_formula
end

.source_download_path(formula, path, checksum: nil, download_queue: nil, enqueue: false) ⇒ Homebrew::API::SourceDownload

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:



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
 
# File 'api/formula.rb', line 31

def self.source_download_path(formula, path, checksum: nil, download_queue: nil, enqueue: false)
  require "local_patch"

  unless LocalPatch.valid_path?(path)
    raise ArgumentError, "API source path must be a relative path within the repository."
  end

  if checksum.nil? && (sha256 = formula.local_patch_checksums[path])
    checksum = Checksum.new(sha256)
  end
  if checksum.blank?
    raise CannotInstallFormulaError,
          "#{formula.full_name}: no checksum in API metadata for #{path}.\n" \
          "Run `brew update` to refresh the API metadata and try again."
  end

  path = Pathname(path).cleanpath

  git_head = formula.tap_git_head || "HEAD"
  tap = formula.tap&.full_name || "Homebrew/homebrew-core"

  download = Homebrew::API::SourceDownload.new(
    "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}",
    checksum,
    formula:,
    cache:   HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}"/path.dirname,
  )

  if enqueue
    require "download_queue"
    download_queue ||= Homebrew::DownloadQueue.default
    download_queue.enqueue(download)
  else
    begin
      if !download.symlink_location.exist? || !download.symlink_location.symlink?
        download.fetch
      else
        download.verify_download_integrity(download.symlink_location)
      end
    rescue ChecksumMismatchError
      # Remove the known-bad download so the next attempt fetches it again.
      download.clear_cache
      raise
    end
  end

  download
end

.tap_migrations ⇒ 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:



182
183
184
185
186
187
188
189
 
# File 'api/formula.rb', line 182

def self.tap_migrations
  unless cache.key?("tap_migrations")
    json_migrations, = fetch_tap_migrations!
    cache["tap_migrations"] = json_migrations
  end

  cache.fetch("tap_migrations")
end

.write_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) 


192
193
194
195
196
197
198
 
# File 'api/formula.rb', line 192

def self.write_names_and_aliases(regenerate: false)
  download_and_cache_data! unless cache.key?("formulae")

  Homebrew::API.write_names_file!("formula", regenerate:) { all_formulae.keys }
  Homebrew::API.write_aliases_file!("formula", regenerate:) { all_aliases }
  Homebrew::API.write_executables_file!(regenerate:, source: cached_json_file_path) { all_formulae }
end