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::DSL, Cask::Info, Cask::Installer, Cask::Installer, Cask::List, Cask::Metadata, Cask::Migrator, Cask::Pkg, Cask::Quarantine, Cask::Reinstall, Cask::Staged, Cask::Uninstall, Cask::Upgrade, Cask::Utils, Cleaner, DependentsMessage, Downloadable, EmbeddedPatch, ExternalPatch, Formula, Formula, FormulaInstaller, FormulaVersions, Formulary, Formulary, Formulary::FormulaLoader, Formulary::FromBottleLoader, Formulary::FromNameLoader, GitHub, GitHub::API, GitHub::API::Error, GitHubPackages, GitHubReleases, Homebrew, Homebrew::API, Homebrew::AbstractCommand, Homebrew::Aliases, Homebrew::Aliases::Alias, Homebrew::Assertions, Homebrew::Attestation, Homebrew::Bump, Homebrew::Bundle::Brew, Homebrew::Bundle::Brew::Services, Homebrew::Bundle::Cask, Homebrew::Bundle::Commands::Exec, Homebrew::Bundle::Installer, Homebrew::Bundle::Remover, Homebrew::CLI::NamedArgs, Homebrew::CLI::Parser, Homebrew::Cleanup, Homebrew::Cleanup, Homebrew::Completions, Homebrew::Diagnostic, Homebrew::Diagnostic::Checks, Homebrew::DownloadQueue, Homebrew::EnvConfig, Homebrew::EnvConfig, Homebrew::ExecutablesDB, Homebrew::FormulaAuditor, Homebrew::FormulaCreator, Homebrew::Help, Homebrew::Install, Homebrew::Livecheck, Homebrew::MissingFormula, Homebrew::Reinstall, Homebrew::RetryableDownload, Homebrew::Search, Homebrew::Services::Cli, Homebrew::Services::Commands::List, Homebrew::Services::FormulaWrapper, Homebrew::Services::System, Homebrew::Style, Homebrew::TestBot::Test, Homebrew::Uninstall, Homebrew::UnversionedCaskChecker, Homebrew::Upgrade, Keg, Keg, Language::Node, Language::Python, LinkageChecker, LockFile, Messages, Migrator, Migrator, Mktemp, OS::Linux, OS::Mac, OS::Mac::CLT, OS::Mac::Readall::ClassMethods, OS::Mac::Reinstall::ClassMethods, Pathname, PyPI, PyPI::Package, Readall, Repology, Reporter, ReporterHub, Requirement, Resource, SBOM, Sandbox, SharedEnvExtension, StringInreplaceExtension, Superenv, SystemCommand::Result, Tap, Tap, UnpackStrategy, UnpackStrategy, UnpackStrategy::Dmg::Bom, Analytics, Attestation, Backtrace, Curl, Curl, Gzip, Link, Utils::Output, 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:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'utils/output.rb', line 113

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) 


32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'utils/output.rb', line 32

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


145
146
147
148
149
150
151
152
153
154
155
156
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
 
# File 'utils/output.rb', line 145

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.

Parameters:

Returns:

  • (T.noreturn) 


135
136
137
138
 
# File 'utils/output.rb', line 135

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


228
229
230
231
232
233
234
 
# File 'utils/output.rb', line 228

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:



107
108
109
110
 
# File 'utils/output.rb', line 107

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) 


58
59
60
 
# File 'utils/output.rb', line 58

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:



46
47
48
49
50
51
52
53
54
55
 
# File 'utils/output.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) ⇒ 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) 


26
27
28
29
 
# File 'utils/output.rb', line 26

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.

Parameters:

Returns:



14
15
16
17
18
19
20
21
22
23
 
# File 'utils/output.rb', line 14

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

This method returns an undefined value.

Print an error message.

Parameters:



92
93
94
95
96
97
98
99
100
101
 
# File 'utils/output.rb', line 92

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.

Parameters:



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

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:



81
82
83
84
85
86
 
# File 'utils/output.rb', line 81

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

  opoo(message)
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:



270
271
272
273
274
275
276
 
# File 'utils/output.rb', line 270

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:



279
280
281
282
283
284
285
 
# File 'utils/output.rb', line 279

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:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'utils/output.rb', line 306

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_install_status(string, installed:, outdated: 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:

  • string (String)
  • installed (Boolean)
  • outdated (Boolean) (defaults to: false)

Returns:



299
300
301
302
303
 
# File 'utils/output.rb', line 299

def pretty_install_status(string, installed:, outdated: false)
  return pretty_uninstalled(string) unless installed

  outdated ? pretty_upgradable(string) : pretty_installed(string)
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.

Parameters:

Returns:



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

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_outdated(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:



248
249
250
251
252
253
254
255
256
 
# File 'utils/output.rb', line 248

def pretty_outdated(string)
  if !$stdout.tty?
    string
  elsif Homebrew::EnvConfig.no_emoji?
    Formatter.error("#{Tty.bold}#{string} (outdated)#{Tty.reset}")
  else
    "#{Tty.bold}#{string} #{Formatter.warning("⚠")}#{Tty.reset}"
  end
end

#pretty_uninstalled(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:



288
289
290
291
292
293
294
295
296
 
# File 'utils/output.rb', line 288

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

#pretty_upgradable(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:



259
260
261
262
263
264
265
266
267
 
# File 'utils/output.rb', line 259

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