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 ```
80 lines
2.1 KiB
Ruby
80 lines
2.1 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "forwardable"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Cask
|
|
# This cop audits variables in casks.
|
|
#
|
|
# ### Example
|
|
#
|
|
# ```ruby
|
|
# # bad
|
|
# cask do
|
|
# arch = Hardware::CPU.intel? ? "darwin" : "darwin-arm64"
|
|
# end
|
|
#
|
|
# # good
|
|
# cask 'foo' do
|
|
# arch arm: "darwin-arm64", intel: "darwin"
|
|
# end
|
|
# ```
|
|
class Variables < Base
|
|
extend Forwardable
|
|
extend AutoCorrector
|
|
include CaskHelp
|
|
|
|
def on_cask(cask_block)
|
|
@cask_block = cask_block
|
|
add_offenses
|
|
end
|
|
|
|
private
|
|
|
|
def_delegator :@cask_block, :cask_node
|
|
|
|
def add_offenses
|
|
variable_assignment(cask_node) do |node, var_name, arch_condition, true_node, false_node|
|
|
arm_node, intel_node = if arch_condition == :arm?
|
|
[true_node, false_node]
|
|
else
|
|
[false_node, true_node]
|
|
end
|
|
|
|
replacement_string = if var_name == :arch
|
|
"arch "
|
|
else
|
|
"#{var_name} = on_arch_conditional "
|
|
end
|
|
replacement_parameters = []
|
|
replacement_parameters << "arm: #{arm_node.source}" unless blank_node?(arm_node)
|
|
replacement_parameters << "intel: #{intel_node.source}" unless blank_node?(intel_node)
|
|
replacement_string += replacement_parameters.join(", ")
|
|
|
|
add_offense(node, message: "Use `#{replacement_string}` instead of `#{node.source}`.") do |corrector|
|
|
corrector.replace(node, replacement_string)
|
|
end
|
|
end
|
|
end
|
|
|
|
def blank_node?(node)
|
|
case node.type
|
|
when :str
|
|
node.value.empty?
|
|
when :nil
|
|
true
|
|
else
|
|
false
|
|
end
|
|
end
|
|
|
|
def_node_search :variable_assignment, <<~PATTERN
|
|
$(lvasgn $_ (if (send (const (const nil? :Hardware) :CPU) ${:arm? :intel?}) $_ $_))
|
|
PATTERN
|
|
end
|
|
end
|
|
end
|
|
end
|