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 ```
36 lines
986 B
Ruby
36 lines
986 B
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
# Used to substitute common paths with generic placeholders when generating JSON for the API.
|
|
module APIHashable
|
|
def generating_hash!
|
|
return if generating_hash?
|
|
|
|
# Apply monkeypatches for API generation
|
|
@old_homebrew_prefix = HOMEBREW_PREFIX
|
|
@old_homebrew_cellar = HOMEBREW_CELLAR
|
|
@old_home = Dir.home
|
|
Object.send(:remove_const, :HOMEBREW_PREFIX)
|
|
Object.const_set(:HOMEBREW_PREFIX, Pathname.new(HOMEBREW_PREFIX_PLACEHOLDER))
|
|
ENV["HOME"] = HOMEBREW_HOME_PLACEHOLDER
|
|
|
|
@generating_hash = true
|
|
end
|
|
|
|
def generated_hash!
|
|
return unless generating_hash?
|
|
|
|
# Revert monkeypatches for API generation
|
|
Object.send(:remove_const, :HOMEBREW_PREFIX)
|
|
Object.const_set(:HOMEBREW_PREFIX, @old_homebrew_prefix)
|
|
ENV["HOME"] = @old_home
|
|
|
|
@generating_hash = false
|
|
end
|
|
|
|
def generating_hash?
|
|
@generating_hash ||= false
|
|
@generating_hash == true
|
|
end
|
|
end
|