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 auto-correct for Style/IfUnlessModifier #9690

Merged

Conversation

koic
Copy link
Member

@koic koic commented Apr 10, 2021

This PR fixes the following incorrect auto-correct for Style/IfUnlessModifier when using a method with heredoc argument.

% cat .rubocop.yml
Layout/LineLength:
  Max: 80

% cat example.rb
fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS) if condition
  string
EOS

% bundle exec rubocop --only Style/IfUnlessModifier -a
(snip)

Inspecting 1 file
C

Offenses:

example.rb:1:70: C: [Corrected] Style/IfUnlessModifier: Modifier form of
if makes the line too long.
fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS) if condition
                                                                     ^^

1 file inspected, 1 offense detected, 1 offense corrected

Before

Auto-corrected to unexpected invalid syntax code.

% cat example.rb
if condition
  fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS)
end
  string
EOS

% ruby -c example.rb
example.rb:2: syntax error, unexpected end-of-input, expecting `end'

After

Auto-corrected to expected valid syntax code.

% cat example.rb
if condition
  fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS)
    string
  EOS
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 the following incorrect auto-correct for `Style/IfUnlessModifier`
when using a method with heredoc argument.

```console
% cat .rubocop.yml
Layout/LineLength:
  Max: 80

% cat example.rb
fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS) if condition
  string
EOS

% bundle exec rubocop --only Style/IfUnlessModifier -a
(snip)

Inspecting 1 file
C

Offenses:

example.rb:1:70: C: [Corrected] Style/IfUnlessModifier: Modifier form of
if makes the line too long.
fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS) if condition
                                                                     ^^

1 file inspected, 1 offense detected, 1 offense corrected
```

## Before

Auto-corrected to unexpected invalid syntax code.

```console
% cat example.rb
if condition
  fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS)
end
  string
EOS

% ruby -c example.rb
example.rb:2: syntax error, unexpected end-of-input, expecting `end'
```

## After

Auto-corrected to expected valid syntax code.

```console
% cat example.rb
if condition
  fooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(<<~EOS)
    string
  EOS
end
```
@bbatsov bbatsov merged commit 1f1e59c into rubocop:master Apr 10, 2021
@bbatsov
Copy link
Collaborator

bbatsov commented Apr 10, 2021

I have to say I never expected that people would ever use a modifier with a heredoc. :-) Good work!

@koic koic deleted the fix_incorrect_autocorrect_for_if_unless_modifier branch April 11, 2021 04:43
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