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
- .api_filename ⇒ String private
- .cached_json_file_path ⇒ Pathname private
- .fetch(name) ⇒ Hash{String => T.untyped} 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_tap_migrations!(download_queue: nil, stale_seconds: Homebrew::API::TAP_MIGRATIONS_STALE_SECONDS) ⇒ Array<([Array<T.untyped>, Hash{String => T.untyped}], Boolean)> 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.
117 118 119 120 121 122 123 124 |
# File 'api/formula.rb', line 117 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.
107 108 109 110 111 112 113 114 |
# File 'api/formula.rb', line 107 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.
127 128 129 130 131 132 133 134 |
# File 'api/formula.rb', line 127 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_filename ⇒ 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.
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_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.
65 66 67 |
# File 'api/formula.rb', line 65 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.
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, 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.
73 74 75 |
# File 'api/formula.rb', line 73 def self.fetch_api!(download_queue: nil, stale_seconds: Homebrew::EnvConfig.api_auto_update_secs.to_i) Homebrew::API.fetch_json_api_file api_filename, stale_seconds:, download_queue: 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.
81 82 83 |
# File 'api/formula.rb', line 81 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, 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.
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, 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.
53 54 55 56 57 58 59 60 61 62 |
# File 'api/formula.rb', line 53 def self.source_download_formula(formula) download = source_download(formula) 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_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.
137 138 139 140 141 142 143 144 |
# File 'api/formula.rb', line 137 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.
147 148 149 150 151 152 153 154 155 156 157 |
# File 'api/formula.rb', line 147 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 |