rubocop-rspec 3.9.0 → 3.10.2

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

@@ -89,6 +89,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

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

@@ -45,6 +45,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

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

@@ -59,7 +59,7 @@ module RuboCop
           }
         PATTERN
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless spec_group?(node)
 
           children = node.body&.child_nodes

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

@@ -42,7 +42,7 @@ module RuboCop
           ...)
         PATTERN
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example?(node)
 
           null_double(node) do |var, receiver|

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

@@ -38,6 +38,13 @@ module RuboCop
           )
         PATTERN
 
+        # @!method each_itblock?(node)
+        def_node_matcher :each_itblock?, <<~PATTERN
+          (itblock
+            (send ... :each) _ (...)
+          )
+        PATTERN
+
         # @!method expectation?(node)
         def_node_matcher :expectation?, <<~PATTERN
           (send (send nil? :expect (lvar %)) :to ...)
@@ -55,6 +62,12 @@ module RuboCop
           end
         end
 
+        def on_itblock(node)
+          each_itblock?(node) do
+            check_offense(node, :it)
+          end
+        end
+
         private
 
         def check_offense(node, argument)

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

@@ -37,7 +37,7 @@ module RuboCop
 
         MSG = 'Declare `subject` above any other `%<offending>s` declarations.'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless subject?(node)
           return unless inside_example_group?(node)
 

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

@@ -55,7 +55,7 @@ module RuboCop
           [RSpec::ScatteredLet]
         end
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group_with_body?(node)
 
           check_let_declarations(node.body) if multiline_block?(node.body)

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

@@ -59,7 +59,7 @@ module RuboCop
         # @!method method_called?(node)
         def_node_search :method_called?, '(send nil? %)'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_or_shared_group_or_including?(node)
 
           unused_let_bang(node) do |let|

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'regexp_parser'
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Enforces the use of `include` matcher instead of `match` when the
+      # matcher is a simple string literal without regex-specific features.
+      #
+      # When `match` is used with a regex that contains only literal characters
+      # (no anchors, character classes, quantifiers, alternations, or
+      # metacharacters), it's clearer to use the `include` matcher instead.
+      #
+      # @example
+      #   # bad
+      #   expect('foobar').to match(/foo/)
+      #   expect(response.body).to match(/http:\/\/example\.com/)
+      #
+      #   # good
+      #   expect('foobar').to include('foo')
+      #   expect(response.body).to include('http://example.com')
+      #
+      #   # good - regex features needed
+      #   expect('foobar').to match(/^foo/)     # anchor
+      #   expect('foobar').to match(/foo\d+/)   # quantifier
+      #   expect('foobar').to match(/foo[ob]/)  # character class
+      #
+      class MatchWithSimpleRegex < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer using `include(%<string>s)` when the regex is a simple ' \
+              'string literal.'
+        RESTRICT_ON_SEND = %i[match].freeze
+
+        # @!method match_with_regexp?(node)
+        def_node_matcher :match_with_regexp?, <<~PATTERN
+          (send nil? :match $regexp)
+        PATTERN
+
+        def on_send(node)
+          match_with_regexp?(node) do |regexp|
+            next unless simple_regexp?(regexp)
+
+            string_literal = regexp_to_string(regexp)
+            message = format(MSG, string: string_literal)
+
+            add_offense(node, message: message) do |corrector|
+              corrector.replace(node, "include(#{string_literal})")
+            end
+          end
+        end
+
+        private
+
+        def simple_regexp?(node)
+          return false if node.interpolation?
+          return false if node.regopt.children.any?
+
+          parsed = Regexp::Parser.parse(node.content)
+          parsed.expressions.all? { |expr| simple_expression?(expr) }
+        end
+
+        def simple_expression?(expr)
+          return false if expr.quantified?
+          return true if expr.is_a?(Regexp::Expression::Literal)
+          return true if expr.is_a?(Regexp::Expression::EscapeSequence::Literal)
+
+          false
+        end
+
+        # Reconstruct the literal string that the regex matches
+        def regexp_to_string(node)
+          parsed = Regexp::Parser.parse(node.content)
+          string_content = parsed.expressions.map do |expr|
+            expr.respond_to?(:char) ? expr.char : expr.text
+          end.join
+
+          to_string_literal(string_content)
+        end
+
+        def to_string_literal(string)
+          if string.include?("'")
+            %("#{string.gsub('"', '\"')}")
+          else
+            "'#{string}'"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -23,7 +23,7 @@ module RuboCop
       class MissingExampleGroupArgument < Base
         MSG = 'The first argument to `%<method>s` should not be empty.'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group?(node)
           return if node.send_node.arguments?
 

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps check if a given node is within an example block.
+      module InsideExample
+        private
+
+        def inside_example?(node)
+          node.each_ancestor(:block).any? { |ancestor| example?(ancestor) }
+        end
+      end
+    end
+  end
+end

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

@@ -39,6 +39,7 @@ module RuboCop
           end
         end
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def on_metadata(_symbols, _hash)
           raise ::NotImplementedError

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps find repeated items in a collection
+      #
+      # Provides a generic method to find repeated items by grouping them
+      # by a key and returning pairs of [item, repeated_lines] for items
+      # that appear more than once.
+      module RepeatedItems
+        # Groups items by key and returns only groups with more than one item
+        #
+        # @param items [Enumerable] the filtered collection to group
+        # @param key_proc [Proc] block returning the grouping key for each item
+        # @return [Array<Array>] array of groups containing more than one item
+        #   that share the same key and there are multiple items in the group
+        def find_repeated_groups(items, key_proc:)
+          items
+            .group_by(&key_proc)
+            .values
+            .reject(&:one?)
+        end
+
+        # Maps a group of items to pairs of [item, repeated_lines]
+        #
+        # @param items [Array] array of items that share the same key
+        # @return [Array<Array>] array of [item, repeated_lines] pairs
+        def add_repeated_lines(items)
+          repeated_lines = items.map(&:first_line)
+          items.map { |item| [item, repeated_lines - [item.first_line]] }
+        end
+      end
+    end
+  end
+end

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

@@ -90,7 +90,7 @@ module RuboCop
           (block (send nil? :aggregate_failures ...) ...)
         PATTERN
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example?(node)
 
           return if example_with_aggregate_failures?(node)

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

@@ -88,7 +88,7 @@ module RuboCop
 
         exclude_limit 'Max'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless spec_group?(node)
 
           count = all_helpers(node).uniq.count

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

@@ -54,7 +54,7 @@ module RuboCop
 
         MSG = 'Do not set more than one subject per example group'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group?(node)
 
           subjects = RuboCop::RSpec::ExampleGroup.new(node).subjects

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

@@ -94,7 +94,7 @@ module RuboCop
         # @!method subject_usage(node)
         def_node_search :subject_usage, '$(send nil? :subject)'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           if !example_or_hook_block?(node) || ignored_shared_example?(node)
             return
           end

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

@@ -96,6 +96,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
       end
     end
   end

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

@@ -33,7 +33,7 @@ module RuboCop
         # @!method first_argument_name(node)
         def_node_matcher :first_argument_name, '(send _ _ ({str sym} $_))'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group_with_body?(node)
 
           find_duplicates(node.body) do |duplicate, name|

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

@@ -340,7 +340,7 @@ module RuboCop
           end
         end
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           check_explicit(node) if style == :explicit
         end
       end

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

@@ -28,6 +28,7 @@ module RuboCop
           end
         end
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def on_send(node)
           return unless match_redundant_around_hook_send?(node)

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

@@ -42,7 +42,7 @@ module RuboCop
       class RepeatedDescription < Base
         MSG = "Don't repeat descriptions within an example group."
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group?(node)
 
           repeated_descriptions(node).each do |description|

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

@@ -16,10 +16,12 @@ module RuboCop
       #   end
       #
       class RepeatedExample < Base
+        include RepeatedItems
+
         MSG = "Don't repeat examples within an example group. " \
               'Repeated on line(s) %<lines>s.'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group?(node)
 
           find_repeated_examples(node).each do |repeated_examples|
@@ -32,10 +34,10 @@ module RuboCop
         def find_repeated_examples(node)
           examples = RuboCop::RSpec::ExampleGroup.new(node).examples
 
-          examples
-            .group_by { |example| build_example_signature(example) }
-            .values
-            .select { |group| group.size > 1 }
+          find_repeated_groups(
+            examples,
+            key_proc: ->(example) { build_example_signature(example) }
+          )
         end
 
         def build_example_signature(example)

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

@@ -44,6 +44,7 @@ module RuboCop
       #
       class RepeatedExampleGroupBody < Base
         include SkipOrPending
+        include RepeatedItems
 
         MSG = 'Repeated %<group>s block body on line(s) %<loc>s'
 
@@ -72,19 +73,14 @@ module RuboCop
         private
 
         def repeated_group_bodies(node)
-          node
-            .children
+          items = node.children
             .select { |child| example_group_with_body?(child) }
             .reject { |child| skip_or_pending_inside_block?(child) }
-            .group_by { |group| signature_keys(group) }
-            .values
-            .reject(&:one?)
-            .flat_map { |groups| add_repeated_lines(groups) }
-        end
 
-        def add_repeated_lines(groups)
-          repeated_lines = groups.map(&:first_line)
-          groups.map { |group| [group, repeated_lines - [group.first_line]] }
+          find_repeated_groups(
+            items,
+            key_proc: ->(group) { signature_keys(group) }
+          ).flat_map { |group| add_repeated_lines(group) }
         end
 
         def signature_keys(group)

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

@@ -44,6 +44,7 @@ module RuboCop
       #
       class RepeatedExampleGroupDescription < Base
         include SkipOrPending
+        include RepeatedItems
 
         MSG = 'Repeated %<group>s block description on line(s) %<loc>s'
 
@@ -71,20 +72,15 @@ module RuboCop
         private
 
         def repeated_group_descriptions(node)
-          node
-            .children
+          items = node.children
             .select { |child| example_group?(child) }
             .reject { |child| skip_or_pending_inside_block?(child) }
             .reject { |child| empty_description?(child) }
-            .group_by { |group| doc_string_and_metadata(group) }
-            .values
-            .reject(&:one?)
-            .flat_map { |groups| add_repeated_lines(groups) }
-        end
 
-        def add_repeated_lines(groups)
-          repeated_lines = groups.map(&:first_line)
-          groups.map { |group| [group, repeated_lines - [group.first_line]] }
+          find_repeated_groups(
+            items,
+            key_proc: ->(group) { doc_string_and_metadata(group) }
+          ).flat_map { |group| add_repeated_lines(group) }
         end
 
         def message(group, repeats)

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

@@ -46,6 +46,8 @@ module RuboCop
       #   end
       #
       class RepeatedIncludeExample < Base
+        include RepeatedItems
+
         MSG = 'Repeated include of shared_examples %<name>s ' \
               'on line(s) %<repeat>s'
 
@@ -73,13 +75,13 @@ module RuboCop
         private
 
         def repeated_include_examples(node)
-          node
-            .children
+          items = node.children
             .select { |child| literal_include_examples?(child) }
-            .group_by { |child| signature_keys(child) }
-            .values
-            .reject(&:one?)
-            .flat_map { |items| add_repeated_lines(items) }
+
+          find_repeated_groups(
+            items,
+            key_proc: ->(child) { signature_keys(child) }
+          ).flat_map { |group| add_repeated_lines(group) }
         end
 
         def literal_include_examples?(node)
@@ -87,11 +89,6 @@ module RuboCop
             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

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

@@ -59,7 +59,7 @@ module RuboCop
           check_and_return_call(node)
         end
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless style == :and_return
           return unless stub_with_block?(node)
 

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

@@ -19,11 +19,11 @@ module RuboCop
       #
       #   # good
       #   describe Foo do
-      #     subject { Foo }
-      #     before { prepare }
       #     let(:foo) { 1 }
       #     let(:bar) { 2 }
       #     let!(:baz) { 3 }
+      #     subject { Foo }
+      #     before { prepare }
       #   end
       #
       class ScatteredLet < Base
@@ -31,7 +31,7 @@ module RuboCop
 
         MSG = 'Group all let/let! blocks in the example group together.'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group_with_body?(node)
 
           check_let_declarations(node.body)
@@ -41,15 +41,21 @@ module RuboCop
 
         def check_let_declarations(body)
           lets = body.each_child_node.select { |node| let?(node) }
+          return if lets.empty?
 
           first_let = lets.first
+          reference_let = first_let
+
           lets.each_with_index do |node, idx|
-            next if node.sibling_index == first_let.sibling_index + idx
+            if node.sibling_index == first_let.sibling_index + idx
+              reference_let = node
+              next
+            end
 
             add_offense(node) do |corrector|
               RuboCop::RSpec::Corrector::MoveNode.new(
                 node, corrector, processed_source
-              ).move_after(first_let)
+              ).move_after(reference_let)
             end
           end
         end

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

@@ -42,12 +42,13 @@ module RuboCop
       class ScatteredSetup < Base
         include FinalEndLocation
         include RangeHelp
+        include RepeatedItems
         extend AutoCorrector
 
         MSG = 'Do not define multiple `%<hook_name>s` hooks in the same ' \
               'example group (also defined on %<lines>s).'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless example_group?(node)
 
           repeated_hooks(node).each do |occurrences|
@@ -63,17 +64,14 @@ module RuboCop
         private
 
         def repeated_hooks(node) # rubocop:disable Metrics/CyclomaticComplexity
-          hooks = RuboCop::RSpec::ExampleGroup.new(node)
-            .hooks
+          hooks = RuboCop::RSpec::ExampleGroup.new(node).hooks
             .reject(&:inside_class_method?)
             .select { |hook| hook.knowable_scope? && hook.name != :around }
-            .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
-            .values
-            .reject(&:one?)
 
-          hooks.map do |hook|
-            hook.map(&:to_node)
-          end
+          find_repeated_groups(
+            hooks,
+            key_proc: ->(hook) { [hook.name, hook.scope, hook.metadata] }
+          ).map { |hook_group| hook_group.map(&:to_node) }
         end
 
         def lines_msg(numbers)