Class: Formulary::FormulaLoader Private

Inherits:
Object
  • Object
show all
Includes:
Context
Defined in:
formulary.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

A FormulaLoader returns instances of formulae. Subclasses implement loaders for particular sources of formulae.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Context

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

Constructor Details

#initialize(name, path, tap: nil) ⇒ 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.

Returns a new instance of FormulaLoader.



473
474
475
476
477
 
# File 'formulary.rb', line 473

def initialize(name, path, tap: nil)
  @name = name
  @path = path
  @tap = tap
end

Instance Attribute Details

#alias_path ⇒ Object (readonly)

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.

The name used to install the formula



469
470
471
 
# File 'formulary.rb', line 469

def alias_path
  @alias_path
end

#name ⇒ Object (readonly)

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.

The formula’s name



465
466
467
 
# File 'formulary.rb', line 465

def name
  @name
end

#path ⇒ Object (readonly)

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.

The formula’s ruby file’s path or filename



467
468
469
 
# File 'formulary.rb', line 467

def path
  @path
end

#tap ⇒ Object (readonly)

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.

The formula’s tap (nil if it should be implicitly determined)



471
472
473
 
# File 'formulary.rb', line 471

def tap
  @tap
end

Instance Method Details

#get_formula(spec, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false) ⇒ 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.

Gets the formula instance. alias_path can be overridden here in case an alias was used to refer to a formula that was loaded in another way.



482
483
484
485
486
 
# File 'formulary.rb', line 482

def get_formula(spec, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false)
  alias_path ||= self.alias_path
  klass(flags: flags, ignore_errors: ignore_errors)
    .new(name, path, spec, alias_path: alias_path, tap: tap, force_bottle: force_bottle)
end

#klass(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. 



488
489
490
491
 
# File 'formulary.rb', line 488

def klass(flags:, ignore_errors:)
  load_file(flags: flags, ignore_errors: ignore_errors) unless Formulary.formula_class_defined_from_path?(path)
  Formulary.formula_class_get_from_path(path)
end