brew/Library/Homebrew/pkg_version.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

59 lines
1.1 KiB
Ruby

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true
require "version"
# Combination of a version and a revision.
class PkgVersion
include Comparable
extend Forwardable
REGEX = /\A(.+?)(?:_(\d+))?\z/
private_constant :REGEX
attr_reader :version, :revision
delegate [:major, :minor, :patch, :major_minor, :major_minor_patch] => :version
def self.parse(path)
_, version, revision = *path.match(REGEX)
version = Version.new(version)
new(version, revision.to_i)
end
def initialize(version, revision)
@version = version
@revision = revision
end
def head?
version.head?
end
sig { returns(String) }
def to_str
if revision.positive?
"#{version}_#{revision}"
else
version.to_s
end
end
sig { returns(String) }
def to_s = to_str
def <=>(other)
return unless other.is_a?(PkgVersion)
version_comparison = (version <=> other.version)
return if version_comparison.nil?
version_comparison.nonzero? || revision <=> other.revision
end
alias eql? ==
def hash
[version, revision].hash
end
end