Merge pull request #1876 from rubocop/remove-feature-methods

Remove RSpec/Capybara/FeatureMethods

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Remove extracted cops in `Capybara`, `FactoryBot` and `Rails` departments. ([@ydah])
 - Remove `RuboCop::RSpec::Language::NodePattern`. ([@ydah])
 - Remove `RSpec/FilePath` cop. ([@ydah])
+- Remove `RSpec/Capybara/FeatureMethods` cop. If you are using this cop, change it to use `RSpec/Dialect`. ([@ydah])
 
 ## 2.29.2 (2024-05-02)
 

Rakefile

@@ -33,8 +33,7 @@ task :build_config do
   require 'rubocop/rspec/config_formatter'
   require 'rubocop/rspec/description_extractor'
 
-  glob = File.join('lib', 'rubocop', 'cop', 'rspec',
-                   '{,capybara}', '*.rb')
+  glob = File.join('lib', 'rubocop', 'cop', 'rspec', '*.rb')
   # Due to YARD's sensitivity to file require order (as of 0.9.25),
   # we have to prepend the list with our base cop, RuboCop::Cop::RSpec::Base.
   # Otherwise, cop's parent class for cops loaded before our base cop class

config/default.yml

@@ -3,10 +3,10 @@ RSpec:
   Enabled: true
   StyleGuideBaseURL: https://rspec.rubystyle.guide
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-rspec
-  Include: &1
+  Include:
     - "**/*_spec.rb"
     - "**/spec/**/*"
-  Language: &2
+  Language:
     inherit_mode:
       merge:
         - Expectations
@@ -990,16 +990,3 @@ RSpec/Yield:
   Enabled: true
   VersionAdded: '1.32'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Yield
-
-RSpec/Capybara:
-  Enabled: true
-  Include: *1
-  Language: *2
-
-RSpec/Capybara/FeatureMethods:
-  Description: Checks for consistent method usage in feature specs.
-  Enabled: true
-  EnabledMethods: []
-  VersionAdded: '1.17'
-  VersionChanged: '2.0'
-  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/FeatureMethods

config/obsoletion.yml

@@ -40,3 +40,8 @@ split:
     alternatives:
       - RSpec/SpecFilePathFormat
       - RSpec/SpecFilePathSuffix
+
+removed:
+  RSpec/Capybara/FeatureMethods:
+    reason: >
+      this cop has migrated to `RSpec/Dialect`. Please use `RSpec/Dialect` instead

docs/modules/ROOT/pages/cops.adoc

@@ -111,8 +111,4 @@
 * xref:cops_rspec.adoc#rspecvoidexpect[RSpec/VoidExpect]
 * xref:cops_rspec.adoc#rspecyield[RSpec/Yield]
 
-=== Department xref:cops_rspec_capybara.adoc[RSpec/Capybara]
-
-* xref:cops_rspec_capybara.adoc#rspeccapybara/featuremethods[RSpec/Capybara/FeatureMethods]
-
 // END_COP_LIST

docs/modules/ROOT/pages/cops_rspec.adoc

@@ -1073,6 +1073,19 @@ a config like:
     PreferredMethods:
       context: describe
 
+If you were previously using the `RSpec/Capybara/FeatureMethods` cop and
+want to keep disabling all Capybara-specific methods that have the same
+native RSpec method (e.g. are just aliases), use the following config:
+
+  RSpec/Dialect:
+    PreferredMethods:
+      background: :before
+      scenario:   :it
+      xscenario:  :xit
+      given:      :let
+      given!:     :let!
+      feature:    :describe
+
 You can expect the following behavior:
 
 === Examples

lib/rubocop/cop/rspec/dialect.rb

@@ -29,6 +29,19 @@ module RSpec
       #     PreferredMethods:
       #       context: describe
       #
+      # If you were previously using the `RSpec/Capybara/FeatureMethods` cop and
+      # want to keep disabling all Capybara-specific methods that have the same
+      # native RSpec method (e.g. are just aliases), use the following config:
+      #
+      #   RSpec/Dialect:
+      #     PreferredMethods:
+      #       background: :before
+      #       scenario:   :it
+      #       xscenario:  :xit
+      #       given:      :let
+      #       given!:     :let!
+      #       feature:    :describe
+      #
       # You can expect the following behavior:
       #
       # @example

lib/rubocop/cop/rspec_cops.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'rspec/capybara/feature_methods'
-
 require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'
 require_relative 'rspec/any_instance'

lib/rubocop/rspec/config_formatter.rb

@@ -7,7 +7,7 @@ module RSpec
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
-      SUBDEPARTMENTS = %(RSpec/Capybara)
+      SUBDEPARTMENTS = [].freeze
       AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 

spec/project/default_config_spec.rb

@@ -5,16 +5,10 @@
     RuboCop::ConfigLoader.load_yaml_configuration('config/default.yml')
   end
 
-  let(:namespaces) do
-    {
-      'rspec' => 'RSpec',
-      'capybara' => 'RSpec/Capybara'
-    }
-  end
+  let(:namespaces) { { 'rspec' => 'RSpec' } }
 
   let(:cop_names) do
-    glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'rspec',
-                                 '{,capybara}', '*.rb')
+    glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'rspec', '*.rb')
     cop_names =
       Pathname.glob(glob).map do |file|
         file_name = file.basename('.rb').to_s