rubocop-rspec 2.0.0.pre → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0940bab64e9ccca8168ff22b5d0f46e6777d015316da687deca6072f0e8c25f0'
-  data.tar.gz: c7a518dbbcbcb63567b4491849a8ef79834051350614a8b8bf284f7f8a31f83d
+  metadata.gz: 53f24b40715eb1f00efa9978b77383037e8c9d61d13c23b068928b05043430ca
+  data.tar.gz: 2d295003c7eefe76dfc7ca0f29711313b8b18b9c8579ce4464a47b47f412b54e
 SHA512:
-  metadata.gz: 9f8b127bdccb77c1f85268adc1cd60f614423914f5889557e71b59a36b040e8dc8c42ad409b4310dd039d5621f928bac3f60293d07e6f419762c02ddfbd5ddb0
-  data.tar.gz: 23922bf8587a2ac38a1bf76b973ba64ec586cf0ea6d32f65602257fd9782ddc8d4553ff964f9ff833c423e19bdb59f733593ca91539ecab709e0b6b29bf3ae53
+  metadata.gz: 15221270a01b2a273708d0e0fd3c35b52a9e40f87f672b2c4b7b547c55df0415394c7d762e4255406553ab26e0432d9a610d38a36d9fa92dddec47209428c856
+  data.tar.gz: 7bbcba195d894aa24d2985444421042314dd018f931763164502ee511c857d3010c074e8206f0af777e99b13ac668d1a32e03a8aefaa8dc38b3714c95ceb9555

data/CHANGELOG.md

@@ -1,11 +1,20 @@
-# Change log
+# Changelog
 
 ## Master (Unreleased)
 
+## 2.0.0 (2020-11-06)
+
+* Remove deprecated class `::RuboCop::Cop::RSpec::Cop`. ([@bquorning][])
+* Retire `RSpec/InvalidPredicateMatcher` cop. ([@pirj][])
+* Remove the code responsible for filtering files to inspect. ([@pirj][])
+* Make RSpec language elements configurable. ([@sl4vr][])
+* Remove `CustomIncludeMethods` `RSpec/EmptyExampleGroup` option in favour of the new RSpec DSL configuration. ([@pirj][])
+* Enabled pending cop (`RSpec/StubbedMock`). ([@pirj][])
+
 ## 2.0.0.pre (2020-10-22)
 
 * Update RuboCop dependency to v1.0.0. ([@bquorning][])
-* **(Potentially breaking)** Change namespace of several cops (`Capybara/*` -> `RSpec/Capybara/*`, `FactoryBot/*` -> `RSpec/FactoryBot/*`, `Rails/*` -> `RSpec/Rails/*`). ([@pirj][], [@bquorning][])
+* Change namespace of several cops (`Capybara/*` -> `RSpec/Capybara/*`, `FactoryBot/*` -> `RSpec/FactoryBot/*`, `Rails/*` -> `RSpec/Rails/*`). ([@pirj][], [@bquorning][])
 
 ## 1.44.1 (2020-10-20)
 
@@ -576,3 +585,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@koic]: https://github.com/koic
 [@Rafix02]: https://github.com/Rafix02
 [@PhilCoggins]: https://github.com/PhilCoggins
+[@sl4vr]: https://github.com/sl4vr

data/README.md

@@ -23,6 +23,10 @@ or if you use bundler put this in your `Gemfile`
 gem 'rubocop-rspec', require: false
 ```
 
+### Upgrading to RuboCop RSpec v2.x
+
+Read all the details in our [Upgrade to Version 2.x](https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html) document.
+
 ## Usage
 
 You need to tell RuboCop to load the RSpec extension. There are three

data/config/default.yml

@@ -1,14 +1,85 @@
 ---
-AllCops:
-  RSpec:
-    Patterns:
-    - _spec.rb
-    - "(?:^|/)spec/"
-  RSpec/FactoryBot:
-    Patterns:
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
+RSpec:
+  Include:
+  - "**/*_spec.rb"
+  - "**/spec/**/*"
+  Language:
+    ExampleGroups:
+      Regular:
+      - describe
+      - context
+      - feature
+      - example_group
+      Skipped:
+      - xdescribe
+      - xcontext
+      - xfeature
+      Focused:
+      - fdescribe
+      - fcontext
+      - ffeature
+    Examples:
+      Regular:
+      - it
+      - specify
+      - example
+      - scenario
+      - its
+      Focused:
+      - fit
+      - fspecify
+      - fexample
+      - fscenario
+      - focus
+      Skipped:
+      - xit
+      - xspecify
+      - xexample
+      - xscenario
+      - skip
+      Pending:
+      - pending
+    Expectations:
+    - expect
+    - is_expected
+    - expect_any_instance_of
+    Helpers:
+    - let
+    - let!
+    Hooks:
+    - prepend_before
+    - before
+    - append_before
+    - around
+    - prepend_after
+    - after
+    - append_after
+    HookScopes:
+    - each
+    - example
+    - context
+    - all
+    - suite
+    Includes:
+      Examples:
+      - it_behaves_like
+      - it_should_behave_like
+      - include_examples
+      Context:
+      - include_context
+    Runners:
+    - to
+    - to_not
+    - not_to
+    SharedGroups:
+      Examples:
+      - shared_examples
+      - shared_examples_for
+      Context:
+      - shared_context
+    Subjects:
+    - subject
+    - subject!
 
 RSpec/AlignLeftLetBrace:
   Description: Checks that left braces for adjacent single line lets are aligned.
@@ -136,8 +207,8 @@ RSpec/Dialect:
 RSpec/EmptyExampleGroup:
   Description: Checks if an example group does not include any tests.
   Enabled: true
-  CustomIncludeMethods: []
   VersionAdded: '1.7'
+  VersionChanged: '2.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyExampleGroup
 
 RSpec/EmptyHook:
@@ -241,6 +312,9 @@ RSpec/ExpectOutput:
 RSpec/FilePath:
   Description: Checks that spec file paths are consistent and well-formed.
   Enabled: true
+  Include:
+  - "**/*_spec*rb*"
+  - "**/spec/**/*"
   CustomTransform:
     RuboCop: rubocop
     RSpec: rspec
@@ -315,12 +389,6 @@ RSpec/InstanceVariable:
   VersionChanged: '1.7'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/InstanceVariable
 
-RSpec/InvalidPredicateMatcher:
-  Description: Checks invalid usage for predicate matcher.
-  Enabled: true
-  VersionAdded: '1.16'
-  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/InvalidPredicateMatcher
-
 RSpec/ItBehavesLike:
   Description: Checks that only one `it_behaves_like` style is used.
   Enabled: true
@@ -561,7 +629,7 @@ RSpec/SingleArgumentMessageChain:
 
 RSpec/StubbedMock:
   Description: Checks that message expectations do not have a configured response.
-  Enabled: pending
+  Enabled: true
   VersionAdded: '1.44'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/StubbedMock
 
@@ -645,6 +713,10 @@ RSpec/Capybara/VisibilityMatcher:
 RSpec/FactoryBot/AttributeDefinedStatically:
   Description: Always declare attribute values as blocks.
   Enabled: true
+  Include:
+  - spec/factories.rb
+  - spec/factories/**/*.rb
+  - features/support/factories/**/*.rb
   VersionAdded: '1.28'
   VersionChanged: '2.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/AttributeDefinedStatically
@@ -652,6 +724,12 @@ RSpec/FactoryBot/AttributeDefinedStatically:
 RSpec/FactoryBot/CreateList:
   Description: Checks for create_list usage.
   Enabled: true
+  Include:
+  - "**/*_spec.rb"
+  - "**/spec/**/*"
+  - spec/factories.rb
+  - spec/factories/**/*.rb
+  - features/support/factories/**/*.rb
   EnforcedStyle: create_list
   SupportedStyles:
   - create_list
@@ -663,6 +741,10 @@ RSpec/FactoryBot/CreateList:
 RSpec/FactoryBot/FactoryClassName:
   Description: Use string value when setting the class attribute explicitly.
   Enabled: true
+  Include:
+  - spec/factories.rb
+  - spec/factories/**/*.rb
+  - features/support/factories/**/*.rb
   VersionAdded: '1.37'
   VersionChanged: '2.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/FactoryClassName

data/lib/rubocop-rspec.rb

@@ -5,26 +5,25 @@ require 'yaml'
 
 require 'rubocop'
 
-require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/inject'
 require_relative 'rubocop/rspec/node'
-require_relative 'rubocop/rspec/top_level_describe'
 require_relative 'rubocop/rspec/wording'
-require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/language/node_pattern'
-require_relative 'rubocop/rspec/top_level_group'
+require_relative 'rubocop/rspec/language'
+
+require_relative 'rubocop/cop/rspec/mixin/top_level_group'
+require_relative 'rubocop/cop/rspec/mixin/variable'
+require_relative 'rubocop/cop/rspec/mixin/final_end_location'
+require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
+
 require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/hook'
-require_relative 'rubocop/rspec/variable'
 require_relative 'rubocop/cop/rspec/base'
-require_relative 'rubocop/cop/rspec/cop'
 require_relative 'rubocop/rspec/align_let_brace'
 require_relative 'rubocop/rspec/factory_bot'
-require_relative 'rubocop/rspec/final_end_location'
-require_relative 'rubocop/rspec/empty_line_separation'
 require_relative 'rubocop/rspec/corrector/move_node'
 
 RuboCop::RSpec::Inject.defaults!

data/lib/rubocop/cop/rspec/align_left_let_brace.rb

@@ -27,11 +27,9 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           return if processed_source.blank?
 
-          token_aligner =
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
-
           token_aligner.offending_tokens.each do |let|
             add_offense(let.loc.begin) do |corrector|
               corrector.insert_before(
@@ -40,6 +38,12 @@ module RuboCop
             end
           end
         end
+
+        private
+
+        def token_aligner
+          RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec/align_right_let_brace.rb

@@ -27,11 +27,9 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           return if processed_source.blank?
 
-          token_aligner =
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
-
           token_aligner.offending_tokens.each do |let|
             add_offense(let.loc.end) do |corrector|
               corrector.insert_before(
@@ -40,6 +38,12 @@ module RuboCop
             end
           end
         end
+
+        private
+
+        def token_aligner
+          RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec/base.rb

@@ -4,30 +4,9 @@ module RuboCop
   module Cop
     module RSpec
       # @abstract parent class to RSpec cops
-      #
-      # The criteria for whether rubocop-rspec analyzes a certain ruby file
-      # is configured via `AllCops/RSpec`. For example, if you want to
-      # customize your project to scan all files within a `test/` directory
-      # then you could add this to your configuration:
-      #
-      # @example configuring analyzed paths
-      #   # .rubocop.yml
-      #   # AllCops:
-      #   #   RSpec:
-      #   #     Patterns:
-      #   #     - '_test.rb$'
-      #   #     - '(?:^|/)test/'
       class Base < ::RuboCop::Cop::Base
         include RuboCop::RSpec::Language
-        include RuboCop::RSpec::Language::NodePattern
-
-        DEFAULT_CONFIGURATION =
-          RuboCop::RSpec::CONFIG.fetch('AllCops').fetch('RSpec')
-
-        DEFAULT_PATTERN_RE = Regexp.union(
-          DEFAULT_CONFIGURATION.fetch('Patterns')
-                               .map(&Regexp.public_method(:new))
-        )
+        extend RuboCop::RSpec::Language::NodePattern
 
         exclude_from_registry
 
@@ -36,39 +15,11 @@ module RuboCop
           RuboCop::Cop::Base.inherited(subclass)
         end
 
-        def relevant_file?(file)
-          relevant_rubocop_rspec_file?(file) && super
-        end
-
-        private
-
-        def relevant_rubocop_rspec_file?(file)
-          rspec_pattern.match?(file)
-        end
-
-        def rspec_pattern
-          if rspec_pattern_config?
-            Regexp.union(rspec_pattern_config.map(&Regexp.public_method(:new)))
-          else
-            DEFAULT_PATTERN_RE
-          end
-        end
-
-        def all_cops_config
-          config
-            .for_all_cops
-        end
-
-        def rspec_pattern_config?
-          return unless all_cops_config.key?('RSpec')
-
-          all_cops_config.fetch('RSpec').key?('Patterns')
-        end
-
-        def rspec_pattern_config
-          all_cops_config
-            .fetch('RSpec', DEFAULT_CONFIGURATION)
-            .fetch('Patterns')
+        # Set the config for dynamic DSL configuration-aware helpers
+        # that have no other means of accessing the configuration.
+        def on_new_investigation
+          super
+          RuboCop::RSpec::Language.config = config['RSpec']['Language']
         end
       end
     end

data/lib/rubocop/cop/rspec/be.rb

@@ -23,7 +23,7 @@ module RuboCop
         MSG = 'Don\'t use `be` without an argument.'
 
         def_node_matcher :be_without_args, <<-PATTERN
-          (send _ #{Runners::ALL.node_pattern_union} $(send nil? :be))
+          (send _ #Runners.all $(send nil? :be))
         PATTERN
 
         def on_send(node)

data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -37,13 +37,13 @@ module RuboCop
           # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
           def_node_matcher :as_is_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
+              #expectation_set_on_current_path $#Runners.all
               ${(send nil? :eq ...) (send nil? :match (regexp ...))})
           PATTERN
 
           def_node_matcher :regexp_str_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
+              #expectation_set_on_current_path $#Runners.all
               $(send nil? :match (str $_)))
           PATTERN
 

data/lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -55,8 +55,9 @@ module RuboCop
             feature:    :describe
           }.freeze
 
-          def_node_matcher :capybara_speak,
-                           SelectorSet.new(MAP.keys).node_pattern_union
+          def_node_matcher :capybara_speak, <<-PATTERN
+            {#{MAP.keys.map(&:inspect).join(' ')}}
+          PATTERN
 
           def_node_matcher :spec?, <<-PATTERN
             (block

data/lib/rubocop/cop/rspec/describe_class.rb

@@ -35,7 +35,7 @@ module RuboCop
       #   describe "A feature example", type: :feature do
       #   end
       class DescribeClass < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
         MSG = 'The first argument to describe should be '\
               'the class or module being tested.'

data/lib/rubocop/cop/rspec/describe_method.rb

@@ -17,7 +17,7 @@ module RuboCop
       #   describe MyClass, '.my_class_method' do
       #   end
       class DescribeMethod < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
         MSG = 'The second argument to describe should be the method '\
               "being tested. '#instance' or '.class'."

data/lib/rubocop/cop/rspec/described_class.rb

@@ -65,8 +65,7 @@ module RuboCop
           (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
-        def_node_matcher :rspec_block?,
-                         RuboCop::RSpec::Language::ALL.block_pattern
+        def_node_matcher :rspec_block?, block_pattern('#ALL.all')
 
         def_node_matcher :scope_changing_syntax?, '{def class module}'