rubocop-rspec 3.8.0 → 3.10.0

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

@@ -57,6 +57,13 @@ module RuboCop
       #     expectations
       #   end
       #
+      #   # good - when variable is used only in example metadata
+      #   skip_message = 'not yet implemented'
+      #
+      #   it 'does something', skip: skip_message do
+      #     expectations
+      #   end
+      #
       #   # good - when variable is used only to include other examples
       #   examples = foo ? 'some examples' : 'other examples'
       #
@@ -103,6 +110,8 @@ module RuboCop
         def allowed_reference?(node)
           node.each_ancestor.any? do |ancestor|
             next true if example_method?(ancestor)
+            next true if in_example_arguments?(ancestor, node)
+
             if includes_method?(ancestor)
               next allowed_includes_arguments?(ancestor, node)
             end
@@ -111,6 +120,15 @@ module RuboCop
           end
         end
 
+        def in_example_arguments?(ancestor, node)
+          return false unless ancestor.send_type?
+          return false unless Examples.all(ancestor.method_name)
+
+          ancestor.arguments.any? do |arg|
+            arg.equal?(node) || arg.each_descendant.any?(node)
+          end
+        end
+
         def allowed_includes_arguments?(node, argument)
           node.arguments[1..].all? do |argument_node|
             next true if argument_node.type?(:dstr, :dsym)

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,89 @@
+# 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)
+          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/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/output.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # NOTE: Originally based on the `Rails/Output` cop.
+    module RSpec
+      # Checks for the use of output calls like puts and print in specs.
+      #
+      # @safety
+      #   This autocorrection is marked as unsafe because, in rare cases, print
+      #   statements can be used on purpose for integration testing and deleting
+      #   them will cause tests to fail.
+      #
+      # @example
+      #   # bad
+      #   puts 'A debug message'
+      #   pp 'A debug message'
+      #   print 'A debug message'
+      class Output < Base
+        extend AutoCorrector
+
+        MSG = 'Do not write to stdout in specs.'
+
+        KERNEL_METHODS = %i[
+          ap
+          p
+          pp
+          pretty_print
+          print
+          puts
+        ].to_set.freeze
+        private_constant :KERNEL_METHODS
+
+        IO_METHODS = %i[
+          binwrite
+          syswrite
+          write
+          write_nonblock
+        ].to_set.freeze
+        private_constant :IO_METHODS
+
+        RESTRICT_ON_SEND = (KERNEL_METHODS + IO_METHODS).to_a.freeze
+
+        # @!method output?(node)
+        def_node_matcher :output?, <<~PATTERN
+          (send nil? KERNEL_METHODS ...)
+        PATTERN
+
+        # @!method io_output?(node)
+        def_node_matcher :io_output?, <<~PATTERN
+          (send
+            {
+              (gvar #match_gvar?)
+              (const {nil? cbase} {:STDOUT :STDERR})
+            }
+            IO_METHODS
+            ...)
+        PATTERN
+
+        def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity
+          return if node.parent&.call_type? || node.block_node
+          return if !output?(node) && !io_output?(node)
+          return if node.arguments.any? { |arg| arg.type?(:hash, :block_pass) }
+
+          add_offense(node) do |corrector|
+            corrector.remove(node)
+          end
+        end
+
+        private
+
+        def match_gvar?(sym)
+          %i[$stdout $stderr].include?(sym)
+        end
+      end
+    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

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

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

@@ -8,6 +8,7 @@ module RuboCop
       # Unify `before` and `after` hooks when possible.
       # However, `around` hooks are allowed to be defined multiple times,
       # as unifying them would typically make the code harder to read.
+      # Hooks defined in class methods are also ignored.
       #
       # @example
       #   # bad
@@ -30,6 +31,14 @@ module RuboCop
       #     around { |example| before2; example.call; after2 }
       #   end
       #
+      #   # good
+      #   describe Foo do
+      #     before { setup1 }
+      #     def self.setup
+      #       before { setup2 }
+      #     end
+      #   end
+      #
       class ScatteredSetup < Base
         include FinalEndLocation
         include RangeHelp
@@ -38,7 +47,7 @@ module RuboCop
         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|
@@ -53,9 +62,10 @@ module RuboCop
 
         private
 
-        def repeated_hooks(node)
+        def repeated_hooks(node) # rubocop:disable Metrics/CyclomaticComplexity
           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

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

@@ -78,7 +78,7 @@ module RuboCop
           (block (send #rspec? #SharedGroups.examples ...) ...)
         PATTERN
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           context_with_only_examples(node) do
             add_offense(node.send_node, message: MSG_EXAMPLES) do |corrector|
               corrector.replace(node.send_node.loc.selector, 'shared_examples')

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

@@ -24,6 +24,8 @@ module RuboCop
       #   end
       #
       class SkipBlockInsideExample < Base
+        include InsideExample
+
         MSG = "Don't pass a block to `skip` inside examples."
 
         def on_block(node)
@@ -34,12 +36,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
-
-        private
-
-        def inside_example?(node)
-          node.each_ancestor(:block).any? { |ancestor| example?(ancestor) }
-        end
+        alias on_itblock on_block
       end
     end
   end

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

@@ -44,6 +44,7 @@ module RuboCop
         include FileHelp
 
         MSG = 'Spec path should end with `%<suffix>s`.'
+        PATH_NAME_BOUNDARY = '(?![[:alnum:]])'
 
         # @!method example_group_arguments(node)
         def_node_matcher :example_group_arguments, <<~PATTERN
@@ -119,7 +120,11 @@ module RuboCop
           # For the suffix shown in the offense message, modify the regular
           # expression pattern to resemble a glob pattern for clearer error
           # messages.
-          suffix = pattern.sub('.*', '*').sub('[^/]*', '*').sub('\.', '.')
+          suffix = pattern
+            .sub(PATH_NAME_BOUNDARY, '')
+            .sub('.*', '*')
+            .sub('[^/]*', '*')
+            .sub('\.', '.')
           add_offense(send_node, message: format(MSG, suffix: suffix))
         end
 
@@ -132,19 +137,21 @@ module RuboCop
         end
 
         def correct_path_pattern(class_name, arguments)
-          path = [expected_path(class_name)]
-          path << '.*' unless ignore?(arguments.first)
-          path << [name_pattern(arguments.first), '[^/]*_spec\.rb']
-          path.join
+          [
+            expected_path(class_name),
+            PATH_NAME_BOUNDARY,
+            method_name_pattern(arguments.first),
+            '[^/]*_spec\.rb'
+          ].join
         end
 
-        def name_pattern(method_name)
-          return if ignore?(method_name)
+        def method_name_pattern(method_name)
+          return if ignore_method_name?(method_name)
 
-          method_name.str_content.gsub(/\s/, '_').gsub(/\W/, '')
+          ".*#{method_name.str_content.gsub(/\s/, '_').gsub(/\W/, '')}"
         end
 
-        def ignore?(method_name)
+        def ignore_method_name?(method_name)
           !method_name&.str_type? || ignore_methods?
         end
 
@@ -175,7 +182,7 @@ module RuboCop
         end
 
         def filename_ends_with?(pattern)
-          expanded_file_path.match?("#{pattern}$")
+          expanded_file_path.match?(%r{(?:\A|/)#{pattern}$})
         end
       end
     end

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

@@ -20,6 +20,8 @@ module RuboCop
       #   subject(:test_subject) { foo }
       #
       class SubjectDeclaration < Base
+        extend AutoCorrector
+
         MSG_LET = 'Use subject explicitly rather than using let'
         MSG_REDUNDANT = 'Ambiguous declaration of subject'
 
@@ -32,7 +34,11 @@ module RuboCop
           offense = offensive_subject_declaration?(node)
           return unless offense
 
-          add_offense(node, message: message_for(offense))
+          add_offense(node, message: message_for(offense)) do |corrector|
+            corrector.replace(node.loc.selector,
+                              node.method_name.to_s.sub('let', 'subject'))
+            corrector.remove(first_argument_range(node))
+          end
         end
 
         private
@@ -40,6 +46,16 @@ module RuboCop
         def message_for(offense)
           Helpers.all(offense) ? MSG_LET : MSG_REDUNDANT
         end
+
+        def first_argument_range(node)
+          if node.arguments.one?
+            node.loc.begin.join(node.loc.end)
+          else
+            node.first_argument.source_range.with(
+              end_pos: node.arguments[1].source_range.begin_pos
+            )
+          end
+        end
       end
     end
   end

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

@@ -52,7 +52,7 @@ module RuboCop
           (block (send #rspec? {#ExampleGroups.all #Examples.all} $_) ...)
         PATTERN
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           example_groups_or_example?(node) do |arg|
             add_offense(arg) if offense?(arg)
           end

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

@@ -13,6 +13,8 @@ module RuboCop
       #   expect(something).to be(1)
       #
       class VoidExpect < Base
+        include InsideExample
+
         MSG = 'Do not use `expect()` without `.to` or `.not_to`. ' \
               'Chain the methods or remove it.'
         RESTRICT_ON_SEND = %i[expect].freeze
@@ -34,7 +36,7 @@ module RuboCop
           check_expect(node)
         end
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless expect_block?(node)
           return unless inside_example?(node)
 
@@ -55,10 +57,6 @@ module RuboCop
 
           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/yield.rb

@@ -27,7 +27,7 @@ module RuboCop
         # @!method block_call?(node)
         def_node_matcher :block_call?, '(send (lvar %) :call ...)'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless method_on_stub?(node.send_node)
 
           block_arg(node.arguments) do |block|

data/lib/rubocop/cop/rspec_cops.rb

@@ -21,6 +21,7 @@ require_relative 'rspec/describe_symbol'
 require_relative 'rspec/described_class'
 require_relative 'rspec/described_class_module_wrapping'
 require_relative 'rspec/dialect'
+require_relative 'rspec/discarded_matcher'
 require_relative 'rspec/duplicated_metadata'
 require_relative 'rspec/empty_example_group'
 require_relative 'rspec/empty_hook'
@@ -61,6 +62,7 @@ require_relative 'rspec/leaky_local_variable'
 require_relative 'rspec/let_before_examples'
 require_relative 'rspec/let_setup'
 require_relative 'rspec/match_array'
+require_relative 'rspec/match_with_simple_regex'
 require_relative 'rspec/message_chain'
 require_relative 'rspec/message_expectation'
 require_relative 'rspec/message_spies'
@@ -75,6 +77,7 @@ require_relative 'rspec/named_subject'
 require_relative 'rspec/nested_groups'
 require_relative 'rspec/no_expectation_example'
 require_relative 'rspec/not_to_not'
+require_relative 'rspec/output'
 require_relative 'rspec/overwriting_setup'
 require_relative 'rspec/pending'
 require_relative 'rspec/pending_without_reason'