Module: Formulary Private
- Extended by:
- Cachable, Context, Utils::Output::Mixin
- Includes:
- Utils::Output::Mixin
- Defined in:
- formulary.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.
The Formulary is responsible for creating instances of Formula. It is not meant to be used directly from formulae.
Defined Under Namespace
Classes: FormulaContentsLoader, FormulaJSONContentsLoader, FormulaLoader, FormulaStubLoader, FromAPILoader, FromBottleLoader, FromCacheLoader, FromKegLoader, FromNameLoader, FromPathLoader, FromTapLoader, FromURILoader, NullLoader
Class Method Summary collapse
- .canonical_name(ref) ⇒ String private
- .class_s(name) ⇒ String private
- .clear_cache ⇒ void private
- .convert_to_string_or_symbol(string) ⇒ String, Symbol private
- .core_path(name) ⇒ Pathname private
-
.enable_factory_cache! ⇒ void
internal
Enable the factory cache.
- .ensure_utf8_encoding(io) ⇒ IO private
-
.factory(ref, spec = :stable, alias_path: nil, from: nil, warn: false, force_bottle: false, flags: [], ignore_errors: false, prefer_stub: false) ⇒ Formula
internal
Return a Formula instance for the given reference.
- .factory_cache ⇒ Hash{String => Formula} private
- .factory_cached? ⇒ Boolean private
- .find_formula_in_tap(name, tap) ⇒ Pathname private
- .formula_class_defined_from_api?(name) ⇒ Boolean private
- .formula_class_defined_from_path?(path) ⇒ Boolean private
- .formula_class_defined_from_stub?(name) ⇒ Boolean private
- .formula_class_get_from_api(name) ⇒ T.class_of(Formula) private
- .formula_class_get_from_path(path) ⇒ T.class_of(Formula) private
- .formula_class_get_from_stub(name) ⇒ T.class_of(Formula) private
-
.from_contents(name, path, contents, spec = :stable, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false) ⇒ Formula
private
Return a Formula instance directly from contents.
-
.from_json_contents(name, contents, spec = :stable, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false) ⇒ Formula
private
Return a Formula instance directly from JSON contents.
-
.from_keg(keg, spec = nil, alias_path: nil, force_bottle: false, flags: []) ⇒ Formula
private
Return a Formula instance for the given keg.
-
.from_rack(rack, spec = nil, alias_path: nil, force_bottle: false, flags: []) ⇒ Formula
private
Return a Formula instance for the given rack.
-
.keg_only?(rack) ⇒ Boolean
private
Return whether given rack is keg-only.
- .load_formula(name, path, contents, namespace, flags:, ignore_errors:) ⇒ T.class_of(Formula) private
- .load_formula_from_json!(name, json_formula_with_variations, flags:) ⇒ T.class_of(Formula) private
- .load_formula_from_path(name, path, flags:, ignore_errors:) ⇒ T.class_of(Formula) private
- .load_formula_from_stub!(name, formula_stub, flags:) ⇒ T.class_of(Formula) private
- .loader_for(ref, from: nil, warn: true) ⇒ FormulaLoader private
- .namespace_key(identifier) ⇒ String private
- .path(ref) ⇒ Pathname private
- .platform_cache ⇒ Hash{Symbol => Hash{String => T.class_of(Formula)}} private
- .replace_placeholders(string) ⇒ String private
- .resolve(name, spec: nil, force_bottle: false, flags: [], prefer_stub: false) ⇒ Formula private
- .tap_formula_name_type(tapped_name, warn:) ⇒ Array<(String, Tap, [Symbol, nil])>? private
- .to_rack(ref) ⇒ Pathname private
Methods included from Context
current, current=, debug?, quiet?, verbose?, with_context
Methods included from Cachable
Methods included from Utils::Output::Mixin
odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, pretty_duration, pretty_installed, pretty_outdated, pretty_uninstalled
Class Method Details
.canonical_name(ref) ⇒ 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.
1301 1302 1303 1304 1305 1306 1307 |
# File 'formulary.rb', line 1301 def self.canonical_name(ref) loader_for(ref).name rescue TapFormulaAmbiguityError # If there are multiple tap formulae with the name of ref, # then ref is the canonical name ref.downcase end |
.class_s(name) ⇒ 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.
577 578 579 580 581 582 583 |
# File 'formulary.rb', line 577 def self.class_s(name) class_name = name.capitalize class_name.gsub!(/[-_.\s]([a-zA-Z0-9])/) { T.must(Regexp.last_match(1)).upcase } class_name.tr!("+", "x") class_name.sub!(/(.)@(\d)/, "\\1AT\\2") class_name end |
.clear_cache ⇒ 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.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'formulary.rb', line 96 def self.clear_cache platform_cache.each do |type, cached_objects| next if type == :formulary_factory cached_objects.each_value do |klass| class_name = klass.name # Already removed from namespace. next if class_name.nil? namespace = Utils.deconstantize(class_name) next if Utils.deconstantize(namespace) != name remove_const(Utils.demodulize(namespace).to_sym) end end super end |
.convert_to_string_or_symbol(string) ⇒ String, Symbol
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.
586 587 588 589 590 |
# File 'formulary.rb', line 586 def self.convert_to_string_or_symbol(string) return T.must(string[1..]).to_sym if string.start_with?(":") string end |
.core_path(name) ⇒ 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.
1380 1381 1382 |
# File 'formulary.rb', line 1380 def self.core_path(name) find_formula_in_tap(name.to_s.downcase, CoreTap.instance) end |
.enable_factory_cache! ⇒ void
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
Enable the factory cache.
37 38 39 40 41 |
# File 'formulary.rb', line 37 def self.enable_factory_cache! @factory_cache_enabled = T.let(true, T.nilable(TrueClass)) cache[platform_cache_tag] ||= {} cache[platform_cache_tag][:formulary_factory] ||= {} end |
.ensure_utf8_encoding(io) ⇒ IO
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.
572 573 574 |
# File 'formulary.rb', line 572 def self.ensure_utf8_encoding(io) io.set_encoding(Encoding::UTF_8) end |
.factory(ref, spec = :stable, alias_path: nil, from: nil, warn: false, force_bottle: false, flags: [], ignore_errors: false, prefer_stub: false) ⇒ Formula
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Return a Formula instance for the given reference.
ref
is a string containing:
- a formula name
- a formula pathname
- a formula URL
- a local bottle reference
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 |
# File 'formulary.rb', line 1122 def self.factory( ref, spec = :stable, alias_path: nil, from: nil, warn: false, force_bottle: false, flags: [], ignore_errors: false, prefer_stub: false ) cache_key = "#{ref}-#{spec}-#{alias_path}-#{from}-#{prefer_stub}" return factory_cache.fetch(cache_key) if factory_cached? && factory_cache.key?(cache_key) loader = FormulaStubLoader.try_new(ref, from:, warn:) if prefer_stub loader ||= loader_for(ref, from:, warn:) formula = loader.get_formula(spec, alias_path:, force_bottle:, flags:, ignore_errors:) factory_cache[cache_key] ||= formula if factory_cached? formula end |
.factory_cache ⇒ Hash{String => 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 |
# File 'formulary.rb', line 60 def self.factory_cache cache[platform_cache_tag] ||= {} cache[platform_cache_tag][:formulary_factory] ||= {} end |
.factory_cached? ⇒ 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.
44 45 46 |
# File 'formulary.rb', line 44 def self.factory_cached? !!@factory_cache_enabled end |
.find_formula_in_tap(name, tap) ⇒ 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.
1385 1386 1387 1388 1389 1390 1391 1392 1393 |
# File 'formulary.rb', line 1385 def self.find_formula_in_tap(name, tap) filename = if name.end_with?(".rb") name else "#{name}.rb" end tap.formula_files_by_name.fetch(name, tap.formula_dir/filename) end |
.formula_class_defined_from_api?(name) ⇒ 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.
71 72 73 |
# File 'formulary.rb', line 71 def self.formula_class_defined_from_api?(name) platform_cache.key?(:api) && platform_cache.fetch(:api).key?(name) end |
.formula_class_defined_from_path?(path) ⇒ 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.
66 67 68 |
# File 'formulary.rb', line 66 def self.formula_class_defined_from_path?(path) platform_cache.key?(:path) && platform_cache.fetch(:path).key?(path.to_s) end |
.formula_class_defined_from_stub?(name) ⇒ 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.
76 77 78 |
# File 'formulary.rb', line 76 def self.formula_class_defined_from_stub?(name) platform_cache.key?(:stub) && platform_cache.fetch(:stub).key?(name) end |
.formula_class_get_from_api(name) ⇒ T.class_of(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.
86 87 88 |
# File 'formulary.rb', line 86 def self.formula_class_get_from_api(name) platform_cache.fetch(:api).fetch(name) end |
.formula_class_get_from_path(path) ⇒ T.class_of(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.
81 82 83 |
# File 'formulary.rb', line 81 def self.formula_class_get_from_path(path) platform_cache.fetch(:path).fetch(path.to_s) end |
.formula_class_get_from_stub(name) ⇒ T.class_of(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.
91 92 93 |
# File 'formulary.rb', line 91 def self.formula_class_get_from_stub(name) platform_cache.fetch(:stub).fetch(name) end |
.from_contents(name, path, contents, spec = :stable, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false) ⇒ 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.
Return a Formula instance directly from contents.
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 |
# File 'formulary.rb', line 1247 def self.from_contents( name, path, contents, spec = :stable, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false ) FormulaContentsLoader.new(name, path, contents) .get_formula(spec, alias_path:, force_bottle:, flags:, ignore_errors:) end |
.from_json_contents(name, contents, spec = :stable, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false) ⇒ 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.
Return a Formula instance directly from JSON contents.
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'formulary.rb', line 1273 def self.from_json_contents( name, contents, spec = :stable, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false ) FormulaJSONContentsLoader.new(name, contents) .get_formula(spec, alias_path:, force_bottle:, flags:, ignore_errors:) end |
.from_keg(keg, spec = nil, alias_path: nil, force_bottle: false, flags: []) ⇒ 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.
Return a Formula instance for the given keg.
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 |
# File 'formulary.rb', line 1197 def self.from_keg( keg, spec = nil, alias_path: nil, force_bottle: false, flags: [] ) tab = keg.tab tap = tab.tap spec ||= tab.spec formula_name = keg.rack.basename.to_s = { alias_path:, from: :keg, warn: false, force_bottle:, flags:, }.compact f = if tap.nil? factory(formula_name, spec, **) else begin factory("#{tap}/#{formula_name}", spec, **) rescue FormulaUnavailableError # formula may be migrated to different tap. Try to search in core and all taps. factory(formula_name, spec, **) end end f.build = tab T.cast(f.build, Tab). = Tab.(f., tab.).as_flags f.version.update_commit(keg.version.version.commit) if f.head? && keg.version.head? f end |
.from_rack(rack, spec = nil, alias_path: nil, force_bottle: false, flags: []) ⇒ 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.
Return a Formula instance for the given rack.
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 |
# File 'formulary.rb', line 1161 def self.from_rack(rack, spec = nil, alias_path: nil, force_bottle: false, flags: []) kegs = rack.directory? ? rack.subdirs.map { |d| Keg.new(d) } : [] keg = kegs.find(&:linked?) || kegs.find(&:optlinked?) || kegs.max_by(&:scheme_and_version) = { alias_path:, force_bottle:, flags:, }.compact if keg from_keg(keg, *spec, **) else factory(rack.basename.to_s, *spec, from: :rack, warn: false, **) end end |
.keg_only?(rack) ⇒ 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.
Return whether given rack is keg-only.
1180 1181 1182 1183 1184 |
# File 'formulary.rb', line 1180 def self.keg_only?(rack) Formulary.from_rack(rack).keg_only? rescue FormulaUnavailableError, TapFormulaAmbiguityError false end |
.load_formula(name, path, contents, namespace, flags:, ignore_errors:) ⇒ T.class_of(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.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'formulary.rb', line 126 def self.load_formula(name, path, contents, namespace, flags:, ignore_errors:) raise "Formula loading disabled by `$HOMEBREW_DISABLE_LOAD_FORMULA`!" if Homebrew::EnvConfig.disable_load_formula? require "formula" require "ignorable" require "stringio" # Capture stdout to prevent formulae from printing to stdout unexpectedly. old_stdout = $stdout $stdout = StringIO.new mod = Module.new namespace = namespace.to_sym remove_const(namespace) if const_defined?(namespace) const_set(namespace, mod) eval_formula = lambda do # Set `BUILD_FLAGS` in the formula's namespace so we can # access them from within the formula's class scope. mod.const_set(:BUILD_FLAGS, flags) mod.module_eval(contents, path.to_s) rescue NameError, ArgumentError, ScriptError, MethodDeprecatedError, MacOSVersion::Error => e if e.is_a?(Ignorable::ExceptionMixin) e.ignore else remove_const(namespace) raise FormulaUnreadableError.new(name, e) end end if ignore_errors Ignorable.hook_raise(&eval_formula) else eval_formula.call end class_name = class_s(name) begin mod.const_get(class_name) rescue NameError => e class_list = mod.constants .map { |const_name| mod.const_get(const_name) } .grep(Class) new_exception = FormulaClassUnavailableError.new(name, path, class_name, class_list) remove_const(namespace) raise new_exception, "", e.backtrace end ensure # TODO: Make printing to stdout an error so that we can print a tap name. # See discussion at https://github.com/Homebrew/brew/pull/20226#discussion_r2195886888 if (printed_to_stdout = $stdout.string.strip.presence) opoo <<~WARNING Formula #{name} attempted to print the following while being loaded: #{printed_to_stdout} WARNING end $stdout = old_stdout end |
.load_formula_from_json!(name, json_formula_with_variations, flags:) ⇒ T.class_of(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.
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'formulary.rb', line 212 def self.load_formula_from_json!(name, json_formula_with_variations, flags:) namespace = :"FormulaNamespaceAPI#{namespace_key(json_formula_with_variations.to_json)}" mod = Module.new remove_const(namespace) if const_defined?(namespace) const_set(namespace, mod) mod.const_set(:BUILD_FLAGS, flags) class_name = class_s(name) json_formula = Homebrew::API.merge_variations(json_formula_with_variations) caveats_string = (replace_placeholders(json_formula["caveats"]) if json_formula["caveats"]) uses_from_macos_names = json_formula.fetch("uses_from_macos", []).map do |dep| next dep unless dep.is_a? Hash dep.keys.first end requirements = {} json_formula["requirements"]&.map do |req| req_name = req["name"].to_sym next if API_SUPPORTED_REQUIREMENTS.exclude?(req_name) req_version = case req_name when :arch req["version"]&.to_sym when :macos, :maximum_macos MacOSVersion::SYMBOLS.key(req["version"]) else req["version"] end = [] << req_version if req_version.present? += req["contexts"]&.map do |tag| case tag when String tag.to_sym when Hash tag.deep_transform_keys(&:to_sym) else tag end end spec_hash = .empty? ? req_name : { req_name => } specs = req["specs"] specs ||= ["stable", "head"] # backwards compatibility specs.each do |spec| requirements[spec.to_sym] ||= [] requirements[spec.to_sym] << spec_hash end end add_deps = lambda do |spec| T.bind(self, SoftwareSpec) dep_json = json_formula.fetch("#{spec}_dependencies", json_formula) dep_json["dependencies"]&.each do |dep| # Backwards compatibility check - uses_from_macos used to be a part of dependencies on Linux next if !json_formula.key?("uses_from_macos_bounds") && uses_from_macos_names.include?(dep) && !Homebrew::SimulateSystem.simulating_or_running_on_macos? depends_on dep end [:build, :test, :recommended, :optional].each do |type| dep_json["#{type}_dependencies"]&.each do |dep| # Backwards compatibility check - uses_from_macos used to be a part of dependencies on Linux next if !json_formula.key?("uses_from_macos_bounds") && uses_from_macos_names.include?(dep) && !Homebrew::SimulateSystem.simulating_or_running_on_macos? depends_on dep => type end end dep_json["uses_from_macos"]&.each_with_index do |dep, index| bounds = dep_json.fetch("uses_from_macos_bounds", [])[index].dup || {} bounds.deep_transform_keys!(&:to_sym) bounds.deep_transform_values!(&:to_sym) if dep.is_a?(Hash) uses_from_macos dep.deep_transform_values(&:to_sym).merge(bounds) else uses_from_macos dep, bounds end end end klass = Class.new(::Formula) do @loaded_from_api = T.let(true, T.nilable(T::Boolean)) @api_source = T.let(json_formula_with_variations, T.nilable(T::Hash[String, T.untyped])) desc json_formula["desc"] homepage json_formula["homepage"] license SPDX.string_to_license_expression(json_formula["license"]) revision json_formula.fetch("revision", 0) version_scheme json_formula.fetch("version_scheme", 0) if (urls_stable = json_formula["urls"]["stable"].presence) stable do url_spec = { tag: urls_stable["tag"], revision: urls_stable["revision"], using: urls_stable["using"]&.to_sym, }.compact url urls_stable["url"], **url_spec version json_formula["versions"]["stable"] sha256 urls_stable["checksum"] if urls_stable["checksum"].present? instance_exec(:stable, &add_deps) requirements[:stable]&.each do |req| depends_on req end end end if (urls_head = json_formula["urls"]["head"].presence) head do url_spec = { branch: urls_head["branch"], using: urls_head["using"]&.to_sym, }.compact url urls_head["url"], **url_spec instance_exec(:head, &add_deps) requirements[:head]&.each do |req| depends_on req end end end if (because = json_formula["no_autobump_msg"]) because = because.to_sym if NO_AUTOBUMP_REASONS_LIST.key?(because.to_sym) no_autobump!(because:) end bottles_stable = json_formula["bottle"]["stable"].presence if bottles_stable bottle do if Homebrew::EnvConfig.bottle_domain == HOMEBREW_BOTTLE_DEFAULT_DOMAIN root_url HOMEBREW_BOTTLE_DEFAULT_DOMAIN else root_url Homebrew::EnvConfig.bottle_domain end rebuild bottles_stable["rebuild"] bottles_stable["files"].each do |tag, bottle_spec| cellar = Formulary.convert_to_string_or_symbol bottle_spec["cellar"] sha256 cellar:, tag.to_sym => bottle_spec["sha256"] end end end if (pour_bottle_only_if = json_formula["pour_bottle_only_if"]) pour_bottle? only_if: pour_bottle_only_if.to_sym end if (keg_only_reason = json_formula["keg_only_reason"].presence) reason = Formulary.convert_to_string_or_symbol keg_only_reason["reason"] keg_only reason, keg_only_reason["explanation"] end if (deprecation_date = json_formula["deprecation_date"].presence) reason = DeprecateDisable.to_reason_string_or_symbol json_formula["deprecation_reason"], type: :formula replacement_formula = json_formula["deprecation_replacement_formula"] replacement_cask = json_formula["deprecation_replacement_cask"] deprecate! date: deprecation_date, because: reason, replacement_formula:, replacement_cask: end if (disable_date = json_formula["disable_date"].presence) reason = DeprecateDisable.to_reason_string_or_symbol json_formula["disable_reason"], type: :formula replacement_formula = json_formula["disable_replacement_formula"] replacement_cask = json_formula["disable_replacement_cask"] disable! date: disable_date, because: reason, replacement_formula:, replacement_cask: end json_formula["conflicts_with"]&.each_with_index do |conflict, index| conflicts_with conflict, because: json_formula.dig("conflicts_with_reasons", index) end json_formula["link_overwrite"]&.each do |overwrite_path| link_overwrite overwrite_path end define_method(:install) do raise NotImplementedError, "Cannot build from source from abstract formula." end @post_install_defined_boolean = T.let(json_formula["post_install_defined"], T.nilable(T::Boolean)) @post_install_defined_boolean = true if @post_install_defined_boolean.nil? # Backwards compatibility define_method(:post_install_defined?) do self.class.instance_variable_get(:@post_install_defined_boolean) end if (service_hash = json_formula["service"].presence) service_hash = Homebrew::Service.from_hash(service_hash) service do T.bind(self, Homebrew::Service) if (run_params = service_hash.delete(:run).presence) case run_params when Hash run(**run_params) when Array, String run run_params end end if (name_params = service_hash.delete(:name).presence) name(**name_params) end service_hash.each do |key, arg| public_send(key, arg) end end end @caveats_string = T.let(caveats_string, T.nilable(String)) define_method(:caveats) do self.class.instance_variable_get(:@caveats_string) end @tap_git_head_string = T.let(json_formula["tap_git_head"], T.nilable(String)) define_method(:tap_git_head) do self.class.instance_variable_get(:@tap_git_head_string) end @oldnames_array = T.let(json_formula["oldnames"] || [json_formula["oldname"]].compact, T.nilable(T::Array[String])) define_method(:oldnames) do self.class.instance_variable_get(:@oldnames_array) end @aliases_array = T.let(json_formula.fetch("aliases", []), T.nilable(T::Array[String])) define_method(:aliases) do self.class.instance_variable_get(:@aliases_array) end @versioned_formulae_array = T.let(json_formula.fetch("versioned_formulae", []), T.nilable(T::Array[String])) define_method(:versioned_formulae_names) do self.class.instance_variable_get(:@versioned_formulae_array) end @ruby_source_path_string = T.let(json_formula["ruby_source_path"], T.nilable(String)) define_method(:ruby_source_path) do self.class.instance_variable_get(:@ruby_source_path_string) end @ruby_source_checksum_string = T.let(json_formula.dig("ruby_source_checksum", "sha256"), T.nilable(String)) @ruby_source_checksum_string ||= json_formula["ruby_source_sha256"] define_method(:ruby_source_checksum) do checksum = self.class.instance_variable_get(:@ruby_source_checksum_string) Checksum.new(checksum) if checksum end end mod.const_set(class_name, klass) platform_cache[:api] ||= {} platform_cache.fetch(:api)[name] = klass end |
.load_formula_from_path(name, path, flags:, ignore_errors:) ⇒ T.class_of(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.
203 204 205 206 207 208 209 |
# File 'formulary.rb', line 203 def self.load_formula_from_path(name, path, flags:, ignore_errors:) contents = path.open("r") { |f| ensure_utf8_encoding(f).read } namespace = "FormulaNamespace#{namespace_key(path.to_s)}" klass = load_formula(name, path, contents, namespace, flags:, ignore_errors:) platform_cache[:path] ||= {} platform_cache.fetch(:path)[path.to_s] = klass end |
.load_formula_from_stub!(name, formula_stub, flags:) ⇒ T.class_of(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.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
# File 'formulary.rb', line 480 def self.load_formula_from_stub!(name, formula_stub, flags:) namespace = :"FormulaNamespaceStub#{namespace_key(formula_stub.to_json)}" mod = Module.new remove_const(namespace) if const_defined?(namespace) const_set(namespace, mod) mod.const_set(:BUILD_FLAGS, flags) class_name = class_s(name) klass = Class.new(::Formula) do @loaded_from_api = T.let(true, T.nilable(T::Boolean)) @loaded_from_stub = T.let(true, T.nilable(T::Boolean)) url "formula-stub://#{name}/#{formula_stub.pkg_version}" version formula_stub.version.to_s revision formula_stub.revision bottle do if Homebrew::EnvConfig.bottle_domain == HOMEBREW_BOTTLE_DEFAULT_DOMAIN root_url HOMEBREW_BOTTLE_DEFAULT_DOMAIN else root_url Homebrew::EnvConfig.bottle_domain end rebuild formula_stub.rebuild sha256 Utils::Bottles.tag.to_sym => formula_stub.sha256 end define_method :install do raise NotImplementedError, "Cannot build from source from abstract stubbed formula." end @aliases_array = formula_stub.aliases define_method(:aliases) do self.class.instance_variable_get(:@aliases_array) end @oldnames_array = formula_stub.oldnames define_method(:oldnames) do self.class.instance_variable_get(:@oldnames_array) end end mod.const_set(class_name, klass) platform_cache[:stub] ||= {} platform_cache.fetch(:stub)[name] = klass end |
.loader_for(ref, from: nil, warn: true) ⇒ FormulaLoader
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.
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 |
# File 'formulary.rb', line 1359 def self.loader_for(ref, from: nil, warn: true) [ FromBottleLoader, FromURILoader, FromAPILoader, FromTapLoader, FromPathLoader, FromNameLoader, FromKegLoader, FromCacheLoader, ].each do |loader_class| if (loader = loader_class.try_new(ref, from:, warn:)) $stderr.puts "#{$PROGRAM_NAME} (#{loader_class}): loading #{ref}" if verbose? && debug? return loader end end NullLoader.new(ref) end |
.namespace_key(identifier) ⇒ 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.
186 187 188 189 190 |
# File 'formulary.rb', line 186 def self.namespace_key(identifier) Digest::SHA2.hexdigest( "#{Homebrew::SimulateSystem.current_os}_#{Homebrew::SimulateSystem.current_arch}:#{identifier}", ) end |
.path(ref) ⇒ 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.
1310 1311 1312 |
# File 'formulary.rb', line 1310 def self.path(ref) loader_for(ref).path end |
.platform_cache ⇒ Hash{Symbol => Hash{String => T.class_of(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.
55 56 57 |
# File 'formulary.rb', line 55 def self.platform_cache cache[platform_cache_tag] ||= {} end |
.replace_placeholders(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.
193 194 195 196 197 |
# File 'formulary.rb', line 193 def self.replace_placeholders(string) string.gsub(HOMEBREW_PREFIX_PLACEHOLDER, HOMEBREW_PREFIX) .gsub(HOMEBREW_CELLAR_PLACEHOLDER, HOMEBREW_CELLAR) .gsub(HOMEBREW_HOME_PLACEHOLDER, Dir.home) end |
.resolve(name, spec: nil, force_bottle: false, flags: [], prefer_stub: false) ⇒ 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.
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'formulary.rb', line 533 def self.resolve( name, spec: nil, force_bottle: false, flags: [], prefer_stub: false ) if name.include?("/") || File.exist?(name) f = factory(name, *spec, force_bottle:, flags:, prefer_stub:) if f.any_version_installed? tab = Tab.for_formula(f) resolved_spec = spec || tab.spec f.active_spec = resolved_spec if f.send(resolved_spec) f.build = tab if f.head? && tab.tabfile k = Keg.new(tab.tabfile.parent) f.version.update_commit(k.version.version.commit) if k.version.head? end end else rack = to_rack(name) alias_path = factory(name, force_bottle:, flags:, prefer_stub:).alias_path f = from_rack(rack, *spec, alias_path:, force_bottle:, flags:) end # If this formula was installed with an alias that has since changed, # then it was specified explicitly in ARGV. (Using the alias would # instead have found the new formula.) # # Because of this, the user is referring to this specific formula, # not any formula targeted by the same alias, so in this context # the formula shouldn't be considered outdated if the alias used to # install it has changed. f.follow_installed_alias = false f end |
.tap_formula_name_type(tapped_name, warn:) ⇒ Array<(String, Tap, [Symbol, nil])>?
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.
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 |
# File 'formulary.rb', line 1315 def self.tap_formula_name_type(tapped_name, warn:) return unless (tap_with_name = Tap.with_formula_name(tapped_name)) tap, name = tap_with_name type = nil # FIXME: Remove the need to do this here. alias_table_key = tap.core_tap? ? name : "#{tap}/#{name}" if (possible_alias = tap.alias_table[alias_table_key].presence) # FIXME: Remove the need to split the name and instead make # the alias table only contain short names. name = possible_alias.split("/").fetch(-1) type = :alias elsif (new_name = tap.formula_renames[name].presence) old_name = tap.core_tap? ? name : tapped_name name = new_name new_name = tap.core_tap? ? name : "#{tap}/#{name}" type = :rename elsif (new_tap_name = tap.tap_migrations[name].presence) new_tap, new_name = Tap.with_formula_name(new_tap_name) || [Tap.fetch(new_tap_name), name] new_tap.ensure_installed! new_tapped_name = "#{new_tap}/#{new_name}" if tapped_name == new_tapped_name opoo "Tap migration for #{tapped_name} points to itself, stopping recursion." else old_name = tap.core_tap? ? name : tapped_name return unless (name_tap_type = tap_formula_name_type(new_tapped_name, warn: false)) name, tap, = name_tap_type new_name = new_tap.core_tap? ? name : "#{tap}/#{name}" type = :migration end end opoo "Formula #{old_name} was renamed to #{new_name}." if warn && old_name && new_name [name, tap, type] end |
.to_rack(ref) ⇒ 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.
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 |
# File 'formulary.rb', line 1287 def self.to_rack(ref) # If using a fully-scoped reference, check if the formula can be resolved. factory(ref) if ref.include? "/" # Check whether the rack with the given name exists. if (rack = HOMEBREW_CELLAR/File.basename(ref, ".rb")).directory? return rack.resolved_path end # Use canonical name to locate rack. (HOMEBREW_CELLAR/canonical_name(ref)).resolved_path end |