brew/Library/Homebrew/rubocops/cask/url_legacy_comma_separators.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

36 lines
1.1 KiB
Ruby

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true
module RuboCop
module Cop
module Cask
# This cop checks for `version.before_comma` and `version.after_comma`.
class UrlLegacyCommaSeparators < Url
include OnUrlStanza
extend AutoCorrector
MSG_CSV = "Use `version.csv.first` instead of `version.before_comma` " \
"and `version.csv.second` instead of `version.after_comma`."
def on_url_stanza(stanza)
return if stanza.stanza_node.type == :block
url_node = stanza.stanza_node.first_argument
legacy_comma_separator_pattern = /version\.(before|after)_comma/
url = url_node.source
return unless url.match?(legacy_comma_separator_pattern)
corrected_url = url.sub("before_comma", "csv.first")&.sub("after_comma", "csv.second")
add_offense(url_node.loc.expression, message: format(MSG_CSV, url:)) do |corrector|
corrector.replace(url_node.source_range, corrected_url)
end
end
end
end
end
end