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/MultilineWhenThen #8750

Merged
merged 1 commit into from Sep 21, 2020

Conversation

koic
Copy link
Member

@koic koic commented Sep 19, 2020

This PR fixes the following incorrect auto-correct for Style/MultilineWhenThen when line break for multiple condidate values of when statement.

% cat example.rb
case condition
when :foo,
     :bar then nil
end

% rubocop -a
(snip)

E

Offenses:

example.rb:3:11: E: Lint/Syntax: unexpected token kNIL
(Using Ruby 2.7 parser; configure using TargetRubyVersion parameter,
under AllCops)
     :bar nil
          ^^^
example.rb:3:11: C: [Corrected] Style/MultilineWhenThen: Do not use then
for multiline when statement.
     :bar then nil
          ^^^^

1 file inspected, 2 offenses detected, 1 offense corrected

% cat example.rb
case condition
when :foo,
     :bar nil
end

% ruby -c example.rb
example.rb:3: syntax error, unexpected `nil', expecting `then' or ',' or
';' or '\n'
     :bar nil

Before submitting the PR make sure the following are checked:

  • 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.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

This PR fixes the following incorrect auto-correct for `Style/MultilineWhenThen`
when line break for multiple condidate values of `when` statement.

```console
% cat example.rb
case condition
when :foo,
     :bar then nil
end

% rubocop -a
(snip)

E

Offenses:

example.rb:3:11: E: Lint/Syntax: unexpected token kNIL
(Using Ruby 2.7 parser; configure using TargetRubyVersion parameter,
under AllCops)
     :bar nil
          ^^^
example.rb:3:11: C: [Corrected] Style/MultilineWhenThen: Do not use then
for multiline when statement.
     :bar then nil
          ^^^^

1 file inspected, 2 offenses detected, 1 offense corrected

% cat example.rb
case condition
when :foo,
     :bar nil
end

% ruby -c example.rb
example.rb:3: syntax error, unexpected `nil', expecting `then' or ',' or
';' or '\n'
     :bar nil
```
@koic koic force-pushed the fix_error_for_style_multiline_when_then branch from 1698047 to c5e6105 Compare September 21, 2020 05:22
@koic koic merged commit 4d6e725 into rubocop:master Sep 21, 2020
@koic koic deleted the fix_error_for_style_multiline_when_then branch September 21, 2020 05:50
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

1 participant