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/SpaceAroundOperators #10054

Conversation

koic
Copy link
Member

@koic koic commented Aug 27, 2021

This PR fixes a false positive for Layout/SpaceAroundOperators when match operators between << and +=.

This change makes the following behavior consistent:

before

Does not register an offense when aligned between <<.

% cat example.rb
# It does not register an offense.
x  << foo
yz << bar

An offense is registered when either is updated to +=.

% cat example.rb
# It does not register an offense.
x  << foo
yz += bar

% bundle exec rubocop --only Layout/SpaceAroundOperators
(snip)

example.rb:2:4: C: [Correctable] Layout/SpaceAroundOperators: Operator
<< should be surrounded by a single space.
x  << foo
^^

1 file inspected, 1 offense detected, 1 offense auto-correctable

After

Both does not register an offense.


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/SpaceAroundOperators`
when match operators between `<<` and `+=`.

This change makes the following behavior consistent:

## before

Does not register an offense when aligned between `<<`.

```consle
% cat example.rb
# It does not register an offense.
x  << foo
yz << bar
```

An offense is registered when either is updated to `+=`.

```console
% cat example.rb
# It does not register an offense.
x  << foo
yz += bar

% bundle exec rubocop --only Layout/SpaceAroundOperators
(snip)

example.rb:2:4: C: [Correctable] Layout/SpaceAroundOperators: Operator
<< should be surrounded by a single space.
x  << foo
^^

1 file inspected, 1 offense detected, 1 offense auto-correctable
```

## After

Both does not register an offense.
@bbatsov
Copy link
Collaborator

bbatsov commented Aug 29, 2021

Looks good. Thanks!

@bbatsov bbatsov merged commit 9db1c7d into rubocop:master Aug 29, 2021
@koic koic deleted the fix_false_positive_for_layout_space_around_operators branch August 29, 2021 10:42
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