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 #9836] Fix incorrect corrections for Layout/HashAlignment when a kwsplat node is on the same line as a pair node with table style #9837

Merged
merged 1 commit into from May 31, 2021

Conversation

dvandersluis
Copy link
Member

Keyword splats were previously treated as pairs using colon style, which some hacks in the Alignment classes to handle them (see #3919). However, this did not account for all possibilities and would cause previous pairs on the same line as the kwsplat to be removed by autocorrection.

Instead, now a special KeywordSplatAlignment type was added to handle kwsplats. The previously behaviour about kwsplats was retained (they will still be aligned with the beginning of the rest of the hash, regardless of enforced style), and the hacks in KeyAlignment and TableAlignment for kwsplats were removed.


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.

…t` when a `kwsplat` node is on the same line as a `pair` node with table style.

Keyword splats were previously treated as pairs using colon style, which some hacks in the Alignment classes to handle them. However, this did not account for all possibilities and would cause previous pairs on the same line as the `kwsplat` to be removed by autocorrection.

Instead, now a special `KeywordSplatAlignment` type was added to handle `kwsplat`s. The previously behaviour about `kwsplat`s was retained (they will still be aligned with the beginning of the rest of the hash, regardless of enforced style), and the hacks in `KeyAlignment` and `TableAlignment` for `kwsplat`s were removed.
@dvandersluis dvandersluis linked an issue May 29, 2021 that may be closed by this pull request
@bbatsov
Copy link
Collaborator

bbatsov commented May 31, 2021

Looks solid. Thanks!

@bbatsov bbatsov merged commit 73575d1 into rubocop:master May 31, 2021
@dvandersluis dvandersluis deleted the issue/9836 branch September 14, 2021 16:04
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.

Infinite loop in Layout/HashAlignment autocorrection
2 participants