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 #10700] Update Style/EmptyMethod to not correct if the correction would exceed the configuration for Layout/LineLength #10742

Merged
merged 1 commit into from Jun 24, 2022

Conversation

dvandersluis
Copy link
Member

When an empty method definition is longer than the Max allowed by Layout/LineLength, autocorrection ends up in an infinite loop: Layout/LineLength splits the method onto two lines, and then Style/EmptyMethod puts it back onto one line.

This changes Style/EmptyMethod to not perform autocorrection with EnforcedStyle: compact if the resulting change will exceed the allowed line length. An offense will still be registered but it will be up to the user to determine how to resolve it, which will prevent the infinite loop.

NOTE: this makes an assumption that Layout/LineLength takes priority over Style/EmptyMethod for the purposes of correction.

Fixes #10700.


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.

…correction would exceed the configuration for `Layout/LineLength`.
@bbatsov
Copy link
Collaborator

bbatsov commented Jun 24, 2022

Looks good to me.

NOTE: this makes an assumption that Layout/LineLength takes priority over Style/EmptyMethod for the purposes of correction.

I'd document this assumption in the cop's docs as well.

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.

Layout/LineLength and some cops causes infinite loop
2 participants