brew/Library/Homebrew/formula_versions.rb
Issy Long 45978435e7
rubocop: Use Sorbet/StrictSigil as it's better than comments
- 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
```
2024-08-12 15:24:27 +01:00

86 lines
2.6 KiB
Ruby

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true
require "formula"
# Helper class for traversing a formula's previous versions.
#
# @api internal
class FormulaVersions
include Context
IGNORED_EXCEPTIONS = [
ArgumentError, NameError, SyntaxError, TypeError,
FormulaSpecificationError, FormulaValidationError,
ErrorDuringExecution, LoadError, MethodDeprecatedError
].freeze
sig { params(formula: Formula).void }
def initialize(formula)
@name = formula.name
@path = formula.path
@repository = T.must(formula.tap).path
@relative_path = @path.relative_path_from(repository).to_s
# Also look at e.g. older homebrew-core paths before sharding.
if (match = @relative_path.match(%r{^(HomebrewFormula|Formula)/([a-z]|lib)/(.+)}))
@old_relative_path = "#{match[1]}/#{match[3]}"
end
@formula_at_revision = {}
end
def rev_list(branch)
repository.cd do
rev_list_cmd = ["git", "rev-list", "--abbrev-commit", "--remove-empty"]
[relative_path, old_relative_path].compact.each do |entry|
Utils.popen_read(*rev_list_cmd, branch, "--", entry) do |io|
yield [io.readline.chomp, entry] until io.eof?
end
end
end
end
sig {
type_parameters(:U)
.params(
revision: String,
formula_relative_path: String,
_block: T.proc.params(arg0: Formula).returns(T.type_parameter(:U)),
).returns(T.nilable(T.type_parameter(:U)))
}
def formula_at_revision(revision, formula_relative_path = relative_path, &_block)
Homebrew.raise_deprecation_exceptions = true
yield @formula_at_revision[revision] ||= begin
contents = file_contents_at_revision(revision, formula_relative_path)
nostdout { Formulary.from_contents(name, path, contents, ignore_errors: true) }
end
rescue *IGNORED_EXCEPTIONS => e
require "utils/backtrace"
# We rescue these so that we can skip bad versions and
# continue walking the history
odebug "#{e} in #{name} at revision #{revision}", Utils::Backtrace.clean(e)
rescue FormulaUnavailableError
nil
ensure
Homebrew.raise_deprecation_exceptions = false
end
private
attr_reader :name, :path, :repository, :relative_path, :old_relative_path
sig { params(revision: String, relative_path: String).returns(String) }
def file_contents_at_revision(revision, relative_path)
repository.cd { Utils.popen_read("git", "cat-file", "blob", "#{revision}:#{relative_path}") }
end
def nostdout(&block)
if verbose?
yield
else
redirect_stdout(File::NULL, &block)
end
end
end