Module: Formulary Private

Extended by:
Cachable, 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?, quiet?, verbose?, with_context

Methods included from Cachable

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_outside_github_actions, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_outdated, pretty_uninstalled, pretty_upgradable

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:



1132
1133
1134
1135
1136
1137
1138
 
# File 'formulary.rb', line 1132

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:



415
416
417
418
419
420
421
 
# File 'formulary.rb', line 415

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.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'formulary.rb', line 95

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:



1217
1218
1219
 
# File 'formulary.rb', line 1217

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.



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

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) 


410
411
412
 
# File 'formulary.rb', line 410

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) ⇒ 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 (Pathname, String, nil) (defaults to: nil)
  • from (Symbol, 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:



980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
 
# File 'formulary.rb', line 980

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

  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.

Returns:



69
70
71
72
 
# File 'formulary.rb', line 69

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) 


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

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:



1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'formulary.rb', line 1222

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.

Parameters:

Returns:

  • (Boolean) 


80
81
82
 
# File 'formulary.rb', line 80

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) 


75
76
77
 
# File 'formulary.rb', line 75

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:



90
91
92
 
# File 'formulary.rb', line 90

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:



85
86
87
 
# File 'formulary.rb', line 85

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

.from_contents(name, path, contents, spec = :stable, alias_path: nil, tap: 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.

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)

Returns:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'formulary.rb', line 1102

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

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

Returns:



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'formulary.rb', line 1051

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

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

Returns:



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'formulary.rb', line 1018

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

Parameters:

Returns:

  • (Boolean) 


1034
1035
1036
1037
1038
 
# File 'formulary.rb', line 1034

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.

Parameters:

Returns:



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

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_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:



202
203
204
205
206
207
208
 
# File 'formulary.rb', line 202

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_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:



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

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

    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_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 == HOMEBREW_BOTTLE_DEFAULT_DOMAIN
          root_url HOMEBREW_BOTTLE_DEFAULT_DOMAIN
        else
          root_url Homebrew::EnvConfig.bottle_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

    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
  end

  mod.const_set(class_name, klass)

  platform_cache[:api] ||= {}
  platform_cache.fetch(:api)[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.

Parameters:

Returns:



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'formulary.rb', line 1196

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.

Parameters:

Returns:



185
186
187
188
189
 
# File 'formulary.rb', line 185

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:



1141
1142
1143
 
# File 'formulary.rb', line 1141

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:



64
65
66
 
# File 'formulary.rb', line 64

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:



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

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:



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

def self.resolve(
  name,
  spec: nil,
  force_bottle: false,
  flags: []
)
  if name.include?("/") || File.exist?(name)
    f = factory(name, *spec, force_bottle:, flags:)
    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(T.must(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:).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.

Parameters:

  • tapped_name (String)
  • warn (Boolean)

Returns:



1146
1147
1148
1149
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
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'formulary.rb', line 1146

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

  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.

Parameters:

Returns:



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'formulary.rb', line 1118

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