rubocop-rspec 1.43.2 → 2.0.1

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

@@ -60,7 +60,7 @@ module RuboCop
             } ...)
         PATTERN
 
-        def_node_matcher :expect?, Expectations::ALL.send_pattern
+        def_node_matcher :expect?, send_pattern('#Expectations.all')
         def_node_matcher :aggregate_failures_block?, <<-PATTERN
           (block (send nil? :aggregate_failures ...) ...)
         PATTERN

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

@@ -85,7 +85,7 @@ module RuboCop
       #
       class MultipleMemoizedHelpers < Base
         include ConfigurableMax
-        include RuboCop::RSpec::Variable
+        include Variable
 
         MSG = 'Example group has too many memoized helpers [%<count>d/%<max>d]'
 
@@ -101,6 +101,7 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           @example_group_memoized_helpers = {}
         end
 
@@ -128,6 +129,7 @@ module RuboCop
 
         def variable_nodes(node)
           example_group = RuboCop::RSpec::ExampleGroup.new(node)
+
           if allow_subject?
             example_group.lets
           else

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

@@ -42,24 +42,20 @@ module RuboCop
       #     it { is_expected.to be_valid }
       #   end
       class NamedSubject < Base
-        MSG = 'Name your test subject if you need '\
-              'to reference it explicitly.'
+        MSG = 'Name your test subject if you need to reference it explicitly.'
 
-        def_node_matcher :rspec_block?, <<-PATTERN
-          {
-            #{Examples::ALL.block_pattern}
-            #{Hooks::ALL.block_pattern}
-          }
-        PATTERN
+        def_node_matcher :example_or_hook_block?,
+                         block_pattern('{#Examples.all #Hooks.all}')
 
-        def_node_matcher :shared_example?, <<-PATTERN
-          #{SharedGroups::EXAMPLES.block_pattern}
-        PATTERN
+        def_node_matcher :shared_example?,
+                         block_pattern('#SharedGroups.examples')
 
         def_node_search :subject_usage, '$(send nil? :subject)'
 
         def on_block(node)
-          return if !rspec_block?(node) || ignored_shared_example?(node)
+          if !example_or_hook_block?(node) || ignored_shared_example?(node)
+            return
+          end
 
           subject_usage(node) do |subject_node|
             add_offense(subject_node.loc.selector)

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

@@ -87,7 +87,7 @@ module RuboCop
       #
       class NestedGroups < Base
         include ConfigurableMax
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
         MSG = 'Maximum example group nesting exceeded [%<total>d/%<max>d].'
 

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

@@ -24,7 +24,8 @@ module RuboCop
       class OverwritingSetup < Base
         MSG = '`%<name>s` is already defined.'
 
-        def_node_matcher :setup?, (Helpers::ALL + Subject::ALL).block_pattern
+        def_node_matcher :setup?, block_pattern('{#Helpers.all #Subjects.all}')
+
         def_node_matcher :first_argument_name, '(send _ _ ({str sym} $_))'
 
         def on_block(node)

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

@@ -34,10 +34,10 @@ module RuboCop
       class Pending < Base
         MSG = 'Pending spec found.'
 
-        PENDING = Examples::PENDING + Examples::SKIPPED + ExampleGroups::SKIPPED
-        SKIPPABLE = ExampleGroups::GROUPS + Examples::EXAMPLES
-
-        def_node_matcher :skippable?, SKIPPABLE.send_pattern
+        def_node_matcher :skippable?,
+                         send_pattern(<<~PATTERN)
+                           {#ExampleGroups.regular #Examples.regular}
+                         PATTERN
 
         def_node_matcher :skipped_in_metadata?, <<-PATTERN
           {
@@ -47,7 +47,15 @@ module RuboCop
         PATTERN
 
         def_node_matcher :skip_or_pending?, '{(sym :skip) (sym :pending)}'
-        def_node_matcher :pending_block?, PENDING.send_pattern
+
+        def_node_matcher :pending_block?,
+                         send_pattern(<<~PATTERN)
+                           {
+                             #ExampleGroups.skipped
+                             #Examples.skipped
+                             #Examples.pending
+                           }
+                         PATTERN
 
         def on_send(node)
           return unless pending_block?(node) || skipped?(node)

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

@@ -30,7 +30,7 @@ module RuboCop
             (send nil? :expect {
               (block $(send !nil? #predicate? ...) ...)
               $(send !nil? #predicate? ...)})
-            $#{Runners::ALL.node_pattern_union}
+            $#Runners.all
             $#boolean_matcher?)
         PATTERN
 
@@ -155,7 +155,7 @@ module RuboCop
         def_node_matcher :predicate_matcher?, <<-PATTERN
           (send
             (send nil? :expect $!nil?)
-            #{Runners::ALL.node_pattern_union}
+            #Runners.all
             {$(send nil? #predicate_matcher_name? ...)
               (block $(send nil? #predicate_matcher_name? ...) ...)})
         PATTERN
@@ -164,7 +164,7 @@ module RuboCop
           (block
             (send
               (send nil? :expect $!nil?)
-              #{Runners::ALL.node_pattern_union}
+              #Runners.all
               $(send nil? #predicate_matcher_name?))
             ...)
         PATTERN

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for repeated include of shared examples.
+      #
+      # @example
+      #
+      #    # bad
+      #    describe 'foo' do
+      #      include_examples 'cool stuff'
+      #      include_examples 'cool stuff'
+      #    end
+      #
+      #    # bad
+      #    describe 'foo' do
+      #      it_behaves_like 'a cool', 'thing'
+      #      it_behaves_like 'a cool', 'thing'
+      #    end
+      #
+      #    # bad
+      #    context 'foo' do
+      #      it_should_behave_like 'a duck'
+      #      it_should_behave_like 'a duck'
+      #    end
+      #
+      #    # good
+      #    describe 'foo' do
+      #      include_examples 'cool stuff'
+      #    end
+      #
+      #    describe 'bar' do
+      #      include_examples 'cool stuff'
+      #    end
+      #
+      #    # good
+      #    describe 'foo' do
+      #      it_behaves_like 'a cool', 'thing'
+      #      it_behaves_like 'a cool', 'person'
+      #    end
+      #
+      #    # good
+      #    context 'foo' do
+      #      it_should_behave_like 'a duck'
+      #      it_should_behave_like 'a goose'
+      #    end
+      #
+      class RepeatedIncludeExample < Base
+        MSG = 'Repeated include of shared_examples %<name>s ' \
+          'on line(s) %<repeat>s'
+
+        def_node_matcher :several_include_examples?, <<-PATTERN
+          (begin <#include_examples? #include_examples? ...>)
+        PATTERN
+
+        def_node_matcher :include_examples?,
+                         send_pattern('#Includes.examples')
+
+        def_node_matcher :shared_examples_name, <<-PATTERN
+          (send _ #Includes.examples $_ ...)
+        PATTERN
+
+        def on_begin(node)
+          return unless several_include_examples?(node)
+
+          repeated_include_examples(node).each do |item, repeats|
+            add_offense(item, message: message(item, repeats))
+          end
+        end
+
+        private
+
+        def repeated_include_examples(node)
+          node
+            .children
+            .select { |child| literal_include_examples?(child) }
+            .group_by { |child| signature_keys(child) }
+            .values
+            .reject(&:one?)
+            .flat_map { |items| add_repeated_lines(items) }
+        end
+
+        def literal_include_examples?(node)
+          include_examples?(node) &&
+            node.arguments.all?(&:recursive_literal_or_const?)
+        end
+
+        def add_repeated_lines(items)
+          repeated_lines = items.map(&:first_line)
+          items.map { |item| [item, repeated_lines - [item.first_line]] }
+        end
+
+        def signature_keys(item)
+          item.arguments
+        end
+
+        def message(item, repeats)
+          format(MSG, name: shared_examples_name(item).source, repeat: repeats)
+        end
+      end
+    end
+  end
+end

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

@@ -23,7 +23,7 @@ module RuboCop
       #   end
       #
       class ScatteredSetup < Base
-        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same '\
+        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same ' \
               'example group (also defined on %<lines>s).'
 
         def on_block(node)

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

@@ -53,20 +53,27 @@ module RuboCop
       class SharedContext < Base
         extend AutoCorrector
 
-        MSG_EXAMPLES = "Use `shared_examples` when you don't "\
-                       'define context.'
+        MSG_EXAMPLES = "Use `shared_examples` when you don't define context."
+        MSG_CONTEXT  = "Use `shared_context` when you don't define examples."
 
-        MSG_CONTEXT  = "Use `shared_context` when you don't "\
-                       'define examples.'
+        def_node_search :examples?,
+                        send_pattern('{#Includes.examples #Examples.all}')
 
-        examples = (Examples::ALL + Includes::EXAMPLES)
-        def_node_search :examples?, examples.send_pattern
+        def_node_search :context?, <<-PATTERN
+          (
+            send #rspec? {
+              #Subjects.all
+              #Helpers.all
+              #Includes.context
+              #Hooks.all
+            } ...
+          )
+        PATTERN
 
-        context = (Hooks::ALL + Helpers::ALL + Includes::CONTEXT + Subject::ALL)
-        def_node_search :context?, context.send_pattern
-
-        def_node_matcher :shared_context, SharedGroups::CONTEXT.block_pattern
-        def_node_matcher :shared_example, SharedGroups::EXAMPLES.block_pattern
+        def_node_matcher :shared_context,
+                         block_pattern('#SharedGroups.context')
+        def_node_matcher :shared_example,
+                         block_pattern('#SharedGroups.examples')
 
         def on_block(node)
           context_with_only_examples(node) do

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

@@ -24,7 +24,9 @@ module RuboCop
         extend AutoCorrector
 
         def_node_matcher :shared_examples,
-                         (SharedGroups::ALL + Includes::ALL).send_pattern
+                         send_pattern(
+                           '{#SharedGroups.all #Includes.all}'
+                         )
 
         def on_send(node)
           shared_examples(node) do

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

@@ -19,7 +19,7 @@ module RuboCop
       class SingleArgumentMessageChain < Base
         extend AutoCorrector
 
-        MSG = 'Use `%<recommended>s` instead of calling '\
+        MSG = 'Use `%<recommended>s` instead of calling ' \
               '`%<called>s` with a single argument.'
 
         def_node_matcher :message_chain, <<-PATTERN

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

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that message expectations do not have a configured response.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo).to receive(:bar).with(42).and_return("hello world")
+      #
+      #   # good (without spies)
+      #   allow(foo).to receive(:bar).with(42).and_return("hello world")
+      #   expect(foo).to receive(:bar).with(42)
+      #
+      class StubbedMock < Base
+        MSG = 'Prefer `%<replacement>s` over `%<method_name>s` when ' \
+              'configuring a response.'
+
+        # @!method message_expectation?(node)
+        #   Match message expectation matcher
+        #
+        #   @example source that matches
+        #     receive(:foo)
+        #
+        #   @example source that matches
+        #     receive_message_chain(:foo, :bar)
+        #
+        #   @example source that matches
+        #     receive(:foo).with('bar')
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Array<RuboCop::AST::Node>] matching nodes
+        def_node_matcher :message_expectation?, <<-PATTERN
+          {
+            (send nil? { :receive :receive_message_chain } ...)  # receive(:foo)
+            (send (send nil? :receive ...) :with ...)            # receive(:foo).with('bar')
+          }
+        PATTERN
+
+        def_node_matcher :configured_response?, <<~PATTERN
+          { :and_return :and_raise :and_throw :and_yield
+            :and_call_original :and_wrap_original }
+        PATTERN
+
+        # @!method expectation(node)
+        #   Match expectation
+        #
+        #   @example source that matches
+        #     is_expected.to be_in_the_bar
+        #
+        #   @example source that matches
+        #     expect(cocktail).to contain_exactly(:fresh_orange_juice, :campari)
+        #
+        #   @example source that matches
+        #     expect_any_instance_of(Officer).to be_alert
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield [RuboCop::AST::Node] expectation, method name, matcher
+        def_node_matcher :expectation, <<~PATTERN
+          (send
+            $(send nil? $#Expectations.all ...)
+            :to $_)
+        PATTERN
+
+        # @!method matcher_with_configured_response(node)
+        #   Match matcher with a configured response
+        #
+        #   @example source that matches
+        #     receive(:foo).and_return('bar')
+        #
+        #   @example source that matches
+        #     receive(:lower).and_raise(SomeError)
+        #
+        #   @example source that matches
+        #     receive(:redirect).and_call_original
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield [RuboCop::AST::Node] matcher
+        def_node_matcher :matcher_with_configured_response, <<~PATTERN
+          (send #message_expectation? #configured_response? _)
+        PATTERN
+
+        # @!method matcher_with_return_block(node)
+        #   Match matcher with a return block
+        #
+        #   @example source that matches
+        #     receive(:foo) { 'bar' }
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield [RuboCop::AST::Node] matcher
+        def_node_matcher :matcher_with_return_block, <<~PATTERN
+          (block #message_expectation? args _)  # receive(:foo) { 'bar' }
+        PATTERN
+
+        # @!method matcher_with_hash(node)
+        #   Match matcher with a configured response defined as a hash
+        #
+        #   @example source that matches
+        #     receive_messages(foo: 'bar', baz: 'qux')
+        #
+        #   @example source that matches
+        #     receive_message_chain(:foo, bar: 'baz')
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield [RuboCop::AST::Node] matcher
+        def_node_matcher :matcher_with_hash, <<~PATTERN
+          {
+            (send nil? :receive_messages hash)           # receive_messages(foo: 'bar', baz: 'qux')
+            (send nil? :receive_message_chain ... hash)  # receive_message_chain(:foo, bar: 'baz')
+          }
+        PATTERN
+
+        # @!method matcher_with_blockpass(node)
+        #   Match matcher with a configured response in block-pass
+        #
+        #   @example source that matches
+        #     receive(:foo, &canned)
+        #
+        #   @example source that matches
+        #     receive_message_chain(:foo, :bar, &canned)
+        #
+        #   @example source that matches
+        #     receive(:foo).with('bar', &canned)
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield [RuboCop::AST::Node] matcher
+        def_node_matcher :matcher_with_blockpass, <<~PATTERN
+          {
+            (send nil? { :receive :receive_message_chain } ... block_pass)  # receive(:foo, &canned)
+            (send (send nil? :receive ...) :with ... block_pass)            # receive(:foo).with('foo', &canned)
+          }
+        PATTERN
+
+        def on_send(node)
+          expectation(node, &method(:on_expectation))
+        end
+
+        private
+
+        def on_expectation(expectation, method_name, matcher)
+          flag_expectation = lambda do
+            add_offense(expectation, message: msg(method_name))
+          end
+
+          matcher_with_configured_response(matcher, &flag_expectation)
+          matcher_with_return_block(matcher, &flag_expectation)
+          matcher_with_hash(matcher, &flag_expectation)
+          matcher_with_blockpass(matcher, &flag_expectation)
+        end
+
+        def msg(method_name)
+          format(MSG,
+                 method_name: method_name,
+                 replacement: replacement(method_name))
+        end
+
+        def replacement(method_name)
+          case method_name
+          when :expect
+            :allow
+          when :is_expected
+            'allow(subject)'
+          when :expect_any_instance_of
+            :allow_any_instance_of
+          end
+        end
+      end
+    end
+  end
+end