Cop for deterministic regexp on String#split by mfbmina · Pull Request #190 · rubocop/rubocop-performance

mfbmina · 2020-11-07T20:29:56Z

This feature was requested here: https://github.com/rubocop-hq/rubocop/issues/8979

Sometimes, a regexp is used when a simple string could solve the problem, this PR looks for that when calling .split.

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.

koic · 2020-11-08T15:25:59Z

I came up with a cop name RedundantSplitRegexpArgument. But there seems to be a better name, however I can't hatch of it yet 😅

mfbmina · 2020-11-08T19:43:59Z

Hello @koic! I applied all the required changes! I also don't have a better name than that 😅 but I like yours better.

tas50 · 2020-11-09T01:40:33Z

Testing this out against my codebase it looks like it's matching on this code:

filter_parts = filter.split(/\./)

This is being autocorrected to:

filter_parts = filter.split('\.')

This should be autocorrected to:

filter_parts = filter.split('.')

mfbmina · 2020-11-09T17:09:38Z

@tas50 I couldn't reproduce your issue. Your case is not considered an offense and it will not be auto-corrected.

I also added a test case for it: https://github.com/rubocop-hq/rubocop-performance/pull/190/files#diff-bbc2461ef6fae3f431f7a7dbc2b3852a9bcf830680f583806a7429e2e414a830R14-R17

koic · 2020-12-18T04:37:44Z

Can you add the changelog entry to CHANGELOG.md and squash your commits into one?

mfbmina · 2020-12-28T13:30:07Z

@koic hello! sorry for taking long to respond to you! I've applied the necessary changes. Please review

mfbmina · 2021-01-14T21:33:19Z

Sorry, @koic!

I've missed this: Can you add the changelog entry to CHANGELOG.md and squash your commits into one?

It is done now!

Apply reviews Remove wrong configuration Fix auto-correction with escaping chars Ignore string special chars Guarantee string will behave the same when using special chars Apply review Add changelog Update docs/modules/ROOT/pages/cops_performance.adoc Co-authored-by: Tim Smith <tsmith84@gmail.com>

mfbmina · 2021-01-21T20:13:53Z

@koic @tas50 is something still missing?

tas50 · 2021-01-21T22:20:40Z

@mfbmina I'm happy with it.

koic · 2021-01-22T04:06:14Z

It looks good overall. I will tweak the changelog after merging. Thank you for implementing the useful cop!

Follow #190 (comment)

mfbmina · 2021-01-22T08:24:28Z

Thank you guys 😄

…gument` Follow rubocop#190. This PR fixes the following incorrect auto-correct for `Performance/RedundantSplitRegexpArgument` when using consecutive special string chars. ```console % cat example.rb "foo\nbar\nbaz\n".split(/\n\n/) % bundle exec rubocop example.rb --only Performance/RedundantSplitRegexpArgument -a Inspecting 1 file C Offenses: example.rb:1:25: C: [Corrected] Performance/RedundantSplitRegexpArgument: Use string as argument instead of regexp. "foo\nbar\nbaz\n".split(/\n\n/) ^^^^^^ 1 file inspected, 1 offense detected, 1 offense corrected ## Before ```console % cat example.rb "foo\nbar\nbaz\n".split("nn") ``` ## After ```console % cat example.rb "foo\nbar\nbaz\n".split("\n\n") ```

* Update rubocop from 1.12.1 to [1.13.0](https://github.com/rubocop-hq/rubocop/releases/tag/v1.13.0) * Update rubocop-performance from 1.9.2 to [1.11.1](https://github.com/rubocop-hq/rubocop-performance/releases/tag/v1.11.1) * Enabled the following rules: * [`Performance/RedundantSplitRegexpArgument`](rubocop/rubocop-performance#190) * [`Style/IfWithBooleanLiteralBranches`](rubocop/rubocop#9396) * [`Lint/TripleQuotes`](rubocop/rubocop#9402) * [`Lint/SymbolConversion`](rubocop/rubocop#9362) * [`Lint/OrAssignmentToConstant`](rubocop/rubocop#9363) * [`Lint/NumberedParameterAssignment`](rubocop/rubocop#9326) * [`Style/HashConversion`](rubocop/rubocop#9478) * [`Gemspec/DateAssignment`](rubocop/rubocop#9496) * [`Style/StringChars`](rubocop/rubocop#9615)

Follow rubocop/rubocop-performance#190 (comment)

koic reviewed Nov 8, 2020

View reviewed changes

Comment thread config/default.yml Outdated

koic reviewed Nov 8, 2020

View reviewed changes

Comment thread config/default.yml Outdated

koic reviewed Nov 8, 2020

View reviewed changes

Comment thread config/default.yml Outdated

koic reviewed Nov 8, 2020

View reviewed changes

Comment thread lib/rubocop/cop/performance/deterministic_regexp.rb Outdated

koic reviewed Nov 8, 2020

View reviewed changes

Comment thread spec/rubocop/cop/performance/deterministic_regexp_spec.rb Outdated

koic reviewed Nov 8, 2020

View reviewed changes

Comment thread spec/rubocop/cop/performance/deterministic_regexp_spec.rb Outdated

mfbmina requested a review from koic November 8, 2020 19:44

koic reviewed Nov 9, 2020

View reviewed changes

Comment thread config/default.yml Outdated

koic reviewed Nov 9, 2020

View reviewed changes

Comment thread config/default.yml Outdated

mfbmina force-pushed the regexp-in-split branch from c208adf to 122f40d Compare November 9, 2020 17:12

mfbmina requested a review from koic November 10, 2020 17:45

koic reviewed Nov 12, 2020

View reviewed changes

Comment thread spec/rubocop/cop/performance/redundant_split_regexp_argument_spec.rb Outdated

koic reviewed Nov 12, 2020

View reviewed changes

Comment thread spec/rubocop/cop/performance/redundant_split_regexp_argument_spec.rb Outdated

mfbmina requested a review from koic November 18, 2020 19:05

koic reviewed Nov 19, 2020

View reviewed changes

Comment thread lib/rubocop/cop/performance/redundant_split_regexp_argument.rb Outdated

mfbmina requested a review from koic November 24, 2020 15:59

koic reviewed Nov 25, 2020

View reviewed changes

Comment thread spec/rubocop/cop/performance/redundant_split_regexp_argument_spec.rb Outdated

koic reviewed Nov 25, 2020

View reviewed changes

Comment thread config/default.yml Outdated

koic reviewed Dec 18, 2020

View reviewed changes

Comment thread lib/rubocop/cop/performance/redundant_split_regexp_argument.rb Outdated

mfbmina force-pushed the regexp-in-split branch from a57f30f to 1ae6d24 Compare January 14, 2021 21:32

tas50 reviewed Jan 14, 2021

View reviewed changes

Comment thread docs/modules/ROOT/pages/cops_performance.adoc Outdated

mfbmina force-pushed the regexp-in-split branch from 618d856 to 5f3d528 Compare January 14, 2021 22:50

mfbmina requested a review from koic January 14, 2021 22:51

koic merged commit d0cc003 into rubocop:master Jan 22, 2021

koic added a commit that referenced this pull request Jan 22, 2021

Tweak the changelog

209a88b

Follow #190 (comment)

mfbmina deleted the regexp-in-split branch January 22, 2021 08:24

koic mentioned this pull request Jan 25, 2021

Fix an incorrect auto-correct for Performance/RedundantSplitRegexpArgument #209

Merged

8 tasks

dependabot Bot mentioned this pull request Mar 16, 2021

Bump rubocop-performance from 1.9.1 to 1.10.1 ministryofjustice/Claim-for-Crown-Court-Defence#3815

Merged

jmkoni mentioned this pull request May 3, 2021

Update rubocop and rubocop-performance and finally add in some new cops standardrb/standard#287

Merged

patrickm53 pushed a commit to patrickm53/performance-develop-rubyonrails that referenced this pull request Sep 23, 2022

Tweak the changelog

3207cd6

Follow rubocop/rubocop-performance#190 (comment)

richardstewart0213 added a commit to richardstewart0213/performance-build-Performance-optimization-analysis- that referenced this pull request Nov 4, 2022

Tweak the changelog

6588756

Follow rubocop/rubocop-performance#190 (comment)

Cute0110 added a commit to Cute0110/Rubocop-Performance that referenced this pull request Sep 28, 2023

Tweak the changelog

108221c

Follow rubocop/rubocop-performance#190 (comment)

SerhiiMisiura added a commit to SerhiiMisiura/Rubocop-Performance that referenced this pull request Oct 5, 2023

Tweak the changelog

1a82583

Follow rubocop/rubocop-performance#190 (comment)

Uh oh!

Conversation

mfbmina commented Nov 7, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koic commented Nov 8, 2020

Uh oh!

mfbmina commented Nov 8, 2020

Uh oh!

tas50 commented Nov 9, 2020

Uh oh!

Uh oh!

Uh oh!

mfbmina commented Nov 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koic commented Dec 18, 2020

Uh oh!

mfbmina commented Dec 28, 2020

Uh oh!

mfbmina commented Jan 14, 2021

Uh oh!

Uh oh!

mfbmina commented Jan 21, 2021

Uh oh!

tas50 commented Jan 21, 2021

Uh oh!

koic commented Jan 22, 2021

Uh oh!

mfbmina commented Jan 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mfbmina commented Nov 9, 2020 •

edited

Loading