Module: Kernel
- Defined in:
- extend/kernel.rb,
extend/ENV.rb
Overview
Contains shorthand Homebrew utility methods like ohai
, opoo
, odisabled
.
Instance Method Summary collapse
-
#disk_usage_readable(size_in_bytes) ⇒ Object
-
#ensure_executable!(name, formula_name = nil, reason: "") ⇒ Object
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
Ensure the given formula is installed This is useful for installing a utility formula (e.g.
shellcheck
forbrew style
). -
#exec_browser(*args) ⇒ Object
-
#exec_editor(*args) ⇒ Object
-
#gzip(*paths) ⇒ Object
GZips the given paths, and returns the gzipped paths.
-
#ignore_interrupts(_opt = nil) ⇒ Object
-
#interactive_shell(formula = nil) ⇒ Object
-
#number_readable(number) ⇒ Object
-
#odebug(title, *sput, always_display: false) ⇒ Object
-
#odeprecated(method, replacement = nil, disable: false, disable_on: nil, disable_for_developers: true, caller: send(:caller)) ⇒ Object
-
#odie(error) ⇒ T.noreturn
-
#odisabled(method, replacement = nil, **options) ⇒ Object
-
#ofail(error) ⇒ Object
-
#oh1(title, truncate: :auto) ⇒ Object
-
#oh1_title(title, truncate: :auto) ⇒ Object
-
#ohai(title, *sput) ⇒ Object
-
#ohai_title(title) ⇒ Object
-
#onoe(message) ⇒ Object
Print a message prefixed with “Error”.
-
#opoo(message) ⇒ Object
Print a message prefixed with “Warning” (do this rarely).
-
#paths ⇒ Object
-
#preferred_shell ⇒ String
-
#pretty_duration(seconds) ⇒ Object
-
#pretty_installed(formula) ⇒ Object
-
#pretty_outdated(formula) ⇒ Object
-
#pretty_uninstalled(formula) ⇒ Object
-
#quiet_system(cmd, *args) ⇒ Object
Prints no output.
-
#redact_secrets(input, secrets) ⇒ Object
-
#redirect_stdout(file) ⇒ Object
-
#require?(path) ⇒ Boolean
-
#safe_system(cmd, *args, **options) ⇒ Object
Kernel.system but with exceptions.
-
#shell_profile ⇒ String
-
#tap_and_name_comparison ⇒ Object
-
#truncate_text_to_approximate_size(str, max_bytes, options = {}) ⇒ Object
Truncates a text string to fit within a byte size constraint, preserving character encoding validity.
-
#which(cmd, path = ENV.fetch("PATH")) ⇒ Object
-
#which_all(cmd, path = ENV.fetch("PATH")) ⇒ Object
-
#which_editor(silent: false) ⇒ Object
-
#with_custom_locale(locale, &block) ⇒ Object
-
#with_env(hash) ⇒ Object
Calls the given block with the passed environment variables added to ENV, then restores ENV afterwards.
-
#with_homebrew_path(&block) ⇒ Object
Instance Method Details
#disk_usage_readable(size_in_bytes) ⇒ Object
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 |
# File 'extend/kernel.rb', line 419 def disk_usage_readable(size_in_bytes) if size_in_bytes >= 1_073_741_824 size = size_in_bytes.to_f / 1_073_741_824 unit = "GB" elsif size_in_bytes >= 1_048_576 size = size_in_bytes.to_f / 1_048_576 unit = "MB" elsif size_in_bytes >= 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: size)}#{unit}" end end |
#ensure_executable!(name, formula_name = nil, reason: "") ⇒ Object
Ensure the given executable is exist otherwise install the brewed version
402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'extend/kernel.rb', line 402 def ensure_executable!(name, formula_name = nil, reason: "") formula_name ||= name executable = [ which(name), which(name, ORIGINAL_PATHS), HOMEBREW_PREFIX/"bin/#{name}", ].compact.first return executable if executable.exist? ensure_formula_installed!(formula_name, reason: reason).opt_bin/name end |
#ensure_formula_installed!(formula_or_name, reason: "", latest: false, output_to_stderr: true, quiet: false) ⇒ Object
Ensure the given formula is installed
This is useful for installing a utility formula (e.g. shellcheck
for brew style
)
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'extend/kernel.rb', line 363 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: latest, reason: 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
308 309 310 311 312 313 314 315 316 317 318 |
# File 'extend/kernel.rb', line 308 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
303 304 305 306 |
# File 'extend/kernel.rb', line 303 def exec_editor(*args) puts "Editing #{args.join "\n"}" with_homebrew_path { safe_system(*which_editor.shellsplit, *args) } end |
#gzip(*paths) ⇒ Object
GZips the given paths, and returns the gzipped paths.
321 322 323 324 |
# File 'extend/kernel.rb', line 321 def gzip(*paths) odisabled "Utils.gzip", "Utils::Gzip.compress" Utils::Gzip.compress(*paths) end |
#ignore_interrupts(_opt = nil) ⇒ Object
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'extend/kernel.rb', line 326 def ignore_interrupts(_opt = nil) # rubocop:disable Style/GlobalVars $ignore_interrupts_nesting_level = 0 unless defined?($ignore_interrupts_nesting_level) $ignore_interrupts_nesting_level += 1 $ignore_interrupts_interrupted = false unless defined?($ignore_interrupts_interrupted) old_sigint_handler = trap(:INT) do $ignore_interrupts_interrupted = true $stderr.print "\n" $stderr.puts "One sec, cleaning up..." end begin yield ensure trap(:INT, old_sigint_handler) $ignore_interrupts_nesting_level -= 1 if $ignore_interrupts_nesting_level == 0 && $ignore_interrupts_interrupted $ignore_interrupts_interrupted = false raise Interrupt end end # rubocop:enable Style/GlobalVars end |
#interactive_shell(formula = nil) ⇒ Object
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'extend/kernel.rb', line 211 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
442 443 444 445 446 |
# File 'extend/kernel.rb', line 442 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
33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'extend/kernel.rb', line 33 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
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 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 |
# File 'extend/kernel.rb', line 86 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)) tap = Tap.fetch(match[:user], match[:repo]) = +"\nPlease report this issue to the #{tap} tap (not Homebrew/brew or Homebrew/homebrew-core)" += ", or even better, submit a PR to fix it" if replacement << ":\n #{line.sub(/^(.*:\d+):.*$/, '\1')}\n\n" break end = +"Calling #{method} is #{verb}! #{}" << if .freeze disable = true if disable_for_developers && Homebrew::EnvConfig.developer? if disable || Homebrew.raise_deprecation_exceptions? exception = MethodDeprecatedError.new() exception.set_backtrace(backtrace) raise exception elsif !Homebrew.auditing? opoo end end |
#odie(error) ⇒ T.noreturn
81 82 83 84 |
# File 'extend/kernel.rb', line 81 def odie(error) onoe error exit 1 end |
#odisabled(method, replacement = nil, **options) ⇒ Object
158 159 160 161 162 |
# File 'extend/kernel.rb', line 158 def odisabled(method, replacement = nil, **) = { disable: true, caller: caller }.merge() # This odeprecated should stick around indefinitely. odeprecated(method, replacement, **) end |
#ofail(error) ⇒ Object
75 76 77 78 |
# File 'extend/kernel.rb', line 75 def ofail(error) onoe error Homebrew.failed = true end |
#oh1(title, truncate: :auto) ⇒ Object
57 58 59 |
# File 'extend/kernel.rb', line 57 def oh1(title, truncate: :auto) puts oh1_title(title, truncate: truncate) end |
#oh1_title(title, truncate: :auto) ⇒ Object
46 47 48 49 50 51 52 53 54 55 |
# File 'extend/kernel.rb', line 46 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
28 29 30 31 |
# File 'extend/kernel.rb', line 28 def ohai(title, *sput) puts ohai_title(title) puts sput end |
#ohai_title(title) ⇒ Object
17 18 19 20 21 22 23 24 25 26 |
# File 'extend/kernel.rb', line 17 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) ⇒ Object
Print a message prefixed with “Error”.
69 70 71 72 73 |
# File 'extend/kernel.rb', line 69 def onoe() Tty.with($stderr) do |stderr| stderr.puts Formatter.error(, label: "Error") end end |
#opoo(message) ⇒ Object
Print a message prefixed with “Warning” (do this rarely).
62 63 64 65 66 |
# File 'extend/kernel.rb', line 62 def opoo() Tty.with($stderr) do |stderr| stderr.puts Formatter.warning(, label: "Warning") end end |
#paths ⇒ Object
415 416 417 |
# File 'extend/kernel.rb', line 415 def paths @paths ||= ORIGINAL_PATHS.uniq.map(&:to_s) end |
#preferred_shell ⇒ String
506 507 508 509 |
# File 'extend/kernel.rb', line 506 def preferred_shell odisabled "preferred_shell" Utils::Shell.preferred_path(default: "/bin/sh") end |
#pretty_duration(seconds) ⇒ Object
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'extend/kernel.rb', line 194 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
164 165 166 167 168 169 170 171 172 |
# File 'extend/kernel.rb', line 164 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
174 175 176 177 178 179 180 181 182 |
# File 'extend/kernel.rb', line 174 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
184 185 186 187 188 189 190 191 192 |
# File 'extend/kernel.rb', line 184 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
Prints no output.
246 247 248 249 250 251 252 253 |
# File 'extend/kernel.rb', line 246 def quiet_system(cmd, *args) 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("/dev/null") $stderr.reopen("/dev/null") end end |
#redact_secrets(input, secrets) ⇒ Object
529 530 531 532 533 |
# File 'extend/kernel.rb', line 529 def redact_secrets(input, secrets) secrets.compact .reduce(input) { |str, secret| str.gsub secret, "******" } .freeze end |
#redirect_stdout(file) ⇒ Object
352 353 354 355 356 357 358 359 |
# File 'extend/kernel.rb', line 352 def redirect_stdout(file) out = $stdout.dup $stdout.reopen(file) yield ensure $stdout.reopen(out) out.close end |
#require?(path) ⇒ Boolean
7 8 9 10 11 12 13 14 15 |
# File 'extend/kernel.rb', line 7 def require?(path) return false if path.nil? require path 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
Kernel.system but with exceptions.
239 240 241 242 243 |
# File 'extend/kernel.rb', line 239 def safe_system(cmd, *args, **) return if Homebrew.system(cmd, *args, **) raise ErrorDuringExecution.new([cmd, *args], status: $CHILD_STATUS) end |
#shell_profile ⇒ String
512 513 514 515 |
# File 'extend/kernel.rb', line 512 def shell_profile odisabled "shell_profile" Utils::Shell.profile end |
#tap_and_name_comparison ⇒ Object
517 518 519 520 521 522 523 524 525 526 527 |
# File 'extend/kernel.rb', line 517 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
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.
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
# File 'extend/kernel.rb', line 452 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
255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'extend/kernel.rb', line 255 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
269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'extend/kernel.rb', line 269 def which_all(cmd, path = ENV.fetch("PATH")) PATH.new(path).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.compact.uniq end |
#which_editor(silent: false) ⇒ Object
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'extend/kernel.rb', line 282 def which_editor(silent: false) editor = Homebrew::EnvConfig.editor return editor if editor # Find VS Code, Sublime Text, Textmate, BBEdit, or vim editor = %w[code 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
234 235 236 |
# File 'extend/kernel.rb', line 234 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.
with_env(PATH: "/bin") do
system "echo $PATH"
end
490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'extend/kernel.rb', line 490 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
230 231 232 |
# File 'extend/kernel.rb', line 230 def with_homebrew_path(&block) with_env(PATH: PATH.new(ORIGINAL_PATHS), &block) end |