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 Style/RedundantSelfAssignmentBranch to handle heredocs #12133

Merged

Conversation

r7kamura
Copy link
Contributor

There is a bug in the autocorrection of Style/RedundantSelfAssignmentBranch, which causes the following replacement if opposite_branch is a heredoc.

Before:

foo =
  if some_condition
    foo
  else
    <<~TEXT
      bar
    TEXT
  end

After:

foo =
  <<~TEXT unless some_condition

So in this pull request, I will modify it to make up for the missing parts in the case of heredoc.

This implementation is roughly the same as other methods of dealing with heredocs, for example, in Style/FileWrite:

def replacement(mode, filename, content, write_node)
replacement = "#{write_method(mode)}(#{filename.source}, #{content.source})"
if heredoc?(write_node)
first_argument = write_node.body.first_argument
<<~REPLACEMENT.chomp
#{replacement}
#{heredoc_range(first_argument).source}
REPLACEMENT
else
replacement
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.

@r7kamura r7kamura force-pushed the style-redundant-self-assignment-branch-heredoc branch from 152c77c to 2badd32 Compare August 19, 2023 11:48
@r7kamura r7kamura force-pushed the style-redundant-self-assignment-branch-heredoc branch from 1cd38a4 to 75580b3 Compare August 19, 2023 15:24
@koic koic merged commit 6815290 into rubocop:master Aug 19, 2023
28 checks passed
@koic
Copy link
Member

koic commented Aug 19, 2023

Thanks!

@r7kamura r7kamura deleted the style-redundant-self-assignment-branch-heredoc branch August 19, 2023 16:06
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