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.
Class Method Summary collapse
-
.all_aliases ⇒ Hash
private
-
.all_formulae ⇒ Hash
private
-
.all_renames ⇒ Hash{String => String}
private
-
.download_and_cache_data! ⇒ Boolean
private
-
.fetch(name) ⇒ Hash
private
-
.source_download(formula) ⇒ ::Formula
private
-
.write_names_and_aliases(regenerate: false) ⇒ void
private
Methods included from Cachable
Class Method Details
.all_aliases ⇒ 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.
73 74 75 76 77 78 79 80 |
# File 'api/formula.rb', line 73 def 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
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.
63 64 65 66 67 68 69 70 |
# File 'api/formula.rb', line 63 def 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.
83 84 85 86 87 88 89 90 |
# File 'api/formula.rb', line 83 def all_renames unless cache.key?("renames") json_updated = download_and_cache_data! write_names_and_aliases(regenerate: json_updated) end cache["renames"] end |
.download_and_cache_data! ⇒ 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.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'api/formula.rb', line 42 def download_and_cache_data! json_formulae, updated = Homebrew::API.fetch_json_api_file "formula.jws.json" cache["aliases"] = {} cache["renames"] = {} cache["formulae"] = json_formulae.to_h do |json_formula| json_formula["aliases"].each do |alias_name| cache["aliases"][alias_name] = json_formula["name"] end (json_formula["oldnames"] || [json_formula["oldname"]].compact).each do |oldname| cache["renames"][oldname] = json_formula["name"] end [json_formula["name"], json_formula.except("name")] end updated 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.
19 20 21 |
# File 'api/formula.rb', line 19 def 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.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'api/formula.rb', line 24 def 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 Formulary.factory(download.symlink_location, formula.active_spec_sym, alias_path: formula.alias_path, flags: formula.class.build_flags) 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.
93 94 95 96 97 98 99 100 101 102 103 |
# File 'api/formula.rb', line 93 def 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: 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 |