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 a false positive for Layout/TrailingEmptyLines #12040

Merged

Conversation

koic
Copy link
Member

@koic koic commented Jul 10, 2023

This PR fixes a false positive for Layout/TrailingEmptyLines to prevent the following incorrect autocorrection when inspecting the % form string %\n\n.

First, Layout/TrailingEmptyLines cop detects an offense upon inspection, but it's valid syntax:

$ echo "x = %\n\n" | be rubocop --stdin example.rb --only Layout/TrailingEmptyLines
Inspecting 1 file
C

Offenses:

example.rb:2:1: C: [Correctable] Layout/TrailingEmptyLines: 2 trailing blank lines detected.

1 file inspected, 1 offense detected, 1 offense autocorrectable

Next, Layout/TrailingEmptyLines cop autocorrects to an invalid syntax and Lint/Syntax occurs:

$ echo "x = %\n\n" | be rubocop --stdin example.rb --only Layout/TrailingEmptyLines -a
Inspecting 1 file
F

Offenses:

example.rb:1:5: F: Lint/Syntax: unterminated string meets end of file
(Using Ruby 2.7 parser; configure using TargetRubyVersion parameter, under AllCops)
x = %
^
example.rb:2:1: C: [Corrected] Layout/TrailingEmptyLines: 2 trailing blank lines detected.

1 file inspected, 2 offenses detected, 1 offense corrected
====================
x = %

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 a false positive for `Layout/TrailingEmptyLines` to prevent
the following incorrect autocorrection when inspecting the `%` form string `%\n\n`.

First, `Layout/TrailingEmptyLines` cop detects an offense upon inspection, but it's valid syntax:

```console
$ echo "x = %\n\n" | be rubocop --stdin example.rb --only Layout/TrailingEmptyLines
Inspecting 1 file
C

Offenses:

example.rb:2:1: C: [Correctable] Layout/TrailingEmptyLines: 2 trailing blank lines detected.

1 file inspected, 1 offense detected, 1 offense autocorrectable
```

Next, `Layout/TrailingEmptyLines` cop autocorrects to an invalid syntax and `Lint/Syntax` occurs:

```
$ echo "x = %\n\n" | be rubocop --stdin example.rb --only Layout/TrailingEmptyLines -a
Inspecting 1 file
F

Offenses:

example.rb:1:5: F: Lint/Syntax: unterminated string meets end of file
(Using Ruby 2.7 parser; configure using TargetRubyVersion parameter, under AllCops)
x = %
^
example.rb:2:1: C: [Corrected] Layout/TrailingEmptyLines: 2 trailing blank lines detected.

1 file inspected, 2 offenses detected, 1 offense corrected
====================
x = %
```
@koic koic merged commit bd4e0db into rubocop:master Jul 10, 2023
28 checks passed
@koic koic deleted the fix_a_false_positive_for_layout_trailing_empty_lines branch July 10, 2023 16:57
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