Module: Kernel

Extended by:
T::Sig
Defined in:
utils.rb,
extend/ENV.rb

Instance Method Summary collapse

Instance Method Details

#capture_stderrString

Returns:



420
421
422
423
424
425
426
427
# File 'utils.rb', line 420

def capture_stderr
  old = $stderr
  $stderr = StringIO.new
  yield
  $stderr.string
ensure
  $stderr = old
end

#disk_usage_readable(size_in_bytes) ⇒ Object



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
# File 'utils.rb', line 515

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



487
488
489
490
491
492
493
494
495
496
497
498
# File 'utils.rb', line 487

def ensure_executable!(name, formula_name = nil, reason: "")
  formula_name ||= name

  executable = [
    which(name),
    which(name, ENV["HOMEBREW_PATH"]),
    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)



448
449
450
451
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
479
480
481
482
483
484
# File 'utils.rb', line 448

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



373
374
375
376
377
378
379
380
381
382
383
# File 'utils.rb', line 373

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["HOMEBREW_DBUS_SESSION_BUS_ADDRESS"]) do
    safe_system(browser, *args)
  end
end

#exec_editor(*args) ⇒ Object



368
369
370
371
# File 'utils.rb', line 368

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.



386
387
388
389
390
391
# File 'utils.rb', line 386

def gzip(*paths)
  paths.map do |path|
    safe_system "gzip", path
    Pathname.new("#{path}.gz")
  end
end

#ignore_interrupts(_opt = nil) ⇒ Object



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
# File 'utils.rb', line 393

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(f = nil) ⇒ Object



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'utils.rb', line 278

def interactive_shell(f = nil)
  unless f.nil?
    ENV["HOMEBREW_DEBUG_PREFIX"] = f.prefix
    ENV["HOMEBREW_DEBUG_INSTALL"] = f.full_name
  end

  if ENV["SHELL"].include?("zsh") && (home = ENV["HOME"])&.start_with?(HOMEBREW_TEMP.resolved_path.to_s)
    FileUtils.mkdir_p home
    FileUtils.touch "#{home}/.zshrc"
  end

  Process.wait fork { exec ENV.fetch("SHELL") }

  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

#nostdout(&block) ⇒ Object



429
430
431
432
433
434
435
# File 'utils.rb', line 429

def nostdout(&block)
  if verbose?
    yield
  else
    redirect_stdout(File::NULL, &block)
  end
end

#number_readable(number) ⇒ Object



538
539
540
541
542
# File 'utils.rb', line 538

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



115
116
117
118
119
120
121
122
123
124
125
126
# File 'utils.rb', line 115

def odebug(title, *sput, always_display: false)
  debug = if respond_to?(:debug)
    debug?
  else
    Context.current.debug?
  end

  return if !debug && !always_display

  puts Formatter.headline(title, color: :magenta)
  puts sput unless sput.empty?
end

#odeprecated(method, replacement = nil, disable: false, disable_on: nil, disable_for_developers: true, caller: send(:caller)) ⇒ Object



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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'utils.rb', line 163

def odeprecated(method, replacement = nil,
                disable:                false,
                disable_on:             nil,
                disable_for_developers: true,
                caller:                 send(:caller))
  replacement_message = if replacement
    "Use #{replacement} instead."
  else
    "There is no replacement."
  end

  unless disable_on.nil?
    if disable_on > Time.now
      will_be_disabled_message = " and will be disabled on #{disable_on.strftime("%Y-%m-%d")}"
    else
      disable = true
    end
  end

  verb = if disable
    "disabled"
  else
    "deprecated#{will_be_disabled_message}"
  end

  # Try to show the most relevant location in message, i.e. (if applicable):
  # - Location in a formula.
  # - Location outside of 'compat/'.
  # - 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

  tap_message = 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])
    tap_message = +"\nPlease report this issue to the #{tap} tap (not Homebrew/brew or Homebrew/core)"
    tap_message += ", or even better, submit a PR to fix it" if replacement
    tap_message << ":\n  #{line.sub(/^(.*:\d+):.*$/, '\1')}\n\n"
    break
  end

  message = +"Calling #{method} is #{verb}! #{replacement_message}"
  message << tap_message if tap_message
  message.freeze

  disable = true if disable_for_developers && Homebrew::EnvConfig.developer?
  if disable || Homebrew.raise_deprecation_exceptions?
    exception = MethodDeprecatedError.new(message)
    exception.set_backtrace(backtrace)
    raise exception
  elsif !Homebrew.auditing?
    opoo message
  end
end

#odie(error) ⇒ Object



158
159
160
161
# File 'utils.rb', line 158

def odie(error)
  onoe error
  exit 1
end

#odisabled(method, replacement = nil, options = {}) ⇒ Object



236
237
238
239
# File 'utils.rb', line 236

def odisabled(method, replacement = nil, options = {})
  options = { disable: true, caller: caller }.merge(options)
  odeprecated(method, replacement, options)
end

#ofail(error) ⇒ Object



153
154
155
156
# File 'utils.rb', line 153

def ofail(error)
  onoe error
  Homebrew.failed = true
end

#oh1(title, truncate: :auto) ⇒ Object



128
129
130
131
132
133
134
135
136
137
# File 'utils.rb', line 128

def oh1(title, truncate: :auto)
  verbose = if respond_to?(:verbose?)
    verbose?
  else
    Context.current.verbose?
  end

  title = Tty.truncate(title) if $stdout.tty? && !verbose && truncate == :auto
  puts Formatter.headline(title, color: :green)
end

#ohai(title, *sput) ⇒ Object



110
111
112
113
# File 'utils.rb', line 110

def ohai(title, *sput)
  puts ohai_title(title)
  puts sput
end

#ohai_title(title) ⇒ Object



99
100
101
102
103
104
105
106
107
108
# File 'utils.rb', line 99

def ohai_title(title)
  verbose = if respond_to?(:verbose?)
    verbose?
  else
    Context.current.verbose?
  end

  title = Tty.truncate(title) if $stdout.tty? && !verbose
  Formatter.headline(title, color: :blue)
end

#onoe(message) ⇒ Object

Print a message prefixed with “Error”.



147
148
149
150
151
# File 'utils.rb', line 147

def onoe(message)
  Tty.with($stderr) do |stderr|
    stderr.puts Formatter.error(message, label: "Error")
  end
end

#opoo(message) ⇒ Object

Print a message prefixed with “Warning” (do this rarely).



140
141
142
143
144
# File 'utils.rb', line 140

def opoo(message)
  Tty.with($stderr) do |stderr|
    stderr.puts Formatter.warning(message, label: "Warning")
  end
end

#parse_author!(author) ⇒ Object

Raises:



508
509
510
511
512
513
# File 'utils.rb', line 508

def parse_author!(author)
  /^(?<name>[^<]+?)[ \t]*<(?<email>[^>]+?)>$/ =~ author
  raise UsageError, "Unable to parse name and email." if name.blank? && email.blank?

  { name: name, email: email }
end

#pathsObject



500
501
502
503
504
505
506
# File 'utils.rb', line 500

def paths
  @paths ||= PATH.new(ENV["HOMEBREW_PATH"]).map do |p|
    File.expand_path(p).chomp("/")
  rescue ArgumentError
    onoe "The following PATH component is invalid: #{p}"
  end.uniq.compact
end

#pretty_duration(s) ⇒ Object



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'utils.rb', line 261

def pretty_duration(s)
  s = s.to_i
  res = +""

  if s > 59
    m = s / 60
    s %= 60
    res = +"#{m} #{"minute".pluralize(m)}"
    return res.freeze if s.zero?

    res << " "
  end

  res << "#{s} #{"second".pluralize(s)}"
  res.freeze
end

#pretty_installed(f) ⇒ Object



241
242
243
244
245
246
247
248
249
# File 'utils.rb', line 241

def pretty_installed(f)
  if !$stdout.tty?
    f.to_s
  elsif Homebrew::EnvConfig.no_emoji?
    Formatter.success("#{Tty.bold}#{f} (installed)#{Tty.reset}")
  else
    "#{Tty.bold}#{f} #{Formatter.success("")}#{Tty.reset}"
  end
end

#pretty_uninstalled(f) ⇒ Object



251
252
253
254
255
256
257
258
259
# File 'utils.rb', line 251

def pretty_uninstalled(f)
  if !$stdout.tty?
    f.to_s
  elsif Homebrew::EnvConfig.no_emoji?
    Formatter.error("#{Tty.bold}#{f} (uninstalled)#{Tty.reset}")
  else
    "#{Tty.bold}#{f} #{Formatter.error("")}#{Tty.reset}"
  end
end

#quiet_system(cmd, *args) ⇒ Object

Prints no output.



313
314
315
316
317
318
319
320
# File 'utils.rb', line 313

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



618
619
620
621
622
# File 'utils.rb', line 618

def redact_secrets(input, secrets)
  secrets.compact
         .reduce(input) { |str, secret| str.gsub secret, "******" }
         .freeze
end

#redirect_stdout(file) ⇒ Object



437
438
439
440
441
442
443
444
# File 'utils.rb', line 437

def redirect_stdout(file)
  out = $stdout.dup
  $stdout.reopen(file)
  yield
ensure
  $stdout.reopen(out)
  out.close
end

#require?(path) ⇒ Boolean

Returns:

  • (Boolean)


89
90
91
92
93
94
95
96
97
# File 'utils.rb', line 89

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.message.include?(path)
end

#safe_system(cmd, *args, **options) ⇒ Object

Kernel.system but with exceptions.



306
307
308
309
310
# File 'utils.rb', line 306

def safe_system(cmd, *args, **options)
  return if Homebrew.system(cmd, *args, **options)

  raise ErrorDuringExecution.new([cmd, *args], status: $CHILD_STATUS)
end

#shell_profileString

Returns:



602
603
604
# File 'utils.rb', line 602

def shell_profile
  Utils::Shell.profile
end

#tap_and_name_comparisonObject



606
607
608
609
610
611
612
613
614
615
616
# File 'utils.rb', line 606

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(s, 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.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
# File 'utils.rb', line 548

def truncate_text_to_approximate_size(s, max_bytes, options = {})
  front_weight = options.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 s if s.bytesize <= max_bytes

  glue = "\n[...snip...]\n"
  max_bytes_in = [max_bytes - glue.bytesize, 1].max
  bytes = s.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 = ) ⇒ Object



322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'utils.rb', line 322

def which(cmd, path = ENV["PATH"])
  PATH.new(path).each do |p|
    begin
      pcmd = File.expand_path(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 = ) ⇒ Object



336
337
338
339
340
341
342
343
344
345
346
347
# File 'utils.rb', line 336

def which_all(cmd, path = ENV["PATH"])
  PATH.new(path).map do |p|
    begin
      pcmd = File.expand_path(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_editorObject



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'utils.rb', line 349

def which_editor
  editor = Homebrew::EnvConfig.editor
  return editor if editor

  # Find Atom, Sublime Text, VS Code, Textmate, BBEdit / TextWrangler, or vim
  editor = %w[atom subl code mate edit vim].find do |candidate|
    candidate if which(candidate, ENV["HOMEBREW_PATH"])
  end
  editor ||= "vim"

  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

  editor
end

#with_custom_locale(locale, &block) ⇒ Object



301
302
303
# File 'utils.rb', line 301

def with_custom_locale(locale, &block)
  with_env(LC_ALL: locale, &block)
end

#with_env(hash) ⇒ Object

Note:

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


586
587
588
589
590
591
592
593
594
595
596
597
598
599
# File 'utils.rb', line 586

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



297
298
299
# File 'utils.rb', line 297

def with_homebrew_path(&block)
  with_env(PATH: PATH.new(ENV["HOMEBREW_PATH"]), &block)
end