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/DefEndAlignment #8653

Merged

Conversation

koic
Copy link
Member

@koic koic commented Sep 5, 2020

This PR fixes a false positive for Layout/DefEndAlignment when using refinements and private def.
It prevents the following error when auto-correcting.

% cat example.rb
using Module.new {
  refine Hash do
    class << Hash
      private def _ruby2_keywords_hash(*args)
      end
    end
  end
}

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

Inspecting 1 file
W

Offenses:

example.rb:5:7: W: [Corrected] Layout/DefEndAlignment: end at 5, 6 is
not aligned with using Module.new {
  refine Hash do
    class << Hash
      private def at 1, 0.
      end
      ^^^

0 files inspected, 1 offense detected, 1 offense corrected
Infinite loop detected in
/Users/koic/src/github.com/koic/rubocop-issues/rails/example.rb.
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:289:in
`check_for_infinite_loop'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:272:in
`block in iterate_until_no_changes'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:271:in
`loop'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:271:in
`iterate_until_no_changes'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:242:in
`do_inspection_loop'

I found it with the following code.
https://github.com/rails/rails/blob/v6.0.3.2/activejob/lib/active_job/arguments.rb#L73-L96


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 a false positive for `Layout/DefEndAlignment`
when using refinements and `private def`.
It prevents the following error when auto-correcting.

```console
% cat example.rb
using Module.new {
  refine Hash do
        class << Hash
      private def _ruby2_keywords_hash(*args)
      end
    end
  end
}

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

Inspecting 1 file
W

Offenses:

example.rb:5:7: W: [Corrected] Layout/DefEndAlignment: end at 5, 6 is
not aligned with using Module.new {
  refine Hash do
        class << Hash
      private def at 1, 0.
      end
      ^^^

0 files inspected, 1 offense detected, 1 offense corrected
Infinite loop detected in
/Users/koic/src/github.com/koic/rubocop-issues/rails/example.rb.
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:289:in
`check_for_infinite_loop'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:272:in
`block in iterate_until_no_changes'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:271:in
`loop'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:271:in
`iterate_until_no_changes'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/runner.rb:242:in
`do_inspection_loop'
```

I found it with the following code.
https://github.com/rails/rails/blob/v6.0.3.2/activejob/lib/active_job/arguments.rb#L73-L96
@bbatsov bbatsov merged commit 69700a5 into rubocop:master Sep 5, 2020
@bbatsov
Copy link
Collaborator

bbatsov commented Sep 5, 2020

Thanks!

@koic koic deleted the fix_a_false_positive_for_def_end_alignment branch September 5, 2020 05:29
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