rubocop-rspec 1.41.0 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4899c717a87d579939d5c1420800d2fe6c150e4421908e75b9d52c57c8362e60
-  data.tar.gz: 1155018e6595c843c1ade5cdecb748af349c1c2f94dbcd5b17fb4a4fb5d324be
+  metadata.gz: 93297f5bb7dfcb8e201365ec296afe22e5e3bbc7150b7a48e7991a22739debdd
+  data.tar.gz: 6343b337cf3d879a50553d09c3f4e30e4ff320285c16b533b8fbd73b8732bcd4
 SHA512:
-  metadata.gz: 79d9dc291018b0551b52c85dc6b09a1151356e1c85fe4e6a8a7aca5ade036be690f9b5aae7301cf232a0d067b18c0321be44f9915d5485dcaf993786ed07d328
-  data.tar.gz: cd9db102d912c42b484c7a514f5954b5f35d29bb7f0f3e186ed946898ba1134de5bf452611812465103aa2effc67016e4536bfc6dd365681aa90b2f4c1957f39
+  metadata.gz: 7c3eabc2946eb2b36bdb7a2be61eda35605b32f6ba0a6433cd3bde30982e13f909ea3330111631293c89cbf0237a46d3e3782610448396cdcf6dd77726e5cbda
+  data.tar.gz: da8f502adeb29f94294eb5a947ee455168dcfb44e23a5ad83365e4503dcdf39225b46bdb5e8357f40a231a4644fc97e8ddb85933fbc78159c43d40bbf5dddc94

data/CHANGELOG.md

@@ -2,6 +2,41 @@
 
 ## Master (Unreleased)
 
+## 1.44.0 (2020-10-20)
+
+* Move our documentation from rubocop-rspec.readthedocs.io to docs.rubocop.org/rubocop-rspec. ([@bquorning][])
+* Add `RSpec/RepeatedIncludeExample` cop. ([@biinari][])
+* Add `RSpec/StubbedMock` cop. ([@bquorning][], [@pirj][])
+* Add `IgnoredMetadata` configuration option to `RSpec/DescribeClass`. ([@Rafix02][])
+* Fix false positives in `RSpec/EmptyExampleGroup`. ([@pirj][])
+* Fix a false positive for `RSpec/EmptyExampleGroup` when example is defined in an `if` branch. ([@koic][])
+
+## 1.43.2 (2020-08-25)
+
+* Fix `RSpec/FilePath` when checking a file with a shared example. ([@pirj][])
+* Fix subject nesting detection in `RSpec/LeadingSubject`. ([@pirj][])
+
+## 1.43.1 (2020-08-17)
+
+* Fix `RSpec/FilePath` when checking a file defining e.g. an empty class. ([@bquorning][])
+
+## 1.43.0 (2020-08-17)
+
+* Add a new base cop class `::RuboCop::Cop::RSpec::Base`. The old base class `::RuboCop::Cop::RSpec::Cop` is deprecated, and will be removed in the next major release. ([@bquorning][])
+* Add support for subject detection after includes and example groups in `RSpec/LeadingSubject`. ([@pirj][])
+* Ignore trailing punctuation in context description prefix. ([@elliterate][])
+* Relax `RSpec/VariableDefinition` cop so interpolated and multiline strings are accepted even when configured to enforce the `symbol` style. ([@bquorning][])
+* Fix `RSpec/EmptyExampleGroup` to flag example groups with examples in invalid scopes. ([@mlarraz][])
+* Fix `RSpec/EmptyExampleGroup` to ignore examples groups with examples defined inside iterators. ([@pirj][])
+* Improve `RSpec/NestedGroups`, `RSpec/FilePath`, `RSpec/DescribeMethod`, `RSpec/MultipleDescribes`, `RSpec/DescribeClass`'s top-level example group detection. ([@pirj][])
+* Add detection of `let!` with a block-pass or a string literal to `RSpec/LetSetup`. ([@pirj][])
+* Add `IgnoredPatterns` configuration option to `RSpec/VariableName`. ([@jtannas][])
+* Add `RSpec/MultipleMemoizedHelpers` cop. ([@mockdeep][])
+
+## 1.42.0 (2020-07-09)
+
+* Update RuboCop dependency to 0.87.0 because of changes to internal APIs. ([@bquorning][], [@Darhazer][])
+
 ## 1.41.0 (2020-07-03)
 
 * Extend the list of Rails spec types for `RSpec/DescribeClass`. ([@pirj][])
@@ -480,8 +515,8 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@rspeicher]: https://github.com/rspeicher
 [@jonatas]: https://github.com/jonatas
 [@pocke]: https://github.com/pocke
-[@bmorrall]: https:/github.com/bmorrall
-[@zverok]: https:/github.com/zverok
+[@bmorrall]: https://github.com/bmorrall
+[@zverok]: https://github.com/zverok
 [@timrogers]: https://github.com/timrogers
 [@yevhene]: https://github.com/yevhene
 [@walf443]: https://github.com/walf443
@@ -525,3 +560,9 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@rolfschmidt]: https://github.com/rolfschmidt
 [@andrykonchin]: https://github.com/andrykonchin
 [@harrylewis]: https://github.com/harrylewis
+[@elliterate]: https://github.com/elliterate
+[@jtannas]: https://github.com/jtannas
+[@mockdeep]: https://github.com/mockdeep
+[@biinari]: https://github.com/biinari
+[@koic]: https://github.com/koic
+[@Rafix02]: https://github.com/Rafix02

data/config/default.yml

@@ -74,9 +74,25 @@ RSpec/ContextWording:
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ContextWording
 
 RSpec/DescribeClass:
-  Description: Check that the first argument to the top level describe is a constant.
-  Enabled: true
+  Description: Check that the first argument to the top-level describe is a constant.
+  Enabled: true
+  IgnoredMetadata:
+    type:
+    - channel
+    - controller
+    - helper
+    - job
+    - mailer
+    - model
+    - request
+    - routing
+    - view
+    - feature
+    - system
+    - mailbox
+    - aruba
   VersionAdded: '1.0'
+  VersionChanged: '1.44'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeClass
 
 RSpec/DescribeMethod:
@@ -381,7 +397,7 @@ RSpec/MissingExampleGroupArgument:
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MissingExampleGroupArgument
 
 RSpec/MultipleDescribes:
-  Description: Checks for multiple top level describes.
+  Description: Checks for multiple top-level example groups.
   Enabled: true
   VersionAdded: '1.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MultipleDescribes
@@ -394,6 +410,14 @@ RSpec/MultipleExpectations:
   VersionChanged: '1.21'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MultipleExpectations
 
+RSpec/MultipleMemoizedHelpers:
+  Description: Checks if example groups contain too many `let` and `subject` calls.
+  Enabled: true
+  AllowSubject: true
+  Max: 5
+  VersionAdded: '1.43'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MultipleMemoizedHelpers
+
 RSpec/MultipleSubjects:
   Description: Checks if an example group defines `subject` multiple times.
   Enabled: true
@@ -486,6 +510,12 @@ RSpec/RepeatedExampleGroupDescription:
   VersionAdded: '1.38'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/RepeatedExampleGroupDescription
 
+RSpec/RepeatedIncludeExample:
+  Description: Check for repeated include of shared examples.
+  Enabled: true
+  VersionAdded: '1.44'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/RepeatedIncludeExample
+
 RSpec/ReturnFromStub:
   Description: Checks for consistent style of stub's return setting.
   Enabled: true
@@ -529,6 +559,12 @@ RSpec/SingleArgumentMessageChain:
   VersionChanged: '1.10'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SingleArgumentMessageChain
 
+RSpec/StubbedMock:
+  Description: Checks that message expectations do not have a configured response.
+  Enabled: pending
+  VersionAdded: '1.44'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/StubbedMock
+
 RSpec/SubjectStub:
   Description: Checks for stubbed test subjects.
   Enabled: true
@@ -558,7 +594,9 @@ RSpec/VariableName:
   SupportedStyles:
   - snake_case
   - camelCase
+  IgnoredPatterns: []
   VersionAdded: '1.40'
+  VersionChanged: '1.43'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VariableName
 
 RSpec/VerifiedDoubles:

data/lib/rubocop-rspec.rb

@@ -19,11 +19,12 @@ 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/blank_line_separation'
+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

@@ -17,36 +17,29 @@ module RuboCop
       #     let(:baz)    { bar }
       #     let(:a)      { b }
       #
-      class AlignLeftLetBrace < Cop
+      class AlignLeftLetBrace < Base
+        extend AutoCorrector
+
         MSG = 'Align left let brace'
 
         def self.autocorrect_incompatible_with
           [Layout::ExtraSpacing]
         end
 
-        def investigate(_processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
-          token_aligner.offending_tokens.each do |let|
-            add_offense(let, location: :begin)
-          end
-        end
+          token_aligner =
+            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
 
-        def autocorrect(let)
-          lambda do |corrector|
-            corrector.insert_before(
-              let.loc.begin,
-              token_aligner.indent_for(let)
-            )
+          token_aligner.offending_tokens.each do |let|
+            add_offense(let.loc.begin) do |corrector|
+              corrector.insert_before(
+                let.loc.begin, token_aligner.indent_for(let)
+              )
+            end
           end
         end
-
-        private
-
-        def token_aligner
-          @token_aligner ||=
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
-        end
       end
     end
   end

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

@@ -17,36 +17,29 @@ module RuboCop
       #     let(:baz)    { bar      }
       #     let(:a)      { b        }
       #
-      class AlignRightLetBrace < Cop
+      class AlignRightLetBrace < Base
+        extend AutoCorrector
+
         MSG = 'Align right let brace'
 
         def self.autocorrect_incompatible_with
           [Layout::ExtraSpacing]
         end
 
-        def investigate(_processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
-          token_aligner.offending_tokens.each do |let|
-            add_offense(let, location: :end)
-          end
-        end
+          token_aligner =
+            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
 
-        def autocorrect(let)
-          lambda do |corrector|
-            corrector.insert_before(
-              let.loc.end,
-              token_aligner.indent_for(let)
-            )
+          token_aligner.offending_tokens.each do |let|
+            add_offense(let.loc.end) do |corrector|
+              corrector.insert_before(
+                let.loc.end, token_aligner.indent_for(let)
+              )
+            end
           end
         end
-
-        private
-
-        def token_aligner
-          @token_aligner ||=
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
-        end
       end
     end
   end

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

@@ -22,7 +22,7 @@ module RuboCop
       #       allow(my_instance).to receive(:foo)
       #     end
       #   end
-      class AnyInstance < Cop
+      class AnyInstance < Base
         MSG = 'Avoid stubbing using `%<method>s`.'
 
         def_node_matcher :disallowed_stub, <<-PATTERN

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

@@ -25,13 +25,13 @@ module RuboCop
       #     some_method
       #     test.run
       #   end
-      class AroundBlock < Cop
+      class AroundBlock < Base
         MSG_NO_ARG     = 'Test object should be passed to around block.'
         MSG_UNUSED_ARG = 'You should call `%<arg>s.call` '\
                          'or `%<arg>s.run`.'
 
         def_node_matcher :hook, <<-PATTERN
-          (block {(send nil? :around) (send nil? :around sym)} (args $...) ...)
+          (block (send nil? :around sym ?) (args $...) ...)
         PATTERN
 
         def_node_search :find_arg_usage, <<-PATTERN

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+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))
+        )
+
+        exclude_from_registry
+
+        # Invoke the original inherited hook so our cops are recognized
+        def self.inherited(subclass) # rubocop:disable Lint/MissingSuper
+          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')
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ module RuboCop
       #   expect(foo).to be 1.0
       #   expect(foo).to be(true)
       #
-      class Be < Cop
+      class Be < Base
         MSG = 'Don\'t use `be` without an argument.'
 
         def_node_matcher :be_without_args, <<-PATTERN
@@ -28,7 +28,7 @@ module RuboCop
 
         def on_send(node)
           be_without_args(node) do |matcher|
-            add_offense(matcher, location: :selector)
+            add_offense(matcher.loc.selector)
           end
         end
       end

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

@@ -35,7 +35,9 @@ module RuboCop
       # necessarily the same type as `b` since the `#==` operator can
       # coerce objects for comparison.
       #
-      class BeEql < Cop
+      class BeEql < Base
+        extend AutoCorrector
+
         MSG = 'Prefer `be` over `eql`.'
 
         def_node_matcher :eql_type_with_identity, <<-PATTERN
@@ -44,13 +46,11 @@ module RuboCop
 
         def on_send(node)
           eql_type_with_identity(node) do |eql|
-            add_offense(eql, location: :selector)
+            add_offense(eql.loc.selector) do |corrector|
+              corrector.replace(eql.loc.selector, 'be')
+            end
           end
         end
-
-        def autocorrect(node)
-          ->(corrector) { corrector.replace(node.loc.selector, 'be') }
-        end
       end
     end
   end

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

@@ -23,7 +23,7 @@ module RuboCop
       #     before(:each) { Widget.create }
       #     after(:each) { Widget.delete_all }
       #   end
-      class BeforeAfterAll < Cop
+      class BeforeAfterAll < Base
         MSG = 'Beware of using `%<hook>s` as it may cause state to leak '\
               'between tests. If you are using `rspec-rails`, and '\
               '`use_transactional_fixtures` is enabled, then records created '\

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

@@ -23,7 +23,9 @@ module RuboCop
         #   expect(page).to have_current_path("/callback")
         #   expect(page).to have_current_path(/widgets/)
         #
-        class CurrentPathExpectation < Cop
+        class CurrentPathExpectation < Base
+          extend AutoCorrector
+
           MSG = 'Do not set an RSpec expectation on `current_path` in ' \
                 'Capybara feature specs - instead, use the ' \
                 '`have_current_path` matcher on `page`'
@@ -47,30 +49,30 @@ module RuboCop
 
           def on_send(node)
             expectation_set_on_current_path(node) do
-              add_offense(node, location: :selector)
+              add_offense(node.loc.selector) do |corrector|
+                next unless node.chained?
+
+                autocorrect(corrector, node)
+              end
             end
           end
 
-          def autocorrect(node)
-            lambda do |corrector|
-              return unless node.chained?
+          private
 
-              as_is_matcher(node.parent) do |to_sym, matcher_node|
-                rewrite_expectation(corrector, node, to_sym, matcher_node)
-              end
+          def autocorrect(corrector, node)
+            as_is_matcher(node.parent) do |to_sym, matcher_node|
+              rewrite_expectation(corrector, node, to_sym, matcher_node)
+            end
 
-              regexp_str_matcher(node.parent) do |to_sym, matcher_node, regexp|
-                rewrite_expectation(corrector, node, to_sym, matcher_node)
-                convert_regexp_str_to_literal(corrector, matcher_node, regexp)
-              end
+            regexp_str_matcher(node.parent) do |to_sym, matcher_node, regexp|
+              rewrite_expectation(corrector, node, to_sym, matcher_node)
+              convert_regexp_str_to_literal(corrector, matcher_node, regexp)
             end
           end
 
-          private
-
           def rewrite_expectation(corrector, node, to_symbol, matcher_node)
             current_path_node = node.first_argument
-            corrector.replace(current_path_node.loc.expression, 'page')
+            corrector.replace(current_path_node, 'page')
             corrector.replace(node.parent.loc.selector, 'to')
             matcher_method = if to_symbol == :to
                                'have_current_path'
@@ -84,7 +86,7 @@ module RuboCop
           def convert_regexp_str_to_literal(corrector, matcher_node, regexp_str)
             str_node = matcher_node.first_argument
             regexp_expr = Regexp.new(regexp_str).inspect
-            corrector.replace(str_node.loc.expression, regexp_expr)
+            corrector.replace(str_node, regexp_expr)
           end
 
           # `have_current_path` with no options will include the querystring
@@ -97,7 +99,7 @@ module RuboCop
             return if %i[regexp str].include?(expectation_last_child.type)
 
             corrector.insert_after(
-              expectation_last_child.loc.expression,
+              expectation_last_child,
               ', ignore_query: true'
             )
           end