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 #9731] Fix two autocorrection issues for Style/NegatedIfElseCondition #9756

Merged
merged 1 commit into from May 2, 2021

Conversation

dvandersluis
Copy link
Member

Previously, when swapping the if and else branches, if one of the branches only had a single statement, the branch would end up not being spaced out properly.

Additionally, when there is a node with a comment inside the if that has an identical node with a comment before the if statement, CommentsHelp.begin_pos_with_comment returns an incorrect range, which was causing a clobbering error. I fixed this by creating ranges of the entire body of the if and else branches, so that they can just be swapped without relying on ProcessedSource#ast_with_comments. See rubocop/rubocop-ast#179.


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.

Comment on lines +53 to +66
it 'registers an offens and corrects a multiline ternary' do
expect_offense(<<~RUBY)
!x ?
^^^^ Invert the negated condition and swap the ternary branches.
do_something :
do_something_else # comment
RUBY

expect_correction(<<~RUBY)
x ?
do_something_else :
do_something # comment
RUBY
end
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't actually correct the comment properly but I wanted to add a test for this case just to document behaviour. Really no one should be writing multiline ternaries like this. 😏

…ElseCondition`.

Previously, when swapping the `if` and `else` branches, if one of the branches only had a single statement, the branch would end up not being spaced out properly.

Additionally, when there is a node with a comment inside the `if` that has an identical node with a comment *before* the `if` statement, `CommentsHelp.begin_pos_with_comment` returns an incorrect range, which was causing a clobbering error. I fixed this by creating ranges of the entire body of the if and else branches, so that they can just be swapped without relying on `ProcessedSource#ast_with_comments`.
@dvandersluis
Copy link
Member Author

Thanks for the review @koic!

@dvandersluis dvandersluis deleted the issue/9731 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.

None yet

2 participants