Merge pull request #1434 from koic/pluginfy_with_lint_roller

Pluginfy RuboCop Rails

Author: koic

.github/workflows/test.yml

@@ -83,7 +83,7 @@ jobs:
               -e "/gem 'rubocop-performance',/d" \
               -e "/gem 'rubocop-rspec',/d" -i Gemfile
           cat << EOF > Gemfile.local
-            gem 'rubocop', '1.52.0' # Specify the oldest supported RuboCop version
+            gem 'rubocop', '1.72.1'
           EOF
       - uses: ruby/setup-ruby@v1
         with:

.rubocop.yml

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

README.md

@@ -31,35 +31,36 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-rails
+plugins: rubocop-rails
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-rails
 ```
 
 Now you can run `rubocop` and it will automatically load the RuboCop Rails
 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-rails
+$ rubocop --plugin rubocop-rails
 ```
 
-Note: `--rails` option is required while `rubocop` command supports `--rails` option.
-
 ### Rake task
 
 ```ruby
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rails'
+  task.plugins << 'rubocop-rails'
 end
 ```
 

changelog/new_pluginfy_with_lint_roller.md

@@ -0,0 +1 @@
+* [#1434](https://github.com/rubocop/rubocop-rails/pull/1434): Pluginfy RuboCop Rails. ([@koic][])

docs/modules/ROOT/pages/usage.adoc

@@ -9,7 +9,7 @@ Put this into your `.rubocop.yml`.
 
 [source,yaml]
 ----
-require: rubocop-rails
+plugins: rubocop-rails
 ----
 
 Now you can run `rubocop` and it will automatically load the RuboCop Rails
@@ -19,18 +19,20 @@ cops together with the standard cops.
 
 [source,sh]
 ----
-$ rubocop --require rubocop-rails
+$ rubocop --plugin rubocop-rails
 ----
 
 == Rake task
 
 [source,ruby]
 ----
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rails'
+  task.plugins << 'rubocop-rails'
 end
 ----
 
+NOTE: The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 == RuboCop Rails configuration
 
 The following settings specific to RuboCop Rails can be configured in `.rubocop.yml`.

lib/rubocop-rails.rb

@@ -7,12 +7,9 @@
 
 require_relative 'rubocop/rails'
 require_relative 'rubocop/rails/version'
-require_relative 'rubocop/rails/inject'
 require_relative 'rubocop/rails/schema_loader'
 require_relative 'rubocop/rails/schema_loader/schema'
-
-RuboCop::Rails::Inject.defaults!
-
+require_relative 'rubocop/rails/plugin'
 require_relative 'rubocop/cop/rails_cops'
 
 require_relative 'rubocop/rails/migration_file_skippable'

lib/rubocop/rails.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
 module RuboCop
-  # RuboCop Rails project namespace
+  # RuboCop Rails project namespace.
   module Rails
-    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/rails/inject.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Rails
+    # A plugin that integrates RuboCop Rails with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-rails',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-rails',
+          description: 'A RuboCop extension focused on enforcing Rails best practices and coding conventions.'
+        )
+      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

lib/rubocop/rails/plugin.rb

@@ -28,13 +28,15 @@ Gem::Specification.new do |s|
     'source_code_uri' => 'https://github.com/rubocop/rubocop-rails/',
     'documentation_uri' => "https://docs.rubocop.org/rubocop-rails/#{RuboCop::Rails::Version.document_version}/",
     'bug_tracker_uri' => 'https://github.com/rubocop/rubocop-rails/issues',
-    'rubygems_mfa_required' => 'true'
+    'rubygems_mfa_required' => 'true',
+    'default_lint_roller_plugin' => 'RuboCop::Rails::Plugin'
   }
 
   s.add_dependency 'activesupport', '>= 4.2.0'
   # Rack::Utils::SYMBOL_TO_STATUS_CODE, which is used by HttpStatus cop, was
   # introduced in rack 1.1
+  s.add_dependency 'lint_roller', '~> 1.1'
   s.add_dependency 'rack', '>= 1.1'
-  s.add_dependency 'rubocop', '>= 1.52.0', '< 2.0'
+  s.add_dependency 'rubocop', '>= 1.72.1', '< 2.0'
   s.add_dependency 'rubocop-ast', '>= 1.38.0', '< 2.0'
 end