rubocop-airbnb 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccce4935f81b65b3ebbdcdf3f5d4b8ab5638185d94f6df4f26cb02bbb8055916
-  data.tar.gz: e9b7b767b4443f4d608a446a1a8043770bb9fd388561b8f99991616747f0b634
+  metadata.gz: 659a6878548873c1b6736354126949f0825dc76a717263eb83cd6ee32ac02561
+  data.tar.gz: f6680699553af27121ae53305d27976d61de7e75ab61f9e2b70e0da13384a78e
 SHA512:
-  metadata.gz: 39764ecfbf6ff6445b6e2db7e8146192bb0f0a42af6f3974e605e604a923747daeee0dda494af367ad4f361a59c25edf2f8967e18853d3a6fb62b73508861bc9
-  data.tar.gz: ce99699300c02cafb988fd73bc54503838f254448f53771948e49977cfc2f84552240bf54b19808a88d33f91334456ff2bd8f654505daf45bd2c80b4f8da3262
+  metadata.gz: 07315be1396edcd8ef9cb29a882fc9c7bf7f31b658704862698ba9664862c9bbad80690977474919dc1e5390bf2145148e9f347fb8ed84e1858d208572c0f527
+  data.tar.gz: 41c7d5db9b3bc0574a969ef1fb6453c3f2a604e78b8c03c7b7e29168b3b212220dab03af7d09774f1f5f13972800b2d728750e6b97bd12fb3529456ce5c8f9f1

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 8.0.0
+* [#72](https://github.com/airbnb/ruby/pull/212) Adopt Rubocop's plugin system (thanks @koic!)
+* Bump minimum gem versions:
+  * `rubocop` from `'~> 1.61'` to `'~> 1.72'`
+  * `rubocop-performance` from `'~> 1.20'` to `'~> 1.24'`
+  * `rubocop-rails` from `'~> 2.24'` to `'~> 2.30'`
+  * `rubocop-rspec` from `'~> 2.26'` to `'~> 3.5'`
+* Add explicit `rubocop-*` gem dependencies which have been extracted
+  * `rubocop-capybara` with min version `'~> 2.22'`
+  * `rubocop-factory_bot` with min version `'~> 2.27'`
+
 # 7.0.0
 * Add support for Ruby 3.3
 * Drop support for Ruby 2.6

data/README.md

@@ -29,7 +29,7 @@ ways to do this:
 First Create a new file `.rubocop_airbnb.yml` in the same directory as your `.rubocop.yml`
 this file should contain
 ```
-require:
+plugins:
   - rubocop-airbnb
 ```
 
@@ -50,10 +50,13 @@ you could potentially experience a bunch of warnings from `.rubocop_todo.yml` fo
 Now you can run `rubocop` and it will automatically load the RuboCop Airbnb
 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-airbnb
+rubocop --plugin rubocop-airbnb
 ```
 
 ## The Cops
@@ -70,4 +73,3 @@ Airbnb/PhraseBundleKeys:
   Exclude:
     - spec/my_poorly_named_spec_file.rb
 ```
-

data/config/default.yml

@@ -29,7 +29,7 @@ RSpec:
   Include:
   - _spec.rb
   - "(?:^|/)spec/"
-RSpec/FactoryBot:
+FactoryBot:
   Include:
   - spec/factories/**/*.rb
   - features/support/factories/**/*.rb
@@ -37,6 +37,8 @@ RSpec/FactoryBot:
 inherit_from:
   - './rubocop-airbnb.yml'
   - './rubocop-bundler.yml'
+  - './rubocop-capybara.yml'
+  - './rubocop-factory_bot.yml'
   - './rubocop-gemspec.yml'
   - './rubocop-layout.yml'
   - './rubocop-lint.yml'

data/config/rubocop-capybara.yml

@@ -0,0 +1,6 @@
+plugins:
+  - rubocop-capybara
+
+Capybara/CurrentPathExpectation:
+  Description: Checks that no expectations are set on Capybara's `current_path`.
+  Enabled: false

data/config/rubocop-factory_bot.yml

@@ -0,0 +1,10 @@
+plugins:
+  - rubocop-factory_bot
+
+FactoryBot/AttributeDefinedStatically:
+  Description: Always declare attribute values as blocks.
+  Enabled: false
+
+FactoryBot/CreateList:
+  Description: Checks for create_list usage.
+  Enabled: true

data/config/rubocop-performance.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
     - rubocop-performance
 
 Performance/Caller:
@@ -122,4 +122,3 @@ Performance/UnfreezeString:
 
 Performance/UriDefaultParser:
   Enabled: false
-

data/config/rubocop-rails.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rails
 
 # before_action doesn't seem to exist, so this doesn't make sense.

data/config/rubocop-rspec.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rspec
 
 RSpec/AlignLeftLetBrace:
@@ -53,6 +53,10 @@ RSpec/DescribedClass:
   Description: 'Use `described_class` for tested class / module'
   Enabled: false
 
+RSpec/Dialect:
+  Description: Enforces custom RSpec dialects.
+  Enabled: false
+
 RSpec/EmptyExampleGroup:
   Description: Checks if an example group does not include any tests.
   Enabled: true
@@ -110,13 +114,6 @@ RSpec/ExpectOutput:
   Description: Checks for opportunities to use `expect { ... }.to output`.
   Enabled: false
 
-RSpec/FilePath:
-  Description: 'Checks the file and folder naming of the spec file.'
-  Enabled: false
-  CustomTransform:
-    RuboCop: rubocop
-    RSpec: rspec
-
 RSpec/Focus:
   Description: Checks if examples are focused.
   Enabled: false
@@ -293,6 +290,17 @@ RSpec/SingleArgumentMessageChain:
   Description: Checks that chains of messages contain more than one element.
   Enabled: true
 
+RSpec/SpecFilePathFormat:
+  Description: Checks that spec file paths are consistent and well-formed.
+  Enabled: false
+  CustomTransform:
+    RuboCop: rubocop
+    RSpec: rspec
+
+RSpec/SpecFilePathSuffix:
+  Description: Checks that spec file paths suffix are consistent and well-formed.
+  Enabled: false
+
 RSpec/SubjectStub:
   Description: Checks for stubbed test subjects.
   Enabled: false
@@ -308,19 +316,3 @@ RSpec/VerifiedDoubles:
 RSpec/VoidExpect:
   Description: This cop checks void `expect()`.
   Enabled: false
-
-RSpec/Capybara/CurrentPathExpectation:
-  Description: Checks that no expectations are set on Capybara's `current_path`.
-  Enabled: false
-
-RSpec/Capybara/FeatureMethods:
-  Description: Checks for consistent method usage in feature specs.
-  Enabled: false
-
-RSpec/FactoryBot/AttributeDefinedStatically:
-  Description: Always declare attribute values as blocks.
-  Enabled: false
-
-RSpec/FactoryBot/CreateList:
-  Description: Checks for create_list usage.
-  Enabled: true

data/lib/rubocop/airbnb/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Airbnb
+    # A plugin that integrates RuboCop Airbnb with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-airbnb',
+          version: VERSION,
+          homepage: 'https://github.com/airbnb/ruby',
+          description: 'A plugin for RuboCop code style enforcing & linting tool.'
+        )
+      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

data/lib/rubocop/airbnb/version.rb

@@ -3,6 +3,6 @@
 module RuboCop
   module Airbnb
     # Version information for the the Airbnb RuboCop plugin.
-    VERSION = '7.0.0'
+    VERSION = '8.0.0'
   end
 end

data/lib/rubocop-airbnb.rb

@@ -7,8 +7,6 @@ require 'rubocop'
 require 'rubocop-performance'
 require 'rubocop-rails'
 
-require 'rubocop/airbnb'
-require 'rubocop/airbnb/inject'
-require 'rubocop/airbnb/version'
-
-RuboCop::Airbnb::Inject.defaults!
+require_relative 'rubocop/airbnb'
+require_relative 'rubocop/airbnb/plugin'
+require_relative 'rubocop/airbnb/version'

data/rubocop-airbnb.gemspec

@@ -25,9 +25,14 @@ Gem::Specification.new do |spec|
     'Gemfile',
   ]
 
-  spec.add_dependency('rubocop', '~> 1.61')
-  spec.add_dependency('rubocop-performance', '~> 1.20')
-  spec.add_dependency('rubocop-rails', '~> 2.24')
-  spec.add_dependency('rubocop-rspec', '~> 2.26')
+  spec.metadata['default_lint_roller_plugin'] = 'RuboCop::Airbnb::Plugin'
+
+  spec.add_dependency('lint_roller', '~> 1.1')
+  spec.add_dependency('rubocop', '~> 1.72')
+  spec.add_dependency('rubocop-capybara', '~> 2.22')
+  spec.add_dependency('rubocop-factory_bot', '~> 2.27')
+  spec.add_dependency('rubocop-performance', '~> 1.24')
+  spec.add_dependency('rubocop-rails', '~> 2.30')
+  spec.add_dependency('rubocop-rspec', '~> 3.5')
   spec.add_development_dependency('rspec', '~> 3.5')
 end

metadata

@@ -1,71 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-airbnb
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Airbnb Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-23 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: '1.72'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: '1.72'
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.27'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.24'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '2.30'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '2.30'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.26'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.26'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +139,8 @@ files:
 - config/default.yml
 - config/rubocop-airbnb.yml
 - config/rubocop-bundler.yml
+- config/rubocop-capybara.yml
+- config/rubocop-factory_bot.yml
 - config/rubocop-gemspec.yml
 - config/rubocop-layout.yml
 - config/rubocop-lint.yml
@@ -110,7 +154,7 @@ files:
 - lib/rubocop-airbnb.rb
 - lib/rubocop/airbnb.rb
 - lib/rubocop/airbnb/inflections.rb
-- lib/rubocop/airbnb/inject.rb
+- lib/rubocop/airbnb/plugin.rb
 - lib/rubocop/airbnb/rails_autoloading.rb
 - lib/rubocop/airbnb/version.rb
 - lib/rubocop/cop/airbnb/class_or_module_declared_in_wrong_file.rb
@@ -154,7 +198,8 @@ files:
 homepage: https://github.com/airbnb/ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  default_lint_roller_plugin: RuboCop::Airbnb::Plugin
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/rubocop/airbnb/inject.rb

@@ -1,20 +0,0 @@
-# Straight up ripped from the custom Rspec rubocop
-# https://github.com/nevir/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-require 'yaml'
-
-module RuboCop
-  module Airbnb
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.load_file(path).to_hash
-        config = Config.new(hash, path)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end