Class: Homebrew::Bundle::Brew Private
- Inherits:
-
PackageType
- Object
- PackageType
- Homebrew::Bundle::Brew
- Extended by:
- Utils::Output::Mixin
- Defined in:
- bundle/brew.rb,
bundle/brew_services.rb
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.
Direct Known Subclasses
Defined Under Namespace
Constant Summary collapse
- PACKAGE_TYPE =
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.
:brew- PACKAGE_TYPE_NAME =
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.
"Formula"
Class Method Summary collapse
- .dump(describe: false, no_restart: false) ⇒ String private
- .dump_output(describe: false, no_restart: false) ⇒ String private
- .fetchable_name(name, options = {}, no_upgrade: false) ⇒ String? private
- .formula_aliases ⇒ Hash{String => String} private
- .formula_in_array?(formula, array) ⇒ Boolean private
- .formula_installed?(formula) ⇒ Boolean private
- .formula_installed_and_up_to_date?(formula, no_upgrade: false) ⇒ Boolean private
- .formula_oldnames ⇒ Hash{String => String} private
- .formula_upgradable?(formula) ⇒ Boolean private
- .formulae ⇒ Array<Hash{Symbol => T.untyped}> private
-
.formulae_by_full_name(name = nil) ⇒ Hash{Symbol => T.untyped}, ...
private
Returns the full
@formulae_by_full_namemap when called without a name, or a single formula's attribute hash when called with a name. - .formulae_by_name(name) ⇒ Hash{Symbol => T.untyped}? private
- .inherited(subclass) ⇒ void private
- .install!(name, preinstall: true, no_upgrade: false, verbose: false, force: false, **options) ⇒ Boolean private
- .install_verb(name, options = {}) ⇒ Object private
- .installed_formulae ⇒ Array<String> private
- .no_upgrade_with_args?(no_upgrade, formula_name) ⇒ Boolean private
- .outdated_formulae ⇒ Array<String> private
- .pinned_formulae ⇒ Array<String> private
- .preinstall!(name, no_upgrade: false, verbose: false, **options) ⇒ Boolean private
- .reset! ⇒ void private
- .upgradable_formulae ⇒ Array<String> private
Instance Method Summary collapse
- #changed? ⇒ Boolean private
- #initialize(name = "", options = {}) ⇒ void constructor private
- #install!(preinstall: true, no_upgrade: false, verbose: false, force: false) ⇒ Boolean private
- #install_change_state!(no_upgrade:, verbose:, force:) ⇒ Boolean private
- #installed_and_up_to_date?(formula, no_upgrade: false) ⇒ Boolean private
- #link_change_state!(verbose: false) ⇒ Boolean private
- #postinstall_change_state!(verbose:) ⇒ Boolean private
- #preinstall!(no_upgrade: false, verbose: false) ⇒ Boolean private
- #restart_service? ⇒ Boolean private
- #restart_service_needed? ⇒ Boolean private
- #service_change_state!(verbose:) ⇒ Boolean private
- #start_service? ⇒ Boolean private
- #start_service_needed? ⇒ Boolean private
Methods included from Utils::Output::Mixin
odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, pretty_deprecated, pretty_disabled, pretty_duration, pretty_installed, pretty_outdated, pretty_uninstalled
Methods inherited from PackageType
check, #checkable_entries, dump_supported?, #exit_early_check, #failure_reason, #find_actionable, #format_checkable, #full_check, install_supported?, type
Constructor Details
#initialize(name = "", options = {}) ⇒ 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.
380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'bundle/brew.rb', line 380 def initialize(name = "", = {}) super() @full_name = name @name = T.let(name.split("/").last || name, String) @args = T.let(.fetch(:args, []).map { |arg| "--#{arg}" }, T::Array[String]) @conflicts_with_arg = T.let(.fetch(:conflicts_with, []), T::Array[String]) @restart_service = T.let([:restart_service], T.nilable(T.any(Symbol, T::Boolean))) @start_service = T.let(.fetch(:start_service, @restart_service), T.nilable(T.any(Symbol, T::Boolean))) @link = T.let(.fetch(:link, nil), T.nilable(T.any(Symbol, T::Boolean))) @postinstall = T.let(.fetch(:postinstall, nil), T.nilable(String)) @version_file = T.let(.fetch(:version_file, nil), T.nilable(String)) @changed = T.let(nil, T.nilable(T::Boolean)) end |
Class Method Details
.dump(describe: false, no_restart: false) ⇒ 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.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'bundle/brew.rb', line 173 def dump(describe: false, no_restart: false) require "bundle/brew_services" requested_formula = formulae.select do |f| f[:installed_on_request?] || !f[:installed_as_dependency?] end requested_formula.map do |f| brewline = if describe && f[:desc].present? f[:desc].split("\n").map { |s| "# #{s}\n" }.join else "" end brewline += "brew \"#{f[:full_name]}\"" args = f[:args].map { |arg| "\"#{arg}\"" }.sort.join(", ") brewline += ", args: [#{args}]" unless f[:args].empty? brewline += ", restart_service: :changed" if !no_restart && Services.started?(f[:full_name]) brewline += ", link: #{f[:link?]}" unless f[:link?].nil? brewline end.join("\n") end |
.dump_output(describe: false, no_restart: false) ⇒ 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.
196 197 198 |
# File 'bundle/brew.rb', line 196 def dump_output(describe: false, no_restart: false) dump(describe:, no_restart:) end |
.fetchable_name(name, options = {}, no_upgrade: false) ⇒ 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.
201 202 203 204 205 206 207 208 209 210 |
# File 'bundle/brew.rb', line 201 def fetchable_name(name, = {}, no_upgrade: false) _ = user, repository, = name.split("/", 3) return if user.present? && repository.present? && Homebrew::Bundle::Tap.installed_taps.exclude?("#{user}/#{repository}") return if formula_installed_and_up_to_date?(name, no_upgrade:) name end |
.formula_aliases ⇒ Hash{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.
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'bundle/brew.rb', line 213 def formula_aliases return @formula_aliases if @formula_aliases @formula_aliases = {} formulae.each do |f| aliases = f[:aliases] next if aliases.blank? aliases.each do |a| @formula_aliases[a] = f[:full_name] if f[:full_name].include? "/" # tap formula tap_name = f[:full_name].rpartition("/").first @formula_aliases["#{tap_name}/#{a}"] = f[:full_name] end end end @formula_aliases end |
.formula_in_array?(formula, array) ⇒ 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.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'bundle/brew.rb', line 81 def formula_in_array?(formula, array) return true if array.include?(formula) return true if array.include?(formula.split("/").fetch(-1)) old_name = formula_oldnames[formula] old_name ||= formula_oldnames[formula.split("/").fetch(-1)] return true if old_name && array.include?(old_name) resolved_full_name = formula_aliases[formula] return false unless resolved_full_name return true if array.include?(resolved_full_name) return true if array.include?(resolved_full_name.split("/").last) false end |
.formula_installed?(formula) ⇒ 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.
98 99 100 |
# File 'bundle/brew.rb', line 98 def formula_installed?(formula) formula_in_array?(formula, installed_formulae) end |
.formula_installed_and_up_to_date?(formula, no_upgrade: false) ⇒ 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.
68 69 70 71 72 73 |
# File 'bundle/brew.rb', line 68 def formula_installed_and_up_to_date?(formula, no_upgrade: false) return false unless formula_installed?(formula) return true if no_upgrade_with_args?(no_upgrade, formula) !formula_upgradable?(formula) end |
.formula_oldnames ⇒ Hash{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.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'bundle/brew.rb', line 233 def formula_oldnames return @formula_oldnames if @formula_oldnames @formula_oldnames = {} formulae.each do |f| oldnames = f[:oldnames] next if oldnames.blank? oldnames.each do |oldname| @formula_oldnames[oldname] = f[:full_name] if f[:full_name].include? "/" # tap formula tap_name = f[:full_name].rpartition("/").first @formula_oldnames["#{tap_name}/#{oldname}"] = f[:full_name] end end end @formula_oldnames end |
.formula_upgradable?(formula) ⇒ 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.
103 104 105 106 |
# File 'bundle/brew.rb', line 103 def formula_upgradable?(formula) # Check local cache first and then authoritative Homebrew source. (formula_in_array?(formula, upgradable_formulae) && Formula[formula].outdated?) || false end |
.formulae ⇒ Array<Hash{Symbol => T.untyped}>
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.
129 130 131 132 133 134 135 |
# File 'bundle/brew.rb', line 129 def formulae return @formulae if @formulae formulae_by_full_name # formulae_by_full_name sets @formulae as a side effect of calling sort! T.cast(@formulae, T::Array[T::Hash[Symbol, T.untyped]]) end |
.formulae_by_full_name(name = nil) ⇒ Hash{Symbol => T.untyped}, ...
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 the full @formulae_by_full_name map when called without a name,
or a single formula's attribute hash when called with a name.
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'bundle/brew.rb', line 144 def formulae_by_full_name(name = nil) return @formulae_by_full_name[name] if name.present? && @formulae_by_full_name&.key?(name) require "formula" require "formulary" Formulary.enable_factory_cache! @formulae_by_name ||= {} @formulae_by_full_name ||= {} if name.nil? formulae = Formula.installed.map { add_formula(it) } sort!(formulae) return @formulae_by_full_name end formula = Formula[name] add_formula(formula) rescue FormulaUnavailableError => e opoo "'#{name}' formula is unreadable: #{e}" {} end |
.formulae_by_name(name) ⇒ Hash{Symbol => T.untyped}?
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.
168 169 170 |
# File 'bundle/brew.rb', line 168 def formulae_by_name(name) T.cast(formulae_by_full_name(name), T.nilable(T::Hash[Symbol, T.untyped])) || @formulae_by_name&.[](name) end |
.inherited(subclass) ⇒ 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.
19 20 21 22 23 |
# File 'bundle/brew.rb', line 19 def inherited(subclass) return if subclass.name == "Homebrew::Bundle::Brew::Services" super end |
.install!(name, preinstall: true, no_upgrade: false, verbose: false, force: false, **options) ⇒ 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.
49 50 51 |
# File 'bundle/brew.rb', line 49 def install!(name, preinstall: true, no_upgrade: false, verbose: false, force: false, **) new(name, ).install!(preinstall:, no_upgrade:, verbose:, force:) end |
.install_verb(name, options = {}) ⇒ 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.
59 60 61 62 63 64 65 |
# File 'bundle/brew.rb', line 59 def install_verb(name, = {}) _ = return "Installing" unless formula_upgradable?(name) "Upgrading" end |
.installed_formulae ⇒ Array<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.
109 110 111 |
# File 'bundle/brew.rb', line 109 def installed_formulae @installed_formulae ||= formulae.map { |f| f[:name] } end |
.no_upgrade_with_args?(no_upgrade, formula_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.
76 77 78 |
# File 'bundle/brew.rb', line 76 def no_upgrade_with_args?(no_upgrade, formula_name) no_upgrade && Bundle.upgrade_formulae.exclude?(formula_name) end |
.outdated_formulae ⇒ Array<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.
119 120 121 |
# File 'bundle/brew.rb', line 119 def outdated_formulae @outdated_formulae ||= formulae.filter_map { |f| f[:name] if f[:outdated?] } end |
.pinned_formulae ⇒ Array<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.
124 125 126 |
# File 'bundle/brew.rb', line 124 def pinned_formulae @pinned_formulae ||= formulae.filter_map { |f| f[:name] if f[:pinned?] } end |
.preinstall!(name, no_upgrade: false, verbose: false, **options) ⇒ 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.
41 42 43 |
# File 'bundle/brew.rb', line 41 def preinstall!(name, no_upgrade: false, verbose: false, **) new(name, ).preinstall!(no_upgrade:, verbose:) end |
.reset! ⇒ 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.
26 27 28 29 30 31 32 33 34 35 36 37 38 |
# File 'bundle/brew.rb', line 26 def reset! require "bundle/brew_services" Homebrew::Bundle::Brew::Services.reset! @installed_formulae = T.let(nil, T.nilable(T::Array[String])) @outdated_formulae = T.let(nil, T.nilable(T::Array[String])) @pinned_formulae = T.let(nil, T.nilable(T::Array[String])) @formulae = T.let(nil, T.nilable(T::Array[T::Hash[Symbol, T.untyped]])) @formulae_by_full_name = T.let(nil, T.nilable(T::Hash[String, T::Hash[Symbol, T.untyped]])) @formulae_by_name = T.let(nil, T.nilable(T::Hash[String, T::Hash[Symbol, T.untyped]])) @formula_aliases = T.let(nil, T.nilable(T::Hash[String, String])) @formula_oldnames = T.let(nil, T.nilable(T::Hash[String, String])) end |
.upgradable_formulae ⇒ Array<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.
114 115 116 |
# File 'bundle/brew.rb', line 114 def upgradable_formulae outdated_formulae - pinned_formulae end |
Instance Method Details
#changed? ⇒ 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.
490 491 492 |
# File 'bundle/brew.rb', line 490 def changed? @changed.present? end |
#install!(preinstall: true, no_upgrade: false, verbose: false, force: false) ⇒ 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.
413 414 415 416 417 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 |
# File 'bundle/brew.rb', line 413 def install!(preinstall: true, no_upgrade: false, verbose: false, force: false) install_result = if preinstall install_change_state!(no_upgrade:, verbose:, force:) else true end result = install_result if installed? service_result = service_change_state!(verbose:) result &&= service_result link_result = link_change_state!(verbose:) result &&= link_result postinstall_result = postinstall_change_state!(verbose:) result &&= postinstall_result if result && @version_file.present? # Use the version from the environment if it hasn't changed. # Strip the revision number because it's not part of the non-Homebrew version. version = if !changed? && (env_version = Bundle.formula_versions_from_env(@name)) PkgVersion.parse(env_version).version else Formula[@full_name].version end.to_s File.write(@version_file, "#{version}\n") puts "Wrote #{@name} version #{version} to #{@version_file}" if verbose end end result end |
#install_change_state!(no_upgrade:, verbose:, force:) ⇒ 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.
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 |
# File 'bundle/brew.rb', line 449 def install_change_state!(no_upgrade:, verbose:, force:) require "tap" if (tap_with_name = ::Tap.with_formula_name(@full_name)) tap, = tap_with_name tap.ensure_installed! end return false unless resolve_conflicts!(verbose:) if installed? upgrade_formula!(verbose:, force:) else install_formula!(verbose:, force:) end end |
#installed_and_up_to_date?(formula, no_upgrade: false) ⇒ 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.
395 396 397 398 399 |
# File 'bundle/brew.rb', line 395 def installed_and_up_to_date?(formula, no_upgrade: false) raise "formula must be a String, got #{formula.class}: #{formula}" unless formula.is_a?(String) self.class.formula_installed_and_up_to_date?(formula, no_upgrade:) end |
#link_change_state!(verbose: false) ⇒ 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.
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 |
# File 'bundle/brew.rb', line 512 def link_change_state!(verbose: false) link_args = [] link_args << "--force" if unlinked_and_keg_only? cmd = case @link when :overwrite link_args << "--overwrite" "link" unless linked? when true "link" unless linked? when false "unlink" if linked? when nil if keg_only? "unlink" if linked? else "link" unless linked? end end if cmd.present? verb = "#{cmd}ing".capitalize with_args = " with #{link_args.join(" ")}" if link_args.present? puts "#{verb} #{@name} formula#{with_args}." if verbose return Bundle.brew(cmd, *link_args, @name, verbose:) end true end |
#postinstall_change_state!(verbose:) ⇒ 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.
543 544 545 546 547 548 549 |
# File 'bundle/brew.rb', line 543 def postinstall_change_state!(verbose:) return true if @postinstall.blank? return true unless changed? puts "Running postinstall for #{@name}: #{@postinstall}" if verbose Kernel.system(@postinstall) || false end |
#preinstall!(no_upgrade: false, verbose: false) ⇒ 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.
402 403 404 405 406 407 408 409 410 |
# File 'bundle/brew.rb', line 402 def preinstall!(no_upgrade: false, verbose: false) if installed? && (self.class.no_upgrade_with_args?(no_upgrade, @name) || !upgradable?) puts "Skipping install of #{@name} formula. It is already installed." if verbose @changed = nil return false end true end |
#restart_service? ⇒ 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.
477 478 479 |
# File 'bundle/brew.rb', line 477 def restart_service? @restart_service.present? end |
#restart_service_needed? ⇒ 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.
482 483 484 485 486 487 |
# File 'bundle/brew.rb', line 482 def restart_service_needed? return false unless restart_service? # Restart if `restart_service: :always`, or if the formula was installed or upgraded @restart_service.to_s == "always" || changed? end |
#service_change_state!(verbose:) ⇒ 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.
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'bundle/brew.rb', line 495 def service_change_state!(verbose:) require "bundle/brew_services" file = Services.versioned_service_file(@name)&.to_s if restart_service_needed? puts "Restarting #{@name} service." if verbose Services.restart(@full_name, file:, verbose:) elsif start_service_needed? puts "Starting #{@name} service." if verbose Services.start(@full_name, file:, verbose:) else true end end |
#start_service? ⇒ 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.
466 467 468 |
# File 'bundle/brew.rb', line 466 def start_service? @start_service.present? end |
#start_service_needed? ⇒ 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.
471 472 473 474 |
# File 'bundle/brew.rb', line 471 def start_service_needed? require "bundle/brew_services" start_service? && !Services.started?(@full_name) end |