rubocop-rspec 2.29.1 → 3.5.0

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

@@ -45,7 +45,7 @@ module RuboCop
 
         # @!method eql_type_with_identity(node)
         def_node_matcher :eql_type_with_identity, <<~PATTERN
-          (send _ :to $(send nil? :eql {true false int float sym nil}))
+          (send _ :to $(send nil? :eql {boolean int float sym nil}))
         PATTERN
 
         def on_send(node)

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

@@ -48,6 +48,10 @@ module RuboCop
             check_be_style(node)
           when :be_nil
             check_be_nil_style(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 

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

@@ -101,24 +101,23 @@ module RuboCop
 
         private
 
-        # rubocop:disable Metrics/MethodLength
         def register_offense(node, change_node)
           if compound_expectations?(node)
-            add_offense(node.source_range,
+            add_offense(node,
                         message: message_compound(change_node)) do |corrector|
               autocorrect_compound(corrector, node)
             end
           else
-            add_offense(node.source_range,
+            add_offense(node,
                         message: message(change_node)) do |corrector|
               autocorrect(corrector, node, change_node)
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def compound_expectations?(node)
-          %i[and or & |].include?(node.parent.method_name)
+          node.parent.send_type? &&
+            %i[and or & |].include?(node.parent.method_name)
         end
 
         def message(change_node)

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

@@ -6,6 +6,7 @@ module RuboCop
       # Checks where `contain_exactly` is used.
       #
       # This cop checks for the following:
+      #
       # - Prefer `match_array` when matching array values.
       # - Prefer `be_empty` when using `contain_exactly` with no arguments.
       #

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

@@ -12,6 +12,9 @@ module RuboCop
       #
       # @see http://www.betterspecs.org/#contexts
       #
+      # If both `Prefixes` and `AllowedPatterns` are empty, this cop will always
+      # report an offense. So you need to set at least one of them.
+      #
       # @example `Prefixes` configuration
       #   # .rubocop.yml
       #   # RSpec/ContextWording:
@@ -58,7 +61,9 @@ module RuboCop
       class ContextWording < Base
         include AllowedPattern
 
-        MSG = 'Context description should match %<patterns>s.'
+        MSG_MATCH = 'Context description should match %<patterns>s.'
+        MSG_ALWAYS = 'Current settings will always report an offense. Please ' \
+                     'add allowed words to `Prefixes` or `AllowedPatterns`.'
 
         # @!method context_wording(node)
         def_node_matcher :context_wording, <<~PATTERN
@@ -67,8 +72,7 @@ module RuboCop
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           context_wording(node) do |context|
-            if bad_pattern?(context)
-              message = format(MSG, patterns: expect_patterns)
+            unless matches_allowed_pattern?(description(context))
               add_offense(context, message: message)
             end
           end
@@ -84,12 +88,6 @@ module RuboCop
           @prefix_regexes ||= prefixes.map { |pre| /^#{Regexp.escape(pre)}\b/ }
         end
 
-        def bad_pattern?(node)
-          return false if allowed_patterns.empty?
-
-          !matches_allowed_pattern?(description(node))
-        end
-
         def description(context)
           if context.xstr_type?
             context.value.value
@@ -98,6 +96,14 @@ module RuboCop
           end
         end
 
+        def message
+          if allowed_patterns.empty?
+            MSG_ALWAYS
+          else
+            format(MSG_MATCH, patterns: expect_patterns)
+          end
+        end
+
         def expect_patterns
           inspected = allowed_patterns.map do |pattern|
             pattern.inspect.gsub(/\A"|"\z/, '/')

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

@@ -29,6 +29,19 @@ module RuboCop
       #     PreferredMethods:
       #       context: describe
       #
+      # If you were previously using the `RSpec/Capybara/FeatureMethods` cop and
+      # want to keep disabling all Capybara-specific methods that have the same
+      # native RSpec method (e.g. are just aliases), use the following config:
+      #
+      #   RSpec/Dialect:
+      #     PreferredMethods:
+      #       background: :before
+      #       scenario:   :it
+      #       xscenario:  :xit
+      #       given:      :let
+      #       given!:     :let!
+      #       feature:    :describe
+      #
       # You can expect the following behavior:
       #
       # @example

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

@@ -130,6 +130,7 @@ module RuboCop
         def_node_matcher :examples?, <<~PATTERN
           {
             #examples_directly_or_in_block?
+            #examples_in_branches?
             (begin <#examples_directly_or_in_block? ...>)
             (begin <#examples_in_branches? ...>)
           }
@@ -170,6 +171,7 @@ module RuboCop
         end
 
         def examples_in_branches?(condition_node)
+          return false unless condition_node
           return false if !condition_node.if_type? && !condition_node.case_type?
 
           condition_node.branches.any? { |branch| examples?(branch) }

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

@@ -21,6 +21,7 @@ module RuboCop
 
         def on_metadata(_symbols, hash)
           return unless hash&.pairs&.empty?
+          return if hash.children.any?(&:kwsplat_type?)
 
           add_offense(hash) do |corrector|
             remove_empty_metadata(corrector, hash)

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

@@ -55,8 +55,8 @@ module RuboCop
         MSG_INSUFFICIENT_DESCRIPTION = 'Your example description is ' \
                                        'insufficient.'
 
-        SHOULD_PREFIX = /\Ashould(?:n't)?\b/i.freeze
-        WILL_PREFIX   = /\A(?:will|won't)\b/i.freeze
+        SHOULD_PREFIX = /\Ashould(?:n't|n’t)?\b/i.freeze
+        WILL_PREFIX   = /\A(?:will|won't|won’t)\b/i.freeze
         IT_PREFIX     = /\Ait /i.freeze
 
         # @!method it_description(node)
@@ -67,7 +67,6 @@ module RuboCop
           } ...) ...)
         PATTERN
 
-        # rubocop:disable Metrics/MethodLength
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           it_description(node) do |description_node, message|
             if message.match?(SHOULD_PREFIX)
@@ -82,7 +81,6 @@ module RuboCop
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         private
 
@@ -128,7 +126,7 @@ module RuboCop
             node.node_parts.map { |child_node| text(child_node) }.join
           when :str
             node.value
-          when :begin
+          else
             node.source
           end
         end

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

@@ -100,7 +100,7 @@ module RuboCop
             node.node_parts.map { |child_node| text(child_node) }.join
           when :str, :sym
             node.value
-          when :begin
+          else
             node.source
           end
         end

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

@@ -65,11 +65,11 @@ module RuboCop
           )
         PATTERN
 
-        def on_send(node) # rubocop:disable Metrics/MethodLength
+        def on_send(node)
           expect_literal(node) do |actual, send_node, matcher, expected|
             next if SKIPPED_MATCHERS.include?(matcher)
 
-            add_offense(actual.source_range) do |corrector|
+            add_offense(actual) do |corrector|
               next unless CORRECTABLE_MATCHERS.include?(matcher)
               next if literal?(expected)
 
@@ -97,7 +97,7 @@ module RuboCop
 
         def complex_literal?(node)
           COMPLEX_LITERALS.include?(node.type) &&
-            node.each_child_node.all?(&method(:literal?))
+            node.each_child_node.all? { |child_node| literal?(child_node) }
         end
       end
     end

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

@@ -29,12 +29,6 @@ module RuboCop
       #   describe 'test' do; end
       #
       #   # bad
-      #   fdescribe 'test' do; end
-      #
-      #   # good
-      #   describe 'test' do; end
-      #
-      #   # bad
       #   shared_examples 'test', focus: true do; end
       #
       #   # good
@@ -81,23 +75,27 @@ module RuboCop
         def on_send(node)
           return if node.chained? || node.each_ancestor(:def, :defs).any?
 
-          focus_metadata(node) do |focus|
-            add_offense(focus) do |corrector|
-              if focus.pair_type? || focus.str_type? || focus.sym_type?
-                corrector.remove(with_surrounding(focus))
-              elsif focus.send_type?
-                correct_send(corrector, focus)
-              end
+          if focused_block?(node)
+            on_focused_block(node)
+          else
+            metadata(node) do |focus|
+              on_metadata(focus)
             end
           end
         end
 
         private
 
-        def focus_metadata(node, &block)
-          yield(node) if focused_block?(node)
+        def on_focused_block(node)
+          add_offense(node) do |corrector|
+            correct_send(corrector, node)
+          end
+        end
 
-          metadata(node, &block)
+        def on_metadata(node)
+          add_offense(node) do |corrector|
+            corrector.remove(with_surrounding(node))
+          end
         end
 
         def with_surrounding(focus)

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

@@ -46,7 +46,7 @@ module RuboCop
 
         ENFORCED_REPLACEMENTS = alternatives.merge(alternatives.invert).freeze
 
-        def on_send(node) # rubocop:disable Metrics/MethodLength
+        def on_send(node)
           return unless (source_range = offending_expect(node))
 
           expectation_source = source_range.source
@@ -69,13 +69,13 @@ module RuboCop
         def offending_expect(node)
           case implicit_expect(node)
           when :is_expected
-            is_expected_range(node.loc)
+            range_for_is_expected(node.loc)
           when :should, :should_not
             node.loc.selector
           end
         end
 
-        def is_expected_range(source_map) # rubocop:disable Naming/PredicateName
+        def range_for_is_expected(source_map)
           Parser::Source::Range.new(
             source_map.expression.source_buffer,
             source_map.expression.begin_pos,

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

@@ -107,6 +107,10 @@ module RuboCop
             corrector.replace(node.location.selector, 'expect(subject).to')
           when :should_not
             corrector.replace(node.location.selector, 'expect(subject).not_to')
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 
@@ -129,6 +133,10 @@ module RuboCop
             implicit_subject_in_non_its_and_non_single_line?(node)
           when :single_statement_only
             implicit_subject_in_non_its_and_non_single_statement?(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           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,14 +66,17 @@ 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
 
         private
 
         SUFFIX_INDEX_REGEX = /_?\d+$/.freeze
+        private_constant :SUFFIX_INDEX_REGEX
         INDEX_REGEX = /\d+/.freeze
+        private_constant :INDEX_REGEX
 
         def filter_indexed_lets(candidates)
           candidates

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

@@ -6,6 +6,7 @@ module RuboCop
       # Checks where `match_array` is used.
       #
       # This cop checks for the following:
+      #
       # - Prefer `contain_exactly` when matching an array with values.
       # - Prefer `eq` when using `match_array` with an empty array literal.
       #

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

@@ -80,6 +80,10 @@ module RuboCop
             MSG_RECEIVE
           when :have_received
             format(MSG_HAVE_RECEIVED, source: receiver.source)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           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/mixin/metadata.rb

@@ -47,15 +47,12 @@ module RuboCop
         private
 
         def on_metadata_arguments(metadata_arguments)
-          *symbols, last = metadata_arguments
-          hash = nil
-          case last&.type
-          when :hash
-            hash = last
-          when :sym
-            symbols << last
+          if metadata_arguments.last&.hash_type?
+            *metadata_arguments, hash = metadata_arguments
+            on_metadata(metadata_arguments, hash)
+          else
+            on_metadata(metadata_arguments, nil)
           end
-          on_metadata(symbols, hash)
         end
       end
     end

data/lib/rubocop/cop/rspec/mixin/top_level_group.rb

@@ -7,6 +7,10 @@ module RuboCop
       module TopLevelGroup
         extend RuboCop::NodePattern::Macros
 
+        DEPRECATED_MODULE_METHOD_WARNING =
+          'top_level_group? is deprecated and will be ' \
+          'removed in the next major version of rubocop_rspec.'
+
         def on_new_investigation
           super
 
@@ -28,7 +32,10 @@ module RuboCop
 
         def on_top_level_group(_node); end
 
+        # @private
+        # @deprecated All callers of this method have been removed.
         def top_level_group?(node)
+          warn DEPRECATED_MODULE_METHOD_WARNING, uplevel: 1
           top_level_groups.include?(node)
         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