rubocop-rspec 1.42.0 → 1.44.1

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

@@ -31,7 +31,7 @@ module RuboCop
       #   # good
       #   describe MyClass do
       #   end
-      class Pending < Cop
+      class Pending < Base
         MSG = 'Pending spec found.'
 
         PENDING = Examples::PENDING + Examples::SKIPPED + ExampleGroups::SKIPPED

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

@@ -208,18 +208,20 @@ module RuboCop
             'is_a?'
           when 'be_an_instance_of', 'be_instance_of', 'an_instance_of'
             'instance_of?'
-          when 'include', 'respond_to'
-            matcher + '?'
+          when 'include'
+            'include?'
+          when 'respond_to'
+            'respond_to?'
           when /^have_(.+)/
             "has_#{Regexp.last_match(1)}?"
           else
-            matcher[/^be_(.+)/, 1] + '?'
+            "#{matcher[/^be_(.+)/, 1]}?"
           end
         end
         # rubocop:enable Metrics/MethodLength
 
         def replacement_matcher(node)
-          case [cop_config['Strict'], node.method_name == :to]
+          case [cop_config['Strict'], node.method?(:to)]
           when [true, true]
             'be(true)'
           when [true, false]
@@ -269,7 +271,7 @@ module RuboCop
       #
       #   # good - the above code is rewritten to it by this cop
       #   expect(foo.something?).to be_truthy
-      class PredicateMatcher < Cop
+      class PredicateMatcher < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
         include InflectedHelper
@@ -288,15 +290,6 @@ module RuboCop
           check_explicit(node) if style == :explicit
         end
 
-        def autocorrect(node)
-          case style
-          when :inflected
-            autocorrect_inflected(node)
-          when :explicit
-            autocorrect_explicit(node)
-          end
-        end
-
         private
 
         # returns args location with whitespace

data/lib/rubocop/cop/rspec/rails/http_status.rb

@@ -30,7 +30,7 @@ module RuboCop
         #   it { is_expected.to have_http_status :success }
         #   it { is_expected.to have_http_status :error }
         #
-        class HttpStatus < Cop
+        class HttpStatus < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
 

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

@@ -23,7 +23,7 @@ module RuboCop
       #     expect(foo).to receive(:bar).at_most(:once)
       #     expect(foo).to receive(:bar).at_most(:twice).times
       #
-      class ReceiveCounts < Cop
+      class ReceiveCounts < Base
         extend AutoCorrector
 
         MSG = 'Use `%<alternative>s` instead of `%<original>s`.'

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

@@ -13,14 +13,14 @@ module RuboCop
       #     # good
       #     expect(foo).not_to receive(:bar)
       #
-      class ReceiveNever < Cop
+      class ReceiveNever < Base
         extend AutoCorrector
         MSG = 'Use `not_to receive` instead of `never`.'
 
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 
         def on_send(node)
-          return unless node.method_name == :never && method_on_stub?(node)
+          return unless node.method?(:never) && method_on_stub?(node)
 
           add_offense(node.loc.selector) do |corrector|
             autocorrect(corrector, node)

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

@@ -40,7 +40,7 @@ module RuboCop
       #       end
       #     end
       #
-      class RepeatedDescription < Cop
+      class RepeatedDescription < Base
         MSG = "Don't repeat descriptions within an example group."
 
         def on_block(node)

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,7 @@ 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
 

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

@@ -26,7 +26,7 @@ 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.'

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,7 @@ module RuboCop
       #     end
       #   end
       #
-      class SharedContext < Cop
+      class SharedContext < Base
         extend AutoCorrector
 
         MSG_EXAMPLES = "Use `shared_examples` when you don't "\

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

@@ -20,7 +20,7 @@ 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,

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

@@ -16,7 +16,7 @@ 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 '\

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