Skip to content

Fix autocorrection error with nested offenses for Rails/IndexWith #1483

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

Merged
merged 1 commit into from
May 21, 2025

Conversation

lovro-bikic
Copy link
Contributor

@lovro-bikic lovro-bikic commented May 20, 2025

Currently, code that registers nested offenses for Rails/IndexWith:

x.each_with_object({}) do |el, h|
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `index_with` over `each_with_object`.
  h[el] = el.each_with_object({}) do |inner_el, inner_h|
#         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `index_with` over `each_with_object`.
    inner_h[inner_el] = foo(inner_el)
  end
end

will fail on autocorrection with Parser::ClobberingError: Parser::Source::TreeRewriter detected clobbering error.

This PR fixes autocorrection by ignoring the node after first autocorrection, so the correction is done in multiple passes.

Since this cop shares logic with Rails/IndexBy, technically that cop is affected as well by this change.


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.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@koic koic merged commit bc95f97 into rubocop:master May 21, 2025
16 checks passed
@koic
Copy link
Member

koic commented May 21, 2025

Thanks!

@lovro-bikic lovro-bikic deleted the index-method-nested-autocorrect branch May 21, 2025 10:07
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.

2 participants