Pluginfy RuboCop Performance

This PR adds support for RuboCop's Plugin feature.

Since RuboCop Performance still supports some older versions of RuboCop,
a conditional check using `RuboCop.const_defined?(:Plugin)` has been added for compatibility.

Once only versions of RuboCop that support the Plugin feature are supported,
the compatibility code and the `RuboCop::Performance::Inject` module will be removed.

This means that the legacy style will gradually become deprecated in the near future.

.rubocop.yml

@@ -1,9 +1,12 @@
 # This is the configuration used to check the rubocop source code.
 
 inherit_from: .rubocop_todo.yml
-require:
+
+plugins:
   - rubocop/cop/internal_affairs
   - rubocop-performance
+
+require:
   - rubocop-rspec
 
 AllCops:

Gemfile

@@ -10,7 +10,8 @@ gem 'bump', require: false
 gem 'prism'
 gem 'rake'
 gem 'rspec'
-gem 'rubocop', github: 'rubocop/rubocop'
+# FIXME: Revert this once rubocop/rubocop#13792 is merged and released.
+gem 'rubocop', github: 'koic/rubocop', branch: 'support_rubocop_extension_plugin'
 gem 'rubocop-rspec', '~> 3.3.0'
 gem 'simplecov'
 gem 'test-queue'

README.md

@@ -22,10 +22,51 @@ gem 'rubocop-performance', require: false
 
 ## Usage
 
-You need to tell RuboCop to load the Performance extension. There are three
+You need to tell RuboCop to load the Performance extension. There are some
 ways to do this:
 
-### RuboCop configuration file
+### RuboCop configuration file (Recommended Style)
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+plugins: rubocop-performance
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+plugins:
+  - rubocop-other-extension
+  - rubocop-performance
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Performance
+cops together with the standard cops.
+
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+.
+
+Now you can run `rubocop` and it will automatically load the RuboCop Performance
+cops together with the standard cops.
+
+### Command line
+
+```sh
+$ rubocop --plugin rubocop-performance
+```
+
+### Rake task
+
+```ruby
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.plugins << 'rubocop-performance'
+end
+```
+
+### RuboCop configuration file (Legacy Style)
 
 Put this into your `.rubocop.yml`.
 
@@ -44,13 +85,13 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Performance
 cops together with the standard cops.
 
-### Command line
+### Command line (Legacy Style)
 
 ```sh
 $ rubocop --require rubocop-performance
 ```
 
-### Rake task
+### Rake task (Legacy Style)
 
 ```ruby
 require 'rubocop/rake_task'

changelog/new_pluginfy_with_lint_roller.md

@@ -0,0 +1 @@
+* [#490](https://github.com/rubocop/rubocop-performance/pull/490): Pluginfy RuboCop Performance. ([@koic][])

docs/modules/ROOT/pages/usage.adoc

@@ -1,29 +1,59 @@
 = Usage
 
-You need to tell RuboCop to load the Performance extension. There are three
+You need to tell RuboCop to load the Performance extension. There are some
 ways to do this:
 
-== RuboCop configuration file
+== RuboCop configuration file (Recommended Style)
 
 Put this into your `.rubocop.yml`.
 
 [source,yaml]
 ----
-require: rubocop-performance
+plugins: rubocop-performance
 ----
 
 Now you can run `rubocop` and it will automatically load the RuboCop Performance
 cops together with the standard cops.
 
+NOTE: The plugin system is supported in RuboCop 1.72+.
+
 == Command line
 
 [source,sh]
 ----
-$ rubocop --require rubocop-performance
+$ rubocop --plugin rubocop-performance
 ----
 
 == Rake task
 
+[source,ruby]
+----
+RuboCop::RakeTask.new do |task|
+  task.plugins << 'rubocop-performance'
+end
+----
+
+== RuboCop configuration file (Legacy Style)
+
+Put this into your `.rubocop.yml`.
+
+[source,yaml]
+----
+require: rubocop-performance
+----
+
+Now you can run `rubocop` and it will automatically load the RuboCop Performance
+cops together with the standard cops.
+
+== Command line (Legacy Style)
+
+[source,sh]
+----
+$ rubocop --require rubocop-performance
+----
+
+== Rake task (Legacy Style)
+
 [source,ruby]
 ----
 RuboCop::RakeTask.new do |task|

lib/rubocop-performance.rb

@@ -4,9 +4,17 @@
 
 require_relative 'rubocop/performance'
 require_relative 'rubocop/performance/version'
-require_relative 'rubocop/performance/inject'
 
-RuboCop::Performance::Inject.defaults!
+# FIXME: When RuboCop Rails requires RuboCop 1.72.0+ only, the following compatibility code can be removed.
+if RuboCop.const_defined?(:Plugin)
+  require_relative 'rubocop/performance/plugin'
+else
+  # NOTE: Until the plugin stabilizes, an option to use the older version of RuboCop is provided.
+  # The plugin will be unified in the future.
+  require_relative 'rubocop/performance/inject'
+
+  RuboCop::Performance::Inject.defaults!
+end
 
 require_relative 'rubocop/cop/performance_cops'
 

lib/rubocop/performance.rb

@@ -8,6 +8,6 @@ module Performance
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
 
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
+    ConfigObsoletion.files << Pathname("#{__dir__}/../../config/obsoletion.yml")
   end
 end

lib/rubocop/performance/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Performance
+    # A plugin that integrates RuboCop Performance with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-performance',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-performance',
+          description: 'A collection of RuboCop cops to check for performance optimizations in Ruby code.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

rubocop-performance.gemspec

@@ -30,6 +30,9 @@ Gem::Specification.new do |s|
     'rubygems_mfa_required' => 'true'
   }
 
+  s.metadata['default_lint_roller_plugin'] = 'RuboCop::Performance::Plugin'
+
+  s.add_dependency('lint_roller', '~> 1.1')
   s.add_dependency('rubocop', '>= 1.48.1', '< 2.0')
   s.add_dependency('rubocop-ast', '>= 1.38.0', '< 2.0')
 end

spec/spec_helper.rb

@@ -3,6 +3,9 @@
 require 'rubocop-performance'
 require 'rubocop/rspec/support'
 
+# FIXME: Once only RuboCop versions that support plugins remain, please remove the `if` condition.
+RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../config/default.yml") if RuboCop.const_defined?(:Plugin)
+
 if ENV.fetch('COVERAGE', nil) == 'true'
   require 'simplecov'
   SimpleCov.start

tasks/cops_documentation.rake

@@ -15,7 +15,7 @@ task update_cops_documentation: :yard_for_generate_documentation do
 
   # NOTE: Update `<<next>>` version for docs/modules/ROOT/pages/cops_performance.adoc
   # when running release tasks.
-  RuboCop::Performance::Inject.defaults!
+  RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../config/default.yml")
 
   CopsDocumentationGenerator.new(departments: deps).call
 end