Extract Performance Cops into a separate gem #5977

bbatsov · 2018-06-09T10:07:03Z

Performance cops have to extracted into a standalone gem (named something like rubocop-performance or whatever).

The reason for this decision is simple. I want RuboCop to be focused just on Ruby and have no framework/library/runtime dependant pieces for the sake of being easier to focus on evolving it. Creating more extensions should also help us come up with a good official API for them. Performance cops are all MRI focused and are highly dependent of the version of MRI you're using, so they don't belong in the core RuboCop.

Any volunteers to do this? I was always ambivalent towards the performance checks (as they often come at the expense of readability), so I'm not particularly interested in working on this.

Drenmi · 2018-06-09T10:15:39Z

Any volunteers to do this? I was always ambivalent towards the performance checks (as they often come at the expense of readability), so I'm not particularly interested in working on this.

Agreed. Language level optimizations also suffer from being subject to the current VM implementation. So a big task for whoever wants to take this would be to benchmark on every Ruby version and see that the improvements still hold.

bbatsov · 2018-06-09T10:33:45Z

Although they just extract it as-is in the beginning and improve things later. Probably performance cops should have explicit versions on which they make sense as part of their config.

gizotti · 2018-06-10T11:57:48Z

Extracting as it is into a gem seems simple enough. I could handle this one if nobody is on it yet.

I also like the idea of showing instructions on how to add the gem if they have performance cops in their configs, the same way you suggested on #5976.

bbatsov · 2018-06-10T12:10:32Z

@gizotti Happy to hear this!

I've created a placeholder repo for the extraction https://github.com/rubocop-hq/rubocop-performance

gizotti · 2018-06-10T12:26:22Z

@bbatsov can you just add a README on the repo please? I can't fork an empty repo :)

bbatsov · 2018-06-10T12:32:47Z

Done.

composerinteralia · 2018-06-10T21:25:15Z

Oh darn, I didn't see that you wanted to take this on @gizotti. I opened rubocop/rubocop-performance#1 but maybe we can work together on it.

If you are already further along than I was, I can also just close the PR. I should have checked the issue again before doing anything.

gizotti · 2018-06-10T21:40:45Z

No worries @composerinteralia, I got to where you were last night so not reason to push my stuff if you already did.
I'll leave you to it, I think if we both work in the same branch we might step on each others toes.

koic · 2018-10-01T12:11:15Z

I'm investigating the same git history problem as the current RuboCop Rails repository. The current situation is below.
#5976 (comment)

koic · 2018-10-12T07:43:29Z

@bbatsov @composerinteralia
Cc @rubocop-hq/rubocop-core

I extracted lib/rubocop/cop/performance/* and spec/rubocop/cop/performance/* along with git history from RuboCop Core (I used git cherry-pick for this extraction) .
I think that lib/rubocop/cop/performance and spec/rubocop/cop/performance will be the most important history in maintenance.

The following branch including previous work done in RuboCop Performance repo, and it is synchronized with the latest performance cops of RuboCop Core.
https://github.com/koic/rubocop-performance/tree/import_performance_cops_with_git_history

If it's OK, force-push this branch to master of RuboCop Performance repo.
https://github.com/rubocop-hq/rubocop-performance

After that, we can restart work based on this git history for this issue.

📝 @amatsuda told me the experiecce that how to divided Kaminari repo at Asakusa.rb. So I was able to obtain great knowledge. Thank you!

Drenmi · 2018-10-12T07:46:25Z

@koic, @amatsuda 🙇

bbatsov · 2018-10-12T07:51:33Z

If it's OK, force-push this branch to master of RuboCop Performance repo.

Yeah, it's OK. Make this happen!

P.S. Great work, probably should document the process somewhere for future reference.

koic · 2018-10-12T09:01:14Z

Thanks! I force-pushed it.
This was a very steady work 😅, but I'm thinking of share know-how somewhere.

koic · 2019-03-13T09:17:30Z

@bbatsov Thank you for waiting. We can release the rubocop-performance gem.

We need to decide on the rubocop-performance version to be released. The version number should be a number greater than 0.61.
rubocop/rubocop-performance#26 (review)

Also, I'm ready to remove performance cops from rubocop-hq/rubocop repo, but before that we need to notify the users in some way.

Anyway, it is good to release the rubocop-performance gem.

bbatsov · 2019-03-13T18:42:10Z

Fantastic work!

Let's go with version 1.0 for rubocop-performance.

bbatsov · 2019-03-13T18:45:19Z

Also, I'm ready to remove performance cops from rubocop-hq/rubocop repo, but before that we need to notify the users in some way.

Let's just add some message that say on gem install that the cops are going to be moved to a different gem. Can't think of any better way to notify them about the change, so I hope this will be enough.

koic · 2019-03-14T07:31:06Z

Thank you for the advice!
First I will release rubocop-performance 1.0. After that, I will open a PR to RuboCop core which will fallback to rubocop-performance with the message.

bbatsov · 2019-03-14T07:34:56Z

👍

Follow up of rubocop/rubocop#5977 (comment). This PR prepares for release 1.0.0.

koic · 2019-03-14T08:29:02Z

rubocop-performance 1.0.0 has been released 🚀
https://rubygems.org/gems/rubocop-performance/versions/1.0.0

bbatsov · 2019-03-14T08:39:11Z

Fantastic!

I'll make an announcement once we've made the necessary changes to RuboCop itself.

Fixes #5977. This PR removes Performance cops from RuboCop core. These cops were transferred to rubocop-hq/rubocop-performance repository. https://github.com/rubocop-hq/rubocop-performance

Performance cops will be extracted from RuboCop to RuboCop Performance when next RuboCop 0.68 will be released. rubocop/rubocop#5977 RuboCop 0.67 is its transition period. Since rails/rails repository uses Performance cops, This PR added rubocop-performance gem to Gemfile. And this PR fixes some offenses using the following auto-correct. ```console % bundle exec rubocop -a Offenses: activerecord/test/cases/connection_adapters/connection_handlers_multi_db_test.rb:212:26: C: [Corrected] Layout/SpaceAroundOperators: Operator = > should be surrounded by a single space. "primary" => { adapter: "sqlite3", database: "db/primary.sqlite3" } ^^ activerecord/test/cases/connection_adapters/connection_handlers_multi_db_test.rb:239:26: C: [Corrected] Layout/SpaceAroundOperators: Operator => should be surrounded by a single space. "primary" => { adapter: "sqlite3", database: "db/primary.sqlite3" } ^^ actionview/test/template/resolver_shared_tests.rb:1:1: C: [Corrected] Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true. module ResolverSharedTests ^ actionview/test/template/resolver_shared_tests.rb:10:33: C: [Corrected] Layout/SpaceAroundEqualsInParameterDefault: Surrounding space missing in default value assignment. def with_file(filename, source="File at #{filename}") ^ actionview/test/template/resolver_shared_tests.rb:106:5: C: [Corrected] Rails/RefuteMethods: Prefer assert_not_same over refute_same. refute_same a, b ^^^^^^^^^^^ 2760 files inspected, 5 offenses detected, 5 offenses corrected ```

Performance cops were moved out in to their own gem in Rubocop 0.68[1], which means that referring to them logs a warning like: `Warning: unrecognized cop Performance/Casecmp found in …` Remove the reference to the performance cop to resolve this. Note that it may negatively impact users who do not upgrade to 0.68, as this previously disabled Performace cop will now be enabled until they upgrade to 0.68. [1]: rubocop/rubocop#5977

@koic

Performance cops were extracted in rubocop/rubocop#5977 and @koic updated to 0.67.2 and added the rubocop-performance gem in rails#35989. This bumps rubocop to 0.68.1 to be on the latest version. Two changes were made in regards to the bump of the version: * The first was that Layout/FirstParameterIndentation was renamed to Layout/IndentFirstArgument. These changes can be seen in rubocop/rubocop#6982 and rubocop/rubocop#6987 * The second was that a new instance of the Style/HashSyntax cop was found. I updated that instance to follow the new Ruby >= 1.9 syntax.

These cops are no longer available in core rubocop. rubocop/rubocop#5977

This should have the same result. The extra gem is because this rubocop-performance functionality was extracted from the main gem and needed to be added back in. More info is in rubocop/rubocop#5977

refs: rubocop/rubocop#5977

pirj · 2020-11-06T20:38:44Z

I've just realised that you used cherry-pick to keep the history in the extracted extension.
If you happen to face a similar task in the future, I highly recommend using git-filter-repo (but be careful, it's destructive to an extent where reflog doesn't help).

marcandre · 2020-11-06T20:43:22Z

👍 That's what I used to extract rubocop-ast

bbatsov · 2020-11-07T07:51:08Z

@pirj Looks pretty cool! Thanks for sharing it!

koic · 2020-11-07T11:32:12Z

@pirj 👍 I can't remember what was wrong, I remember giving up on git filter-branch because something couldn't be achieved at that time. And I didn't know "git-filter-repo", it could have been easier with it! 😅 Great thank you for letting me know.

Follow up of rubocop/rubocop#5977 (comment). This PR prepares for release 1.0.0.

bbatsov added refactoring help wanted labels Jun 9, 2018

bbatsov added this to the 1.0.0 milestone Jun 9, 2018

bbatsov added the high priority A ticket considered important by RuboCop's Core Team label Sep 12, 2018

matkoniecz mentioned this issue Jan 8, 2019

promote Performance/LstripRstrip to Style/LstripRstrip #6637

Closed

koic added a commit to koic/rubocop-performance that referenced this issue Mar 14, 2019

Preparing for 1.0.0 release

b2b2f97

Follow up of rubocop/rubocop#5977 (comment). This PR prepares for release 1.0.0.

koic mentioned this issue Mar 14, 2019

Preparing for 1.0.0 release rubocop/rubocop-performance#34

Merged

8 tasks

bbatsov closed this as completed in #6890 Apr 8, 2019

koic mentioned this issue Apr 16, 2019

Bump RuboCop to 0.67.2 rails/rails#35989

Merged

dylnclrk mentioned this issue Apr 30, 2019

Remove reference to performance cop carbonfive/c5-conventions#6

Closed

tiegz mentioned this issue May 3, 2019

Update rubocop yaml librariesio/bibliothecary#452

Merged

natesholland mentioned this issue May 4, 2019

Bump RuboCop to 0.68.1 rails/rails#36176

Closed

benthorner pushed a commit to alphagov/govuk-lint that referenced this issue May 8, 2019

Remove performance cops

ecf3892

These cops are no longer available in core rubocop. rubocop/rubocop#5977

benthorner pushed a commit to alphagov/govuk-lint that referenced this issue May 8, 2019

Remove performance cops

a9e01f6

These cops are no longer available in core rubocop. rubocop/rubocop#5977

osis mentioned this issue May 8, 2019

Upgrade rubocop to 0.68.1 and adds rubocop-performance 1.0.0 pivotal/LicenseFinder#581

Merged

benthorner mentioned this issue May 8, 2019

Remove performance cops alphagov/govuk-lint#115

Merged

MrChrisW mentioned this issue May 30, 2019

Namespace Changes for RuboCop 0.70 github/rubocop-github#38

Merged

ta1kt0me added a commit to grooves/forkwell_cop that referenced this issue May 31, 2019

Follow up extracting Performance cop to gem

ea50a76

refs: rubocop/rubocop#5977

kennyadsl mentioned this issue Jul 17, 2019

Extension maintenance solidusio/solidus_auth_devise#163

Merged

yahonda mentioned this issue Apr 14, 2020

[WIP] Migrate Arel code from Rails to Oracle enhanced adapter rsim/oracle-enhanced#2001

Closed

3 tasks

rdipardo mentioned this issue Apr 29, 2020

Add vendor/ to excluded directories in .rubocop.yml pages-themes/slate#39

Closed

gemmaro mentioned this issue Oct 3, 2021

RuboCopのバージョンについて aozorahack/aozora2html#44

Closed

renawatson68 added a commit to renawatson68/performance-develop-rubyonrails that referenced this issue Sep 23, 2022

Preparing for 1.0.0 release

784febe

Follow up of rubocop/rubocop#5977 (comment). This PR prepares for release 1.0.0.

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

Preparing for 1.0.0 release

7b8fe0b

Follow up of rubocop/rubocop#5977 (comment). This PR prepares for release 1.0.0.

MarttiCheng added a commit to MarttiCheng/Rubocop-Performance that referenced this issue Sep 28, 2023

Preparing for 1.0.0 release

cffb7bd

Follow up of rubocop/rubocop#5977 (comment). This PR prepares for release 1.0.0.

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

Preparing for 1.0.0 release

7b644ac

Follow up of rubocop/rubocop#5977 (comment). This PR prepares for release 1.0.0.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extract Performance Cops into a separate gem #5977

Extract Performance Cops into a separate gem #5977

bbatsov commented Jun 9, 2018

Drenmi commented Jun 9, 2018

bbatsov commented Jun 9, 2018

gizotti commented Jun 10, 2018 •

edited

bbatsov commented Jun 10, 2018

gizotti commented Jun 10, 2018

bbatsov commented Jun 10, 2018

composerinteralia commented Jun 10, 2018 •

edited

gizotti commented Jun 10, 2018

koic commented Oct 1, 2018

koic commented Oct 12, 2018

Drenmi commented Oct 12, 2018

bbatsov commented Oct 12, 2018

koic commented Oct 12, 2018

koic commented Mar 13, 2019

bbatsov commented Mar 13, 2019

bbatsov commented Mar 13, 2019

koic commented Mar 14, 2019

bbatsov commented Mar 14, 2019

koic commented Mar 14, 2019

bbatsov commented Mar 14, 2019

pirj commented Nov 6, 2020

marcandre commented Nov 6, 2020

bbatsov commented Nov 7, 2020

koic commented Nov 7, 2020

Extract Performance Cops into a separate gem #5977

Extract Performance Cops into a separate gem #5977

Comments

bbatsov commented Jun 9, 2018

Drenmi commented Jun 9, 2018

bbatsov commented Jun 9, 2018

gizotti commented Jun 10, 2018 • edited

bbatsov commented Jun 10, 2018

gizotti commented Jun 10, 2018

bbatsov commented Jun 10, 2018

composerinteralia commented Jun 10, 2018 • edited

gizotti commented Jun 10, 2018

koic commented Oct 1, 2018

koic commented Oct 12, 2018

Drenmi commented Oct 12, 2018

bbatsov commented Oct 12, 2018

koic commented Oct 12, 2018

koic commented Mar 13, 2019

bbatsov commented Mar 13, 2019

bbatsov commented Mar 13, 2019

koic commented Mar 14, 2019

bbatsov commented Mar 14, 2019

koic commented Mar 14, 2019

bbatsov commented Mar 14, 2019

pirj commented Nov 6, 2020

marcandre commented Nov 6, 2020

bbatsov commented Nov 7, 2020

koic commented Nov 7, 2020

gizotti commented Jun 10, 2018 •

edited

composerinteralia commented Jun 10, 2018 •

edited