rubocop-rspec 2.29.1 → 3.5.0

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

@@ -94,11 +94,6 @@ module RuboCop
           (send #rspec? ${#ExampleGroups.skipped} ...)
         PATTERN
 
-        # @!method pending_step_without_reason?(node)
-        def_node_matcher :pending_step_without_reason?, <<~PATTERN
-          (send nil? {:skip :pending})
-        PATTERN
-
         def on_send(node)
           on_pending_by_metadata(node)
           return unless (parent = parent_node(node))

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

@@ -15,6 +15,8 @@ module RuboCop
 
         def check_inflected(node)
           predicate_in_actual?(node) do |predicate, to, matcher|
+            next if cannot_replace_predicate?(predicate)
+
             msg = message_inflected(predicate)
             add_offense(node, message: msg) do |corrector|
               remove_predicate(corrector, predicate)
@@ -32,12 +34,16 @@ module RuboCop
               (block $(send !nil? #predicate? ...) ...)
               $(send !nil? #predicate? ...)})
             $#Runners.all
-            $#boolean_matcher?)
+            $#boolean_matcher? ...)
         PATTERN
 
+        def cannot_replace_predicate?(send_node)
+          send_node.method?(:respond_to?) && send_node.arguments.length > 1
+        end
+
         # @!method be_bool?(node)
         def_node_matcher :be_bool?, <<~PATTERN
-          (send nil? {:be :eq :eql :equal} {true false})
+          (send nil? {:be :eq :eql :equal} boolean)
         PATTERN
 
         # @!method be_boolthy?(node)
@@ -63,7 +69,6 @@ module RuboCop
                  matcher_name: to_predicate_matcher(predicate.method_name))
         end
 
-        # rubocop:disable Metrics/MethodLength
         def to_predicate_matcher(name)
           case name = name.to_s
           when 'is_a?'
@@ -80,7 +85,6 @@ module RuboCop
             "be_#{name[0..-2]}"
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def remove_predicate(corrector, predicate)
           range = predicate.loc.dot.with(
@@ -106,12 +110,16 @@ module RuboCop
 
         def true?(to_symbol, matcher)
           result = case matcher.method_name
-                   when :be, :eq
+                   when :be, :eq, :eql, :equal
                      matcher.first_argument.true_type?
                    when :be_truthy, :a_truthy_value
                      true
                    when :be_falsey, :be_falsy, :a_falsey_value, :a_falsy_value
                      false
+                   else
+                     # :nocov:
+                     :noop
+                     # :nocov:
                    end
           to_symbol == :to ? result : !result
         end
@@ -174,7 +182,7 @@ module RuboCop
 
         def heredoc_argument?(matcher)
           matcher.arguments.select do |arg|
-            %i[str dstr xstr].include?(arg.type)
+            arg.str_type? || arg.dstr_type? || arg.xstr_type?
           end.any?(&:heredoc?)
         end
 
@@ -183,8 +191,12 @@ module RuboCop
           (send
             (send nil? :expect $!nil?)
             #Runners.all
-            {$(send nil? #predicate_matcher_name? ...)
-              (block $(send nil? #predicate_matcher_name? ...) ...)})
+            {
+              $(send nil? #predicate_matcher_name? ...)
+              (block $(send nil? #predicate_matcher_name? ...) ...)
+            }
+            ...
+          )
         PATTERN
 
         # @!method predicate_matcher_block?(node)
@@ -229,7 +241,6 @@ module RuboCop
           corrector.insert_after(actual, ".#{predicate}" + args + block)
         end
 
-        # rubocop:disable Metrics/MethodLength
         def to_predicate_method(matcher)
           case matcher = matcher.to_s
           when 'be_a', 'be_an', 'be_a_kind_of', 'a_kind_of', 'be_kind_of'
@@ -246,7 +257,6 @@ module RuboCop
             "#{matcher[/\Abe_(.+)/, 1]}?"
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def replacement_matcher(node)
           case [cop_config['Strict'], node.method?(:to)]
@@ -256,7 +266,7 @@ module RuboCop
             'be(false)'
           when [false, true]
             'be_truthy'
-          when [false, false]
+          else
             'be_falsey'
           end
         end
@@ -325,6 +335,10 @@ module RuboCop
             check_inflected(node)
           when :explicit
             check_explicit(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 

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

@@ -17,7 +17,6 @@ module RuboCop
       #
       class RemoveConst < Base
         include RuboCop::RSpec::Language
-        extend RuboCop::RSpec::Language::NodePattern
 
         MSG = 'Do not use remove_const in specs. ' \
               'Consider using e.g. `stub_const`.'

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

@@ -72,6 +72,7 @@ module RuboCop
 
         def detect_offense(subject_node)
           return if subject_node.chained?
+          return if subject_node.parent.send_type?
           return unless (block_node = expect_block(subject_node))
 
           add_offense(block_node)

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

@@ -80,10 +80,10 @@ module RuboCop
 
         def check_block_body(block)
           body = block.body
-          unless dynamic?(body) # rubocop:disable Style/GuardClause
-            add_offense(block.loc.begin, message: MSG_AND_RETURN) do |corrector|
-              BlockBodyCorrector.new(block).call(corrector)
-            end
+          return if dynamic?(body)
+
+          add_offense(block.loc.begin, message: MSG_AND_RETURN) do |corrector|
+            BlockBodyCorrector.new(block).call(corrector)
           end
         end
 
@@ -162,6 +162,7 @@ module RuboCop
           end
 
           NULL_BLOCK_BODY = Struct.new(:loc, :source).new(nil, 'nil')
+          private_constant :NULL_BLOCK_BODY
         end
       end
     end

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

@@ -23,6 +23,7 @@ module RuboCop
       #   end
       #
       class ScatteredSetup < Base
+        include FinalEndLocation
         include RangeHelp
         extend AutoCorrector
 
@@ -75,8 +76,13 @@ module RuboCop
         def autocorrect(corrector, first_occurrence, occurrence)
           return if first_occurrence == occurrence || !first_occurrence.body
 
+          # Take heredocs into account
+          body = occurrence.body&.source_range&.with(
+            end_pos: final_end_location(occurrence).begin_pos
+          )
+
           corrector.insert_after(first_occurrence.body,
-                                 "\n#{occurrence.body.source}")
+                                 "\n#{body&.source}")
           corrector.remove(range_by_whole_lines(occurrence.source_range,
                                                 include_final_newline: true))
         end

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

@@ -67,11 +67,10 @@ module RuboCop
         end
 
         def autocorrect_hash_arg(corrector, arg)
-          key, value = *arg.children.first
-
-          corrector.replace(arg, key_to_arg(key))
+          pair = arg.pairs.first
+          corrector.replace(arg, key_to_arg(pair.key))
           corrector.insert_after(arg.parent.loc.end,
-                                 ".and_return(#{value.source})")
+                                 ".and_return(#{pair.value.source})")
         end
 
         def autocorrect_array_arg(corrector, arg)

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

@@ -5,6 +5,8 @@ module RuboCop
     module RSpec
       # Sort RSpec metadata alphabetically.
       #
+      # Only the trailing metadata is sorted.
+      #
       # @example
       #   # bad
       #   describe 'Something', :b, :a
@@ -16,6 +18,9 @@ module RuboCop
       #   context 'Something', baz: true, foo: 'bar'
       #   it 'works', :a, :b, baz: true, foo: 'bar'
       #
+      #   # good, trailing metadata is sorted
+      #   describe 'Something', 'description', :a, :b, :z
+      #   context 'Something', :z, variable, :a, :b
       class SortMetadata < Base
         extend AutoCorrector
         include Metadata
@@ -23,8 +28,14 @@ module RuboCop
 
         MSG = 'Sort metadata alphabetically.'
 
-        def on_metadata(symbols, hash)
+        # @!method match_ambiguous_trailing_metadata?(node)
+        def_node_matcher :match_ambiguous_trailing_metadata?, <<~PATTERN
+          (send _ _ _ ... !{hash sym str dstr xstr})
+        PATTERN
+
+        def on_metadata(args, hash)
           pairs = hash&.pairs || []
+          symbols = trailing_symbols(args)
           return if sorted?(symbols, pairs)
 
           crime_scene = crime_scene(symbols, pairs)
@@ -35,6 +46,15 @@ module RuboCop
 
         private
 
+        def trailing_symbols(args)
+          args = args[...-1] if last_arg_could_be_a_hash?(args)
+          args.reverse.take_while(&:sym_type?).reverse
+        end
+
+        def last_arg_could_be_a_hash?(args)
+          args.last && match_ambiguous_trailing_metadata?(args.last.parent)
+        end
+
         def crime_scene(symbols, pairs)
           metadata = symbols + pairs
 
@@ -57,13 +77,7 @@ module RuboCop
         end
 
         def sort_symbols(symbols)
-          symbols.sort_by do |symbol|
-            if %i[str sym].include?(symbol.type)
-              symbol.value.to_s.downcase
-            else
-              symbol.source.downcase
-            end
-          end
+          symbols.sort_by { |symbol| symbol.value.to_s.downcase }
         end
       end
     end

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

@@ -14,8 +14,9 @@ module RuboCop
       #   expect(foo).to receive(:bar).with(42)
       #
       class StubbedMock < Base
-        MSG = 'Prefer `%<replacement>s` over `%<method_name>s` when ' \
+        MSG = 'Prefer %<replacement>s over `%<method_name>s` when ' \
               'configuring a response.'
+        RESTRICT_ON_SEND = %i[to].freeze
 
         # @!method message_expectation?(node)
         #   Match message expectation matcher
@@ -133,10 +134,10 @@ module RuboCop
           }
         PATTERN
 
-        RESTRICT_ON_SEND = %i[to].freeze
-
         def on_send(node)
-          expectation(node, &method(:on_expectation))
+          expectation(node) do |expectation, method_name, matcher|
+            on_expectation(expectation, method_name, matcher)
+          end
         end
 
         private
@@ -153,19 +154,23 @@ module RuboCop
         end
 
         def msg(method_name)
-          format(MSG,
-                 method_name: method_name,
-                 replacement: replacement(method_name))
+          format(
+            MSG,
+            method_name: method_name,
+            replacement: replacement(method_name)
+          )
         end
 
         def replacement(method_name)
           case method_name
           when :expect
-            :allow
+            '`allow`'
           when :is_expected
-            'allow(subject)'
+            '`allow(subject)`'
           when :expect_any_instance_of
-            :allow_any_instance_of
+            '`allow_any_instance_of`'
+          else
+            'an allow statement'
           end
         end
       end

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

@@ -113,8 +113,8 @@ module RuboCop
         PATTERN
 
         def on_top_level_group(node)
-          @explicit_subjects = find_all_explicit(node, &method(:subject?))
-          @subject_overrides = find_all_explicit(node, &method(:let?))
+          @explicit_subjects = find_all_explicit(node) { |n| subject?(n) }
+          @subject_overrides = find_all_explicit(node) { |n| let?(n) }
 
           find_subject_expectations(node) do |stub|
             add_offense(stub)

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

@@ -32,34 +32,41 @@ module RuboCop
       #
       class UnspecifiedException < Base
         MSG = 'Specify the exception being captured'
-        RESTRICT_ON_SEND = %i[to].freeze
 
-        # @!method empty_raise_error_or_exception(node)
-        def_node_matcher :empty_raise_error_or_exception, <<~PATTERN
-          (send
-            (block
-                (send nil? :expect) ...)
-            :to
-            (send nil? {:raise_error :raise_exception})
-          )
+        RESTRICT_ON_SEND = %i[
+          raise_exception
+          raise_error
+        ].freeze
+
+        # @!method expect_to?(node)
+        def_node_matcher :expect_to?, <<~PATTERN
+          (send (block (send nil? :expect) ...) :to ...)
         PATTERN
 
         def on_send(node)
           return unless empty_exception_matcher?(node)
 
-          add_offense(node.children.last)
+          add_offense(node)
         end
 
         private
 
         def empty_exception_matcher?(node)
-          empty_raise_error_or_exception(node) && !block_with_args?(node.parent)
+          return false if node.arguments? || node.block_literal?
+
+          expect_to = find_expect_to(node)
+          return false unless expect_to
+          return false if expect_to.block_node&.arguments?
+
+          true
         end
 
-        def block_with_args?(node)
-          return false unless node&.block_type?
+        def find_expect_to(node)
+          node.each_ancestor.find do |ancestor|
+            break if ancestor.block_type?
 
-          node.arguments?
+            expect_to?(ancestor)
+          end
         end
       end
     end

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

@@ -5,14 +5,14 @@ module RuboCop
     module RSpec
       # Checks for consistent verified double reference style.
       #
-      # Only investigates references that are one of the supported styles.
-      #
       # @see https://rspec.info/features/3-12/rspec-mocks/verifying-doubles
       #
-      # This cop can be configured in your configuration using the
-      # `EnforcedStyle` option and supports `--auto-gen-config`.
+      # @safety
+      #   This cop is unsafe because the correction requires loading the class.
+      #   Loading before stubbing causes RSpec to only allow instance methods
+      #   to be stubbed.
       #
-      # @example `EnforcedStyle: constant` (default)
+      # @example
       #   # bad
       #   let(:foo) do
       #     instance_double('ClassName', method_name: 'returned_value')
@@ -23,18 +23,7 @@ module RuboCop
       #     instance_double(ClassName, method_name: 'returned_value')
       #   end
       #
-      # @example `EnforcedStyle: string`
-      #   # bad
-      #   let(:foo) do
-      #     instance_double(ClassName, method_name: 'returned_value')
-      #   end
-      #
-      #   # good
-      #   let(:foo) do
-      #     instance_double('ClassName', method_name: 'returned_value')
-      #   end
-      #
-      # @example Reference is not in the supported style list. No enforcement
+      # @example Reference is any dynamic variable. No enforcement
       #
       #   # good
       #   let(:foo) do
@@ -42,9 +31,9 @@ module RuboCop
       #   end
       class VerifiedDoubleReference < Base
         extend AutoCorrector
-        include ConfigurableEnforcedStyle
 
-        MSG = 'Use a %<style>s class reference for verified doubles.'
+        MSG = 'Use a constant class reference for verified doubles. ' \
+              'String references are not verifying unless the class is loaded.'
 
         RESTRICT_ON_SEND = Set[
           :class_double,
@@ -57,53 +46,25 @@ module RuboCop
           :stub_model
         ].freeze
 
-        REFERENCE_TYPE_STYLES = {
-          str: :string,
-          const: :constant
-        }.freeze
-
         # @!method verified_double(node)
         def_node_matcher :verified_double, <<~PATTERN
           (send
             nil?
             RESTRICT_ON_SEND
-            $_class_reference
+            $str
             ...)
         PATTERN
 
         def on_send(node)
-          verified_double(node) do |class_reference|
-            break correct_style_detected unless opposing_style?(class_reference)
-
-            message = format(MSG, style: style)
-            expression = class_reference.source_range
-
-            add_offense(expression, message: message) do |corrector|
-              offense = class_reference.source
-              corrector.replace(expression, correct_style(offense))
-
-              opposite_style_detected
+          verified_double(node) do |string_argument_node|
+            add_offense(string_argument_node) do |corrector|
+              autocorrect(corrector, string_argument_node)
             end
           end
         end
 
-        private
-
-        def opposing_style?(class_reference)
-          class_reference_style = REFERENCE_TYPE_STYLES[class_reference.type]
-
-          # Only enforce supported styles
-          return false unless class_reference_style
-
-          class_reference_style != style
-        end
-
-        def correct_style(offense)
-          if style == :string
-            "'#{offense}'"
-          else
-            offense.gsub(/^['"]|['"]$/, '')
-          end
+        def autocorrect(corrector, node)
+          corrector.replace(node, node.value)
         end
       end
     end

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

@@ -29,12 +29,14 @@ module RuboCop
 
         def on_send(node)
           return unless expect?(node)
+          return unless inside_example?(node)
 
           check_expect(node)
         end
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless expect_block?(node)
+          return unless inside_example?(node)
 
           check_expect(node)
         end
@@ -49,11 +51,14 @@ module RuboCop
 
         def void?(expect)
           parent = expect.parent
-          return true unless parent
           return true if parent.begin_type?
 
           parent.block_type? && parent.body == expect
         end
+
+        def inside_example?(node)
+          node.each_ancestor(:block).any? { |ancestor| example?(ancestor) }
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec_cops.rb

@@ -1,29 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'rspec/capybara/current_path_expectation'
-require_relative 'rspec/capybara/feature_methods'
-require_relative 'rspec/capybara/match_style'
-require_relative 'rspec/capybara/negation_matcher'
-require_relative 'rspec/capybara/specific_actions'
-require_relative 'rspec/capybara/specific_finders'
-require_relative 'rspec/capybara/specific_matcher'
-require_relative 'rspec/capybara/visibility_matcher'
-
-require_relative 'rspec/factory_bot/attribute_defined_statically'
-require_relative 'rspec/factory_bot/consistent_parentheses_style'
-require_relative 'rspec/factory_bot/create_list'
-require_relative 'rspec/factory_bot/factory_class_name'
-require_relative 'rspec/factory_bot/factory_name_style'
-require_relative 'rspec/factory_bot/syntax_methods'
-
-require_relative 'rspec/rails/avoid_setup_hook'
-require_relative 'rspec/rails/have_http_status'
-require_relative 'rspec/rails/http_status'
-require_relative 'rspec/rails/inferred_spec_type'
-require_relative 'rspec/rails/minitest_assertions'
-require_relative 'rspec/rails/negation_be_valid'
-require_relative 'rspec/rails/travel_around'
-
 require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'
 require_relative 'rspec/any_instance'
@@ -63,8 +39,8 @@ require_relative 'rspec/excessive_docstring_spacing'
 require_relative 'rspec/expect_actual'
 require_relative 'rspec/expect_change'
 require_relative 'rspec/expect_in_hook'
+require_relative 'rspec/expect_in_let'
 require_relative 'rspec/expect_output'
-require_relative 'rspec/file_path'
 require_relative 'rspec/focus'
 require_relative 'rspec/hook_argument'
 require_relative 'rspec/hooks_before_examples'
@@ -88,6 +64,7 @@ require_relative 'rspec/message_expectation'
 require_relative 'rspec/message_spies'
 require_relative 'rspec/metadata_style'
 require_relative 'rspec/missing_example_group_argument'
+require_relative 'rspec/missing_expectation_target_method'
 require_relative 'rspec/multiple_describes'
 require_relative 'rspec/multiple_expectations'
 require_relative 'rspec/multiple_memoized_helpers'

data/lib/rubocop/rspec/concept.rb

@@ -5,7 +5,6 @@ module RuboCop
     # Wrapper for RSpec DSL methods
     class Concept
       extend RuboCop::NodePattern::Macros
-      extend Language::NodePattern
       include Language
 
       def initialize(node)

data/lib/rubocop/rspec/config_formatter.rb

@@ -6,31 +6,7 @@ module RuboCop
   module RSpec
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
-      EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
-      SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
-      EXTRACTED_COPS = %(
-        RSpec/Capybara/CurrentPathExpectation
-        RSpec/Capybara/MatchStyle
-        RSpec/Capybara/NegationMatcher
-        RSpec/Capybara/SpecificActions
-        RSpec/Capybara/SpecificFinders
-        RSpec/Capybara/SpecificMatcher
-        RSpec/Capybara/VisibilityMatcher
-        RSpec/FactoryBot/AttributeDefinedStatically
-        RSpec/FactoryBot/ConsistentParenthesesStyle
-        RSpec/FactoryBot/CreateList
-        RSpec/FactoryBot/FactoryClassName
-        RSpec/FactoryBot/FactoryNameStyle
-        RSpec/FactoryBot/SyntaxMethods
-        RSpec/Rails/AvoidSetupHook
-        RSpec/Rails/HaveHttpStatus
-        RSpec/Rails/HttpStatus
-        RSpec/Rails/InferredSpecType
-        RSpec/Rails/MinitestAssertions
-        RSpec/Rails/NegationBeValid
-        RSpec/Rails/TravelAround
-      )
-      AMENDMENTS = %(Metrics/BlockLength)
+      EXTENSION_ROOT_DEPARTMENT = %r{^RSpec/}.freeze
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
       def initialize(config, descriptions)
@@ -40,19 +16,15 @@ module RuboCop
 
       def dump
         YAML.dump(unified_config)
-          .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
-          .gsub(*AMENDMENTS, "\n\\0")
-          .gsub(/^(\s+)- /, '\1  - ')
-          .gsub('"~"', '~')
+          .gsub(%r{^\w+/}, "\n\\0")   # Add an extra newline before each cop.
+          .gsub(/^(\s+)- /, '\1  - ') # Add 2 spaces before each array element.
+          .gsub('"~"', '~')           # Don't quote tilde, YAML's null value.
       end
 
       private
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
-          next if SUBDEPARTMENTS.include?(cop) || AMENDMENTS.include?(cop)
-          next if EXTRACTED_COPS.include?(cop)
-
           replace_nil(unified[cop])
           unified[cop].merge!(descriptions.fetch(cop))
           unified[cop]['Reference'] = reference(cop)