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 an incorrect autocorrect for Style/SoleNestedConditional #11944

Conversation

koic
Copy link
Member

@koic koic commented Jun 12, 2023

This PR fixes an incorrect autocorrect for Style/SoleNestedConditional with Style/MethodCallWithArgsParentheses.

if items.include? item
  if condition
    do_something
  end
end

Before

$ bundle exec rubocop -a --only Style/MethodCallWithArgsParentheses,Style/SoleNestedConditional
Inspecting 1 file
F

Offenses:

example.rb:1:4: C: [Corrected] Style/MethodCallWithArgsParentheses: Use parentheses for method calls with arguments.
if items.include? item
   ^^^^^^^^^^^^^^^^^^^
example.rb:1:24: F: Lint/Syntax: unexpected token tRPAREN
(Using Ruby 3.3 parser; configure using TargetRubyVersion parameter, under AllCops)
if items.include?(item)) && condition
                       ^
example.rb:2:3: C: [Corrected] Style/SoleNestedConditional: Consider merging nested conditions into outer if conditions.
  if condition
  ^^
example.rb:3:3: F: Lint/Syntax: unexpected token kEND
(Using Ruby 3.3 parser; configure using TargetRubyVersion parameter, under AllCops)
  end
  ^^^

1 file inspected, 4 offenses detected, 2 offenses corrected

Syntax error with redundant closing parentheses.

if items.include?(item)) && condition
    do_something
  end

After

Valid syntax.

if items.include?(item) && condition
    do_something
  end

Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

This PR fixes an incorrect autocorrect for `Style/SoleNestedConditional` with
`Style/MethodCallWithArgsParentheses`.

```ruby
if items.include? item
  if condition
    do_something
  end
end
```

## Before

```console
$ bundle exec rubocop -a --only Style/MethodCallWithArgsParentheses,Style/SoleNestedConditional
Inspecting 1 file
F

Offenses:

example.rb:1:4: C: [Corrected] Style/MethodCallWithArgsParentheses: Use parentheses for method calls with arguments.
if items.include? item
   ^^^^^^^^^^^^^^^^^^^
example.rb:1:24: F: Lint/Syntax: unexpected token tRPAREN
(Using Ruby 3.3 parser; configure using TargetRubyVersion parameter, under AllCops)
if items.include?(item)) && condition
                       ^
example.rb:2:3: C: [Corrected] Style/SoleNestedConditional: Consider merging nested conditions into outer if conditions.
  if condition
  ^^
example.rb:3:3: F: Lint/Syntax: unexpected token kEND
(Using Ruby 3.3 parser; configure using TargetRubyVersion parameter, under AllCops)
  end
  ^^^

1 file inspected, 4 offenses detected, 2 offenses corrected
```

Syntax error with redundant closing parentheses.

```console
if items.include?(item)) && condition
    do_something
  end
```

## After

Valid syntax.

```console
if items.include?(item) && condition
    do_something
  end
```
@koic koic force-pushed the fix_an_incorrect_for_style_sole_nested_conditional branch from cbf7c4b to 809c1a8 Compare June 12, 2023 03:30
@bbatsov bbatsov merged commit 664bd71 into rubocop:master Jun 12, 2023
28 checks passed
@bbatsov
Copy link
Collaborator

bbatsov commented Jun 12, 2023

Thanks!

@koic koic deleted the fix_an_incorrect_for_style_sole_nested_conditional branch June 12, 2023 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants