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
- .all_aliases ⇒ Hash{String => String} private
- .all_formulae ⇒ Hash{String => T.untyped} private
- .all_renames ⇒ Hash{String => String} private
- .cached_json_file_path ⇒ Pathname private
- .fetch_api!(download_queue: nil, stale_seconds: Homebrew::EnvConfig.api_auto_update_secs.to_i) ⇒ Array<([Array<T.untyped>, Hash{String => T.untyped}], Boolean)> private
- .fetch_formula_json!(name, download_queue: nil) ⇒ void private
- .fetch_tap_migrations!(download_queue: nil, stale_seconds: Homebrew::API::TAP_MIGRATIONS_STALE_SECONDS) ⇒ Array<([Array<T.untyped>, Hash{String => T.untyped}], Boolean)> private
- .formula_json(name) ⇒ Hash{String => T.untyped} private
- .source_download(formula, download_queue: nil) ⇒ Homebrew::API::SourceDownload private
- .source_download_formula(formula) ⇒ ::Formula private
- .tap_migrations ⇒ Hash{String => T.untyped} private
- .write_names_and_aliases(regenerate: false) ⇒ void private
Methods included from Cachable
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.
124 125 126 127 128 129 130 131 |
# File 'api/formula.rb', line 124 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.
114 115 116 117 118 119 120 121 |
# File 'api/formula.rb', line 114 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_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.
134 135 136 137 138 139 140 141 |
# File 'api/formula.rb', line 134 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 |
.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.
72 73 74 |
# File 'api/formula.rb', line 72 def self.cached_json_file_path HOMEBREW_CACHE_API/DEFAULT_API_FILENAME end |
.fetch_api!(download_queue: nil, stale_seconds: Homebrew::EnvConfig.api_auto_update_secs.to_i) ⇒ 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.
80 81 82 |
# File 'api/formula.rb', line 80 def self.fetch_api!(download_queue: nil, stale_seconds: Homebrew::EnvConfig.api_auto_update_secs.to_i) Homebrew::API.fetch_json_api_file DEFAULT_API_FILENAME, stale_seconds:, download_queue: end |
.fetch_formula_json!(name, download_queue: nil) ⇒ 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.
27 28 29 30 31 32 33 34 35 36 |
# File 'api/formula.rb', line 27 def self.fetch_formula_json!(name, download_queue: nil) endpoint = "formula/#{name}.json" json_formula, updated = Homebrew::API.fetch_json_api_file endpoint, download_queue: download_queue return if download_queue json_formula = JSON.parse((HOMEBREW_CACHE_API/endpoint).read) unless updated cache["formula_json"] ||= {} cache["formula_json"][name] = json_formula end |
.fetch_tap_migrations!(download_queue: nil, stale_seconds: Homebrew::API::TAP_MIGRATIONS_STALE_SECONDS) ⇒ 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.
88 89 90 |
# File 'api/formula.rb', line 88 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 |
.formula_json(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.
20 21 22 23 24 |
# File 'api/formula.rb', line 20 def self.formula_json(name) fetch_formula_json! name if !cache.key?("formula_json") || !cache.fetch("formula_json").key?(name) cache.fetch("formula_json").fetch(name) end |
.source_download(formula, download_queue: nil) ⇒ 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.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'api/formula.rb', line 39 def self.source_download(formula, download_queue: nil) 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::SourceDownload.new( "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}", formula.ruby_source_checksum, cache: HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}/Formula", ) if download_queue download_queue.enqueue(download) elsif !download.symlink_location.exist? download.fetch end download 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.
60 61 62 63 64 65 66 67 68 69 |
# File 'api/formula.rb', line 60 def self.source_download_formula(formula) download = source_download(formula) with_env(HOMEBREW_INTERNAL_ALLOW_PACKAGES_FROM_PATHS: "1") do Formulary.factory(download.symlink_location, formula.active_spec_sym, alias_path: formula.alias_path, flags: formula.class.build_flags) end 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.
144 145 146 147 148 149 150 151 |
# File 'api/formula.rb', line 144 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.
154 155 156 157 158 159 |
# File 'api/formula.rb', line 154 def self.write_names_and_aliases(regenerate: false) download_and_cache_data! unless cache.key?("formulae") Homebrew::API.write_names_file!(all_formulae.keys, "formula", regenerate:) Homebrew::API.write_aliases_file!(all_aliases, "formula", regenerate:) end |