Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix #9874] Fix a false positive for Style/RegexpLiteral #9878

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/fix_false_positive_for_style_regexp_literal.md
@@ -0,0 +1 @@
* [#9874](https://github.com/rubocop/rubocop/issues/9874): Fix a false positive for `Style/RegexpLiteral` when using `%r` regexp literal with `EnforcedStyle: omit_parentheses` of `Style/MethodCallWithArgsParentheses`. ([@koic][])
10 changes: 9 additions & 1 deletion lib/rubocop/cop/style/regexp_literal.rb
Expand Up @@ -117,7 +117,7 @@ def allowed_mixed_slash?(node)
def allowed_percent_r_literal?(node)
style == :slashes && contains_disallowed_slash?(node) ||
style == :percent_r ||
allowed_mixed_percent_r?(node)
allowed_mixed_percent_r?(node) || omit_parentheses_style?(node)
end

def allowed_mixed_percent_r?(node)
Expand Down Expand Up @@ -149,6 +149,14 @@ def preferred_delimiters
config.for_cop('Style/PercentLiteralDelimiters') ['PreferredDelimiters']['%r'].chars
end

def omit_parentheses_style?(node)
return false unless node.parent&.call_type?

enforced_style = config.for_cop('Style/MethodCallWithArgsParentheses')['EnforcedStyle']

enforced_style == 'omit_parentheses'
end

def correct_delimiters(node, corrector)
replacement = calculate_replacement(node)
corrector.replace(node.loc.begin, replacement.first)
Expand Down
107 changes: 107 additions & 0 deletions spec/rubocop/cop/style/regexp_literal_spec.rb
Expand Up @@ -5,10 +5,13 @@
supported_styles = { 'SupportedStyles' => %w[slashes percent_r mixed] }
RuboCop::Config.new('Style/PercentLiteralDelimiters' =>
percent_literal_delimiters_config,
'Style/MethodCallWithArgsParentheses' =>
method_call_with_args_parentheses_config,
'Style/RegexpLiteral' =>
cop_config.merge(supported_styles))
end
let(:percent_literal_delimiters_config) { { 'PreferredDelimiters' => { '%r' => '{}' } } }
let(:method_call_with_args_parentheses_config) { { 'EnforcedStyle' => 'require_parentheses' } }

describe 'when regex contains slashes in interpolation' do
let(:cop_config) { { 'EnforcedStyle' => 'slashes' } }
Expand Down Expand Up @@ -488,4 +491,108 @@
end
end
end

context 'when `EnforcedStyle: require_parentheses` of `Style/MethodCallWithArgsParentheses` cop' do
let(:method_call_with_args_parentheses_config) { { 'EnforcedStyle' => 'require_parentheses' } }

context 'when using `%r` regexp with `EnforcedStyle: slashes`' do
let(:cop_config) { { 'EnforcedStyle' => 'slashes' } }

it 'registers an offense when used as a method argument' do
expect_offense(<<~RUBY)
do_something %r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end

it 'registers an offense when used as a safe navigation method argument' do
expect_offense(<<~RUBY)
foo&.do_something %r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end

it 'registers an offense when not used as a method argument' do
expect_offense(<<~RUBY)
%r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end
end

context 'when using `%r` regexp with `EnforcedStyle: mixed`' do
let(:cop_config) { { 'EnforcedStyle' => 'mixed' } }

it 'registers an offense when used as a method argument' do
expect_offense(<<~RUBY)
do_something %r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end

it 'registers an offense when used as a safe navigation method argument' do
expect_offense(<<~RUBY)
foo&.do_something %r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end

it 'registers an offense when not used as a method argument' do
expect_offense(<<~RUBY)
%r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end
end
end

context 'when `EnforcedStyle: omit_parentheses` of `Style/MethodCallWithArgsParentheses` cop' do
let(:method_call_with_args_parentheses_config) { { 'EnforcedStyle' => 'omit_parentheses' } }

context 'when using `%r` regexp with `EnforcedStyle: slashes`' do
let(:cop_config) { { 'EnforcedStyle' => 'slashes' } }

it 'does not register an offense when used as a method argument' do
expect_no_offenses(<<~RUBY)
do_something %r/regexp/
RUBY
end

it 'does not register an offense when used as a safe navigation method argument' do
expect_no_offenses(<<~RUBY)
foo&.do_something %r/regexp/
RUBY
end

it 'registers an offense when not used as a method argument' do
expect_offense(<<~RUBY)
%r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end
end

context 'when using `%r` regexp with `EnforcedStyle: mixed`' do
let(:cop_config) { { 'EnforcedStyle' => 'mixed' } }

it 'does not register an offense when used as a method argument' do
expect_no_offenses(<<~RUBY)
do_something %r/regexp/
RUBY
end

it 'does not register an offense when used as a safe navigation method argument' do
expect_no_offenses(<<~RUBY)
foo&.do_something %r/regexp/
RUBY
end

it 'registers an offense when not used as a method argument' do
expect_offense(<<~RUBY)
%r/regexp/
^^^^^^^^^^ Use `//` around regular expression.
RUBY
end
end
end
end