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 ```
73 lines
2.0 KiB
Ruby
73 lines
2.0 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Homebrew
|
|
# Checks for code that can be simplified using `Object#blank?`.
|
|
#
|
|
# NOTE: Auto-correction for this cop is unsafe because `' '.empty?` returns `false`,
|
|
# but `' '.blank?` returns `true`. Therefore, auto-correction is not compatible
|
|
# if the receiver is a non-empty blank string.
|
|
#
|
|
# ### Example
|
|
#
|
|
# ```ruby
|
|
# # bad
|
|
# foo.nil? || foo.empty?
|
|
# foo == nil || foo.empty?
|
|
#
|
|
# # good
|
|
# foo.blank?
|
|
# ```
|
|
class Blank < Base
|
|
extend AutoCorrector
|
|
|
|
MSG = "Use `%<prefer>s` instead of `%<current>s`."
|
|
|
|
# `(send nil $_)` is not actually a valid match for an offense. Nodes
|
|
# that have a single method call on the left hand side
|
|
# (`bar || foo.empty?`) will blow up when checking
|
|
# `(send (:nil) :== $_)`.
|
|
def_node_matcher :nil_or_empty?, <<~PATTERN
|
|
(or
|
|
{
|
|
(send $_ :!)
|
|
(send $_ :nil?)
|
|
(send $_ :== nil)
|
|
(send nil :== $_)
|
|
}
|
|
{
|
|
(send $_ :empty?)
|
|
(send (send (send $_ :empty?) :!) :!)
|
|
}
|
|
)
|
|
PATTERN
|
|
|
|
def on_or(node)
|
|
nil_or_empty?(node) do |var1, var2|
|
|
return if var1 != var2
|
|
|
|
message = format(MSG, prefer: replacement(var1), current: node.source)
|
|
add_offense(node, message:) do |corrector|
|
|
autocorrect(corrector, node)
|
|
end
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def autocorrect(corrector, node)
|
|
variable1, _variable2 = nil_or_empty?(node)
|
|
range = node.source_range
|
|
corrector.replace(range, replacement(variable1))
|
|
end
|
|
|
|
def replacement(node)
|
|
node.respond_to?(:source) ? "#{node.source}.blank?" : "blank?"
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|