Module: Kernel

Defined in:
Library/Homebrew/utils.rb

Instance Method Summary collapse

Instance Method Details

#archs_for_command(cmd) ⇒ Object

Returns array of architectures that the given command or library is built for.


372
373
374
375
# File 'Library/Homebrew/utils.rb', line 372

def archs_for_command(cmd)
  cmd = which(cmd) unless Pathname.new(cmd).absolute?
  Pathname.new(cmd).archs
end

#capture_stderrObject


386
387
388
389
390
391
392
393
# File 'Library/Homebrew/utils.rb', line 386

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

#disk_usage_readable(size_in_bytes) ⇒ Object


418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
# File 'Library/Homebrew/utils.rb', line 418

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

#exec_browser(*args) ⇒ Object


353
354
355
356
357
358
359
360
361
# File 'Library/Homebrew/utils.rb', line 353

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

  safe_system(browser, *args)
end

#exec_editor(*args) ⇒ Object


348
349
350
351
# File 'Library/Homebrew/utils.rb', line 348

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.


364
365
366
367
368
369
# File 'Library/Homebrew/utils.rb', line 364

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

#ignore_interrupts(opt = nil) ⇒ Object


377
378
379
380
381
382
383
384
# File 'Library/Homebrew/utils.rb', line 377

def ignore_interrupts(opt = nil)
  std_trap = trap("INT") do
    puts "One sec, just cleaning up" unless opt == :quietly
  end
  yield
ensure
  trap("INT", std_trap)
end

#interactive_shell(f = nil) ⇒ Object


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'Library/Homebrew/utils.rb', line 258

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") && ENV["HOME"].start_with?(HOMEBREW_TEMP.resolved_path.to_s)
    FileUtils.mkdir_p ENV["HOME"]
    FileUtils.touch "#{ENV["HOME"]}/.zshrc"
  end

  Process.wait fork { exec ENV["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

#nostdoutObject


395
396
397
398
399
400
401
402
403
404
405
406
407
408
# File 'Library/Homebrew/utils.rb', line 395

def nostdout
  if verbose?
    yield
  else
    begin
      out = $stdout.dup
      $stdout.reopen(File::NULL)
      yield
    ensure
      $stdout.reopen(out)
      out.close
    end
  end
end

#number_readable(number) ⇒ Object


441
442
443
444
445
# File 'Library/Homebrew/utils.rb', line 441

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


109
110
111
112
113
114
115
116
117
118
119
120
# File 'Library/Homebrew/utils.rb', line 109

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

  return unless debug || always_display

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

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


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
# File 'Library/Homebrew/utils.rb', line 157

def odeprecated(method, replacement = nil, disable: false, disable_on: nil, 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|
    line.include?(HOMEBREW_CACHE) ||
    line.include?("/.brew/") ||
    line.include?("/.metadata/")
  end

  tap_message = nil

  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

  if Homebrew::EnvConfig.developer? || 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


152
153
154
155
# File 'Library/Homebrew/utils.rb', line 152

def odie(error)
  onoe error
  exit 1
end

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


216
217
218
219
# File 'Library/Homebrew/utils.rb', line 216

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

#ofail(error) ⇒ Object


147
148
149
150
# File 'Library/Homebrew/utils.rb', line 147

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

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


122
123
124
125
126
127
128
129
130
131
# File 'Library/Homebrew/utils.rb', line 122

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


104
105
106
107
# File 'Library/Homebrew/utils.rb', line 104

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

#ohai_title(title) ⇒ Object


93
94
95
96
97
98
99
100
101
102
# File 'Library/Homebrew/utils.rb', line 93

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".


141
142
143
144
145
# File 'Library/Homebrew/utils.rb', line 141

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).


134
135
136
137
138
# File 'Library/Homebrew/utils.rb', line 134

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

#pathsObject


410
411
412
413
414
415
416
# File 'Library/Homebrew/utils.rb', line 410

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


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'Library/Homebrew/utils.rb', line 241

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


221
222
223
224
225
226
227
228
229
# File 'Library/Homebrew/utils.rb', line 221

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


231
232
233
234
235
236
237
238
239
# File 'Library/Homebrew/utils.rb', line 231

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.


293
294
295
296
297
298
299
300
# File 'Library/Homebrew/utils.rb', line 293

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


519
520
521
522
523
# File 'Library/Homebrew/utils.rb', line 519

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

#require?(path) ⇒ Boolean

Returns:

  • (Boolean)

83
84
85
86
87
88
89
90
91
# File 'Library/Homebrew/utils.rb', line 83

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.


286
287
288
289
290
# File 'Library/Homebrew/utils.rb', line 286

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

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

#shell_profileObject


503
504
505
# File 'Library/Homebrew/utils.rb', line 503

def shell_profile
  Utils::Shell.profile
end

#tap_and_name_comparisonObject


507
508
509
510
511
512
513
514
515
516
517
# File 'Library/Homebrew/utils.rb', line 507

def tap_and_name_comparison
  proc do |a, b|
    if a.include?("/") && !b.include?("/")
      1
    elsif !a.include?("/") && 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.


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
# File 'Library/Homebrew/utils.rb', line 451

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 = ENV["PATH"]) ⇒ Object


302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'Library/Homebrew/utils.rb', line 302

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 = ENV["PATH"]) ⇒ Object


316
317
318
319
320
321
322
323
324
325
326
327
# File 'Library/Homebrew/utils.rb', line 316

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


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
# File 'Library/Homebrew/utils.rb', line 329

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

  # Find Atom, Sublime Text, Textmate, BBEdit / TextWrangler, or vim
  editor = %w[atom subl 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


281
282
283
# File 'Library/Homebrew/utils.rb', line 281

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

488
489
490
491
492
493
494
495
496
497
498
499
500
501
# File 'Library/Homebrew/utils.rb', line 488

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


277
278
279
# File 'Library/Homebrew/utils.rb', line 277

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