Module: Formulary

Extended by:
Cachable
Defined in:
Library/Homebrew/formulary.rb

Overview

The Formulary is responsible for creating instances of Formula. It is not meant to be used directly from formulae.

Defined Under Namespace

Classes: AliasLoader, BottleLoader, FormulaContentsLoader, FormulaLoader, FromPathLoader, FromUrlLoader, NullLoader, TapLoader

Constant Summary collapse

URL_START_REGEX =
%r{(https?|ftp|file)://}.freeze

Class Method Summary collapse

Methods included from Cachable

cache, clear_cache

Class Method Details

.canonical_name(ref) ⇒ Object


406
407
408
409
410
411
412
# File 'Library/Homebrew/formulary.rb', line 406

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


96
97
98
99
100
101
102
# File 'Library/Homebrew/formulary.rb', line 96

def self.class_s(name)
  class_name = name.capitalize
  class_name.gsub!(/[-_.\s]([a-zA-Z0-9])/) { Regexp.last_match(1).upcase }
  class_name.tr!("+", "x")
  class_name.sub!(/(.)@(\d)/, "\\1AT\\2")
  class_name
end

.core_path(name) ⇒ Object


472
473
474
# File 'Library/Homebrew/formulary.rb', line 472

def self.core_path(name)
  CoreTap.instance.formula_dir/"#{name.to_s.downcase}.rb"
end

.enable_factory_cache!Object


14
15
16
# File 'Library/Homebrew/formulary.rb', line 14

def self.enable_factory_cache!
  @factory_cache = true
end

.ensure_utf8_encoding(io) ⇒ Object


92
93
94
# File 'Library/Homebrew/formulary.rb', line 92

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

.factory(ref, spec = :stable, alias_path: nil, from: nil) ⇒ Object

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

Raises:

  • (ArgumentError)

324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'Library/Homebrew/formulary.rb', line 324

def self.factory(ref, spec = :stable, alias_path: nil, from: nil)
  raise ArgumentError, "Formulae must have a ref!" unless ref

  cache_key = "#{ref}-#{spec}-#{alias_path}-#{from}"
  if factory_cached? && cache[:formulary_factory] &&
     cache[:formulary_factory][cache_key]
    return cache[:formulary_factory][cache_key]
  end

  formula = loader_for(ref, from: from).get_formula(spec, alias_path: alias_path)
  if factory_cached?
    cache[:formulary_factory] ||= {}
    cache[:formulary_factory][cache_key] ||= formula
  end
  formula
end

.factory_cached?Boolean

Returns:

  • (Boolean)

18
19
20
# File 'Library/Homebrew/formulary.rb', line 18

def self.factory_cached?
  !@factory_cache.nil?
end

.formula_class_defined?(path) ⇒ Boolean

Returns:

  • (Boolean)

22
23
24
# File 'Library/Homebrew/formulary.rb', line 22

def self.formula_class_defined?(path)
  cache.key?(path)
end

.formula_class_get(path) ⇒ Object


26
27
28
# File 'Library/Homebrew/formulary.rb', line 26

def self.formula_class_get(path)
  cache.fetch(path)
end

.from_contents(name, path, contents, spec = :stable) ⇒ Object

Return a Formula instance directly from contents


389
390
391
# File 'Library/Homebrew/formulary.rb', line 389

def self.from_contents(name, path, contents, spec = :stable)
  FormulaContentsLoader.new(name, path, contents).get_formula(spec)
end

.from_keg(keg, spec = nil, alias_path: nil) ⇒ Object

Return a Formula instance for the given keg. It will auto resolve formula's spec when requested spec is nil


367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'Library/Homebrew/formulary.rb', line 367

def self.from_keg(keg, spec = nil, alias_path: nil)
  tab = Tab.for_keg(keg)
  tap = tab.tap
  spec ||= tab.spec

  f = if tap.nil?
    factory(keg.rack.basename.to_s, spec, alias_path: alias_path, from: :keg)
  else
    begin
      factory("#{tap}/#{keg.rack.basename}", spec, alias_path: alias_path, from: :keg)
    rescue FormulaUnavailableError
      # formula may be migrated to different tap. Try to search in core and all taps.
      factory(keg.rack.basename.to_s, spec, alias_path: alias_path, from: :keg)
    end
  end
  f.build = tab
  f.build.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) ⇒ Object

Return a Formula instance for the given rack. It will auto resolve formula's spec when requested spec is nil

The :alias_path option 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.


347
348
349
350
351
352
353
354
355
356
# File 'Library/Homebrew/formulary.rb', line 347

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

  if keg
    from_keg(keg, spec, alias_path: alias_path)
  else
    factory(rack.basename.to_s, spec || :stable, alias_path: alias_path, from: :rack)
  end
end

.keg_only?(rack) ⇒ Boolean

Return whether given rack is keg-only

Returns:

  • (Boolean)

359
360
361
362
363
# File 'Library/Homebrew/formulary.rb', line 359

def self.keg_only?(rack)
  Formulary.from_rack(rack).keg_only?
rescue FormulaUnavailableError, TapFormulaAmbiguityError, TapFormulaWithOldnameAmbiguityError
  false
end

.load_formula(name, path, contents, namespace) ⇒ Object


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'Library/Homebrew/formulary.rb', line 30

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

  mod = Module.new
  const_set(namespace, mod)
  begin
    mod.module_eval(contents, path)
  rescue NameError, ArgumentError, ScriptError => e
    raise FormulaUnreadableError.new(name, e)
  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)
    raise new_exception, "", e.backtrace
  end
end

.load_formula_from_path(name, path) ⇒ Object


53
54
55
56
57
58
# File 'Library/Homebrew/formulary.rb', line 53

def self.load_formula_from_path(name, path)
  contents = path.open("r") { |f| ensure_utf8_encoding(f).read }
  namespace = "FormulaNamespace#{Digest::MD5.hexdigest(path.to_s)}"
  klass = load_formula(name, path, contents, namespace)
  cache[path] = klass
end

.loader_for(ref, from: nil) ⇒ Object


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
# File 'Library/Homebrew/formulary.rb', line 418

def self.loader_for(ref, from: nil)
  case ref
  when Pathname::BOTTLE_EXTNAME_RX
    return BottleLoader.new(ref)
  when URL_START_REGEX
    return FromUrlLoader.new(ref)
  when HOMEBREW_TAP_FORMULA_REGEX
    return TapLoader.new(ref, from: from)
  end

  return FromPathLoader.new(ref) if File.extname(ref) == ".rb" && Pathname.new(ref).expand_path.exist?

  formula_with_that_name = core_path(ref)
  return FormulaLoader.new(ref, formula_with_that_name) if formula_with_that_name.file?

  possible_alias = CoreTap.instance.alias_dir/ref
  return AliasLoader.new(possible_alias) if possible_alias.file?

  possible_tap_formulae = tap_paths(ref)
  raise TapFormulaAmbiguityError.new(ref, possible_tap_formulae) if possible_tap_formulae.size > 1

  if possible_tap_formulae.size == 1
    path = possible_tap_formulae.first.resolved_path
    name = path.basename(".rb").to_s
    return FormulaLoader.new(name, path)
  end

  if newref = CoreTap.instance.formula_renames[ref]
    formula_with_that_oldname = core_path(newref)
    return FormulaLoader.new(newref, formula_with_that_oldname) if formula_with_that_oldname.file?
  end

  possible_tap_newname_formulae = []
  Tap.each do |tap|
    if newref = tap.formula_renames[ref]
      possible_tap_newname_formulae << "#{tap.name}/#{newref}"
    end
  end

  if possible_tap_newname_formulae.size > 1
    raise TapFormulaWithOldnameAmbiguityError.new(ref, possible_tap_newname_formulae)
  end

  return TapLoader.new(possible_tap_newname_formulae.first, from: from) unless possible_tap_newname_formulae.empty?

  possible_keg_formula = Pathname.new("#{HOMEBREW_PREFIX}/opt/#{ref}/.brew/#{ref}.rb")
  return FormulaLoader.new(ref, possible_keg_formula) if possible_keg_formula.file?

  possible_cached_formula = Pathname.new("#{HOMEBREW_CACHE_FORMULA}/#{ref}.rb")
  return FormulaLoader.new(ref, possible_cached_formula) if possible_cached_formula.file?

  NullLoader.new(ref)
end

.path(ref) ⇒ Object


414
415
416
# File 'Library/Homebrew/formulary.rb', line 414

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

.resolve(name, spec: nil) ⇒ Object


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'Library/Homebrew/formulary.rb', line 60

def self.resolve(name, spec: nil)
  if name.include?("/") || File.exist?(name)
    f = factory(name, *spec)
    if f.any_version_installed?
      tab = Tab.for_formula(f)
      resolved_spec = spec || tab.spec
      f.active_spec = resolved_spec if f.send(resolved_spec)
      f.build = tab
      if f.head? && tab.tabfile
        k = Keg.new(tab.tabfile.parent)
        f.version.update_commit(k.version.version.commit) if k.version.head?
      end
    end
  else
    rack = to_rack(name)
    alias_path = factory(name).alias_path
    f = from_rack(rack, *spec, alias_path: alias_path)
  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_paths(name, taps = Dir[HOMEBREW_LIBRARY/"Taps/*/*/"]) ⇒ Object


476
477
478
479
480
481
482
483
484
485
486
# File 'Library/Homebrew/formulary.rb', line 476

def self.tap_paths(name, taps = Dir[HOMEBREW_LIBRARY/"Taps/*/*/"])
  name = name.to_s.downcase
  taps.map do |tap|
    Pathname.glob([
                    "#{tap}Formula/#{name}.rb",
                    "#{tap}HomebrewFormula/#{name}.rb",
                    "#{tap}#{name}.rb",
                    "#{tap}Aliases/#{name}",
                  ]).find(&:file?)
  end.compact
end

.to_rack(ref) ⇒ Object


393
394
395
396
397
398
399
400
401
402
403
404
# File 'Library/Homebrew/formulary.rb', line 393

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