Top Level Namespace

Defined Under Namespace

Modules: ArchitectureListExtension, Cachable, Commands, Debrew, Dependable, DiskUsageExtension, Emoji, EnvActivation, FileUtils, Formatter, FormulaCellarChecks, FormulaClassUnavailableErrorModule, FormulaUnreadableErrorModule, Formulary, Git, GitHub, GitRepositoryExtension, Hardware, HashValidator, Hbc, Homebrew, HomebrewArgvExtension, IRB, InstallRenamed, Language, MachOShim, Metafiles, OS, Patch, Predicable, Readall, RuboCop, SharedEnvExtension, StringInreplaceExtension, Superenv, Tty, Utils Classes: AbstractDownloadStrategy, AbstractFileDownloadStrategy, ArchRequirement, BazaarDownloadStrategy, Bottle, BottleDisableReason, BottleFormulaUnavailableError, BottleSpecification, Buffer, Build, BuildEnvironment, BuildError, BuildFlagsError, BuildOptions, BuildToolsError, CVSDownloadStrategy, CannotInstallFormulaError, CaskLock, Caveats, Checksum, ChecksumMismatchError, ChecksumMissingError, Cleaner, CompilerFailure, CompilerSelectionError, CompilerSelector, CoreTap, CurlApacheMirrorDownloadStrategy, CurlBottleDownloadStrategy, CurlDownloadStrategy, CurlDownloadStrategyError, CurlPostDownloadStrategy, CxxStdlib, DATAPatch, Dependencies, Dependency, DependencyCollector, DeprecatedOption, Descriptions, DownloadError, DownloadStrategyDetector, DuplicateResourceError, EmacsRequirement, EmbeddedPatch, ErrorDuringExecution, ExternalPatch, Formula, FormulaAmbiguousPythonError, FormulaAuditor, FormulaClassUnavailableError, FormulaConflict, FormulaConflictError, FormulaCreator, FormulaInstallationAlreadyAttemptedError, FormulaInstaller, FormulaLock, FormulaPin, FormulaSpecificationError, FormulaText, FormulaUnavailableError, FormulaUnreadableError, FormulaUnspecifiedError, FormulaValidationError, FormulaVersions, FortranRequirement, FossilDownloadStrategy, GPG2Requirement, GitDownloadStrategy, GitHubGitDownloadStrategy, GitHubPrivateRepositoryDownloadStrategy, GitHubPrivateRepositoryReleaseDownloadStrategy, GitRequirement, Gpg, HeadSoftwareSpec, HeadVersion, IO, JavaRequirement, Keg, KegOnlyReason, KegUnspecifiedError, LD64Dependency, LanguageModuleRequirement, LegacyPatch, LinkageChecker, LocalBottleDownloadStrategy, Locale, LockFile, MPIRequirement, MaximumMacOSRequirement, MercurialDownloadStrategy, MercurialRequirement, MethodDeprecatedError, Migrator, MinimumMacOSRequirement, MissingApplyError, Module, MultipleVersionsInstalledError, MysqlRequirement, NilClass, NoSuchKegError, NoUnzipCurlDownloadStrategy, NonBinaryOsxfuseRequirement, NotAKegError, OperationInProgressError, Option, Options, OsxfuseRequirement, PATH, Pathname, PerlRequirement, PkgVersion, PostgresqlRequirement, PourBottleCheck, PrettyListing, Python3Requirement, PythonRequirement, RbenvRequirement, Reporter, ReporterHub, Requirement, Requirements, Resource, ResourceAuditor, ResourceMissingError, ResourceStageContext, RubyRequirement, S3DownloadStrategy, Sandbox, SoftwareSpec, String, StringPatch, SubversionDownloadStrategy, Symbol, SystemConfig, Tab, Tap, TapAlreadyTappedError, TapAlreadyUnshallowError, TapConfig, TapDependency, TapFormulaAmbiguityError, TapFormulaClassUnavailableError, TapFormulaUnavailableError, TapFormulaUnreadableError, TapFormulaWithOldnameAmbiguityError, TapPinStatusError, TapRemoteMismatchError, TapUnavailableError, TeXRequirement, TuntapRequirement, UnsatisfiedRequirements, UnsignedKextRequirement, UsageError, VCSDownloadStrategy, Version, X11Requirement, XcodeRequirement

Constant Summary

RUBY_VERSION_SPLIT =

check ruby version before requiring any modules.

RUBY_VERSION.split "."
RUBY_X =
RUBY_VERSION_SPLIT[0].to_i
RUBY_Y =
RUBY_VERSION_SPLIT[1].to_i
HOMEBREW_LIBRARY_PATH =
Pathname.new(__FILE__).realpath.parent
TEST_TIMEOUT_SECONDS =
5 * 60
HOMEBREW_BREW_FILE =

Path to bin/brew main executable in HOMEBREW_PREFIX

Pathname.new(ENV["HOMEBREW_BREW_FILE"])
HOMEBREW_PREFIX =

Where we link under

Pathname.new(ENV["HOMEBREW_PREFIX"])
HOMEBREW_REPOSITORY =

Where .git is found

Pathname.new(ENV["HOMEBREW_REPOSITORY"])
HOMEBREW_LIBRARY =

Where we store most of Homebrew, taps, and various metadata

Pathname.new(ENV["HOMEBREW_LIBRARY"])
HOMEBREW_SHIMS_PATH =

Where shim scripts for various build and SCM tools are stored

HOMEBREW_LIBRARY/"Homebrew/shims"
HOMEBREW_LINKED_KEGS =

Where we store symlinks to currently linked kegs

HOMEBREW_PREFIX/"var/homebrew/linked"
HOMEBREW_PINNED_KEGS =

Where we store symlinks to currently version-pinned kegs

HOMEBREW_PREFIX/"var/homebrew/pinned"
HOMEBREW_LOCK_DIR =

Where we store lock files

HOMEBREW_PREFIX/"var/homebrew/locks"
HOMEBREW_CELLAR =

Where we store built products

Pathname.new(ENV["HOMEBREW_CELLAR"])
HOMEBREW_CACHE =

Where downloads (bottles, source tarballs, etc.) are cached

Pathname.new(ENV["HOMEBREW_CACHE"])
HOMEBREW_CACHE_FORMULA =

Where brews installed via URL are cached

HOMEBREW_CACHE/"Formula"
HOMEBREW_LOGS =

Where build, postinstall, and test logs of formulae are written to

Pathname.new(ENV["HOMEBREW_LOGS"] || "~/Library/Logs/Homebrew/").expand_path
HOMEBREW_TEMP =

Must use /tmp instead of $TMPDIR because long paths break Unix domain sockets

Pathname.new(ENV.fetch("HOMEBREW_TEMP", "/tmp"))
HOMEBREW_LOAD_PATH =

Load path used by standalone scripts to access the Homebrew code base

HOMEBREW_LIBRARY_PATH
HOMEBREW_PRODUCT =
ENV["HOMEBREW_PRODUCT"]
HOMEBREW_VERSION =
ENV["HOMEBREW_VERSION"]
HOMEBREW_WWW =
"https://brew.sh".freeze
RUBY_PATH =
Pathname.new(RbConfig.ruby)
RUBY_BIN =
RUBY_PATH.dirname
HOMEBREW_USER_AGENT_CURL =
ENV["HOMEBREW_USER_AGENT_CURL"]
HOMEBREW_USER_AGENT_RUBY =
"#{ENV["HOMEBREW_USER_AGENT"]} ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}".freeze
HOMEBREW_USER_AGENT_FAKE_SAFARI =
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/602.4.8 (KHTML, like Gecko) Version/10.0.3 Safari/602.4.8".freeze
HOMEBREW_PULL_API_REGEX =
%r{https://api\.github\.com/repos/([\w-]+)/([\w-]+)?/pulls/(\d+)}
HOMEBREW_PULL_OR_COMMIT_URL_REGEX =
%r[https://github\.com/([\w-]+)/([\w-]+)?/(?:pull/(\d+)|commit/[0-9a-fA-F]{4,40})]
ORIGINAL_PATHS =
PATH.new(ENV["HOMEBREW_PATH"]).map do |p|
  begin
    Pathname.new(p).expand_path
  rescue
    nil
  end
end.compact.freeze
HOMEBREW_INTERNAL_COMMAND_ALIASES =
{
  "ls" => "list",
  "homepage" => "home",
  "-S" => "search",
  "up" => "update",
  "ln" => "link",
  "instal" => "install", # gem does the same
  "uninstal" => "uninstall",
  "rm" => "uninstall",
  "remove" => "uninstall",
  "configure" => "diy",
  "abv" => "info",
  "dr" => "doctor",
  "--repo" => "--repository",
  "environment" => "--env",
  "--config" => "config",
}.freeze
HOMEBREW_HELP =
<<-EOS.unindent.freeze
  Example usage:
    brew search [TEXT|/REGEX/]
    brew (info|home|options) [FORMULA...]
    brew install FORMULA...
    brew update
    brew upgrade [FORMULA...]
    brew uninstall FORMULA...
    brew list [FORMULA...]

  Troubleshooting:
    brew config
    brew doctor
    brew install -vd FORMULA

  Developers:
    brew create [URL [--no-fetch]]
    brew edit [FORMULA...]
    https://docs.brew.sh/Formula-Cookbook.html

  Further help:
    man brew
    brew help [COMMAND]
    brew home
EOS
HOMEBREW_RUBOCOP_VERSION =

RuboCop version used for brew style and brew cask style

"0.50.0"
HOMEBREW_RUBOCOP_CASK_VERSION =

has to be updated when RuboCop version changes

"~> 0.14.2"
OFFICIAL_TAPS =
%w[
  nginx
  php
  science
].freeze
OFFICIAL_CASK_TAPS =
%w[
  cask
  versions
].freeze
OFFICIAL_CMD_TAPS =
{
  "homebrew/bundle" => ["bundle"],
  "homebrew/test-bot" => ["test-bot"],
  "homebrew/services" => ["services"],
}.freeze
DEPRECATED_OFFICIAL_TAPS =
%w[
  apache
  binary
  completions
  devel-only
  dupes
  emacs
  fuse
  games
  gui
  head-only
  python
  tex
  versions
  x11
].freeze
HOMEBREW_TAP_FORMULA_REGEX =

match taps' formulae, e.g. someuser/sometap/someformula

%r{^([\w-]+)/([\w-]+)/([\w+-.@]+)$}
HOMEBREW_TAP_CASK_REGEX =

match taps' casks, e.g. someuser/sometap/somecask

%r{^([\w-]+)/([\w-]+)/([a-z0-9\-]+)$}
HOMEBREW_TAP_DIR_REGEX =

match taps' directory paths, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap

%r{#{Regexp.escape(HOMEBREW_LIBRARY)}/Taps/(?<user>[\w-]+)/(?<repo>[\w-]+)}
HOMEBREW_TAP_PATH_REGEX =

match taps' formula paths, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap/someformula

Regexp.new(HOMEBREW_TAP_DIR_REGEX.source + %r{/(.*)}.source)
HOMEBREW_CASK_TAP_CASK_REGEX =

match the default and the versions brew-cask tap e.g. Caskroom/cask or Caskroom/versions

%r{^([Cc]askroom)/(cask|versions)/([\w+-.]+)$}
BOTTLE_ERB =
<<-EOS.freeze
  bottle do
    <% if !root_url.start_with?(BottleSpecification::DEFAULT_DOMAIN) %>
    root_url "<%= root_url %>"
    <% end %>
    <% if prefix != BottleSpecification::DEFAULT_PREFIX %>
    prefix "<%= prefix %>"
    <% end %>
    <% if cellar.is_a? Symbol %>
    cellar :<%= cellar %>
    <% elsif cellar != BottleSpecification::DEFAULT_CELLAR %>
    cellar "<%= cellar %>"
    <% end %>
    <% if rebuild.positive? %>
    rebuild <%= rebuild %>
    <% end %>
    <% checksums.each do |checksum_type, checksum_values| %>
    <% checksum_values.each do |checksum_value| %>
    <% checksum, macos = checksum_value.shift %>
    <%= checksum_type %> "<%= checksum %>" => :<%= macos %>
    <% end %>
    <% end %>
  end
EOS
MAXIMUM_STRING_MATCHES =
100
BUG_REPORTS_URL =
"https://github.com/caskroom/homebrew-cask#reporting-bugs".freeze
PYTHON_VIRTUALENV_URL =
"https://files.pythonhosted.org/packages/d4/0c/9840c08189e030873387a73b90ada981885010dd9aea134d6de30cd24cb8/virtualenv-15.1.0.tar.gz".freeze
PYTHON_VIRTUALENV_SHA256 =
"02f8102c2436bb03b3ee6dede1919d1dac8a427541652e5ec95171ec8adbc93a".freeze

Instance Method Summary collapse

Methods included from EnvActivation

activate_extensions!, clear_sensitive_environment!, with_build_environment

Methods included from GitRepositoryExtension

git?, git_head, git_last_commit, git_last_commit_date, git_origin, git_short_head

Methods included from HomebrewArgvExtension

bottle_arch, build_all_from_source?, build_bottle?, build_devel?, build_formula_from_source?, build_from_source?, build_head?, build_stable?, build_universal?, casks, cc, collect_build_flags, debug?, dry_run?, env, fetch_head?, flag?, flags_only, force?, force_bottle?, formula_install_option_names, formulae, git?, homebrew_developer?, ignore_deps?, include?, interactive?, json, keep_tmp?, kegs, named, next, no_sandbox?, one?, only_deps?, options_only, quieter?, resolved_formulae, sandbox?, switch?, value, values, verbose?

Instance Method Details

#archs_for_command(cmd) ⇒ Object

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



386
387
388
389
# File 'Library/Homebrew/utils.rb', line 386

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

#capture_stderrObject



400
401
402
403
404
405
406
407
# File 'Library/Homebrew/utils.rb', line 400

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

#curl(*args) ⇒ Object



36
37
38
# File 'Library/Homebrew/utils/curl.rb', line 36

def curl(*args)
  safe_system(*curl_args(*args))
end

#curl_args(*extra_args, show_output: false, user_agent: :default) ⇒ Object



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'Library/Homebrew/utils/curl.rb', line 11

def curl_args(*extra_args, show_output: false, user_agent: :default)
  args = [
    curl_executable.to_s,
    "--show-error",
  ]

  args << "--user-agent" << case user_agent
  when :browser, :fake
    HOMEBREW_USER_AGENT_FAKE_SAFARI
  when :default
    HOMEBREW_USER_AGENT_CURL
  else
    user_agent
  end

  unless show_output
    args << "--fail"
    args << "--progress-bar" unless ARGV.verbose?
    args << "--verbose" if ENV["HOMEBREW_CURL_VERBOSE"]
    args << "--silent" if !$stdout.tty? || ENV["TRAVIS"]
  end

  args + extra_args
end

#curl_download(*args, to: nil, continue_at: "-", **options) ⇒ Object



40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'Library/Homebrew/utils/curl.rb', line 40

def curl_download(*args, to: nil, continue_at: "-", **options)
  had_incomplete_download ||= File.exist?(to)
  curl("--location", "--remote-time", "--continue-at", continue_at.to_s, "--output", to, *args, **options)
rescue ErrorDuringExecution
  # `curl` error 33: HTTP server doesn't seem to support byte ranges. Cannot resume.
  # HTTP status 416: Requested range not satisfiable
  if ($CHILD_STATUS.exitstatus == 33 || had_incomplete_download) && continue_at == "-"
    continue_at = 0
    had_incomplete_download = false
    retry
  end

  raise
end

#curl_executableObject



4
5
6
7
8
9
# File 'Library/Homebrew/utils/curl.rb', line 4

def curl_executable
  curl = Pathname.new ENV["HOMEBREW_CURL"]
  curl = Pathname.new "/usr/bin/curl" unless curl.exist?
  return curl if curl.executable?
  raise "#{curl} is not executable"
end

#curl_output(*args, **options) ⇒ Object



55
56
57
# File 'Library/Homebrew/utils/curl.rb', line 55

def curl_output(*args, **options)
  Open3.capture3(*curl_args(*args, show_output: true, **options))
end

#deep_merge_hashes(hash1, hash2) ⇒ Object



1
2
3
4
5
6
7
8
9
10
# File 'Library/Homebrew/utils/hash.rb', line 1

def deep_merge_hashes(hash1, hash2)
  merger = proc do |_key, v1, v2|
    if v1.is_a?(Hash) && v2.is_a?(Hash)
      v1.merge v2, &merger
    else
      v2
    end
  end
  hash1.merge hash2, &merger
end

#disk_usage_readable(size_in_bytes) ⇒ Object



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'Library/Homebrew/utils.rb', line 434

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("%.1f", size)}#{unit}"
  end
end

#exec_browser(*args) ⇒ Object



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

def exec_browser(*args)
  browser = ENV["HOMEBREW_BROWSER"]
  browser ||= OS::PATH_OPEN if defined?(OS::PATH_OPEN)
  return unless browser
  safe_exec(browser, *args)
end

#exec_editor(*args) ⇒ Object



359
360
361
362
# File 'Library/Homebrew/utils.rb', line 359

def exec_editor(*args)
  puts "Editing #{args.join "\n"}"
  with_homebrew_path { safe_exec(which_editor, *args) }
end

#gzip(*paths) ⇒ Object

GZips the given paths, and returns the gzipped paths



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

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

#ignore_interrupts(opt = nil) ⇒ Object



391
392
393
394
395
396
397
398
# File 'Library/Homebrew/utils.rb', line 391

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'Library/Homebrew/utils.rb', line 150

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


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
# File 'Library/Homebrew/utils.rb', line 497

def migrate_legacy_keg_symlinks_if_necessary
  legacy_linked_kegs = HOMEBREW_LIBRARY/"LinkedKegs"
  return unless legacy_linked_kegs.directory?

  HOMEBREW_LINKED_KEGS.mkpath unless legacy_linked_kegs.children.empty?
  legacy_linked_kegs.children.each do |link|
    name = link.basename.to_s
    src = begin
      link.realpath
    rescue Errno::ENOENT
      begin
        (HOMEBREW_PREFIX/"opt/#{name}").realpath
      rescue Errno::ENOENT
        begin
          Formulary.factory(name).installed_prefix
        rescue
          next
        end
      end
    end
    dst = HOMEBREW_LINKED_KEGS/name
    dst.unlink if dst.exist?
    FileUtils.ln_sf(src.relative_path_from(dst.parent), dst)
  end
  FileUtils.rm_rf legacy_linked_kegs

  legacy_pinned_kegs = HOMEBREW_LIBRARY/"PinnedKegs"
  return unless legacy_pinned_kegs.directory?

  HOMEBREW_PINNED_KEGS.mkpath unless legacy_pinned_kegs.children.empty?
  legacy_pinned_kegs.children.each do |link|
    name = link.basename.to_s
    src = link.realpath
    dst = HOMEBREW_PINNED_KEGS/name
    FileUtils.ln_sf(src.relative_path_from(dst.parent), dst)
  end
  FileUtils.rm_rf legacy_pinned_kegs
end

#nostdoutObject



409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'Library/Homebrew/utils.rb', line 409

def nostdout
  if ARGV.verbose?
    yield
  else
    begin
      out = $stdout.dup
      $stdout.reopen("/dev/null")
      yield
    ensure
      $stdout.reopen(out)
      out.close
    end
  end
end

#number_readable(number) ⇒ Object



457
458
459
460
461
# File 'Library/Homebrew/utils.rb', line 457

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) ⇒ Object

global methods



20
21
22
23
24
# File 'Library/Homebrew/cask/lib/hbc/utils.rb', line 20

def odebug(title, *sput)
  return unless ARGV.debug?
  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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'Library/Homebrew/utils.rb', line 58

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
  tap_message = nil
  caller_message = backtrace.detect do |line|
    next unless line =~ %r{^#{Regexp.escape(HOMEBREW_LIBRARY)}/Taps/([^/]+/[^/]+)/}
    tap = Tap.fetch Regexp.last_match(1)
    tap_message = "\nPlease report this to the #{tap} tap!"
    true
  end
  caller_message ||= backtrace.detect do |line|
    !line.start_with?("#{HOMEBREW_LIBRARY_PATH}/compat/")
  end
  caller_message ||= backtrace[1]

  message = <<-EOS.undent
    Calling #{method} is #{verb}!
    #{replacement_message}
    #{caller_message}#{tap_message}
  EOS

  if ARGV.homebrew_developer? || disable ||
     Homebrew.raise_deprecation_exceptions?
    raise MethodDeprecatedError, message
  elsif !Homebrew.auditing?
    opoo "#{message}\n"
  end
end

#odie(error) ⇒ Object



53
54
55
56
# File 'Library/Homebrew/utils.rb', line 53

def odie(error)
  onoe error
  exit 1
end

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



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

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

#ofail(error) ⇒ Object



48
49
50
51
# File 'Library/Homebrew/utils.rb', line 48

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

#oh1(title, options = {}) ⇒ Object



32
33
34
35
36
37
# File 'Library/Homebrew/utils.rb', line 32

def oh1(title, options = {})
  if $stdout.tty? && !ARGV.verbose? && options.fetch(:truncate, :auto) == :auto
    title = Tty.truncate(title)
  end
  puts Formatter.headline(title, color: :green)
end

#ohai(title, *sput) ⇒ Object



26
27
28
29
30
# File 'Library/Homebrew/utils.rb', line 26

def ohai(title, *sput)
  title = Tty.truncate(title) if $stdout.tty? && !ARGV.verbose?
  puts Formatter.headline(title, color: :blue)
  puts sput
end

#onoe(message) ⇒ Object



44
45
46
# File 'Library/Homebrew/utils.rb', line 44

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

#opoo(message) ⇒ Object

Print a warning (do this rarely)



40
41
42
# File 'Library/Homebrew/utils.rb', line 40

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

#paths(env_path = ENV["PATH"]) ⇒ Object



424
425
426
427
428
429
430
431
432
# File 'Library/Homebrew/utils.rb', line 424

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

#pretty_duration(s) ⇒ Object



135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'Library/Homebrew/utils.rb', line 135

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

  if s > 59
    m = s / 60
    s %= 60
    res = Formatter.pluralize(m, "minute")
    return res if s.zero?
    res << " "
  end

  res << Formatter.pluralize(s, "second")
end

#pretty_installed(f) ⇒ Object



115
116
117
118
119
120
121
122
123
# File 'Library/Homebrew/utils.rb', line 115

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

#pretty_uninstalled(f) ⇒ Object



125
126
127
128
129
130
131
132
133
# File 'Library/Homebrew/utils.rb', line 125

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

#quiet_system(cmd, *args) ⇒ Object

prints no output



301
302
303
304
305
306
307
308
# File 'Library/Homebrew/utils.rb', line 301

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

#require?(path) ⇒ Boolean

Returns:

  • (Boolean)


18
19
20
21
22
23
24
# File 'Library/Homebrew/utils.rb', line 18

def require?(path)
  return false if path.nil?
  require path
rescue LoadError => e
  # we should raise on syntax errors but not if the file doesn't exist.
  raise unless e.message.include?(path)
end

#run_as_not_developer(&_block) ⇒ Object



289
290
291
292
293
# File 'Library/Homebrew/utils.rb', line 289

def run_as_not_developer(&_block)
  with_env "HOMEBREW_DEVELOPER" => nil do
    yield
  end
end

#safe_exec(cmd, *args) ⇒ Object



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

def safe_exec(cmd, *args)
  # This buys us proper argument quoting and evaluation
  # of environment variables in the cmd parameter.
  exec "/bin/sh", "-c", "#{cmd} \"$@\"", "--", *args
end

#safe_system(cmd, *args) ⇒ Object

Kernel.system but with exceptions



296
297
298
# File 'Library/Homebrew/utils.rb', line 296

def safe_system(cmd, *args)
  Homebrew.system(cmd, *args) || raise(ErrorDuringExecution.new(cmd, args))
end

#shell_profileObject



560
561
562
# File 'Library/Homebrew/utils.rb', line 560

def shell_profile
  Utils::Shell.profile
end

#superenv?Boolean

Returns:

  • (Boolean)


6
7
8
# File 'Library/Homebrew/extend/ENV.rb', line 6

def superenv?
  ARGV.env != "std" && Superenv.bin
end

#tap_and_name_comparisonObject



564
565
566
567
568
569
570
571
572
573
574
# File 'Library/Homebrew/utils.rb', line 564

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.



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
# File 'Library/Homebrew/utils.rb', line 467

def truncate_text_to_approximate_size(s, max_bytes, options = {})
  front_weight = options.fetch(:front_weight, 0.5)
  if front_weight < 0.0 || front_weight > 1.0
    raise "opts[:front_weight] must be between 0.0 and 1.0"
  end
  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..-1]
  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..-1]
  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



310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'Library/Homebrew/utils.rb', line 310

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



324
325
326
327
328
329
330
331
332
333
334
335
# File 'Library/Homebrew/utils.rb', line 324

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'Library/Homebrew/utils.rb', line 337

def which_editor
  editor = ENV.values_at("HOMEBREW_EDITOR", "HOMEBREW_VISUAL")
              .compact
              .reject(&:empty?)
              .first
  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 ||= "/usr/bin/vim"

  opoo <<-EOS.undent
    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) ⇒ Object



281
282
283
284
285
286
287
# File 'Library/Homebrew/utils.rb', line 281

def with_custom_locale(locale)
  old_locale = ENV["LC_ALL"]
  ENV["LC_ALL"] = locale
  yield
ensure
  ENV["LC_ALL"] = old_locale
end

#with_env(hash) ⇒ Object

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

Note that this method is not thread-safe - other threads which happen to be scheduled during the block will also see these environment variables.



546
547
548
549
550
551
552
553
554
555
556
557
558
# File 'Library/Homebrew/utils.rb', line 546

def with_env(hash)
  old_values = {}
  begin
    hash.each do |key, value|
      old_values[key] = ENV.delete(key)
      ENV[key] = value
    end

    yield if block_given?
  ensure
    ENV.update(old_values)
  end
end

#with_homebrew_pathObject



273
274
275
276
277
278
279
# File 'Library/Homebrew/utils.rb', line 273

def with_homebrew_path
  old_path = ENV["PATH"]
  ENV["PATH"] = ENV["HOMEBREW_PATH"]
  yield
ensure
  ENV["PATH"] = old_path
end

#with_system_pathObject



265
266
267
268
269
270
271
# File 'Library/Homebrew/utils.rb', line 265

def with_system_path
  old_path = ENV["PATH"]
  ENV["PATH"] = PATH.new("/usr/bin", "/bin")
  yield
ensure
  ENV["PATH"] = old_path
end