Module: Formulary Private

Extended by:
Cachable, Context
Includes:
Kernel
Defined in:
formulary.rb,
formulary.rbi

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.

Defined Under Namespace

Modules: PathnameWriteMkpath Classes: FormulaContentsLoader, FormulaLoader, FromAPILoader, FromBottleLoader, FromCacheLoader, FromKegLoader, FromNameLoader, FromPathLoader, FromTapLoader, FromURILoader, NullLoader

Constant Summary

Constants included from Kernel

Kernel::IGNORE_INTERRUPTS_MUTEX

Class Method Summary collapse

Methods included from Context

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

Methods included from Cachable

cache, clear_cache

Methods included from Kernel

#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path

Class Method Details

.canonical_name(ref) ⇒ Object

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. 



1166
1167
1168
1169
1170
1171
1172
 
# File 'formulary.rb', line 1166

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) ⇒ Object

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. 



524
525
526
527
528
529
530
 
# File 'formulary.rb', line 524

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 ⇒ Object

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. 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'formulary.rb', line 61

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) ⇒ Object

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. 



532
533
534
535
536
 
# File 'formulary.rb', line 532

def self.convert_to_string_or_symbol(string)
  return string[1..].to_sym if string.start_with?(":")

  string
end

.core_path(name) ⇒ Object

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. 



1243
1244
1245
 
# File 'formulary.rb', line 1243

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

def self.enable_factory_cache!
  @factory_cache = true
end

.ensure_utf8_encoding(io) ⇒ Object

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. 



520
521
522
 
# File 'formulary.rb', line 520

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

.factory(ref, spec = :stable, alias_path: nil, from: T.unsafe(nil), warn: T.unsafe(nil), force_bottle: T.unsafe(nil), flags: T.unsafe(nil), ignore_errors: T.unsafe(nil)) ⇒ 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

Parameters:

  • ref (Pathname, String)
  • spec (Symbol) (defaults to: :stable)
  • alias_path (nil, Pathname, String) (defaults to: nil)
  • from (Symbol) (defaults to: T.unsafe(nil))
  • warn (Boolean) (defaults to: T.unsafe(nil))
  • force_bottle (Boolean) (defaults to: T.unsafe(nil))
  • flags (Array<String>) (defaults to: T.unsafe(nil))
  • ignore_errors (Boolean) (defaults to: T.unsafe(nil))

Returns:



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'formulary.rb', line 996

def self.factory(
  ref,
  spec = :stable,
  alias_path: nil,
  from: T.unsafe(nil),
  warn: T.unsafe(nil),
  force_bottle: T.unsafe(nil),
  flags: T.unsafe(nil),
  ignore_errors: T.unsafe(nil)
)
  cache_key = "#{ref}-#{spec}-#{alias_path}-#{from}"
  if factory_cached? && platform_cache[:formulary_factory]&.key?(cache_key)
    return platform_cache[:formulary_factory][cache_key]
  end

  loader_options = { from:, warn: }.compact
  formula_options = { alias_path:,
                      force_bottle:,
                      flags:,
                      ignore_errors: }.compact

  formula = loader_for(ref, **loader_options)
            .get_formula(spec, **formula_options)

  if factory_cached?
    platform_cache[:formulary_factory] ||= {}
    platform_cache[:formulary_factory][cache_key] ||= formula
  end

  formula
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) 


37
38
39
 
# File 'formulary.rb', line 37

def self.factory_cached?
  !@factory_cache.nil?
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:



1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'formulary.rb', line 1248

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.

Returns:

  • (Boolean) 


49
50
51
 
# File 'formulary.rb', line 49

def self.formula_class_defined_from_api?(name)
  platform_cache.key?(:api) && platform_cache[: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.

Returns:

  • (Boolean) 


45
46
47
 
# File 'formulary.rb', line 45

def self.formula_class_defined_from_path?(path)
  platform_cache.key?(:path) && platform_cache[:path].key?(path)
end

.formula_class_get_from_api(name) ⇒ Object

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. 



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

def self.formula_class_get_from_api(name)
  platform_cache[:api].fetch(name)
end

.formula_class_get_from_path(path) ⇒ Object

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

def self.formula_class_get_from_path(path)
  platform_cache[:path].fetch(path)
end

.from_contents(name, path, contents, spec = :stable, alias_path: T.unsafe(nil), force_bottle: T.unsafe(nil), flags: T.unsafe(nil), ignore_errors: T.unsafe(nil)) ⇒ 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) (defaults to: T.unsafe(nil))
  • force_bottle (Boolean) (defaults to: T.unsafe(nil))
  • flags (Array<String>) (defaults to: T.unsafe(nil))
  • ignore_errors (Boolean) (defaults to: T.unsafe(nil))

Returns:



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

def self.from_contents(
  name,
  path,
  contents,
  spec = :stable,
  alias_path: T.unsafe(nil),
  force_bottle: T.unsafe(nil),
  flags: T.unsafe(nil),
  ignore_errors: T.unsafe(nil)
)
  options = {
    alias_path:,
    force_bottle:,
    flags:,
    ignore_errors:,
  }.compact
  FormulaContentsLoader.new(name, path, contents).get_formula(spec, **options)
end

.from_keg(keg, spec = T.unsafe(nil), alias_path: T.unsafe(nil), force_bottle: T.unsafe(nil), flags: T.unsafe(nil)) ⇒ 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) (defaults to: T.unsafe(nil))
  • alias_path (Pathname, String) (defaults to: T.unsafe(nil))
  • force_bottle (Boolean) (defaults to: T.unsafe(nil))
  • flags (Array<String>) (defaults to: T.unsafe(nil))

Returns:



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
1116
1117
1118
1119
 
# File 'formulary.rb', line 1084

def self.from_keg(
  keg,
  spec = T.unsafe(nil),
  alias_path: T.unsafe(nil),
  force_bottle: T.unsafe(nil),
  flags: T.unsafe(nil)
)
  tab = keg.tab
  tap = tab.tap
  spec ||= tab.spec

  formula_name = keg.rack.basename.to_s

  options = {
    alias_path:,
    from:         :keg,
    warn:         false,
    force_bottle:,
    flags:,
  }.compact

  f = if tap.nil?
    factory(formula_name, spec, **options)
  else
    begin
      factory("#{tap}/#{formula_name}", spec, **options)
    rescue FormulaUnavailableError
      # formula may be migrated to different tap. Try to search in core and all taps.
      factory(formula_name, spec, **options)
    end
  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_rack(rack, spec = T.unsafe(nil), alias_path: T.unsafe(nil), force_bottle: T.unsafe(nil), flags: T.unsafe(nil)) ⇒ 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) (defaults to: T.unsafe(nil)) —

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

  • alias_path (Pathname, String) (defaults to: T.unsafe(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: T.unsafe(nil))
  • flags (Array<String>) (defaults to: T.unsafe(nil))

Returns:



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'formulary.rb', line 1044

def self.from_rack(
  rack, spec = T.unsafe(nil),
  alias_path: T.unsafe(nil),
  force_bottle: T.unsafe(nil),
  flags: T.unsafe(nil)
)
  kegs = rack.directory? ? rack.subdirs.map { |d| Keg.new(d) } : []
  keg = kegs.find(&:linked?) || kegs.find(&:optlinked?) || kegs.max_by(&:scheme_and_version)

  options = {
    alias_path:,
    force_bottle:,
    flags:,
  }.compact

  if keg
    from_keg(keg, *spec, **options)
  else
    factory(rack.basename.to_s, *spec, from: :rack, warn: false, **options)
  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.

Returns:

  • (Boolean) 


1067
1068
1069
1070
1071
 
# File 'formulary.rb', line 1067

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:) ⇒ Object

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. 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'formulary.rb', line 95

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"

  mod = Module.new
  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)
  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) }
                    .select { |const| const.is_a?(Class) }
    new_exception = FormulaClassUnavailableError.new(name, path, class_name, class_list)
    remove_const(namespace)
    raise new_exception, "", e.backtrace
  end
end

.load_formula_from_api(name, 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.

Parameters:

Returns:

Raises:



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
 
# File 'formulary.rb', line 158

def self.load_formula_from_api(name, flags:)
  namespace = :"FormulaNamespaceAPI#{namespace_key(name)}"

  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::Formula.all_formulae[name]
  raise FormulaUnavailableError, name if json_formula.nil?

  json_formula = Homebrew::API.merge_variations(json_formula)

  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_tags = []
    req_tags << req_version if req_version.present?
    req_tags += 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 = req_tags.empty? ? req_name : { req_name => req_tags }

    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 = if Homebrew::API.internal_json_v3?
    lambda do |deps|
      T.bind(self, SoftwareSpec)

      deps&.each do |name, info|
        tags = case info&.dig("tags")
        in Array => tag_list
          tag_list.map(&:to_sym)
        in String => tag
          tag.to_sym
        else
          nil
        end

        if info&.key?("uses_from_macos")
          bounds = info["uses_from_macos"].dup || {}
          bounds.deep_transform_keys!(&:to_sym)
          bounds.deep_transform_values!(&:to_sym)

          if tags
            uses_from_macos name => tags, **bounds
          else
            uses_from_macos name, **bounds
          end
        elsif tags
          depends_on name => tags
        else
          depends_on name
        end
      end
    end
  else
    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
  end

  klass = Class.new(::Formula) do
    @loaded_from_api = true

    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 Homebrew::API.internal_json_v3? ? json_formula["version"] : json_formula["versions"]["stable"]
        sha256 urls_stable["checksum"] if urls_stable["checksum"].present?

        if Homebrew::API.internal_json_v3?
          instance_exec(json_formula["dependencies"], &add_deps)
        else
          instance_exec(:stable, &add_deps)
        end

        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

        if Homebrew::API.internal_json_v3?
          instance_exec(json_formula["head_dependencies"], &add_deps)
        else
          instance_exec(:head, &add_deps)
        end

        requirements[:head]&.each do |req|
          depends_on req
        end
      end
    end

    bottles_stable = if Homebrew::API.internal_json_v3?
      json_formula["bottle"]
    else
      json_formula["bottle"]["stable"]
    end.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
      deprecate! date: deprecation_date, because: reason
    end

    if (disable_date = json_formula["disable_date"].presence)
      reason = DeprecateDisable.to_reason_string_or_symbol json_formula["disable_reason"], type: :formula
      disable! date: disable_date, because: reason
    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

    def install
      raise "Cannot build from source from abstract formula."
    end

    @post_install_defined_boolean = json_formula["post_install_defined"]
    @post_install_defined_boolean = true if @post_install_defined_boolean.nil? # Backwards compatibility
    def post_install_defined?
      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 = json_formula["caveats"]
    def caveats
      caveats_string = self.class.instance_variable_get(:@caveats_string)
      return unless caveats_string

      caveats_string.gsub(HOMEBREW_PREFIX_PLACEHOLDER, HOMEBREW_PREFIX)
                    .gsub(HOMEBREW_CELLAR_PLACEHOLDER, HOMEBREW_CELLAR)
                    .gsub(HOMEBREW_HOME_PLACEHOLDER, Dir.home)
    end

    @tap_git_head_string = if Homebrew::API.internal_json_v3?
      Homebrew::API::Formula.tap_git_head
    else
      json_formula["tap_git_head"]
    end

    def tap_git_head
      self.class.instance_variable_get(:@tap_git_head_string)
    end

    unless Homebrew::API.internal_json_v3?
      @oldnames_array = json_formula["oldnames"] || [json_formula["oldname"]].compact
      def oldnames
        self.class.instance_variable_get(:@oldnames_array)
      end

      @aliases_array = json_formula.fetch("aliases", [])
      def aliases
        self.class.instance_variable_get(:@aliases_array)
      end
    end

    @versioned_formulae_array = json_formula.fetch("versioned_formulae", [])
    def versioned_formulae_names
      self.class.instance_variable_get(:@versioned_formulae_array)
    end

    @ruby_source_path_string = json_formula["ruby_source_path"]
    def ruby_source_path
      self.class.instance_variable_get(:@ruby_source_path_string)
    end

    @ruby_source_checksum_string = json_formula.dig("ruby_source_checksum", "sha256")
    @ruby_source_checksum_string ||= json_formula["ruby_source_sha256"]
    def ruby_source_checksum
      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[: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.

Parameters:

Returns:



149
150
151
152
153
154
155
 
# File 'formulary.rb', line 149

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[:path][path] = klass
end

.loader_for(ref, from: T.unsafe(nil), warn: true) ⇒ Object

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. 



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'formulary.rb', line 1222

def self.loader_for(ref, from: T.unsafe(nil), warn: true)
  options = { from:, warn: }.compact

  [
    FromBottleLoader,
    FromURILoader,
    FromAPILoader,
    FromTapLoader,
    FromPathLoader,
    FromNameLoader,
    FromKegLoader,
    FromCacheLoader,
    NullLoader,
  ].each do |loader_class|
    if (loader = loader_class.try_new(ref, **options))
      $stderr.puts "#{$PROGRAM_NAME} (#{loader_class}): loading #{ref}" if debug?
      return loader
    end
  end
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:



139
140
141
142
143
 
# File 'formulary.rb', line 139

def self.namespace_key(identifier)
  Digest::SHA2.hexdigest(
    "#{Homebrew::SimulateSystem.current_os}_#{Homebrew::SimulateSystem.current_arch}:#{identifier}",
  )
end

.path(ref) ⇒ Object

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. 



1174
1175
1176
 
# File 'formulary.rb', line 1174

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

.platform_cache ⇒ Object

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. 



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

def self.platform_cache
  cache["#{Homebrew::SimulateSystem.current_os}_#{Homebrew::SimulateSystem.current_arch}"] ||= {}
end

.resolve(name, spec: T.unsafe(nil), force_bottle: T.unsafe(nil), flags: T.unsafe(nil)) ⇒ 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) (defaults to: T.unsafe(nil))
  • force_bottle (Boolean) (defaults to: T.unsafe(nil))
  • flags (Array<String>) (defaults to: T.unsafe(nil))

Returns:



476
477
478
479
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
 
# File 'formulary.rb', line 476

def self.resolve(
  name,
  spec: T.unsafe(nil),
  force_bottle: T.unsafe(nil),
  flags: T.unsafe(nil)
)
  options = {
    force_bottle:,
    flags:,
  }.compact

  if name.include?("/") || File.exist?(name)
    f = factory(name, *spec, **options)
    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)
    if (alias_path = factory(name, **options).alias_path)
      options[:alias_path] = alias_path
    end
    f = from_rack(rack, *spec, **options)
  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.

Parameters:

  • tapped_name (String)
  • warn (Boolean)

Returns:



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'formulary.rb', line 1179

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 = T.must(possible_alias.split("/").last)
    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) ⇒ Object

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. 



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
 
# File 'formulary.rb', line 1153

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