Class: Formulary::FormulaLoader Private
- 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.
Direct Known Subclasses
FormulaContentsLoader, FromAPILoader, FromBottleLoader, FromCacheLoader, FromKegLoader, FromPathLoader, FromTapLoader, FromURILoader, NullLoader
Instance Attribute Summary collapse
-
#alias_path ⇒ Pathname?
readonly
private
The name used to install the formula.
-
#name ⇒ String
readonly
private
The formula's name.
-
#path ⇒ Pathname
readonly
private
The formula file's path.
-
#tap ⇒ Tap?
readonly
private
The formula's tap (
nil
if it should be implicitly determined).
Instance Method Summary collapse
-
#get_formula(spec, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false) ⇒ Object
private
Gets the formula instance.
- #initialize(name, path, alias_path: nil, tap: nil) ⇒ void constructor private
- #klass(flags:, ignore_errors:) ⇒ Object private
Methods included from Context
current, current=, #debug?, #quiet?, #verbose?, #with_context
Constructor Details
#initialize(name, path, alias_path: nil, tap: nil) ⇒ 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.
521 522 523 524 525 526 |
# File 'formulary.rb', line 521 def initialize(name, path, alias_path: nil, tap: nil) @name = name @path = path @alias_path = alias_path @tap = tap end |
Instance Attribute Details
#alias_path ⇒ Pathname? (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.
514 515 516 |
# File 'formulary.rb', line 514 def alias_path @alias_path end |
#name ⇒ String (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.
506 507 508 |
# File 'formulary.rb', line 506 def name @name end |
#path ⇒ Pathname (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 file's path.
510 511 512 |
# File 'formulary.rb', line 510 def path @path end |
#tap ⇒ Tap? (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).
518 519 520 |
# File 'formulary.rb', line 518 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.
531 532 533 534 535 |
# File 'formulary.rb', line 531 def get_formula(spec, alias_path: nil, force_bottle: false, flags: [], ignore_errors: false) alias_path ||= self.alias_path klass(flags:, ignore_errors:) .new(name, path, spec, alias_path:, tap:, 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.
537 538 539 540 |
# File 'formulary.rb', line 537 def klass(flags:, ignore_errors:) load_file(flags:, ignore_errors:) unless Formulary.formula_class_defined_from_path?(path) Formulary.formula_class_get_from_path(path) end |