rubocop-rspec 1.41.0 → 1.44.0

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

@@ -15,7 +15,7 @@ module RuboCop
       #      expect(user).to be_valid
       #    end
       #
-      class RepeatedExample < Cop
+      class RepeatedExample < Base
         MSG = "Don't repeat examples within an example group."
 
         def on_block(node)
@@ -41,7 +41,7 @@ module RuboCop
         def example_signature(example)
           key_parts = [example.metadata, example.implementation]
 
-          if example.definition.method_name == :its
+          if example.definition.method?(:its)
             key_parts << example.definition.arguments
           end
 

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

@@ -43,7 +43,7 @@ module RuboCop
       #      it { is_expected.to respond_to :each }
       #    end
       #
-      class RepeatedExampleGroupBody < Cop
+      class RepeatedExampleGroupBody < Base
         MSG = 'Repeated %<group>s block body on line(s) %<loc>s'
 
         def_node_matcher :several_example_groups?, <<-PATTERN

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

@@ -43,7 +43,7 @@ module RuboCop
       #      # example group
       #    end
       #
-      class RepeatedExampleGroupDescription < Cop
+      class RepeatedExampleGroupDescription < Base
         MSG = 'Repeated %<group>s block description on line(s) %<loc>s'
 
         def_node_matcher :several_example_groups?, <<-PATTERN

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

@@ -0,0 +1,103 @@
+# 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?, Includes::EXAMPLES.send_pattern
+
+        def_node_matcher :shared_examples_name, <<-PATTERN
+          (send _ #{Includes::EXAMPLES.node_pattern_union} $_ ...)
+        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/return_from_stub.rb

@@ -33,7 +33,8 @@ module RuboCop
       #   # also good as the returned value is dynamic
       #   allow(Foo).to receive(:bar) { bar.baz }
       #
-      class ReturnFromStub < Cop
+      class ReturnFromStub < Base
+        extend AutoCorrector
         include ConfigurableEnforcedStyle
 
         MSG_AND_RETURN = 'Use `and_return` for static values.'
@@ -59,24 +60,14 @@ module RuboCop
           check_block_body(node)
         end
 
-        def autocorrect(node)
-          if style == :block
-            AndReturnCallCorrector.new(node)
-          else
-            BlockBodyCorrector.new(node)
-          end
-        end
-
         private
 
         def check_and_return_call(node)
           and_return_value(node) do |and_return, args|
             unless dynamic?(args)
-              add_offense(
-                and_return,
-                location: :selector,
-                message: MSG_BLOCK
-              )
+              add_offense(and_return.loc.selector, message: MSG_BLOCK) do |corr|
+                AndReturnCallCorrector.new(and_return).call(corr)
+              end
             end
           end
         end
@@ -84,11 +75,9 @@ module RuboCop
         def check_block_body(block)
           body = block.body
           unless dynamic?(body) # rubocop:disable Style/GuardClause
-            add_offense(
-              block,
-              location: :begin,
-              message: MSG_AND_RETURN
-            )
+            add_offense(block.loc.begin, message: MSG_AND_RETURN) do |corrector|
+              BlockBodyCorrector.new(block).call(corrector)
+            end
           end
         end
 
@@ -153,7 +142,7 @@ module RuboCop
             return if heredoc?
 
             corrector.replace(
-              block.loc.expression,
+              block,
               "#{block.send_node.source}.and_return(#{body.source})"
             )
           end

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

@@ -26,7 +26,9 @@ module RuboCop
       #     let!(:baz) { 3 }
       #   end
       #
-      class ScatteredLet < Cop
+      class ScatteredLet < Base
+        extend AutoCorrector
+
         MSG = 'Group all let/let! blocks in the example group together.'
 
         def on_block(node)
@@ -35,15 +37,6 @@ module RuboCop
           check_let_declarations(node.body)
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            first_let = find_first_let(node.parent)
-            RuboCop::RSpec::Corrector::MoveNode.new(
-              node, corrector, processed_source
-            ).move_after(first_let)
-          end
-        end
-
         private
 
         def check_let_declarations(body)
@@ -53,7 +46,11 @@ module RuboCop
           lets.each_with_index do |node, idx|
             next if node.sibling_index == first_let.sibling_index + idx
 
-            add_offense(node)
+            add_offense(node) do |corrector|
+              RuboCop::RSpec::Corrector::MoveNode.new(
+                node, corrector, processed_source
+              ).move_after(first_let)
+            end
           end
         end
 

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

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

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

@@ -50,7 +50,9 @@ module RuboCop
       #     end
       #   end
       #
-      class SharedContext < Cop
+      class SharedContext < Base
+        extend AutoCorrector
+
         MSG_EXAMPLES = "Use `shared_examples` when you don't "\
                        'define context.'
 
@@ -68,22 +70,14 @@ module RuboCop
 
         def on_block(node)
           context_with_only_examples(node) do
-            add_shared_item_offense(node.send_node, MSG_EXAMPLES)
+            add_offense(node.send_node, message: MSG_EXAMPLES) do |corrector|
+              corrector.replace(node.send_node.loc.selector, 'shared_examples')
+            end
           end
 
           examples_with_only_context(node) do
-            add_shared_item_offense(node.send_node, MSG_CONTEXT)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            context_with_only_examples(node.parent) do
-              corrector.replace(node.loc.selector, 'shared_examples')
-            end
-
-            examples_with_only_context(node.parent) do
-              corrector.replace(node.loc.selector, 'shared_context')
+            add_offense(node.send_node, message: MSG_CONTEXT) do |corrector|
+              corrector.replace(node.send_node.loc.selector, 'shared_context')
             end
           end
         end
@@ -97,13 +91,6 @@ module RuboCop
         def examples_with_only_context(node)
           shared_example(node) { yield if context?(node) && !examples?(node) }
         end
-
-        def add_shared_item_offense(node, message)
-          add_offense(
-            node,
-            message: message
-          )
-        end
       end
     end
   end

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

@@ -20,7 +20,9 @@ module RuboCop
       #   shared_examples_for 'foo bar baz'
       #   include_examples 'foo bar baz'
       #
-      class SharedExamples < Cop
+      class SharedExamples < Base
+        extend AutoCorrector
+
         def_node_matcher :shared_examples,
                          (SharedGroups::ALL + Includes::ALL).send_pattern
 
@@ -30,14 +32,9 @@ module RuboCop
             next unless ast_node&.sym_type?
 
             checker = Checker.new(ast_node)
-            add_offense(checker.node, message: checker.message)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            checker = Checker.new(node)
-            corrector.replace(node.loc.expression, checker.preferred_style)
+            add_offense(checker.node, message: checker.message) do |corrector|
+              corrector.replace(checker.node, checker.preferred_style)
+            end
           end
         end
 

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

@@ -16,7 +16,9 @@ module RuboCop
       #   allow(foo).to receive(:bar, :baz)
       #   allow(foo).to receive("bar.baz")
       #
-      class SingleArgumentMessageChain < Cop
+      class SingleArgumentMessageChain < Base
+        extend AutoCorrector
+
         MSG = 'Use `%<recommended>s` instead of calling '\
               '`%<called>s` with a single argument.'
 
@@ -30,22 +32,23 @@ module RuboCop
           message_chain(node) do |arg|
             return if valid_usage?(arg)
 
-            add_offense(node, location: :selector)
-          end
-        end
+            method = node.method_name
+            msg = format(MSG, recommended: replacement(method), called: method)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.selector, replacement(node.method_name))
-            message_chain(node) do |arg|
-              autocorrect_hash_arg(corrector, arg) if single_key_hash?(arg)
-              autocorrect_array_arg(corrector, arg) if arg.array_type?
+            add_offense(node.loc.selector, message: msg) do |corrector|
+              autocorrect(corrector, node, method, arg)
             end
           end
         end
 
         private
 
+        def autocorrect(corrector, node, method, arg)
+          corrector.replace(node.loc.selector, replacement(method))
+          autocorrect_hash_arg(corrector, arg) if single_key_hash?(arg)
+          autocorrect_array_arg(corrector, arg) if arg.array_type?
+        end
+
         def valid_usage?(node)
           return true unless node.literal? || node.array_type?
 
@@ -63,7 +66,7 @@ module RuboCop
         def autocorrect_hash_arg(corrector, arg)
           key, value = *arg.children.first
 
-          corrector.replace(arg.loc.expression, key_to_arg(key))
+          corrector.replace(arg, key_to_arg(key))
           corrector.insert_after(arg.parent.loc.end,
                                  ".and_return(#{value.source})")
         end
@@ -71,7 +74,7 @@ module RuboCop
         def autocorrect_array_arg(corrector, arg)
           value = arg.children.first
 
-          corrector.replace(arg.loc.expression, value.source)
+          corrector.replace(arg, value.source)
         end
 
         def key_to_arg(node)
@@ -82,12 +85,6 @@ module RuboCop
         def replacement(method)
           method.equal?(:receive_message_chain) ? 'receive' : 'stub'
         end
-
-        def message(node)
-          method = node.method_name
-
-          format(MSG, recommended: replacement(method), called: method)
-        end
       end
     end
   end

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.node_pattern_union} ...)
+            :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