Module: Utils::Output::Mixin Private

Extended by:
T::Helpers
Included in:
AbstractDownloadStrategy, BottleSpecification, Build, BuildError, CPAN, Cask::Artifact::AbstractArtifact, Cask::Artifact::AbstractArtifact, Cask::Audit, Cask::Auditor, Cask::Cask, Cask::CaskLoader, Cask::CaskLoader::FromNameLoader, Cask::CaskLoader::ILoader, Cask::Caskroom, Cask::Config, Cask::DSL, Cask::DSL::DependsOn, Cask::Info, Cask::Installer, Cask::Installer, Cask::List, Cask::Metadata, Cask::Migrator, Cask::Migrator, Cask::Pkg, Cask::Quarantine, Cask::Reinstall, Cask::Staged, Cask::Uninstall, Cask::Upgrade, Cask::Utils, Cleaner, DependentsMessage, DevelopmentTools, Downloadable, Downloadable::VerificationCache, EmbeddedPatch, ExternalPatch, Formula, Formula, FormulaInstaller, FormulaVersions, Formulary, Formulary, Formulary::FormulaLoader, Formulary::FromBottleLoader, Formulary::FromNameLoader, GitHub, GitHub::API, GitHub::API::Error, GitHubPackages, GitHubReleases, GitHubRunnerMatrix, Homebrew, Homebrew::API, Homebrew::API::Cask::CaskStructGenerator, Homebrew::API::Cask::CaskStructGenerator, Homebrew::AbstractCommand, Homebrew::AbstractSubcommand, Homebrew::Aliases, Homebrew::Aliases::Alias, Homebrew::Ask, Homebrew::Assertions, Homebrew::Attestation, Homebrew::Bump, Homebrew::Bundle::Brew, Homebrew::Bundle::Brew::Services, Homebrew::Bundle::Cask, Homebrew::Bundle::Installer, Homebrew::Bundle::Remover, Homebrew::CLI::NamedArgs, Homebrew::CLI::Parser, Homebrew::Cleanup, Homebrew::Cleanup, Homebrew::Cmd::Bundle, Homebrew::Cmd::Bundle::ExecSubcommand, Homebrew::Cmd::Services, Homebrew::Cmd::Services::ListSubcommand, Homebrew::Completions, Homebrew::Diagnostic, Homebrew::Diagnostic::Checks, Homebrew::DownloadQueue, Homebrew::EnvConfig, Homebrew::EnvConfig, Homebrew::ExecutablesDB, Homebrew::FormulaAuditor, Homebrew::FormulaCreator, Homebrew::Help, Homebrew::Install, Homebrew::InstallSteps::Runner, Homebrew::Livecheck, Homebrew::MissingFormula, Homebrew::Reinstall, Homebrew::RetryableDownload, Homebrew::Search, Homebrew::Service, Homebrew::Services::Cli, Homebrew::Services::FormulaWrapper, Homebrew::Services::System, Homebrew::Style, Homebrew::TestBot, Homebrew::TestBot::Test, Homebrew::Trust, Homebrew::Uninstall, Homebrew::UnversionedCaskChecker, Homebrew::Upgrade, Homebrew::Vulns::CachedFeed, Homebrew::Vulns::Match, Homebrew::Vulns::Vulnerability, Keg, Keg, Language::Node, Language::Python, LinkageChecker, LockFile, MacOSRequirement, Messages, Migrator, Migrator, Mktemp, OS::Linux, OS::Mac, OS::Mac::CLT, OS::Mac::Cask::Quarantine::ClassMethods, OS::Mac::Readall::ClassMethods, OS::Mac::Reinstall::ClassMethods, Pathname, PyPI, PyPI::Package, Readall, Repology, Reporter, ReporterHub, Requirement, Resource, SBOM, Sandbox, Sandbox, Sandbox::Landlock, SharedEnvExtension, StringInreplaceExtension, Superenv, SystemCommand::Result, Tap, Tap, UnpackStrategy, UnpackStrategy, UnpackStrategy::Dmg::Bom, Analytics, Attestation, Backtrace, Curl, Curl, Gzip, Link, Utils::Output, PortableRuby, Svn, Tar
Defined in:
utils/output.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.

Mixin used to add these helpers to stdout and stderr.

Instance Method Summary collapse

Instance Method Details

#issue_reporting_message(issues_url, homebrew: false, read_this: false) ⇒ String

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.

Parameters:

  • issues_url (String)
  • homebrew (Boolean) (defaults to: false)
  • read_this (Boolean) (defaults to: false)

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'utils/output.rb', line 124

def issue_reporting_message(issues_url, homebrew: false, read_this: false)
  formatted_issues_url = Formatter.url(issues_url)

  if read_this
    Formatter.error(formatted_issues_url, label: "READ THIS")
  elsif homebrew
    <<~EOS
      #{Tty.bold}Please report this issue:#{Tty.reset}
        #{formatted_issues_url}
    EOS
  else
    <<~EOS
      If reporting this issue please do so at (not Homebrew/* repositories):
        #{formatted_issues_url}
    EOS
  end
end

#odebug(title, *sput, always_display: false) ⇒ void

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.

This method returns an undefined value.

Parameters:

  • title (String, Exception)
  • sput (T.anything)
  • always_display (Boolean) (defaults to: false) 


41
42
43
44
45
46
 
# File 'utils/output.rb', line 41

def odebug(title, *sput, always_display: false)
  return if !always_display && !output_context?(:debug?)

  $stderr.puts Formatter.headline(title.to_s, 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)) ⇒ void

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.

This method returns an undefined value.

Output a deprecation warning/error message.

Parameters:

  • method (String)
  • replacement (String, Symbol, nil) (defaults to: nil)
  • disable (Boolean) (defaults to: false)
  • disable_on (Time, nil) (defaults to: nil)
  • disable_for_developers (Boolean) (defaults to: true)
  • caller (Array<String>) (defaults to: send(:caller)) 


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

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

    require "tap"

    tap = Tap.fetch(match[:user], match[:repository])
    tap_message = "\nPlease report this issue to the #{tap.full_name} tap"
    tap_message += " (not Homebrew/* repositories)" unless tap.official?
    tap_message += ", or even better, submit a PR to fix it" if replacement
    tap_message << ":\n  #{line.sub(/^(.*:\d+):.*$/, '\1')}\n\n"
    break
  end
  file, line, = backtrace.first.split(":")
  line = line.to_i if line.present?

  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?
    require "utils/github/actions"
    GitHub::Actions.puts_annotation_if_env_set!(:error, message, file:, line:)
    exception = MethodDeprecatedError.new(message)
    exception.set_backtrace(backtrace)
    raise exception
  elsif !Homebrew.auditing?
    opoo message
  end
end

#odie(error) ⇒ T.noreturn

Print an error message and fail immediately.

Keep in sync with odie in Library/Homebrew/utils.sh.

Parameters:

Returns:

  • (T.noreturn) 


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

def odie(error)
  onoe error
  exit 1
end

#odisabled(method, replacement = nil, disable_on: nil, disable_for_developers: true, caller: send(:caller)) ⇒ void

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.

This method returns an undefined value.

Parameters:

  • method (String)
  • replacement (String, Symbol, nil) (defaults to: nil)
  • disable_on (Time, nil) (defaults to: nil)
  • disable_for_developers (Boolean) (defaults to: true)
  • caller (Array<String>) (defaults to: send(:caller)) 


240
241
242
243
244
245
246
 
# File 'utils/output.rb', line 240

def odisabled(method, replacement = nil,
              disable_on:             nil,
              disable_for_developers: true,
              caller:                 send(:caller))
  # This odeprecated should stick around indefinitely.
  odeprecated(method, replacement, disable: true, disable_on:, disable_for_developers:, caller:)
end

#ofail(error) ⇒ void

This method returns an undefined value.

Print an error message and fail at the end of the program.

Parameters:



118
119
120
121
 
# File 'utils/output.rb', line 118

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

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

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.

This method returns an undefined value.

Parameters:

  • title (String)
  • truncate (Symbol, Boolean) (defaults to: :auto) 


55
56
57
 
# File 'utils/output.rb', line 55

def oh1(title, truncate: :auto)
  puts oh1_title(title, truncate:)
end

#oh1_title(title, truncate: :auto) ⇒ String

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.

Parameters:

  • title (String)
  • truncate (Symbol, Boolean) (defaults to: :auto)

Returns:



49
50
51
52
 
# File 'utils/output.rb', line 49

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

#ohai(title, *sput) ⇒ void

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.

This method returns an undefined value.

Parameters:

  • title (String, Exception)
  • sput (T.anything) 


35
36
37
38
 
# File 'utils/output.rb', line 35

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

#ohai_title(title) ⇒ String

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.

Keep in sync with ohai in Library/Homebrew/utils.sh.

Parameters:

Returns:



29
30
31
32
 
# File 'utils/output.rb', line 29

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

#onoe(message) ⇒ void

This method returns an undefined value.

Print an error message.

Keep in sync with onoe in Library/Homebrew/utils.sh.

Parameters:



103
104
105
106
107
108
109
110
111
112
 
# File 'utils/output.rb', line 103

def onoe(message)
  require "utils/github/actions"
  return if GitHub::Actions.puts_annotation_if_env_set!(:error, message.to_s)

  require "utils/formatter"

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

#opoo(message) ⇒ void

This method returns an undefined value.

Print a warning message.

Keep in sync with opoo in Library/Homebrew/utils.sh.

Parameters:



64
65
66
67
68
69
70
71
72
73
 
# File 'utils/output.rb', line 64

def opoo(message)
  require "utils/github/actions"
  return if GitHub::Actions.puts_annotation_if_env_set!(:warning, message.to_s)

  require "utils/formatter"

  Tty.with($stderr) do |stderr|
    stderr.puts Formatter.warning(message, 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.

Parameters:



91
92
93
94
95
96
 
# File 'utils/output.rb', line 91

def opoo_outside_github_actions(message)
  require "utils/github/actions"
  return if GitHub::Actions.env_set?

  opoo(message)
end

#opoo_without_github_actions_annotation(message) ⇒ void

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.

This method returns an undefined value.

Parameters:



76
77
78
79
80
81
82
83
84
85
 
# File 'utils/output.rb', line 76

def opoo_without_github_actions_annotation(message)
  require "utils/github/actions"
  return opoo(message) unless GitHub::Actions.env_set?

  require "utils/formatter"

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

#pretty_cannot_install(string, bold: true) ⇒ String

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.

Parameters:

  • string (String)
  • bold (Boolean) (defaults to: true)

Returns:



292
293
294
295
296
297
298
299
300
301
 
# File 'utils/output.rb', line 292

def pretty_cannot_install(string, bold: true)
  weight = bold ? Tty.bold.to_s : ""
  if !$stdout.tty?
    string
  elsif Homebrew::EnvConfig.no_emoji?
    Formatter.error("#{weight}#{string} (can't be installed)#{Tty.reset}")
  else
    "#{weight}#{string} #{Formatter.error("⊘")}#{Tty.reset}"
  end
end

#pretty_deprecated(string) ⇒ String

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.

Parameters:

Returns:



274
275
276
277
278
279
280
 
# File 'utils/output.rb', line 274

def pretty_deprecated(string)
  if $stdout.tty?
    "#{string} #{Formatter.warning("(deprecated)")}"
  else
    string
  end
end

#pretty_disabled(string) ⇒ String

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.

Parameters:

Returns:



283
284
285
286
287
288
289
 
# File 'utils/output.rb', line 283

def pretty_disabled(string)
  if $stdout.tty?
    "#{string} #{Formatter.error("(disabled)")}"
  else
    string
  end
end

#pretty_duration(seconds) ⇒ String

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.

Parameters:

Returns:



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
 
# File 'utils/output.rb', line 370

def pretty_duration(seconds)
  seconds = seconds.to_i
  hide_seconds = seconds > 300

  minutes, seconds = seconds.divmod(60)
  hours, minutes = minutes.divmod(60)

  res = +""

  if hours.positive?
    res << Utils.pluralize("hour", hours, include_count: true)
    return res.freeze if minutes.zero?

    res << " " << Utils.pluralize("minute", minutes, include_count: true)
    return res.freeze
  end

  if minutes.positive?
    res << Utils.pluralize("minute", minutes, include_count: true)
    return res.freeze if hide_seconds || seconds.zero?

    res << " "
  end

  res << Utils.pluralize("second", seconds, include_count: true)
  res.freeze
end

#pretty_install_status(string, installed:, warning: false, outdated: false, deprecated: false, disabled: false, can_install: true, mark_uninstalled: false, bold: nil) ⇒ String

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.

Parameters:

  • string (String)
  • installed (Boolean)
  • warning (Boolean) (defaults to: false)
  • outdated (Boolean) (defaults to: false)
  • deprecated (Boolean) (defaults to: false)
  • disabled (Boolean) (defaults to: false)
  • can_install (Boolean) (defaults to: true)
  • mark_uninstalled (Boolean) (defaults to: false)
  • bold (Boolean, nil) (defaults to: nil)

Returns:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'utils/output.rb', line 343

def pretty_install_status(string, installed:, warning: false, outdated: false, deprecated: false,
                          disabled: false, can_install: true, mark_uninstalled: false,
                          bold: nil)
  bold = installed if bold.nil?
  status = if warning
    pretty_warning(string, bold:)
  elsif installed && outdated
    pretty_upgradable(string, bold:)
  elsif installed
    pretty_installed(string)
  elsif !can_install
    pretty_cannot_install(string, bold:)
  elsif mark_uninstalled
    pretty_uninstalled(string, bold:)
  else
    pretty_unmarked(string, bold:)
  end
  if disabled
    pretty_disabled(status)
  elsif deprecated
    pretty_deprecated(status)
  else
    status
  end
end

#pretty_installed(string) ⇒ String

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.

Keep status labels, colours and emoji in sync with pretty_installed in Library/Homebrew/utils.sh.

Parameters:

Returns:



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

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

#pretty_uninstalled(string, bold: true) ⇒ String

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.

Keep status labels, colours and emoji in sync with pretty_uninstalled in Library/Homebrew/utils.sh.

Parameters:

  • string (String)
  • bold (Boolean) (defaults to: true)

Returns:



306
307
308
309
310
311
312
313
314
315
 
# File 'utils/output.rb', line 306

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

#pretty_unmarked(string, bold: true) ⇒ String

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.

Parameters:

  • string (String)
  • bold (Boolean) (defaults to: true)

Returns:



318
319
320
321
322
323
324
 
# File 'utils/output.rb', line 318

def pretty_unmarked(string, bold: true)
  if bold && $stdout.tty?
    "#{Tty.bold}#{string}#{Tty.reset}"
  else
    string
  end
end

#pretty_upgradable(string, bold: true) ⇒ String

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.

Parameters:

  • string (String)
  • bold (Boolean) (defaults to: true)

Returns:



262
263
264
265
266
267
268
269
270
271
 
# File 'utils/output.rb', line 262

def pretty_upgradable(string, bold: true)
  weight = bold ? Tty.bold.to_s : ""
  if !$stdout.tty?
    string
  elsif Homebrew::EnvConfig.no_emoji?
    "#{weight}#{string} (upgradable)#{Tty.reset}"
  else
    "#{weight}#{string} #{Formatter.success("↑")}#{Tty.reset}"
  end
end

#pretty_warning(string, bold: true) ⇒ String

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.

Parameters:

  • string (String)
  • bold (Boolean) (defaults to: true)

Returns:



327
328
329
330
331
332
333
334
335
336
 
# File 'utils/output.rb', line 327

def pretty_warning(string, bold: true)
  weight = bold ? Tty.bold.to_s : ""
  if !$stdout.tty?
    string
  elsif Homebrew::EnvConfig.no_emoji?
    Formatter.warning("#{weight}#{string} (warning)#{Tty.reset}")
  else
    "#{weight}#{string} #{Formatter.warning("⚠")}#{Tty.reset}"
  end
end