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"
INTERNAL_V3_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. 

"internal/v3/homebrew-core.jws.json"

Class Method Summary collapse

Methods included from Cachable

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:



89
90
91
92
93
94
95
96
 
# File 'api/formula.rb', line 89

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

  cache["aliases"]
end

.all_formulae ⇒ Hash{String => Hash}

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:



79
80
81
82
83
84
85
86
 
# File 'api/formula.rb', line 79

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

  cache["formulae"]
end

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



99
100
101
102
103
104
105
106
 
# File 'api/formula.rb', line 99

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

  cache["renames"]
end

.cached_json_file_path ⇒ Object

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. 



44
45
46
47
48
49
50
 
# File 'api/formula.rb', line 44

def self.cached_json_file_path
  if Homebrew::API.internal_json_v3?
    HOMEBREW_CACHE_API/INTERNAL_V3_API_FILENAME
  else
    HOMEBREW_CACHE_API/DEFAULT_API_FILENAME
  end
end

.fetch(name) ⇒ Hash

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:



19
20
21
 
# File 'api/formula.rb', line 19

def self.fetch(name)
  Homebrew::API.fetch "formula/#{name}.json"
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:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'api/formula.rb', line 24

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_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:



120
121
122
123
124
125
126
127
128
 
# File 'api/formula.rb', line 120

def self.tap_git_head
  # Note sure we need to reload here.
  unless cache.key?("tap_git_head")
    json_updated = download_and_cache_data!
    write_names_and_aliases(regenerate: json_updated)
  end

  cache["tap_git_head"]
end

.tap_migrations ⇒ Hash

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:



109
110
111
112
113
114
115
116
117
 
# File 'api/formula.rb', line 109

def self.tap_migrations
  # Not sure that we need to reload here.
  unless cache.key?("tap_migrations")
    json_updated = download_and_cache_data!
    write_names_and_aliases(regenerate: json_updated)
  end

  cache["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) 


131
132
133
134
135
136
137
138
139
140
141
 
# File 'api/formula.rb', line 131

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