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

Add new Performance/RedundantEqualityComparisonBlock cop #213

Conversation

koic
Copy link
Member

@koic koic commented Feb 19, 2021

This PR adds new Performance/RedundantEqualityComparisonBlock cop.

The cop checks for uses Enumerable#all?, Enumerable#any?, Enumerable#one?, and Enumerable#none? are compared with === or similar methods in block.

By default, Object#=== behaves the same as Object#==, but this behavior is appropriately redefined in subclass. For example, Range#=== returns true when argument is within the range.

Therefore, It is marked as unsafe by default because === and == do not always behave the same.

# bad
items.all? { |item| pattern === item }
items.all? { |item| item == other }
items.all? { |item| item.is_a?(Klass) }
items.all? { |item| item.kind_of?(Klass) }

# good
items.all?(pattern)

cf. rails/rails#41363

Thank you for the cop idea @kamipo!


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).
  • 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.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

This PR adds new `Performance/RedundantEqualityComparisonBlock` cop.

The cop checks for uses `Enumerable#all?`, `Enumerable#any?`, `Enumerable#one?`,
and `Enumerable#none?` are compared with `===` or similar methods in block.

By default, `Object#===` behaves the same as `Object#==`, but this
behavior is appropriately redefined in subclass. For example,
`Range#===` returns `true` when argument is within the range.
Therefore, It is marked as unsafe by default because `===` and `==`
do not always behave the same.

```ruby
# bad
items.all? { |item| pattern === item }
items.all? { |item| item == other }
items.all? { |item| item.is_a?(Klass) }
items.all? { |item| item.kind_of?(Klass) }

# good
items.all?(pattern)
```

cf. rails/rails#41363
@koic koic merged commit 4c55471 into rubocop:master Feb 22, 2021
@koic koic deleted the add_new_performance_redundant_equality_comparison_block_cop branch February 22, 2021 19:44
koic added a commit to koic/rubocop-performance that referenced this pull request Mar 1, 2021
…lityComparisonBlock`

Fixes rubocop#213.

This PR fixes a false positive for `Performance/RedundantEqualityComparisonBlock`
when using block argument is used for an argument of `is_a`.
@koic koic mentioned this pull request Apr 4, 2021
8 tasks
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.

1 participant