Class: Dependency
Overview
This class is part of an internal API. This class may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this class if possible, as it may be removed or changed without warning.
A dependency on another Homebrew formula.
Direct Known Subclasses
Constant Summary
Constants included from Dependable
Instance Attribute Summary collapse
- #name ⇒ String readonly private
- #tap ⇒ Tap? readonly private
Attributes included from Dependable
Class Method Summary collapse
- .action(dependent, dep, &block) ⇒ Object internal
-
.expand(dependent, deps = dependent.deps, cache_key: nil, &block) ⇒ Object
internal
Expand the dependencies of each dependent recursively, optionally yielding
[dependent, dep]
pairs to allow callers to apply arbitrary filters to the list. -
.keep_but_prune_recursive_deps ⇒ void
internal
Keep a dependency, but prune its dependencies.
- .merge_repeats(all) ⇒ Object internal
-
.prune ⇒ void
private
Prune a dependency and its dependencies recursively.
-
.skip ⇒ void
private
Prune a single dependency but do not prune its dependencies.
Instance Method Summary collapse
- #dup_with_formula_name(formula) ⇒ T.self_type private
-
#initialize(name, tags = []) ⇒ Dependency
constructor
internal
A new instance of Dependency.
- #installed?(minimum_version: nil, minimum_revision: nil) ⇒ Boolean private
- #missing_options(inherited_options) ⇒ Object internal
- #option_names ⇒ Object internal
- #satisfied?(inherited_options = [], minimum_version: nil, minimum_revision: nil) ⇒ Boolean internal
- #to_formula ⇒ Object internal
- #uses_from_macos? ⇒ Boolean private
Methods included from Cachable
Methods included from Dependable
#build?, #implicit?, #option_tags, #optional?, #options, #prune_from_option?, #prune_if_build_and_not_dependent?, #recommended?, #required?, #test?
Constructor Details
#initialize(name, tags = []) ⇒ Dependency
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.
Returns a new instance of Dependency.
20 21 22 23 24 25 26 27 28 29 |
# File 'dependency.rb', line 20 def initialize(name, = []) raise ArgumentError, "Dependency must have a name!" unless name @name = name @tags = return unless (tap_with_name = Tap.with_formula_name(name)) @tap, = tap_with_name end |
Instance Attribute Details
#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.
15 16 17 |
# File 'dependency.rb', line 15 def name @name 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.
18 19 20 |
# File 'dependency.rb', line 18 def tap @tap end |
Class Method Details
.action(dependent, dep, &block) ⇒ Object
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.
163 164 165 166 167 168 169 170 171 |
# File 'dependency.rb', line 163 def action(dependent, dep, &block) catch(:action) do if block yield dependent, dep elsif dep.optional? || dep.recommended? prune unless dependent.build.with?(dep) end end end |
.expand(dependent, deps = dependent.deps, cache_key: nil, &block) ⇒ Object
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.
Expand the dependencies of each dependent recursively, optionally yielding
[dependent, dep]
pairs to allow callers to apply arbitrary filters to
the list.
The default filter, which is applied when a block is not given, omits
optionals and recommends based on what the dependent has asked for
120 121 122 123 124 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 |
# File 'dependency.rb', line 120 def (dependent, deps = dependent.deps, cache_key: nil, &block) # Keep track dependencies to avoid infinite cyclic dependency recursion. @expand_stack ||= [] @expand_stack.push dependent.name if cache_key.present? cache[cache_key] ||= {} return cache[cache_key][cache_id dependent].dup if cache[cache_key][cache_id dependent] end = [] deps.each do |dep| next if dependent.name == dep.name case action(dependent, dep, &block) when :prune next when :skip next if @expand_stack.include? dep.name .concat((dep.to_formula, cache_key:, &block)) when :keep_but_prune_recursive_deps << dep else next if @expand_stack.include? dep.name dep_formula = dep.to_formula .concat((dep_formula, cache_key:, &block)) # Fixes names for renamed/aliased formulae. dep = dep.dup_with_formula_name(dep_formula) << dep end end = merge_repeats() cache[cache_key][cache_id dependent] = .dup if cache_key.present? ensure @expand_stack.pop end |
.keep_but_prune_recursive_deps ⇒ 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.
Keep a dependency, but prune its dependencies.
189 190 191 |
# File 'dependency.rb', line 189 def keep_but_prune_recursive_deps throw(:action, :keep_but_prune_recursive_deps) end |
.merge_repeats(all) ⇒ Object
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.
193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'dependency.rb', line 193 def merge_repeats(all) grouped = all.group_by(&:name) all.map(&:name).uniq.map do |name| deps = grouped.fetch(name) dep = deps.first = (deps) kwargs = {} kwargs[:bounds] = dep.bounds if dep.uses_from_macos? dep.class.new(name, , **kwargs) end end |
.prune ⇒ 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.
Prune a dependency and its dependencies recursively.
175 176 177 |
# File 'dependency.rb', line 175 def prune throw(:action, :prune) end |
.skip ⇒ 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.
Prune a single dependency but do not prune its dependencies.
181 182 183 |
# File 'dependency.rb', line 181 def skip throw(:action, :skip) end |
Instance Method Details
#dup_with_formula_name(formula) ⇒ T.self_type
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.
108 109 110 |
# File 'dependency.rb', line 108 def dup_with_formula_name(formula) self.class.new(formula.full_name.to_s, ) end |
#installed?(minimum_version: nil, minimum_revision: nil) ⇒ 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.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'dependency.rb', line 47 def installed?(minimum_version: nil, minimum_revision: nil) formula = begin to_formula rescue FormulaUnavailableError nil end return false unless formula return true if formula.latest_version_installed? return false if minimum_version.blank? installed_version = formula.any_installed_version return false unless installed_version # Tabs prior to 4.1.18 did not have revision or pkg_version fields. # As a result, we have to be more conversative when we do not have # a minimum revision from the tab and assume that if the formula has a # the same version and a non-zero revision that it needs upgraded. if minimum_revision.present? minimum_pkg_version = PkgVersion.new(minimum_version, minimum_revision) installed_version >= minimum_pkg_version elsif installed_version.version == minimum_version formula.revision.zero? else installed_version.version > minimum_version end end |
#missing_options(inherited_options) ⇒ Object
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.
81 82 83 84 85 86 87 88 |
# File 'dependency.rb', line 81 def () formula = to_formula required = required |= required &= formula..to_a required -= Tab.for_formula(formula). required end |
#option_names ⇒ Object
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.
90 91 92 |
# File 'dependency.rb', line 90 def option_names [name.split("/").last].freeze end |
#satisfied?(inherited_options = [], minimum_version: nil, minimum_revision: nil) ⇒ Boolean
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.
76 77 78 79 |
# File 'dependency.rb', line 76 def satisfied?( = [], minimum_version: nil, minimum_revision: nil) installed?(minimum_version:, minimum_revision:) && ().empty? end |
#to_formula ⇒ Object
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.
40 41 42 43 44 |
# File 'dependency.rb', line 40 def to_formula formula = Formulary.factory(name, warn: false) formula.build = BuildOptions.new(, formula.) formula end |
#uses_from_macos? ⇒ 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.
95 96 97 |
# File 'dependency.rb', line 95 def uses_from_macos? false end |