Merge pull request #2042 from koic/pluginfy_with_lint_roller

Pluginfy RuboCop RSpec

Author: bquorning

.github/workflows/main.yml

@@ -91,7 +91,7 @@ jobs:
       - uses: actions/checkout@v4
       - name: Use oldest RuboCop allowed by gemspec
         run: |
-          sed -nr "s/ *spec.add_dependency 'rubocop', '~> ([0-9\.]+)'/gem 'rubocop', '= \1'/p" \
+          sed -nr "s/ *spec.add_dependency 'rubocop'.*'>= ([0-9\.]+)'/gem 'rubocop', '= \1'/p" \
             rubocop-rspec.gemspec > Gemfile.local
           cat Gemfile.local
       - uses: ruby/setup-ruby@v1

.rubocop.yml

@@ -1,10 +1,10 @@
 inherit_from: .rubocop_todo.yml
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
-  - rubocop/cop/internal_affairs
+  - rubocop-internal_affairs
 
 AllCops:
   DisplayCopNames: true

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Don't let `RSpec/PredicateMatcher` replace `respond_to?` with two arguments with the RSpec `respond_to` matcher. ([@bquorning])
 - Fix `RSpec/PredicateMatcher` support for `eql` and `equal` matchers. ([@bquorning])
+- Pluginfy RuboCop RSpec. ([@koic])
 
 ## 3.4.0 (2025-01-20)
 

README.md

@@ -48,31 +48,34 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-rspec
+plugins: rubocop-rspec
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-rspec
 ```
 
 Now you can run `rubocop` and it will automatically load the RuboCop RSpec
 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
 
 ```bash
-rubocop --require rubocop-rspec
+rubocop --plugin rubocop-rspec
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec'
+  task.plugins << 'rubocop-rspec'
 end
 ```
 

docs/modules/ROOT/pages/usage.adoc

@@ -8,20 +8,22 @@ There are three ways to do this:
 Put this into your `.rubocop.yml`:
 
 ----
-require: rubocop-rspec
+plugins: rubocop-rspec
 ----
 
 or, if you are using several extensions:
 
 ----
-require:
+plugins:
   - rubocop-rspec
   - rubocop-performance
 ----
 
 Now you can run `rubocop` and it will automatically load the RuboCop RSpec
 cops together with the standard cops.
 
+NOTE: The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 === RSpec DSL configuration
 
 In case you https://github.com/rspec/rspec-core/blob/b0d0843a285693c64cdbe0c85726db155b46047e/lib/rspec/core/configuration.rb#L1122[define aliases for RSpec DSL], i.e. examples, example groups, hooks, or include example statements, you need to configure it so those elements are properly detected by RuboCop RSpec.
@@ -78,15 +80,15 @@ RuboCop RSpec's https://github.com/rubocop/rubocop-rspec/blob/a43424527c09fae2e6
 
 [source,bash]
 ----
-$ rubocop --require rubocop-rspec
+$ rubocop --plugin rubocop-rspec
 ----
 
 == Rake task
 
 [source,ruby]
 ----
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec'
+  task.plugins << 'rubocop-rspec'
 end
 ----
 

lib/rubocop-rspec.rb

@@ -6,9 +6,9 @@
 require 'rubocop'
 
 require_relative 'rubocop/rspec'
-require_relative 'rubocop/rspec/inject'
 require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/node'
+require_relative 'rubocop/rspec/plugin'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/wording'
 
@@ -34,8 +34,6 @@
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/hook'
 
-RuboCop::RSpec::Inject.defaults!
-
 require_relative 'rubocop/cop/rspec_cops'
 
 # We have to register our autocorrect incompatibilities in RuboCop's cops

lib/rubocop/rspec.rb

@@ -3,12 +3,5 @@
 module RuboCop
   # RuboCop RSpec project namespace
   module RSpec
-    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

lib/rubocop/rspec/inject.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module RSpec
+    # A plugin that integrates RuboCop RSpec with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-rspec',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-rspec',
+          description: 'Code style checking for RSpec files.'
+        )
+      end
+      # :nocov:
+
+      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

lib/rubocop/rspec/plugin.rb

@@ -34,8 +34,10 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'changelog_uri' => 'https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md',
     'documentation_uri' => 'https://docs.rubocop.org/rubocop-rspec/',
-    'rubygems_mfa_required' => 'true'
+    'rubygems_mfa_required' => 'true',
+    'default_lint_roller_plugin' => 'RuboCop::RSpec::Plugin'
   }
 
-  spec.add_dependency 'rubocop', '~> 1.61'
+  spec.add_dependency 'lint_roller', '~> 1.1'
+  spec.add_dependency 'rubocop', '~> 1.72', '>= 1.72.1'
 end