rubocop-rspec 2.29.2 → 3.0.5

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

@@ -27,7 +27,7 @@ module RuboCop
         # @!method expectation(node)
         def_node_search :expectation, '(send nil? #Expectations.all ...)'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node)
           return unless hook?(node)
           return if node.body.nil?
 

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Do not use `expect` in let.
+      #
+      # @example
+      #   # bad
+      #   let(:foo) do
+      #     expect(something).to eq 'foo'
+      #   end
+      #
+      #   # good
+      #   it do
+      #     expect(something).to eq 'foo'
+      #   end
+      #
+      class ExpectInLet < Base
+        MSG = 'Do not use `%<expect>s` in let'
+
+        # @!method expectation(node)
+        def_node_search :expectation, '(send nil? #Expectations.all ...)'
+
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          return unless let?(node)
+          return if node.body.nil?
+
+          expectation(node.body) do |expect|
+            add_offense(expect.loc.selector, message: message(expect))
+          end
+        end
+
+        private
+
+        def message(expect)
+          format(MSG, expect: expect.method_name)
+        end
+      end
+    end
+  end
+end

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

@@ -48,8 +48,8 @@ module RuboCop
         include AllowedIdentifiers
         include AllowedPattern
 
-        MSG = 'This `let` statement uses index in its name. Please give it ' \
-              'a meaningful name.'
+        MSG = 'This `let` statement uses `%<index>s` in its name. ' \
+              'Please give it a meaningful name.'
 
         # @!method let_name(node)
         def_node_matcher :let_name, <<~PATTERN
@@ -66,7 +66,8 @@ module RuboCop
           return unless children
 
           filter_indexed_lets(children).each do |let_node|
-            add_offense(let_node)
+            index = let_name(let_node)[INDEX_REGEX]
+            add_offense(let_node, message: format(MSG, index: index))
           end
         end
 

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

@@ -119,7 +119,7 @@ module RuboCop
         private
 
         def inside_describe_block?(node)
-          node.each_ancestor(:block).any?(&method(:spec_group?))
+          node.each_ancestor(:block).any? { |ancestor| spec_group?(ancestor) }
         end
       end
     end

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

@@ -45,13 +45,8 @@ module RuboCop
         PATTERN
 
         def on_metadata(symbols, hash)
-          # RSpec example groups accept two string arguments. In such a case,
-          # the rspec_metadata matcher will interpret the second string
-          # argument as a metadata symbol.
-          symbols.shift if symbols.first&.str_type?
-
           symbols.each do |symbol|
-            on_metadata_symbol(symbol)
+            on_metadata_symbol(symbol) if symbol.sym_type?
           end
 
           return unless hash

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks if `.to`, `not_to` or `to_not` are used.
+      #
+      # The RSpec::Expectations::ExpectationTarget must use `to`, `not_to` or
+      # `to_not` to run. Therefore, this cop checks if other methods are used.
+      #
+      # @example
+      #   # bad
+      #   expect(something).kind_of? Foo
+      #   is_expected == 42
+      #   expect{something}.eq? BarError
+      #
+      #   # good
+      #   expect(something).to be_a Foo
+      #   is_expected.to eq 42
+      #   expect{something}.to raise_error BarError
+      #
+      class MissingExpectationTargetMethod < Base
+        MSG = 'Use `.to`, `.not_to` or `.to_not` to set an expectation.'
+        RESTRICT_ON_SEND = %i[expect is_expected].freeze
+
+        # @!method expect?(node)
+        def_node_matcher :expect?, <<~PATTERN
+          {
+            (send nil? :expect ...)
+            (send nil? :is_expected)
+          }
+        PATTERN
+
+        # @!method expect_block?(node)
+        def_node_matcher :expect_block?, <<~PATTERN
+          (block #expect? (args) _body)
+        PATTERN
+
+        # @!method expectation_without_runner?(node)
+        def_node_matcher :expectation_without_runner?, <<~PATTERN
+          (send {#expect? #expect_block?} !#Runners.all ...)
+        PATTERN
+
+        def on_send(node)
+          node = node.parent if node.parent&.block_type?
+
+          expectation_without_runner?(node.parent) do
+            add_offense(node.parent.loc.selector)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module RuboCop
 
         def on_top_level_group(node)
           top_level_example_groups =
-            top_level_groups.select(&method(:example_group?))
+            top_level_groups.select { |group| example_group?(group) }
 
           return if top_level_example_groups.one?
           return unless top_level_example_groups.first.equal?(node)

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

@@ -67,12 +67,12 @@ module RuboCop
       #   end
       #
       class MultipleExpectations < Base
-        include ConfigurableMax
-
         MSG = 'Example has too many expectations [%<total>d/%<max>d].'
 
         ANYTHING = ->(_node) { true }
-        TRUE = ->(node) { node.true_type? }
+        TRUE_NODE = lambda(&:true_type?)
+
+        exclude_limit 'Max'
 
         # @!method aggregate_failures?(node)
         def_node_matcher :aggregate_failures?, <<~PATTERN
@@ -110,7 +110,7 @@ module RuboCop
           node_with_aggregate_failures = find_aggregate_failures(example_node)
           return false unless node_with_aggregate_failures
 
-          aggregate_failures?(node_with_aggregate_failures, TRUE)
+          aggregate_failures?(node_with_aggregate_failures, TRUE_NODE)
         end
 
         def find_aggregate_failures(example_node)

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

@@ -82,11 +82,12 @@ module RuboCop
       #   end
       #
       class MultipleMemoizedHelpers < Base
-        include ConfigurableMax
         include Variable
 
         MSG = 'Example group has too many memoized helpers [%<count>d/%<max>d]'
 
+        exclude_limit 'Max'
+
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless spec_group?(node)
 
@@ -108,10 +109,8 @@ module RuboCop
         attr_reader :example_group_memoized_helpers
 
         def all_helpers(node)
-          [
-            *helpers(node),
-            *node.each_ancestor(:block).flat_map(&method(:helpers))
-          ]
+          helpers(node) +
+            node.each_ancestor(:block).flat_map { |ancestor| helpers(ancestor) }
         end
 
         def helpers(node)

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

@@ -107,8 +107,11 @@ module RuboCop
         private
 
         def ignored_shared_example?(node)
-          cop_config['IgnoreSharedExamples'] &&
-            node.each_ancestor(:block).any?(&method(:shared_example?))
+          return false unless cop_config['IgnoreSharedExamples']
+
+          node.each_ancestor(:block).any? do |ancestor|
+            shared_example?(ancestor)
+          end
         end
 
         def check_explicit_subject(node)

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

@@ -92,7 +92,6 @@ module RuboCop
       #   end
       #
       class NestedGroups < Base
-        include ConfigurableMax
         include TopLevelGroup
 
         MSG = 'Maximum example group nesting exceeded [%<total>d/%<max>d].'
@@ -103,6 +102,8 @@ module RuboCop
           "Configuration key `#{DEPRECATED_MAX_KEY}` for #{cop_name} is " \
           'deprecated in favor of `Max`. Please use that instead.'
 
+        exclude_limit 'Max'
+
         def on_top_level_group(node)
           find_nested_example_groups(node) do |example_group, nesting|
             self.max = nesting

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

@@ -32,7 +32,7 @@ module RuboCop
               (block $(send !nil? #predicate? ...) ...)
               $(send !nil? #predicate? ...)})
             $#Runners.all
-            $#boolean_matcher?)
+            $#boolean_matcher? ...)
         PATTERN
 
         # @!method be_bool?(node)
@@ -174,7 +174,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 +183,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)

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/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/sort_metadata.rb

@@ -58,7 +58,7 @@ module RuboCop
 
         def sort_symbols(symbols)
           symbols.sort_by do |symbol|
-            if %i[str sym].include?(symbol.type)
+            if symbol.str_type? || symbol.sym_type?
               symbol.value.to_s.downcase
             else
               symbol.source.downcase

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

@@ -136,7 +136,9 @@ module RuboCop
         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

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,39 @@ 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)
-        end
+          return false if node.arguments? || node.block_literal?
 
-        def block_with_args?(node)
-          return false unless node&.block_type?
+          expect_to = find_expect_to(node)
+          return false unless expect_to
+          return false if expect_to.block_node&.arguments?
+
+          true
+        end
 
-          node.arguments?
+        def find_expect_to(node)
+          node.each_ancestor(:send).find do |ancestor|
+            expect_to?(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

@@ -7,29 +7,7 @@ module RuboCop
     # 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
-      )
+      SUBDEPARTMENTS = [].freeze
       AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
@@ -51,7 +29,6 @@ module RuboCop
       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))

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Cop
+      # Source and spec generator for new cops
+      #
+      # This generator will take a cop name and generate a source file
+      # and spec file when given a valid qualified cop name.
+      # @api private
+      class Generator < RuboCop::Cop::Generator
+        def todo
+          <<~TODO
+            Do 4 steps:
+              1. Modify the description of #{badge} in config/default.yml
+              2. Implement your new cop in the generated file!
+              3. Add an entry about new cop to CHANGELOG.md
+              4. Commit your new cop with a message such as
+                 e.g. "Add new `#{badge}` cop"
+          TODO
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/language.rb

@@ -13,7 +13,6 @@ module RuboCop
     # using the configured aliases.
     module Language
       extend RuboCop::NodePattern::Macros
-      extend NodePattern
 
       class << self
         attr_accessor :config

data/lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb

@@ -21,7 +21,7 @@ RSpec.shared_context 'with default RSpec/Language config' do
     when Array
       object.map { |item| deep_dup(item) }
     when Hash
-      object.transform_values(&method(:deep_dup))
+      object.transform_values { |value| deep_dup(value) }
     else
       object # only collections undergo modifications and need duping
     end

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '2.29.2'
+      STRING = '3.0.5'
     end
   end
 end

data/lib/rubocop/rspec/wording.rb

@@ -4,10 +4,10 @@ module RuboCop
   module RSpec
     # RSpec example wording rewriter
     class Wording
-      SHOULDNT_PREFIX    = /\Ashould(?:n't| not)\b/i.freeze
+      SHOULDNT_PREFIX    = /\Ashould(?:n't|n’t| not)\b/i.freeze
       SHOULDNT_BE_PREFIX = /#{SHOULDNT_PREFIX} be\b/i.freeze
       WILL_NOT_PREFIX    = /\Awill not\b/i.freeze
-      WONT_PREFIX        = /\Awon't\b/i.freeze
+      WONT_PREFIX        = /\Awo(?:n't|n’t)\b/i.freeze
       ES_SUFFIX_PATTERN  = /(?:o|s|x|ch|sh|z)\z/i.freeze
       IES_SUFFIX_PATTERN = /[^aeou]y\z/i.freeze
 

data/lib/rubocop-rspec.rb

@@ -4,19 +4,14 @@ require 'pathname'
 require 'yaml'
 
 require 'rubocop'
-require 'rubocop-capybara'
-require 'rubocop-factory_bot'
 
 require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/inject'
-require_relative 'rubocop/rspec/language/node_pattern'
+require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/node'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/wording'
 
-# Dependent on `RuboCop::RSpec::Language::NodePattern`.
-require_relative 'rubocop/rspec/language'
-
 require_relative 'rubocop/cop/rspec/mixin/file_help'
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
@@ -39,9 +34,6 @@ require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/hook'
 
-# need after `require 'rubocop/cop/rspec/base'``
-require 'rubocop-rspec_rails'
-
 RuboCop::RSpec::Inject.defaults!
 
 require_relative 'rubocop/cop/rspec_cops'
@@ -58,12 +50,4 @@ RuboCop::Cop::Layout::ExtraSpacing.singleton_class.prepend(
   end
 )
 
-RuboCop::Cop::Style::TrailingCommaInArguments.singleton_class.prepend(
-  Module.new do
-    def autocorrect_incompatible_with
-      super.push(RuboCop::Cop::RSpec::Capybara::CurrentPathExpectation)
-    end
-  end
-)
-
 RuboCop::AST::Node.include(RuboCop::RSpec::Node)