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 autocorrect for Layout/ClassStructure when definitions that need to be sorted are defined alternately #11529

Merged

Conversation

ydah
Copy link
Member

@ydah ydah commented Feb 1, 2023

This PR is fix an incorrect autocorrect for Layout/ClassStructure when definitions that need to be sorted are defined alternately.

Code to reproduce

class A
  private def foo; end

  def bar; end

  private def baz; end

  def qux; end
end

Expected behavior

Automatically corrected as follows:

class A
  def bar; end

  def qux; end

  private def foo; end

  private def baz; end
end

Actual behavior

Automatically corrected as follows:

class A
  def qux; end

  def bar; end

  def qux; end # <------ Duplicate

  private def foo; end

  private def baz; end
end

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.

…ions that need to be sorted are defined alternately

This PR is fix an incorrect autocorrect for `Layout/ClassStructure`
when definitions that need to be sorted are defined alternately.

## Code to reproduce

```ruby
class A
  private def foo; end

  def bar; end

  private def baz; end

  def qux; end
end
```

## Expected behavior

Automatically corrected as follows:

```ruby
class A
  def bar; end

  def qux; end

  private def foo; end

  private def baz; end
end
```

## Actual behavior

Automatically corrected as follows:

```ruby
class A
  def qux; end

  def bar; end

  def qux; end # <------ Duplicate

  private def foo; end

  private def baz; end
end
```
@ydah ydah force-pushed the fix-incorrect-autocorrect-class-structure branch from 27e6d0b to 1a1c4ff Compare February 1, 2023 15:44
@koic
Copy link
Member

koic commented Feb 2, 2023

There is some impact on existing autocorrection, but overall I think it's an acceptable trade-off. Thank you.

@koic koic merged commit 62c0e90 into rubocop:master Feb 2, 2023
@ydah ydah deleted the fix-incorrect-autocorrect-class-structure branch February 2, 2023 07:09
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