Merge pull request #6367 from reitermarkus/kernel
Move global methods into `Kernel` module.
This commit is contained in:
Markus Reiter
GitHub
commit
0054dd32e1
@ -16,177 +16,6 @@ require "utils/tty"
|
||||
require "tap_constants"
|
||||
require "time"
|
||||
|
||||
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
|
||||
|
||||
def ohai_title(title)
|
||||
title = Tty.truncate(title) if $stdout.tty? && !ARGV.verbose?
|
||||
Formatter.headline(title, color: :blue)
|
||||
end
|
||||
|
||||
def ohai(title, *sput)
|
||||
puts ohai_title(title)
|
||||
puts sput
|
||||
end
|
||||
|
||||
def odebug(title, *sput)
|
||||
return unless ARGV.debug?
|
||||
|
||||
puts Formatter.headline(title, color: :magenta)
|
||||
puts sput unless sput.empty?
|
||||
end
|
||||
|
||||
def oh1(title, options = {})
|
||||
title = Tty.truncate(title) if $stdout.tty? && !ARGV.verbose? && options.fetch(:truncate, :auto) == :auto
|
||||
puts Formatter.headline(title, color: :green)
|
||||
end
|
||||
|
||||
# Print a warning (do this rarely)
|
||||
def opoo(message)
|
||||
$stderr.puts Formatter.warning(message, label: "Warning")
|
||||
end
|
||||
|
||||
def onoe(message)
|
||||
$stderr.puts Formatter.error(message, label: "Error")
|
||||
end
|
||||
|
||||
def ofail(error)
|
||||
onoe error
|
||||
Homebrew.failed = true
|
||||
end
|
||||
|
||||
def odie(error)
|
||||
onoe error
|
||||
exit 1
|
||||
end
|
||||
|
||||
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 to the #{tap} tap"
|
||||
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 ARGV.homebrew_developer? || disable || Homebrew.raise_deprecation_exceptions?
|
||||
exception = MethodDeprecatedError.new(message)
|
||||
exception.set_backtrace(backtrace)
|
||||
raise exception
|
||||
elsif !Homebrew.auditing?
|
||||
opoo message
|
||||
end
|
||||
end
|
||||
|
||||
def odisabled(method, replacement = nil, options = {})
|
||||
options = { disable: true, caller: caller }.merge(options)
|
||||
odeprecated(method, replacement, options)
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
module Homebrew
|
||||
module_function
|
||||
|
||||
@ -245,36 +74,208 @@ module Homebrew
|
||||
# rubocop:enable Style/GlobalVars
|
||||
end
|
||||
|
||||
def with_homebrew_path
|
||||
module Kernel
|
||||
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
|
||||
|
||||
def ohai_title(title)
|
||||
title = Tty.truncate(title) if $stdout.tty? && !ARGV.verbose?
|
||||
Formatter.headline(title, color: :blue)
|
||||
end
|
||||
|
||||
def ohai(title, *sput)
|
||||
puts ohai_title(title)
|
||||
puts sput
|
||||
end
|
||||
|
||||
def odebug(title, *sput)
|
||||
return unless ARGV.debug?
|
||||
|
||||
puts Formatter.headline(title, color: :magenta)
|
||||
puts sput unless sput.empty?
|
||||
end
|
||||
|
||||
def oh1(title, options = {})
|
||||
title = Tty.truncate(title) if $stdout.tty? && !ARGV.verbose? && options.fetch(:truncate, :auto) == :auto
|
||||
puts Formatter.headline(title, color: :green)
|
||||
end
|
||||
|
||||
# Print a warning (do this rarely)
|
||||
def opoo(message)
|
||||
$stderr.puts Formatter.warning(message, label: "Warning")
|
||||
end
|
||||
|
||||
def onoe(message)
|
||||
$stderr.puts Formatter.error(message, label: "Error")
|
||||
end
|
||||
|
||||
def ofail(error)
|
||||
onoe error
|
||||
Homebrew.failed = true
|
||||
end
|
||||
|
||||
def odie(error)
|
||||
onoe error
|
||||
exit 1
|
||||
end
|
||||
|
||||
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 to the #{tap} tap"
|
||||
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 ARGV.homebrew_developer? || disable || Homebrew.raise_deprecation_exceptions?
|
||||
exception = MethodDeprecatedError.new(message)
|
||||
exception.set_backtrace(backtrace)
|
||||
raise exception
|
||||
elsif !Homebrew.auditing?
|
||||
opoo message
|
||||
end
|
||||
end
|
||||
|
||||
def odisabled(method, replacement = nil, options = {})
|
||||
options = { disable: true, caller: caller }.merge(options)
|
||||
odeprecated(method, replacement, options)
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
def with_homebrew_path
|
||||
with_env(PATH: PATH.new(ENV["HOMEBREW_PATH"])) do
|
||||
yield
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def with_custom_locale(locale)
|
||||
def with_custom_locale(locale)
|
||||
with_env(LC_ALL: locale) do
|
||||
yield
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Kernel.system but with exceptions
|
||||
def safe_system(cmd, *args, **options)
|
||||
# Kernel.system but with exceptions
|
||||
def safe_system(cmd, *args, **options)
|
||||
return if Homebrew.system(cmd, *args, **options)
|
||||
|
||||
raise ErrorDuringExecution.new([cmd, *args], status: $CHILD_STATUS)
|
||||
end
|
||||
end
|
||||
|
||||
# Prints no output
|
||||
def quiet_system(cmd, *args)
|
||||
# Prints no output
|
||||
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
|
||||
end
|
||||
|
||||
def which(cmd, path = ENV["PATH"])
|
||||
def which(cmd, path = ENV["PATH"])
|
||||
PATH.new(path).each do |p|
|
||||
begin
|
||||
pcmd = File.expand_path(cmd, p)
|
||||
@ -286,9 +287,9 @@ def which(cmd, path = ENV["PATH"])
|
||||
return Pathname.new(pcmd) if File.file?(pcmd) && File.executable?(pcmd)
|
||||
end
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
def which_all(cmd, path = ENV["PATH"])
|
||||
def which_all(cmd, path = ENV["PATH"])
|
||||
PATH.new(path).map do |p|
|
||||
begin
|
||||
pcmd = File.expand_path(cmd, p)
|
||||
@ -299,9 +300,9 @@ def which_all(cmd, path = ENV["PATH"])
|
||||
end
|
||||
Pathname.new(pcmd) if File.file?(pcmd) && File.executable?(pcmd)
|
||||
end.compact.uniq
|
||||
end
|
||||
end
|
||||
|
||||
def which_editor
|
||||
def which_editor
|
||||
editor = ENV.values_at("HOMEBREW_EDITOR", "HOMEBREW_VISUAL")
|
||||
.compact
|
||||
.reject(&:empty?)
|
||||
@ -321,14 +322,14 @@ def which_editor
|
||||
EOS
|
||||
|
||||
editor
|
||||
end
|
||||
end
|
||||
|
||||
def exec_editor(*args)
|
||||
def exec_editor(*args)
|
||||
puts "Editing #{args.join "\n"}"
|
||||
with_homebrew_path { safe_system(*which_editor.shellsplit, *args) }
|
||||
end
|
||||
end
|
||||
|
||||
def exec_browser(*args)
|
||||
def exec_browser(*args)
|
||||
browser = ENV["HOMEBREW_BROWSER"]
|
||||
browser ||= OS::PATH_OPEN if defined?(OS::PATH_OPEN)
|
||||
return unless browser
|
||||
@ -336,41 +337,41 @@ def exec_browser(*args)
|
||||
ENV["DISPLAY"] = ENV["HOMEBREW_DISPLAY"]
|
||||
|
||||
safe_system(browser, *args)
|
||||
end
|
||||
end
|
||||
|
||||
# GZips the given paths, and returns the gzipped paths
|
||||
def gzip(*paths)
|
||||
# GZips the given paths, and returns the gzipped paths
|
||||
def gzip(*paths)
|
||||
paths.map do |path|
|
||||
safe_system "gzip", path
|
||||
Pathname.new("#{path}.gz")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Returns array of architectures that the given command or library is built for.
|
||||
def archs_for_command(cmd)
|
||||
# Returns array of architectures that the given command or library is built for.
|
||||
def archs_for_command(cmd)
|
||||
cmd = which(cmd) unless Pathname.new(cmd).absolute?
|
||||
Pathname.new(cmd).archs
|
||||
end
|
||||
end
|
||||
|
||||
def ignore_interrupts(opt = nil)
|
||||
def ignore_interrupts(opt = nil)
|
||||
std_trap = trap("INT") do
|
||||
puts "One sec, just cleaning up" unless opt == :quietly
|
||||
end
|
||||
yield
|
||||
ensure
|
||||
ensure
|
||||
trap("INT", std_trap)
|
||||
end
|
||||
end
|
||||
|
||||
def capture_stderr
|
||||
def capture_stderr
|
||||
old = $stderr
|
||||
$stderr = StringIO.new
|
||||
yield
|
||||
$stderr.string
|
||||
ensure
|
||||
ensure
|
||||
$stderr = old
|
||||
end
|
||||
end
|
||||
|
||||
def nostdout
|
||||
def nostdout
|
||||
if ARGV.verbose?
|
||||
yield
|
||||
else
|
||||
@ -383,9 +384,9 @@ def nostdout
|
||||
out.close
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def paths
|
||||
def paths
|
||||
@paths ||= PATH.new(ENV["HOMEBREW_PATH"]).map do |p|
|
||||
begin
|
||||
File.expand_path(p).chomp("/")
|
||||
@ -393,9 +394,9 @@ def paths
|
||||
onoe "The following PATH component is invalid: #{p}"
|
||||
end
|
||||
end.uniq.compact
|
||||
end
|
||||
end
|
||||
|
||||
def disk_usage_readable(size_in_bytes)
|
||||
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"
|
||||
@ -416,19 +417,19 @@ def disk_usage_readable(size_in_bytes)
|
||||
else
|
||||
"#{format("%.1f", size)}#{unit}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def number_readable(number)
|
||||
def number_readable(number)
|
||||
numstr = number.to_i.to_s
|
||||
(numstr.size - 3).step(1, -3) { |i| numstr.insert(i, ",") }
|
||||
numstr
|
||||
end
|
||||
end
|
||||
|
||||
# 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.
|
||||
def truncate_text_to_approximate_size(s, max_bytes, options = {})
|
||||
# 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.
|
||||
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
|
||||
@ -454,19 +455,19 @@ def truncate_text_to_approximate_size(s, max_bytes, options = {})
|
||||
out.encode!("UTF-16", invalid: :replace)
|
||||
out.encode!("UTF-8")
|
||||
out
|
||||
end
|
||||
end
|
||||
|
||||
# Calls the given block with the passed environment variables
|
||||
# added to ENV, then restores ENV afterwards.
|
||||
# Example:
|
||||
# <pre>with_env(PATH: "/bin") do
|
||||
# system "echo $PATH"
|
||||
# end</pre>
|
||||
#
|
||||
# Note that this method is *not* thread-safe - other threads
|
||||
# which happen to be scheduled during the block will also
|
||||
# see these environment variables.
|
||||
def with_env(hash)
|
||||
# Calls the given block with the passed environment variables
|
||||
# added to ENV, then restores ENV afterwards.
|
||||
# Example:
|
||||
# <pre>with_env(PATH: "/bin") do
|
||||
# system "echo $PATH"
|
||||
# end</pre>
|
||||
#
|
||||
# Note that this method is *not* thread-safe - other threads
|
||||
# which happen to be scheduled during the block will also
|
||||
# see these environment variables.
|
||||
def with_env(hash)
|
||||
old_values = {}
|
||||
begin
|
||||
hash.each do |key, value|
|
||||
@ -479,13 +480,13 @@ def with_env(hash)
|
||||
ensure
|
||||
ENV.update(old_values)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def shell_profile
|
||||
def shell_profile
|
||||
Utils::Shell.profile
|
||||
end
|
||||
end
|
||||
|
||||
def tap_and_name_comparison
|
||||
def tap_and_name_comparison
|
||||
proc do |a, b|
|
||||
if a.include?("/") && !b.include?("/")
|
||||
1
|
||||
@ -495,14 +496,15 @@ def tap_and_name_comparison
|
||||
a <=> b
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def command_help_lines(path)
|
||||
def command_help_lines(path)
|
||||
path.read.lines.grep(/^#:/).map { |line| line.slice(2..-1) }
|
||||
end
|
||||
end
|
||||
|
||||
def redact_secrets(input, secrets)
|
||||
def redact_secrets(input, secrets)
|
||||
secrets.compact
|
||||
.reduce(input) { |str, secret| str.gsub secret, "******" }
|
||||
.freeze
|
||||
end
|
||||
end
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user