Module: Formulary Private

Extended by:
Cacheable, Context, T::Generic, 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, FromAPILoader, FromBottleLoader, FromCacheLoader, FromKegLoader, FromNameLoader, FromPathLoader, FromTapLoader, FromURILoader, NullLoader

Constant Summary collapse

Cache =

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. 

type_template { { fixed: T::Hash[String, T.untyped] } }

Class Method Summary collapse

Methods included from Context

current, current=, debug?, deferred_environment_expansion?, quiet?, verbose?, with_context

Methods included from Cacheable

cache, clear_cache

Methods included from Utils::Output::Mixin

issue_reporting_message, odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_once, opoo_outside_github_actions, opoo_without_github_actions_annotation, pretty_cannot_install, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_removed, pretty_uninstalled, pretty_unmarked, pretty_upgradable, pretty_warning

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.

Parameters:

Returns:



1188
1189
1190
1191
1192
1193
1194
 
# File 'formulary.rb', line 1188

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.

Parameters:

Returns:



483
484
485
486
487
488
489
 
# File 'formulary.rb', line 483

def self.class_s(name)
  class_name = name.capitalize
  class_name.gsub!(/[-_.\s][a-zA-Z0-9]/) { |matched| matched.chars.fetch(-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.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'formulary.rb', line 88

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

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

Parameters:

Returns:



1277
1278
1279
 
# File 'formulary.rb', line 1277

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.



33
34
35
36
37
 
# File 'formulary.rb', line 33

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.

Parameters:

  • io (IO)

Returns:

  • (IO) 


478
479
480
 
# File 'formulary.rb', line 478

def self.ensure_utf8_encoding(io)
  io.set_encoding(Encoding::UTF_8)
end

.factory(ref, spec = :stable, alias_path: nil, warn: false, 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.

Look up a formula by name, without interpreting paths, bottles or source.

Parameters:

  • ref (String)
  • spec (Symbol) (defaults to: :stable)
  • alias_path (Pathname, String, nil) (defaults to: nil)
  • warn (Boolean) (defaults to: false)
  • force_bottle (Boolean) (defaults to: false)
  • flags (Array<String>) (defaults to: [])
  • ignore_errors (Boolean) (defaults to: false)

Returns:



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'formulary.rb', line 970

def self.factory(
  ref,
  spec = :stable,
  alias_path: nil,
  warn: false,
  force_bottle: false,
  flags: [],
  ignore_errors: false
)
  cache_key = "name:#{ref}-#{spec}-#{alias_path}"
  if factory_cached? && factory_cache.key?(cache_key) && Utils::Path.valid_package_name?(ref)
    return factory_cache.fetch(cache_key)
  end

  loader = loader_for(ref, 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.

Returns:



62
63
64
65
 
# File 'formulary.rb', line 62

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.

Returns:

  • (Boolean) 


40
41
42
 
# File 'formulary.rb', line 40

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.

Parameters:

Returns:



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
 
# File 'formulary.rb', line 1282

def self.find_formula_in_tap(name, tap)
  filename = if name.end_with?(".rb")
    name
  else
    "#{name}.rb"
  end

  # For API-known formulae the sharded path can be computed directly,
  # avoiding building a map of ~8500 `Pathname`s for a single lookup.
  # Only use already-loaded API data to avoid triggering downloads here.
  if tap.is_a?(CoreTap) && !Homebrew::EnvConfig.no_install_from_api? &&
     Homebrew::API::Internal.formula_hashes_cached? && Homebrew::API.formula_name?(name)
    return tap.formula_dir/tap.new_formula_subdirectory(name)/"#{name.downcase}.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.

Parameters:

Returns:

  • (Boolean) 


73
74
75
 
# File 'formulary.rb', line 73

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.

Parameters:

Returns:

  • (Boolean) 


68
69
70
 
# File 'formulary.rb', line 68

def self.formula_class_defined_from_path?(path)
  platform_cache.key?(:path) && platform_cache.fetch(:path).key?(path.to_s)
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.

Parameters:

Returns:



83
84
85
 
# File 'formulary.rb', line 83

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.

Parameters:

Returns:



78
79
80
 
# File 'formulary.rb', line 78

def self.formula_class_get_from_path(path)
  platform_cache.fetch(:path).fetch(path.to_s)
end

.from_bottle(path, spec = :stable, 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.

Load a local bottle explicitly selected for installation.

Parameters:

Returns:



1026
1027
1028
1029
 
# File 'formulary.rb', line 1026

def self.from_bottle(path, spec = :stable, force_bottle: false, flags: [])
  loader = FromBottleLoader.from_path(path) || NullLoader.new(path)
  loader.get_formula(spec, force_bottle:, flags:)
end

.from_contents(name, path, contents, spec = :stable, alias_path: nil, tap: nil, force_bottle: false, flags: [], ignore_errors: false, from_metadata: 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.

Parameters:

  • name (String)
  • path (Pathname)
  • contents (String)
  • spec (Symbol) (defaults to: :stable)
  • alias_path (Pathname, nil) (defaults to: nil)
  • tap (Tap, nil) (defaults to: nil)
  • force_bottle (Boolean) (defaults to: false)
  • flags (Array<String>) (defaults to: [])
  • ignore_errors (Boolean) (defaults to: false)
  • from_metadata (Boolean) (defaults to: false)

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'formulary.rb', line 1133

def self.from_contents(
  name,
  path,
  contents,
  spec = :stable,
  alias_path: nil,
  tap: nil,
  force_bottle: false,
  flags: [],
  ignore_errors: false,
  from_metadata: false
)
  FormulaContentsLoader.new(name, path, contents, tap:, from_metadata:)
                       .get_formula(spec, alias_path:, force_bottle:, flags:, ignore_errors:)
end

.from_keg(keg, spec = nil, alias_path: nil, force_bottle: false, flags: [], from_cache: 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 for the given keg.

Parameters:

  • keg (Keg)
  • spec (Symbol, nil) (defaults to: nil)
  • alias_path (Pathname, String, nil) (defaults to: nil)
  • force_bottle (Boolean) (defaults to: false)
  • flags (Array<String>) (defaults to: [])
  • from_cache (Boolean) (defaults to: false) —

    restrict formula lookup to name-based loaders for cache cleanup.

Returns:



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'formulary.rb', line 1081

def self.from_keg(
  keg,
  spec = nil,
  alias_path: nil,
  force_bottle: false,
  flags: [],
  from_cache: false
)
  tab = keg.tab
  tap = tab.tap
  spec ||= tab.spec

  formula_name = keg.rack.basename.to_s

  f = begin
    if tap.nil?
      factory(formula_name, spec, alias_path:, warn: false, force_bottle:, flags:)
    else
      begin
        factory("#{tap}/#{formula_name}", spec, alias_path:, warn: false, force_bottle:, flags:)
      rescue FormulaUnavailableError
        # formula may be migrated to different tap. Try to search in core and all taps.
        factory(formula_name, spec, alias_path:, warn: false, force_bottle:, flags:)
      end
    end
  rescue FormulaUnavailableError
    raise if from_cache

    from_path(keg/".brew/#{keg.name}.rb", spec, alias_path:, force_bottle:, flags:)
  end
  f.build = tab
  T.cast(f.build, Tab).used_options = Tab.remap_deprecated_options(f.deprecated_options, tab.used_options).as_flags
  f.version.update_commit(keg.version.version.commit) if f.head? && keg.version.head?
  f
end

.from_path(path, 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.

Load a parent-selected Ruby source file. Homebrew/brew callers only.

Parameters:

  • path (Pathname, String)
  • spec (Symbol) (defaults to: :stable)
  • alias_path (Pathname, String, nil) (defaults to: nil)
  • force_bottle (Boolean) (defaults to: false)
  • flags (Array<String>) (defaults to: [])
  • ignore_errors (Boolean) (defaults to: false)

Returns:



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'formulary.rb', line 999

def self.from_path(path, spec = :stable, alias_path: nil, force_bottle: false,
                   flags: [], ignore_errors: false)
  cache_key = "path:#{path}-#{spec}-#{alias_path}"
  return factory_cache.fetch(cache_key) if factory_cached? && factory_cache.key?(cache_key)

  loader = FromPathLoader.from_path(path) || NullLoader.new(path)
  formula = loader.get_formula(spec, alias_path:, force_bottle:, flags:, ignore_errors:)
  factory_cache[cache_key] ||= formula if factory_cached?
  formula
end

.from_rack(rack, spec = nil, alias_path: nil, force_bottle: false, flags: [], from_cache: false, keg: Keg.from_rack(rack)) ⇒ 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.

Parameters:

  • rack (Pathname)
  • spec (Symbol, nil) (defaults to: nil) —

    when nil, will auto resolve the formula's spec.

  • alias_path (Pathname, String, nil) (defaults to: nil) —

    will be used if the formula is found not to be installed and discarded if it is installed because the alias_path used to install the formula will be set instead.

  • force_bottle (Boolean) (defaults to: false)
  • flags (Array<String>) (defaults to: [])
  • from_cache (Boolean) (defaults to: false) —

    restrict formula lookup to name-based loaders for cache cleanup.

  • keg (Keg, nil) (defaults to: Keg.from_rack(rack))

Returns:



1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'formulary.rb', line 1050

def self.from_rack(rack, spec = nil, alias_path: nil, force_bottle: false, flags: [], from_cache: false,
                   keg: Keg.from_rack(rack))
  if keg
    from_keg(keg, spec, alias_path:, force_bottle:, flags:, from_cache:)
  else
    factory(rack.basename.to_s, spec || :stable, alias_path:,
            warn: false, force_bottle:, flags:)
  end
end

.from_tap_path(path) ⇒ 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.

Load a registered tap source file for auditing or CI.

Parameters:

Returns:

Raises:



1013
1014
1015
1016
1017
1018
 
# File 'formulary.rb', line 1013

def self.from_tap_path(path)
  tap_path = Utils::Path.tap_package_path(Pathname(path), :formula)
  raise FormulaUnavailableError, path.to_s unless tap_path

  from_path(tap_path)
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.

Parameters:

Returns:

  • (Boolean) 


1062
1063
1064
1065
1066
 
# File 'formulary.rb', line 1062

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:, from_metadata: false) ⇒ 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.

Parameters:

Returns:



119
120
121
122
123
124
125
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
184
185
186
187
188
189
 
# File 'formulary.rb', line 119

def self.load_formula(name, path, contents, namespace, flags:, ignore_errors:, from_metadata: false)
  raise "Formula loading disabled by `$HOMEBREW_DISABLE_LOAD_FORMULA`!" if Homebrew::EnvConfig.disable_load_formula?

  Homebrew::Trust.require_trusted_formula!(name, path)

  require "formula"
  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.const_set(:LOADED_FROM_METADATA, true) if from_metadata
    mod.module_eval(contents, path.to_s)
  rescue NameError, ArgumentError, ScriptError, MethodDeprecatedError, MacOSVersion::Error => e
    remove_const(namespace)
    raise FormulaUnreadableError.new(name, e)
  end
  ENV.clear_sensitive_environment_for_eval! do
    if ignore_errors
      require "ignorable"

      on_ignorable = lambda do |e|
        case e
        when NameError, ArgumentError, MethodDeprecatedError, MacOSVersion::Error then :ignore
        else :raise
        end
      end
      Ignorable.hook_raise(on_ignorable:, &eval_formula)
    else
      eval_formula.call
    end
  end

  class_name = class_s(name)

  # The formula's class name and module constants are only known at runtime.
  # rubocop:disable Sorbet/ConstantsFromStrings
  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
  # rubocop:enable Sorbet/ConstantsFromStrings
ensure
  if old_stdout && $stdout.respond_to?(:string) && (printed_to_stdout = $stdout.string.strip.presence)
    warning = <<~WARNING
      Formula #{name} attempted to print the following while being loaded:
      #{printed_to_stdout}
    WARNING
    if (tap = Tap.from_path(path)) && (issues_url = tap.issues_url)
      warning += Utils::Output.issue_reporting_message(issues_url, homebrew: tap.official?)
    end
    opoo warning
  end
  $stdout = old_stdout if old_stdout
end

.load_formula_from_path(name, path, flags:, ignore_errors:, from_metadata: false) ⇒ 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.

Parameters:

Returns:



210
211
212
213
214
215
216
 
# File 'formulary.rb', line 210

def self.load_formula_from_path(name, path, flags:, ignore_errors:, from_metadata: false)
  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:, from_metadata:)
  platform_cache[:path] ||= {}
  platform_cache.fetch(:path)[path.to_s] = klass
end

.load_formula_from_struct!(name, formula_struct, api_source:, tap_git_head:, flags:, internal_api: false) ⇒ 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.

Parameters:

Returns:



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
 
# File 'formulary.rb', line 228

def self.load_formula_from_struct!(name, formula_struct, api_source:, tap_git_head:, flags:, internal_api: false)
  namespace = :"FormulaNamespaceAPI#{namespace_key(api_source.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)
  ruby_source_path = "Formula/#{CoreTap.instance.new_formula_subdirectory(name)}/#{name.downcase}.rb"

  klass = Class.new(::Formula) do
    @loaded_from_api = T.let(true, T.nilable(T::Boolean))
    @loaded_from_internal_api = T.let(internal_api, T.nilable(T::Boolean))
    @api_source = T.let(api_source, T.nilable(T::Hash[String, T.untyped]))

    desc formula_struct.desc
    homepage formula_struct.homepage
    license formula_struct.license
    revision formula_struct.revision
    version_scheme formula_struct.version_scheme
    compatibility_version formula_struct.compatibility_version

    if formula_struct.stable?
      stable do
        url(*formula_struct.stable_url_args)
        version formula_struct.stable_version
        if (checksum = formula_struct.stable_checksum)
          sha256 checksum
        end

        formula_struct.stable_patches.each do |patch_hash|
          patch patch_hash.fetch("strip", patch_hash[:strip]).to_sym do
            T.bind(self, Resource::Patch)

            if (patch_url = patch_hash.fetch("url", patch_hash[:url]))
              url patch_url
              if (patch_sha256 = patch_hash.fetch("sha256", patch_hash[:sha256]))
                sha256 patch_sha256
              end
              apply patch_hash.fetch("apply", patch_hash[:apply]) if patch_hash.fetch("apply", patch_hash[:apply])
              if (patch_directory = patch_hash.fetch("directory", patch_hash[:directory]))
                directory patch_directory
              end
            elsif (patch_file = patch_hash.fetch("file", patch_hash[:file]))
              file patch_file
            end

            if (patch_resolves = patch_hash.fetch("resolves", patch_hash[:resolves]))
              resolves(*patch_resolves.map { |resolved| resolved.fetch("id", resolved[:id]) })
            end
          end
        end

        formula_struct.stable_dependencies.each do |dep|
          depends_on dep
        end

        formula_struct.stable_uses_from_macos.each do |args|
          uses_from_macos(*args)
        end
      end
    end

    if formula_struct.head?
      head do
        url(*formula_struct.head_url_args)

        formula_struct.head_dependencies.each do |dep|
          depends_on dep
        end

        formula_struct.head_uses_from_macos.each do |args|
          uses_from_macos(*args)
        end
      end
    end

    no_autobump!(**formula_struct.no_autobump_args) if formula_struct.no_autobump?

    if formula_struct.bottle?
      bottle do
        if Homebrew::EnvConfig.bottle_domain_custom?
          root_url Homebrew::EnvConfig.bottle_domain
        else
          root_url HOMEBREW_BOTTLE_DEFAULT_DOMAIN
        end
        rebuild formula_struct.bottle_rebuild
        formula_struct.bottle_checksums.each do |args|
          sha256(**args)
        end
      end
    end

    pour_bottle?(**formula_struct.pour_bottle_args) if formula_struct.pour_bottle?

    keg_only(*formula_struct.keg_only_args) if formula_struct.keg_only?

    deprecate!(**formula_struct.deprecate_args) if formula_struct.deprecate?
    disable!(**formula_struct.disable_args) if formula_struct.disable?

    formula_struct.conflicts.each do |name, args|
      conflicts_with(name, **args)
    end

    formula_struct.link_overwrite_paths.each do |path|
      link_overwrite path
    end

    @post_install_steps = T.let(
      formula_struct.post_install_steps,
      T.nilable(Homebrew::InstallSteps::Steps),
    )
    @post_install_steps_defined = T.let(formula_struct.post_install_steps.present?, T.nilable(T::Boolean))

    define_method(:install) do
      raise NotImplementedError, "Cannot build from source from abstract formula."
    end

    @post_install_defined_boolean = T.let(formula_struct.post_install_defined, T.nilable(T::Boolean))
    define_method(:post_install_defined?) do
      self.class.instance_variable_get(:@post_install_defined_boolean)
    end

    if formula_struct.service?
      service do
        run(*formula_struct.service_run_args, **formula_struct.service_run_kwargs) if formula_struct.service_run?
        name(**formula_struct.service_name_args) if formula_struct.service_name?

        formula_struct.service_args.each do |key, arg|
          public_send(key, arg)
        end
      end
    end

    @caveats_string = T.let(formula_struct.caveats, T.nilable(String))
    define_method(:caveats) do
      self.class.instance_variable_get(:@caveats_string)
    end

    @tap_git_head_string = T.let(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(formula_struct.oldnames, T.nilable(T::Array[String]))
    define_method(:oldnames) do
      self.class.instance_variable_get(:@oldnames_array)
    end

    @aliases_array = T.let(formula_struct.aliases, T.nilable(T::Array[String]))
    define_method(:aliases) do
      self.class.instance_variable_get(:@aliases_array)
    end

    @versioned_formulae_array = T.let(formula_struct.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(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(formula_struct.ruby_source_checksum, T.nilable(String))
    define_method(:ruby_source_checksum) do
      checksum = self.class.instance_variable_get(:@ruby_source_checksum_string)
      Checksum.new(checksum) if checksum
    end

    define_method(:local_patch_checksums) do
      formula_struct.local_patch_checksums
    end
  end

  mod.const_set(class_name, klass)

  platform_cache[:api] ||= {}
  platform_cache.fetch(:api)[name] = klass
end

.loader_for(ref, 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.

Parameters:

  • ref (String)
  • warn (Boolean) (defaults to: true)

Returns:



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'formulary.rb', line 1262

def self.loader_for(ref, warn: true)
  unless Utils::Path.valid_package_name?(ref)
    opoo "Loading formulae from paths or URLs is not supported; use a formula name." if warn
    return NullLoader.new(ref.to_s)
  end

  loader = FromAPILoader.try_new(ref, warn:) ||
           FromTapLoader.try_new(ref, warn:) ||
           FromNameLoader.try_new(ref, warn:) ||
           NullLoader.new(ref)
  $stderr.puts "#{$PROGRAM_NAME} (#{loader.class}): loading #{ref}" if verbose? && debug?
  loader
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.

Parameters:

Returns:



192
193
194
195
196
 
# File 'formulary.rb', line 192

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.

Parameters:

Returns:



1197
1198
1199
 
# File 'formulary.rb', line 1197

def self.path(ref)
  loader_for(ref).path
end

.platform_cache ⇒ 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:



57
58
59
 
# File 'formulary.rb', line 57

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.

Parameters:

Returns:



199
200
201
202
203
 
# File 'formulary.rb', line 199

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: []) ⇒ 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:

  • name (String)
  • spec (Symbol, nil) (defaults to: nil)
  • force_bottle (Boolean) (defaults to: false)
  • flags (Array<String>) (defaults to: [])

Returns:



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
 
# File 'formulary.rb', line 414

def self.resolve(
  name,
  spec: nil,
  force_bottle: false,
  flags: []
)
  if name.include?("/")
    f = resolve_installed_spec(factory(name, spec || :stable, force_bottle:, flags:), spec:)
  else
    rack = to_rack(name)
    alias_path = begin
      factory(name, force_bottle:, flags:).alias_path
    rescue FormulaUnavailableError
      nil
    end
    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

.resolve_from_path(path, spec: nil, 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.

Resolve the installed spec of a parent-selected source file.

Parameters:

Returns:



450
451
452
453
454
 
# File 'formulary.rb', line 450

def self.resolve_from_path(path, spec: nil, flags: [])
  formula = resolve_installed_spec(from_path(path, spec || :stable, flags:), spec:)
  formula.follow_installed_alias = false
  formula
end

.tap_formula_name_type(tapped_name, warn:) ⇒ Array<(String, Tap, [Symbol, nil], [String, 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.

Parameters:

  • tapped_name (String)
  • warn (Boolean)

Returns:



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
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'formulary.rb', line 1205

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
  alias_name = 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)
    alias_name = name
    # FIXME: Remove the need to split the name and instead make
    #        the alias table only contain short names.
    name = Utils.name_from_full_name(possible_alias)
    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)
    unless new_tap
      if new_tap_name.include?("/")
        new_tap = Tap.fetch(new_tap_name)
        new_name = name
      else
        new_tap = tap
        new_name = new_tap_name
      end
    end
    new_tapped_name = "#{new_tap}/#{new_name}"

    if tapped_name != new_tapped_name
      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

  if warn && old_name && new_name
    destination_exists = find_formula_in_tap(name, tap).exist? ||
                         (tap.core_tap? && !Homebrew::EnvConfig.no_install_from_api? &&
                          Homebrew::API.formula_name?(name))
    opoo "Formula #{old_name} was renamed to #{new_name}." if destination_exists
  end

  [name, tap, type, alias_name]
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.

Parameters:

Returns:



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'formulary.rb', line 1150

def self.to_rack(ref)
  # If using a fully-scoped reference, check the formula can be resolved to
  # reject a bogus reference like `fake/tap/hello`. An untrusted tap is no
  # barrier to uninstalling an installed formula: this error only fires once
  # the formula file exists and is raised before the file is evaluated.
  begin
    factory(ref) if ref.include? "/"
  rescue Homebrew::UntrustedTapError
    nil
  end

  # Check whether the rack with the given name exists.
  if (rack = HOMEBREW_CELLAR/File.basename(ref, ".rb")).directory?
    return Utils::Path.resolved_path(rack)
  end

  # Use canonical name to locate rack.
  rack = Utils::Path.resolved_path(HOMEBREW_CELLAR/canonical_name(ref))
  return rack if rack.directory?

  possible_rack = begin
    formula = factory(ref)
    possible_names = formula.possible_names.reject { |name| (HOMEBREW_CELLAR/name).symlink? }
    installed_kegs = formula.installed_kegs(possible_names)
    matching_racks = installed_kegs.group_by(&:rack).filter_map do |installed_rack, kegs|
      next if installed_rack.symlink? || kegs.any? { |keg| keg.tab.tap != formula.tap }

      installed_rack
    end
    matching_racks.first if matching_racks.one?
  rescue FormulaUnavailableError, TapFormulaAmbiguityError, Homebrew::UntrustedTapError,
         JSON::ParserError, SystemCallError
    nil
  end
  possible_rack || rack
end