Module: Kernel Private
- Included in:
- Cask::DSL::DependsOn, Cask::URL, Dependencies, DependenciesHelpers, Formulary, Ignorable, Requirements, Utils::AST
- Defined in:
- extend/kernel.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
move these out of Kernel
.
Contains shorthand Homebrew utility methods like ohai
, opoo
, odisabled
.
Constant Summary collapse
- IGNORE_INTERRUPTS_MUTEX =
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.
Thread::Mutex.new.freeze
Instance Method Summary collapse
- #disk_usage_readable(size_in_bytes) ⇒ Object private
-
#ensure_executable!(name, formula_name = nil, reason: "", latest: false) ⇒ Object
private
Ensure the given executable is exist otherwise install the brewed version.
-
#ensure_formula_installed!(formula_or_name, reason: "", latest: false, output_to_stderr: true, quiet: false) ⇒ Object
private
Ensure the given formula is installed This is useful for installing a utility formula (e.g.
shellcheck
forbrew style
). - #exec_browser(*args) ⇒ Object private
- #exec_editor(*args) ⇒ Object private
- #ignore_interrupts ⇒ Object private
- #interactive_shell(formula = nil) ⇒ Object private
- #number_readable(number) ⇒ Object private
- #odebug(title, *sput, always_display: false) ⇒ Object private
-
#odeprecated(method, replacement = nil, disable: false, disable_on: nil, disable_for_developers: true, caller: send(:caller)) ⇒ Object
private
Output a deprecation warning/error message.
-
#odie(error) ⇒ T.noreturn
Print an error message and fail immediately.
- #odisabled(method, replacement = nil, **options) ⇒ Object private
-
#ofail(error) ⇒ void
Print an error message and fail at the end of the program.
- #oh1(title, truncate: :auto) ⇒ Object private
- #oh1_title(title, truncate: :auto) ⇒ Object private
- #ohai(title, *sput) ⇒ Object private
- #ohai_title(title) ⇒ Object private
-
#onoe(message) ⇒ void
Print an error message.
-
#opoo(message) ⇒ void
Print a warning message.
-
#opoo_outside_github_actions(message) ⇒ void
Print a warning message only if not running in GitHub Actions.
- #paths ⇒ Object private
- #pretty_duration(seconds) ⇒ Object private
- #pretty_installed(formula) ⇒ Object private
- #pretty_outdated(formula) ⇒ Object private
- #pretty_uninstalled(formula) ⇒ Object private
-
#quiet_system(cmd, *args) ⇒ Object
internal
Run a system command without any output.
- #redact_secrets(input, secrets) ⇒ Object private
- #redirect_stdout(file) ⇒ Object private
- #require?(path) ⇒ Boolean private
-
#safe_system(cmd, *args, **options) ⇒ Object
private
Kernel.system but with exceptions.
- #tap_and_name_comparison ⇒ Object private
-
#truncate_text_to_approximate_size(str, max_bytes, options = {}) ⇒ Object
private
Truncates a text string to fit within a byte size constraint, preserving character encoding validity.
-
#which(cmd, path = ENV.fetch("PATH")) ⇒ Object
Find a command.
- #which_all(cmd, path = ENV.fetch("PATH")) ⇒ Object private
- #which_editor(silent: false) ⇒ Object private
- #with_custom_locale(locale, &block) ⇒ Object private
-
#with_env(hash) ⇒ Object
Calls the given block with the passed environment variables added to
ENV
, then restoresENV
afterwards. - #with_homebrew_path(&block) ⇒ Object private
Instance Method Details
#disk_usage_readable(size_in_bytes) ⇒ 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.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 |
# File 'extend/kernel.rb', line 480 def disk_usage_readable(size_in_bytes) if size_in_bytes.abs >= 1_073_741_824 size = size_in_bytes.to_f / 1_073_741_824 unit = "GB" elsif size_in_bytes.abs >= 1_048_576 size = size_in_bytes.to_f / 1_048_576 unit = "MB" elsif size_in_bytes.abs >= 1_024 size = size_in_bytes.to_f / 1_024 unit = "KB" else size = size_in_bytes unit = "B" end # avoid trailing zero after decimal point if ((size * 10).to_i % 10).zero? "#{size.to_i}#{unit}" else "#{format("%<size>.1f", size:)}#{unit}" end end |
#ensure_executable!(name, formula_name = nil, reason: "", latest: 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.
Ensure the given executable is exist otherwise install the brewed version
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
# File 'extend/kernel.rb', line 460 def ensure_executable!(name, formula_name = nil, reason: "", latest: false) formula_name ||= name executable = [ which(name), which(name, ORIGINAL_PATHS), # We prefer the opt_bin path to a formula's executable over the prefix # path where available, since the former is stable during upgrades. HOMEBREW_PREFIX/"opt/#{formula_name}/bin/#{name}", HOMEBREW_PREFIX/"bin/#{name}", ].compact.first return executable if executable.exist? ensure_formula_installed!(formula_name, reason:, latest:).opt_bin/name end |
#ensure_formula_installed!(formula_or_name, reason: "", latest: false, output_to_stderr: true, quiet: 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.
Ensure the given formula is installed
This is useful for installing a utility formula (e.g. shellcheck
for brew style
)
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 |
# File 'extend/kernel.rb', line 421 def ensure_formula_installed!(formula_or_name, reason: "", latest: false, output_to_stderr: true, quiet: false) if output_to_stderr || quiet file = if quiet File::NULL else $stderr end # Call this method itself with redirected stdout redirect_stdout(file) do return ensure_formula_installed!(formula_or_name, latest:, reason:, output_to_stderr: false) end end require "formula" formula = if formula_or_name.is_a?(Formula) formula_or_name else Formula[formula_or_name] end reason = " for #{reason}" if reason.present? unless formula.any_version_installed? ohai "Installing `#{formula.name}`#{reason}..." safe_system HOMEBREW_BREW_FILE, "install", "--formula", formula.full_name end if latest && !formula.latest_version_installed? ohai "Upgrading `#{formula.name}`#{reason}..." safe_system HOMEBREW_BREW_FILE, "upgrade", "--formula", formula.full_name end formula end |
#exec_browser(*args) ⇒ 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.
376 377 378 379 380 381 382 383 384 385 386 |
# File 'extend/kernel.rb', line 376 def exec_browser(*args) browser = Homebrew::EnvConfig.browser browser ||= OS::PATH_OPEN if defined?(OS::PATH_OPEN) return unless browser ENV["DISPLAY"] = Homebrew::EnvConfig.display with_env(DBUS_SESSION_BUS_ADDRESS: ENV.fetch("HOMEBREW_DBUS_SESSION_BUS_ADDRESS", nil)) do safe_system(browser, *args) end end |
#exec_editor(*args) ⇒ 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.
371 372 373 374 |
# File 'extend/kernel.rb', line 371 def exec_editor(*args) puts "Editing #{args.join "\n"}" with_homebrew_path { safe_system(*which_editor.shellsplit, *args) } end |
#ignore_interrupts ⇒ 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.
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'extend/kernel.rb', line 390 def ignore_interrupts IGNORE_INTERRUPTS_MUTEX.synchronize do interrupted = T.let(false, T::Boolean) old_sigint_handler = trap(:INT) do interrupted = true $stderr.print "\n" $stderr.puts "One sec, cleaning up..." end begin yield ensure trap(:INT, old_sigint_handler) raise Interrupt if interrupted end end end |
#interactive_shell(formula = nil) ⇒ 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.
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'extend/kernel.rb', line 270 def interactive_shell(formula = nil) unless formula.nil? ENV["HOMEBREW_DEBUG_PREFIX"] = formula.prefix ENV["HOMEBREW_DEBUG_INSTALL"] = formula.full_name end if Utils::Shell.preferred == :zsh && (home = Dir.home).start_with?(HOMEBREW_TEMP.resolved_path.to_s) FileUtils.mkdir_p home FileUtils.touch "#{home}/.zshrc" end Process.wait fork { exec Utils::Shell.preferred_path(default: "/bin/bash") } return if $CHILD_STATUS.success? raise "Aborted due to non-zero exit status (#{$CHILD_STATUS.exitstatus})" if $CHILD_STATUS.exited? raise $CHILD_STATUS.inspect end |
#number_readable(number) ⇒ 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.
503 504 505 506 507 |
# File 'extend/kernel.rb', line 503 def number_readable(number) numstr = number.to_i.to_s (numstr.size - 3).step(1, -3) { |i| numstr.insert(i, ",") } numstr end |
#odebug(title, *sput, always_display: 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.
50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'extend/kernel.rb', line 50 def odebug(title, *sput, always_display: false) debug = if respond_to?(:debug) T.unsafe(self).debug? else Context.current.debug? end return if !debug && !always_display $stderr.puts Formatter.headline(title, color: :magenta) $stderr.puts sput unless sput.empty? end |
#odeprecated(method, replacement = nil, disable: false, disable_on: nil, disable_for_developers: true, caller: send(:caller)) ⇒ 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.
Output a deprecation warning/error message.
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'extend/kernel.rb', line 138 def odeprecated(method, replacement = nil, disable: false, disable_on: nil, disable_for_developers: true, caller: send(:caller)) = if replacement "Use #{replacement} instead." else "There is no replacement." end unless disable_on.nil? if disable_on > Time.now = " and will be disabled on #{disable_on.strftime("%Y-%m-%d")}" else disable = true end end verb = if disable "disabled" else "deprecated#{}" end # Try to show the most relevant location in message, i.e. (if applicable): # - Location in a formula. # - Location of caller of deprecated method (if all else fails). backtrace = caller # Don't throw deprecations at all for cached, .brew or .metadata files. return if backtrace.any? do |line| next true if line.include?(HOMEBREW_CACHE.to_s) next true if line.include?("/.brew/") next true if line.include?("/.metadata/") next false unless line.match?(HOMEBREW_TAP_PATH_REGEX) path = Pathname(line.split(":", 2).first) next false unless path.file? next false unless path.readable? formula_contents = path.read formula_contents.include?(" deprecate! ") || formula_contents.include?(" disable! ") end = T.let(nil, T.nilable(String)) backtrace.each do |line| next unless (match = line.match(HOMEBREW_TAP_PATH_REGEX)) require "tap" tap = Tap.fetch(match[:user], match[:repository]) = "\nPlease report this issue to the #{tap.full_name} tap" += " (not Homebrew/* repositories)" unless tap.official? += ", or even better, submit a PR to fix it" if replacement << ":\n #{line.sub(/^(.*:\d+):.*$/, '\1')}\n\n" break end file, line, = backtrace.first.split(":") line = line.to_i if line.present? = "Calling #{method} is #{verb}! #{}" << if .freeze disable = true if disable_for_developers && Homebrew::EnvConfig.developer? if disable || Homebrew.raise_deprecation_exceptions? require "utils/github/actions" GitHub::Actions.puts_annotation_if_env_set(:error, , file:, line:) exception = MethodDeprecatedError.new() exception.set_backtrace(backtrace) raise exception elsif !Homebrew.auditing? opoo end end |
#odie(error) ⇒ T.noreturn
Print an error message and fail immediately.
132 133 134 135 |
# File 'extend/kernel.rb', line 132 def odie(error) onoe error exit 1 end |
#odisabled(method, replacement = nil, **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.
217 218 219 220 221 |
# File 'extend/kernel.rb', line 217 def odisabled(method, replacement = nil, **) = { disable: true, caller: }.merge() # This odeprecated should stick around indefinitely. odeprecated(method, replacement, **) end |
#ofail(error) ⇒ void
This method returns an undefined value.
Print an error message and fail at the end of the program.
123 124 125 126 |
# File 'extend/kernel.rb', line 123 def ofail(error) onoe error Homebrew.failed = true end |
#oh1(title, truncate: :auto) ⇒ 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.
74 75 76 |
# File 'extend/kernel.rb', line 74 def oh1(title, truncate: :auto) puts oh1_title(title, truncate:) end |
#oh1_title(title, truncate: :auto) ⇒ 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.
63 64 65 66 67 68 69 70 71 72 |
# File 'extend/kernel.rb', line 63 def oh1_title(title, truncate: :auto) verbose = if respond_to?(:verbose?) T.unsafe(self).verbose? else Context.current.verbose? end title = Tty.truncate(title.to_s) if $stdout.tty? && !verbose && truncate == :auto Formatter.headline(title, color: :green) end |
#ohai(title, *sput) ⇒ 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.
45 46 47 48 |
# File 'extend/kernel.rb', line 45 def ohai(title, *sput) puts ohai_title(title) puts sput end |
#ohai_title(title) ⇒ 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.
34 35 36 37 38 39 40 41 42 43 |
# File 'extend/kernel.rb', line 34 def ohai_title(title) verbose = if respond_to?(:verbose?) T.unsafe(self).verbose? else Context.current.verbose? end title = Tty.truncate(title.to_s) if $stdout.tty? && !verbose Formatter.headline(title, color: :blue) end |
#onoe(message) ⇒ void
This method returns an undefined value.
Print an error message.
108 109 110 111 112 113 114 115 116 117 |
# File 'extend/kernel.rb', line 108 def onoe() require "utils/github/actions" return if GitHub::Actions.puts_annotation_if_env_set(:error, .to_s) require "utils/formatter" Tty.with($stderr) do |stderr| stderr.puts Formatter.error(, label: "Error") end end |
#opoo(message) ⇒ void
This method returns an undefined value.
Print a warning message.
82 83 84 85 86 87 88 89 90 91 |
# File 'extend/kernel.rb', line 82 def opoo() require "utils/github/actions" return if GitHub::Actions.puts_annotation_if_env_set(:warning, .to_s) require "utils/formatter" Tty.with($stderr) do |stderr| stderr.puts Formatter.warning(, label: "Warning") end end |
#opoo_outside_github_actions(message) ⇒ void
This method returns an undefined value.
Print a warning message only if not running in GitHub Actions.
97 98 99 100 101 102 |
# File 'extend/kernel.rb', line 97 def opoo_outside_github_actions() require "utils/github/actions" return if GitHub::Actions.env_set? opoo() end |
#paths ⇒ 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.
476 477 478 |
# File 'extend/kernel.rb', line 476 def paths @paths ||= ORIGINAL_PATHS.uniq.map(&:to_s) end |
#pretty_duration(seconds) ⇒ 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.
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'extend/kernel.rb', line 253 def pretty_duration(seconds) seconds = seconds.to_i res = +"" if seconds > 59 minutes = seconds / 60 seconds %= 60 res = +Utils.pluralize("minute", minutes, include_count: true) return res.freeze if seconds.zero? res << " " end res << Utils.pluralize("second", seconds, include_count: true) res.freeze end |
#pretty_installed(formula) ⇒ 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.
223 224 225 226 227 228 229 230 231 |
# File 'extend/kernel.rb', line 223 def pretty_installed(formula) if !$stdout.tty? formula.to_s elsif Homebrew::EnvConfig.no_emoji? Formatter.success("#{Tty.bold}#{formula} (installed)#{Tty.reset}") else "#{Tty.bold}#{formula} #{Formatter.success("✔")}#{Tty.reset}" end end |
#pretty_outdated(formula) ⇒ 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.
233 234 235 236 237 238 239 240 241 |
# File 'extend/kernel.rb', line 233 def pretty_outdated(formula) if !$stdout.tty? formula.to_s elsif Homebrew::EnvConfig.no_emoji? Formatter.error("#{Tty.bold}#{formula} (outdated)#{Tty.reset}") else "#{Tty.bold}#{formula} #{Formatter.warning("⚠")}#{Tty.reset}" end end |
#pretty_uninstalled(formula) ⇒ 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.
243 244 245 246 247 248 249 250 251 |
# File 'extend/kernel.rb', line 243 def pretty_uninstalled(formula) if !$stdout.tty? formula.to_s elsif Homebrew::EnvConfig.no_emoji? Formatter.error("#{Tty.bold}#{formula} (uninstalled)#{Tty.reset}") else "#{Tty.bold}#{formula} #{Formatter.error("✘")}#{Tty.reset}" end end |
#quiet_system(cmd, *args) ⇒ 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.
Run a system command without any output.
309 310 311 312 313 314 315 316 317 318 |
# File 'extend/kernel.rb', line 309 def quiet_system(cmd, *args) require "utils" Homebrew._system(cmd, *args) do # Redirect output streams to `/dev/null` instead of closing as some programs # will fail to execute if they can't write to an open stream. $stdout.reopen(File::NULL) $stderr.reopen(File::NULL) end end |
#redact_secrets(input, secrets) ⇒ 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.
584 585 586 587 588 |
# File 'extend/kernel.rb', line 584 def redact_secrets(input, secrets) secrets.compact .reduce(input) { |str, secret| str.gsub secret, "******" } .freeze end |
#redirect_stdout(file) ⇒ 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.
410 411 412 413 414 415 416 417 |
# File 'extend/kernel.rb', line 410 def redirect_stdout(file) out = $stdout.dup $stdout.reopen(file) yield ensure $stdout.reopen(out) out.close end |
#require?(path) ⇒ 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.
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'extend/kernel.rb', line 16 def require?(path) return false if path.nil? if defined?(Warnings) # Work around require warning when done repeatedly: # https://bugs.ruby-lang.org/issues/21091 Warnings.ignore(/already initialized constant/, /previous definition of/) do require path end else require path end true rescue LoadError => e # we should raise on syntax errors but not if the file doesn't exist. raise unless e..include?(path) end |
#safe_system(cmd, *args, **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.
Kernel.system but with exceptions.
298 299 300 301 302 303 304 |
# File 'extend/kernel.rb', line 298 def safe_system(cmd, *args, **) require "utils" return if Homebrew.system(cmd, *args, **) raise ErrorDuringExecution.new([cmd, *args], status: $CHILD_STATUS) end |
#tap_and_name_comparison ⇒ 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.
572 573 574 575 576 577 578 579 580 581 582 |
# File 'extend/kernel.rb', line 572 def tap_and_name_comparison proc do |a, b| if a.include?("/") && b.exclude?("/") 1 elsif a.exclude?("/") && b.include?("/") -1 else a <=> b end end end |
#truncate_text_to_approximate_size(str, max_bytes, 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.
Truncates a text string to fit within a byte size constraint, preserving character encoding validity. The returned string will be not much longer than the specified max_bytes, though the exact shortfall or overrun may vary.
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 |
# File 'extend/kernel.rb', line 513 def truncate_text_to_approximate_size(str, max_bytes, = {}) front_weight = .fetch(:front_weight, 0.5) raise "opts[:front_weight] must be between 0.0 and 1.0" if front_weight < 0.0 || front_weight > 1.0 return str if str.bytesize <= max_bytes glue = "\n[...snip...]\n" max_bytes_in = [max_bytes - glue.bytesize, 1].max bytes = str.dup.force_encoding("BINARY") glue_bytes = glue.encode("BINARY") n_front_bytes = (max_bytes_in * front_weight).floor n_back_bytes = max_bytes_in - n_front_bytes if n_front_bytes.zero? front = bytes[1..0] back = bytes[-max_bytes_in..] elsif n_back_bytes.zero? front = bytes[0..(max_bytes_in - 1)] back = bytes[1..0] else front = bytes[0..(n_front_bytes - 1)] back = bytes[-n_back_bytes..] end out = front + glue_bytes + back out.force_encoding("UTF-8") out.encode!("UTF-16", invalid: :replace) out.encode!("UTF-8") out end |
#which(cmd, path = ENV.fetch("PATH")) ⇒ Object
Find a command.
323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'extend/kernel.rb', line 323 def which(cmd, path = ENV.fetch("PATH")) PATH.new(path).each do |p| begin pcmd = File.(cmd, p) rescue ArgumentError # File.expand_path will raise an ArgumentError if the path is malformed. # See https://github.com/Homebrew/legacy-homebrew/issues/32789 next end return Pathname.new(pcmd) if File.file?(pcmd) && File.executable?(pcmd) end nil end |
#which_all(cmd, path = ENV.fetch("PATH")) ⇒ 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.
337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'extend/kernel.rb', line 337 def which_all(cmd, path = ENV.fetch("PATH")) PATH.new(path).filter_map do |p| begin pcmd = File.(cmd, p) rescue ArgumentError # File.expand_path will raise an ArgumentError if the path is malformed. # See https://github.com/Homebrew/legacy-homebrew/issues/32789 next end Pathname.new(pcmd) if File.file?(pcmd) && File.executable?(pcmd) end.uniq end |
#which_editor(silent: 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.
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'extend/kernel.rb', line 350 def which_editor(silent: false) editor = Homebrew::EnvConfig.editor return editor if editor # Find VS Code variants, Sublime Text, Textmate, BBEdit, or vim editor = %w[code codium cursor code-insiders subl mate bbedit vim].find do |candidate| candidate if which(candidate, ORIGINAL_PATHS) end editor ||= "vim" unless silent opoo <<~EOS Using #{editor} because no editor was set in the environment. This may change in the future, so we recommend setting EDITOR or HOMEBREW_EDITOR to your preferred text editor. EOS end editor end |
#with_custom_locale(locale, &block) ⇒ 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.
293 294 295 |
# File 'extend/kernel.rb', line 293 def with_custom_locale(locale, &block) with_env(LC_ALL: locale, &block) end |
#with_env(hash) ⇒ Object
This method is not thread-safe – other threads which happen to be scheduled during the block will also see these environment variables.
Calls the given block with the passed environment variables
added to ENV
, then restores ENV
afterwards.
Example
with_env(PATH: "/bin") do
system "echo $PATH"
end
557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'extend/kernel.rb', line 557 def with_env(hash) old_values = {} begin hash.each do |key, value| key = key.to_s old_values[key] = ENV.delete(key) ENV[key] = value end yield if block_given? ensure ENV.update(old_values) end end |
#with_homebrew_path(&block) ⇒ 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.
289 290 291 |
# File 'extend/kernel.rb', line 289 def with_homebrew_path(&block) with_env(PATH: PATH.new(ORIGINAL_PATHS), &block) end |