rubocops/text: Allow bin interpolation inside word arrays

- We discovered that the following syntax in the formula `sqlsmith`
  should actually be OK because the `\n` is like whitespace.

```ruby
cmd = %W[
  #{bin}/sqlsmith
  --threads=4
  --timeout=10
]
shell_output(cmd)
```
This commit is contained in:
Issy Long 2024-08-04 23:38:11 +01:00
parent 9279693a34
commit cb8769c2a0
No known key found for this signature in database
2 changed files with 39 additions and 21 deletions

View File

@ -140,6 +140,8 @@ module RuboCop
end end
interpolated_bin_path_starts_with(body_node, "/#{@formula_name}") do |bin_node| interpolated_bin_path_starts_with(body_node, "/#{@formula_name}") do |bin_node|
next if bin_node.ancestors.any?(&:array_type?)
offending_node(bin_node) offending_node(bin_node)
cmd = bin_node.source.match(%r{\#{bin}/(\S+)})[1]&.delete_suffix('"') || @formula_name cmd = bin_node.source.match(%r{\#{bin}/(\S+)})[1]&.delete_suffix('"') || @formula_name
problem "Use `bin/\"#{cmd}\"` instead of `\"\#{bin}/#{cmd}\"`" do |corrector| problem "Use `bin/\"#{cmd}\"` instead of `\"\#{bin}/#{cmd}\"`" do |corrector|

View File

@ -132,6 +132,7 @@ RSpec.describe RuboCop::Cop::FormulaAuditStrict::Text do
RUBY RUBY
end end
context "for interpolated bin paths" do
it 'reports an offense & autocorrects if "\#{bin}/<formula_name>" or other dashed binaries too are present' do it 'reports an offense & autocorrects if "\#{bin}/<formula_name>" or other dashed binaries too are present' do
expect_offense(<<~RUBY, "/homebrew-core/Formula/foo.rb") expect_offense(<<~RUBY, "/homebrew-core/Formula/foo.rb")
class Foo < Formula class Foo < Formula
@ -166,4 +167,19 @@ RSpec.describe RuboCop::Cop::FormulaAuditStrict::Text do
RUBY RUBY
end end
end end
it 'does not report an offense if "\#{bin}/foo" is in a word array' do
expect_no_offenses(<<~RUBY, "/homebrew-core/Formula/foo.rb")
class Foo < Formula
test do
cmd = %W[
\#{bin}/foo
version
]
assert_match version.to_s, shell_output(cmd)
end
end
RUBY
end
end
end end