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 a false negative in UselessAssignment with nested conditionals #4162

Merged
merged 3 commits into from Mar 24, 2017

Conversation

yujinakayama
Copy link
Collaborator

@yujinakayama yujinakayama commented Mar 24, 2017

The cop can detects the following useless assignment:

if flag_a
  # This is useless ...
  foo = 1
else
  # ... since this will never run together with the assignment
  puts foo
end

This is done by checking if branches of the assignment and reference are exclusive.

However, previously it couldn't detect the following useless assignment:

if flag_a
  # This is useless ...
  foo = 1
else
  if flag_b
    # ... since this will never run together with the assignment
    puts foo
  end
end

Because the old logic worked correctly only when the both branches belong to a same conditional (i.e. paired if and else).

With the new logic it can detect such useless assignments by checking ancestor branches.


Before submitting the PR make sure the following are checked:

  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Used the same coding conventions as the rest of the project.
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • All tests are passing.
  • The new code doesn't generate RuboCop offenses.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Updated cop documentation with rake generate_cops_documentation (required only when you've added a new cop or changed the configuration/documentation of an existing cop).

The cop can detects the following useless assignment:

```
if flag_a
  # This is useless ...
  foo = 1
else
  # ... since this will never run together with the assignment
  puts foo
end
```

This is done by checking if branches of the assignment and reference are
exclusive.

However, previously it couldn't detect the following useless assignment:

```
if flag_a
  # This is useless ...
  foo = 1
else
  if flag_b
    # ... since this will never run together with the assignment
    puts foo
  end
end
```

Because the old logic worked correctly _only_ when the both branches
belong to a same conditional (i.e. paired `if` and `else`).

With the new logic it can detect such useless assignments by checking
ancestor branches.
@bbatsov bbatsov merged commit 38df640 into rubocop:master Mar 24, 2017
@bbatsov
Copy link
Collaborator

bbatsov commented Mar 24, 2017

👍 Great work!

@yujinakayama yujinakayama deleted the handle-nested-branches branch March 24, 2017 21:58
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