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 Layout/LineLength #9938

Merged

Conversation

koic
Copy link
Member

@koic koic commented Jul 17, 2021

This PR fixes the following incorrect auto-correct for Layout/LineLength when a heredoc is used as the first element of an array.

% cat example.rb
[<<~STRING, { key1: value1, key2: value2 }]
STRING

% ruby -c example.rb
Syntax OK

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

% bundle exec rubocop --only Layout/LineLength example.rb -a
(snip)

Inspecting 1 file
C

Offenses:

example.rb:1:41: C: [Corrected] Layout/LineLength: Line is too long. [43/40]
[<<~STRING, { key1: value1, key2: value2 }]
                                        ^^^

1 file inspected, 1 offense detected, 1 offense corrected

% cat example.rb
[<<~STRING,
{ key1: value1, key2: value2 }]
STRING

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

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 `Layout/LineLength`
when a heredoc is used as the first element of an array.

```console
% cat example.rb
[<<~STRING, { key1: value1, key2: value2 }]
STRING

% ruby -c example.rb
Syntax OK

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

% bundle exec rubocop --only Layout/LineLength example.rb -a
(snip)

Inspecting 1 file
C

Offenses:

example.rb:1:41: C: [Corrected] Layout/LineLength: Line is too long. [43/40]
[<<~STRING, { key1: value1, key2: value2 }]
                                        ^^^

1 file inspected, 1 offense detected, 1 offense corrected

% cat example.rb
[<<~STRING,
{ key1: value1, key2: value2 }]
STRING

% ruby -c example.rb
example.rb:1: syntax error, unexpected end-of-input, expecting ']'
```
@koic koic force-pushed the fix_incorrect_autocorrect_for_layout_line_length branch from 6b4482a to e1edb41 Compare July 17, 2021 16:35
@bbatsov bbatsov merged commit 0886479 into rubocop:master Jul 19, 2021
@bbatsov
Copy link
Collaborator

bbatsov commented Jul 19, 2021

I never thought I'd see a heredoc used in an array. :-) Thanks for tackling this!

@koic koic deleted the fix_incorrect_autocorrect_for_layout_line_length branch July 19, 2021 07:18
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