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 AllowRegexpMatch option to Performance/RedundantEqualityComparisonBlock #347

Conversation

koic
Copy link
Member

@koic koic commented Mar 13, 2023

Follow up #340.

This PR adds AllowRegexpMatch option to Performance/RedundantEqualityComparisonBlock.

# `AllowRegexpMatch: true` (default)

# good
items.all? { |item| item =~ pattern }
items.all? { |item| item.match?(pattern) }

# `AllowRegexpMatch: false`

# bad
items.all? { |item| item =~ pattern }
items.all? { |item| item.match?(pattern) }

AllowRegexpMatch: false by default because regexp.match?('string') often used in block changes to the opposite result:

[/pattern/].all? { |regexp| regexp.match?('pattern') } # => true
[/pattern/].all? { |regexp| regexp =~ 'pattern' }      # => true
[/pattern/].all?('pattern')                            # => false

cc @fatkodima


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.

@koic koic force-pushed the add_allow_regexp_match_option_to_performance_redundant_equality_comparison_block branch from 0916a99 to ef0cdd4 Compare March 13, 2023 16:02
…isonBlock`

Follow up rubocop#340.

This PR adds `AllowRegexpMatch` option to `Performance/RedundantEqualityComparisonBlock`.

```ruby
# `AllowRegexpMatch: true` (default)

# good
items.all? { |item| item =~ pattern }
items.all? { |item| item.match?(pattern) }

# `AllowRegexpMatch: false`

# bad
items.all? { |item| item =~ pattern }
items.all? { |item| item.match?(pattern) }
```

`AllowRegexpMatch: false` by default because `regexp.match?('string')` often used in block
changes to the opposite result:

```ruby
[/pattern/].all? { |regexp| regexp.match?('pattern') } # => true
[/pattern/].all? { |regexp| regexp =~ 'pattern' }      # => true
[/pattern/].all?('pattern')                            # => false
```
@koic koic force-pushed the add_allow_regexp_match_option_to_performance_redundant_equality_comparison_block branch from ef0cdd4 to a160f92 Compare March 13, 2023 16:04
@fatkodima
Copy link
Contributor

You probably forgot to add Changed: <<next>> to the default.yml.
Lgtm 👍 , thanks.

@koic
Copy link
Member Author

koic commented Mar 14, 2023

VersionChanged: <<next>> is not written intentionally. Because #340 has not been released yet and the new AllowRegexpMatch option defaults to false so there is backward compatibility.

@koic koic merged commit 31cb27c into rubocop:master Mar 14, 2023
@koic koic deleted the add_allow_regexp_match_option_to_performance_redundant_equality_comparison_block branch March 14, 2023 16:52
koic added a commit that referenced this pull request Apr 9, 2023
#339 has been feature changed to #347.
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