45978435e7
- Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
67 lines
1.8 KiB
Ruby
67 lines
1.8 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module Utils
|
|
IO_DEFAULT_BUFFER_SIZE = 4096
|
|
private_constant :IO_DEFAULT_BUFFER_SIZE
|
|
|
|
def self.popen_read(*args, safe: false, **options, &block)
|
|
output = popen(args, "rb", options, &block)
|
|
return output if !safe || $CHILD_STATUS.success?
|
|
|
|
raise ErrorDuringExecution.new(args, status: $CHILD_STATUS, output: [[:stdout, output]])
|
|
end
|
|
|
|
def self.safe_popen_read(*args, **options, &block)
|
|
popen_read(*args, safe: true, **options, &block)
|
|
end
|
|
|
|
def self.popen_write(*args, safe: false, **options)
|
|
output = ""
|
|
popen(args, "w+b", options) do |pipe|
|
|
# Before we yield to the block, capture as much output as we can
|
|
loop do
|
|
output += pipe.read_nonblock(IO_DEFAULT_BUFFER_SIZE)
|
|
rescue IO::WaitReadable, EOFError
|
|
break
|
|
end
|
|
|
|
yield pipe
|
|
pipe.close_write
|
|
pipe.wait_readable
|
|
|
|
# Capture the rest of the output
|
|
output += pipe.read
|
|
output.freeze
|
|
end
|
|
return output if !safe || $CHILD_STATUS.success?
|
|
|
|
raise ErrorDuringExecution.new(args, status: $CHILD_STATUS, output: [[:stdout, output]])
|
|
end
|
|
|
|
def self.safe_popen_write(*args, **options, &block)
|
|
popen_write(*args, safe: true, **options, &block)
|
|
end
|
|
|
|
def self.popen(args, mode, options = {})
|
|
IO.popen("-", mode) do |pipe|
|
|
if pipe
|
|
return pipe.read unless block_given?
|
|
|
|
yield pipe
|
|
else
|
|
options[:err] ||= "/dev/null" unless ENV["HOMEBREW_STDERR"]
|
|
begin
|
|
exec(*args, options)
|
|
rescue Errno::ENOENT
|
|
$stderr.puts "brew: command not found: #{args[0]}" if options[:err] != :close
|
|
exit! 127
|
|
rescue SystemCallError
|
|
$stderr.puts "brew: exec failed: #{args[0]}" if options[:err] != :close
|
|
exit! 1
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|