Module: Homebrew::API::Formula Private

Extended by:
Cachable
Defined in:
api/formula.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.

Constant Summary collapse

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 Cachable

cache, clear_cache

Class Method Details

.all_aliasesHash{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:



106
107
108
109
110
111
112
113
# File 'api/formula.rb', line 106

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_formulaeHash{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:



96
97
98
99
100
101
102
103
# File 'api/formula.rb', line 96

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

.all_renamesHash{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:



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

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

  cache.fetch("renames")
end

.api_filenameString

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

def self.api_filename
  return DEFAULT_API_FILENAME unless ENV.fetch("HOMEBREW_USE_INTERNAL_API", false)

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

.cached_json_file_pathPathname

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:



53
54
55
# File 'api/formula.rb', line 53

def self.cached_json_file_path
  HOMEBREW_CACHE_API/api_filename
end

.fetch(name) ⇒ 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.

Parameters:

Returns:



27
28
29
# File 'api/formula.rb', line 27

def self.fetch(name)
  Homebrew::API.fetch "formula/#{name}.json"
end

.fetch_api!(download_queue: nil) ⇒ 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:

Returns:



61
62
63
# File 'api/formula.rb', line 61

def self.fetch_api!(download_queue: nil)
  Homebrew::API.fetch_json_api_file api_filename, download_queue:
end

.fetch_tap_migrations!(download_queue: nil) ⇒ 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:

Returns:



69
70
71
72
# File 'api/formula.rb', line 69

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

.source_download(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:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'api/formula.rb', line 32

def self.source_download(formula)
  path = formula.ruby_source_path || "Formula/#{formula.name}.rb"
  git_head = formula.tap_git_head || "HEAD"
  tap = formula.tap&.full_name || "Homebrew/homebrew-core"

  download = Homebrew::API::Download.new(
    "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}",
    formula.ruby_source_checksum,
    cache: HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}/Formula",
  )
  download.fetch

  with_env(HOMEBREW_FORBID_PACKAGES_FROM_PATHS: nil) do
    Formulary.factory(download.symlink_location,
                      formula.active_spec_sym,
                      alias_path: formula.alias_path,
                      flags:      formula.class.build_flags)
  end
end

.tap_migrationsHash{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:



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

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)


136
137
138
139
140
141
142
143
144
145
146
# File 'api/formula.rb', line 136

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

  return unless Homebrew::API.write_names_file!(all_formulae.keys, "formula", regenerate:)

  (HOMEBREW_CACHE_API/"formula_aliases.txt").open("w") do |file|
    all_aliases.each do |alias_name, real_name|
      file.puts "#{alias_name}|#{real_name}"
    end
  end
end