Pluginfy RuboCop Performance

koic · koic · commit b83339d4bad0 · 2025-02-16T00:56:39.000+09:00
This PR adds support for RuboCop's Plugin feature: rubocop/rubocop#13792 It replaces the ad-hoc `Inject` with RuboCop plugins introduced in RuboCop 1.72. NOTE: Version 1.72.1 or later is specified, as it includes rubocop/rubocop#13837, which removes the `Inject` from spec_helper.rb. While 1.72.0 is sufficient for runtime, but specifying the patch version 1.72.1 keeps things simple.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -92,7 +92,7 @@ jobs:
           sed -e "/gem 'rubocop', github: 'rubocop\/rubocop'/d" \
               -e "/gem 'rubocop-rspec',/d" -i Gemfile
           cat << EOF > Gemfile.local
-            gem 'rubocop', '1.48.1' # Specify the oldest supported RuboCop version
+            gem 'rubocop', '1.72.1' # Specify the oldest supported RuboCop version
           EOF
       - name: set up Ruby
         uses: ruby/setup-ruby@v1
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,9 +1,12 @@
 # This is the configuration used to check the rubocop source code.
 
 inherit_from: .rubocop_todo.yml
-require:
-  - rubocop/cop/internal_affairs
+
+plugins:
+  - rubocop-internal_affairs
   - rubocop-performance
+
+require:
   - rubocop-rspec
 
 AllCops:
diff --git a/README.md b/README.md
@@ -30,24 +30,27 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-performance
+plugins: rubocop-performance
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+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+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```sh
-$ rubocop --require rubocop-performance
+$ rubocop --plugin rubocop-performance
 ```
 
 ### Rake task
@@ -56,7 +59,7 @@ $ rubocop --require rubocop-performance
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-performance'
+  task.plugins << 'rubocop-performance'
 end
 ```
 
diff --git a/changelog/new_pluginfy_with_lint_roller.md b/changelog/new_pluginfy_with_lint_roller.md
@@ -0,0 +1 @@
+* [#490](https://github.com/rubocop/rubocop-performance/pull/490): Pluginfy RuboCop Performance. ([@koic][])
diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc
@@ -9,24 +9,26 @@ 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+. In earlier versions, use `require` instead of `plugins`.
+
 == Command line
 
 [source,sh]
 ----
-$ rubocop --require rubocop-performance
+$ rubocop --plugin rubocop-performance
 ----
 
 == Rake task
 
 [source,ruby]
 ----
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-performance'
+  task.plugins << 'rubocop-performance'
 end
 ----
diff --git a/lib/rubocop-performance.rb b/lib/rubocop-performance.rb
@@ -4,10 +4,7 @@
 
 require_relative 'rubocop/performance'
 require_relative 'rubocop/performance/version'
-require_relative 'rubocop/performance/inject'
-
-RuboCop::Performance::Inject.defaults!
-
+require_relative 'rubocop/performance/plugin'
 require_relative 'rubocop/cop/performance_cops'
 
 RuboCop::Cop::Lint::UnusedMethodArgument.singleton_class.prepend(
diff --git a/lib/rubocop/performance.rb b/lib/rubocop/performance.rb
@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
 module RuboCop
-  # RuboCop Performance project namespace
+  # RuboCop Performance project namespace.
   module Performance
-    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
   end
 end
diff --git a/lib/rubocop/performance/inject.rb b/lib/rubocop/performance/inject.rb
diff --git a/lib/rubocop/performance/plugin.rb b/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)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        ConfigObsoletion.files << project_root.join('config', 'obsoletion.yml')
+
+        LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join('config', 'default.yml'))
+      end
+    end
+  end
+end
diff --git a/rubocop-performance.gemspec b/rubocop-performance.gemspec
@@ -27,9 +27,11 @@ Gem::Specification.new do |s|
     'source_code_uri' => 'https://github.com/rubocop/rubocop-performance/',
     'documentation_uri' => "https://docs.rubocop.org/rubocop-performance/#{RuboCop::Performance::Version.document_version}/",
     'bug_tracker_uri' => 'https://github.com/rubocop/rubocop-performance/issues',
-    'rubygems_mfa_required' => 'true'
+    'rubygems_mfa_required' => 'true',
+    'default_lint_roller_plugin' => 'RuboCop::Performance::Plugin'
   }
 
-  s.add_dependency('rubocop', '>= 1.48.1', '< 2.0')
+  s.add_dependency('lint_roller', '~> 1.1')
+  s.add_dependency('rubocop', '>= 1.72.1', '< 2.0')
   s.add_dependency('rubocop-ast', '>= 1.38.0', '< 2.0')
 end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -9,10 +9,6 @@
 end
 
 RSpec.configure do |config|
-  # TODO: It can be removed when the oldest supported RuboCop version is greater than 1.71.0.
-  # https://github.com/rubocop/rubocop/pull/13748
-  config.include RuboCop::RSpec::ExpectOffense
-
   config.shared_context_metadata_behavior = :apply_to_host_groups
   config.filter_run_when_matching :focus
   config.filter_run_excluding broken_on: :prism if ENV['PARSER_ENGINE'] == 'parser_prism'
diff --git a/tasks/cops_documentation.rake b/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

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+* [#490](https://github.com/rubocop/rubocop-performance/pull/490): Pluginfy RuboCop Performance. ([@koic][])`