rubocop-rspec 2.18.1 → 2.19.0

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

@@ -57,27 +57,26 @@ module RuboCop
         MSG_CONTEXT  = "Use `shared_context` when you don't define examples."
 
         # @!method examples?(node)
-        def_node_search :examples?,
-                        send_pattern('{#Includes.examples #Examples.all}')
+        def_node_search :examples?, <<~PATTERN
+          (send nil? {#Includes.examples #Examples.all} ...)
+        PATTERN
 
         # @!method context?(node)
         def_node_search :context?, <<-PATTERN
-          (
-            send #rspec? {
-              #Subjects.all
-              #Helpers.all
-              #Includes.context
-              #Hooks.all
-            } ...
+          (send nil?
+            {#Subjects.all #Helpers.all #Includes.context #Hooks.all} ...
           )
         PATTERN
 
         # @!method shared_context(node)
-        def_node_matcher :shared_context,
-                         block_pattern('#SharedGroups.context')
+        def_node_matcher :shared_context, <<~PATTERN
+          (block (send #rspec? #SharedGroups.context ...) ...)
+        PATTERN
+
         # @!method shared_example(node)
-        def_node_matcher :shared_example,
-                         block_pattern('#SharedGroups.examples')
+        def_node_matcher :shared_example, <<~PATTERN
+          (block (send #rspec? #SharedGroups.examples ...) ...)
+        PATTERN
 
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           context_with_only_examples(node) do

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

@@ -24,10 +24,12 @@ module RuboCop
         extend AutoCorrector
 
         # @!method shared_examples(node)
-        def_node_matcher :shared_examples,
-                         send_pattern(
-                           '{#SharedGroups.all #Includes.all}'
-                         )
+        def_node_matcher :shared_examples, <<~PATTERN
+          {
+            (send #rspec? #SharedGroups.all ...)
+            (send nil? #Includes.all ...)
+          }
+        PATTERN
 
         def on_send(node)
           shared_examples(node) do

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for passing a block to `skip` within examples.
+      #
+      # @example
+      #   # bad
+      #   it 'does something' do
+      #     skip 'not yet implemented' do
+      #       do_something
+      #     end
+      #   end
+      #
+      #   # good
+      #   it 'does something' do
+      #     skip 'not yet implemented'
+      #     do_something
+      #   end
+      #
+      #   # good - when outside example
+      #   skip 'not yet implemented' do
+      #   end
+      #
+      class SkipBlockInsideExample < Base
+        MSG = "Don't pass a block to `skip` inside examples."
+
+        def on_block(node)
+          return unless node.method?(:skip)
+          return unless inside_example?(node)
+
+          add_offense(node)
+        end
+
+        alias on_numblock on_block
+
+        private
+
+        def inside_example?(node)
+          node.each_ancestor(:block).any? { |ancestor| example?(ancestor) }
+        end
+      end
+    end
+  end
+end

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

@@ -38,8 +38,8 @@ module RuboCop
           metadata = symbols + pairs
 
           range_between(
-            metadata.first.loc.expression.begin_pos,
-            metadata.last.loc.expression.end_pos
+            metadata.first.source_range.begin_pos,
+            metadata.last.source_range.end_pos
           )
         end
 

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

@@ -27,10 +27,13 @@ module RuboCop
         extend AutoCorrector
         include ConfigurableEnforcedStyle
         include Variable
+        include InsideExampleGroup
 
         MSG = 'Use %<style>s for variable names.'
 
         def on_send(node)
+          return unless inside_example_group?(node)
+
           variable_definition?(node) do |variable|
             next unless style_violation?(variable)
 

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

@@ -42,15 +42,18 @@ module RuboCop
         include ConfigurableNaming
         include AllowedPattern
         include Variable
+        include InsideExampleGroup
 
         MSG = 'Use %<style>s for variable names.'
 
         def on_send(node)
+          return unless inside_example_group?(node)
+
           variable_definition?(node) do |variable|
             return if variable.dstr_type? || variable.dsym_type?
             return if matches_allowed_pattern?(variable.value)
 
-            check_name(node, variable.value, variable.loc.expression)
+            check_name(node, variable.value, variable.source_range)
           end
         end
 

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

@@ -76,10 +76,10 @@ module RuboCop
             break correct_style_detected unless opposing_style?(class_reference)
 
             message = format(MSG, style: style)
-            expression = class_reference.loc.expression
+            expression = class_reference.source_range
 
             add_offense(expression, message: message) do |corrector|
-              violation = class_reference.children.last.to_s
+              violation = class_reference.source
               corrector.replace(expression, correct_style(violation))
 
               opposite_style_detected
@@ -102,7 +102,7 @@ module RuboCop
           if style == :string
             "'#{violation}'"
           else
-            violation
+            violation.gsub(/^['"]|['"]$/, '')
           end
         end
       end

data/lib/rubocop/cop/rspec_cops.rb

@@ -25,6 +25,7 @@ rescue LoadError
 end
 require_relative 'rspec/rails/inferred_spec_type'
 require_relative 'rspec/rails/minitest_assertions'
+require_relative 'rspec/rails/travel_around'
 
 require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'
@@ -37,6 +38,7 @@ require_relative 'rspec/be_nil'
 require_relative 'rspec/before_after_all'
 require_relative 'rspec/change_by_zero'
 require_relative 'rspec/class_check'
+require_relative 'rspec/contain_exactly'
 require_relative 'rspec/context_method'
 require_relative 'rspec/context_wording'
 require_relative 'rspec/describe_class'
@@ -77,6 +79,7 @@ require_relative 'rspec/leading_subject'
 require_relative 'rspec/leaky_constant_declaration'
 require_relative 'rspec/let_before_examples'
 require_relative 'rspec/let_setup'
+require_relative 'rspec/match_array'
 require_relative 'rspec/message_chain'
 require_relative 'rspec/message_expectation'
 require_relative 'rspec/message_spies'
@@ -95,6 +98,7 @@ require_relative 'rspec/pending_without_reason'
 require_relative 'rspec/predicate_matcher'
 require_relative 'rspec/receive_counts'
 require_relative 'rspec/receive_never'
+require_relative 'rspec/redundant_around'
 require_relative 'rspec/repeated_description'
 require_relative 'rspec/repeated_example'
 require_relative 'rspec/repeated_example_group_body'
@@ -106,6 +110,7 @@ require_relative 'rspec/scattered_setup'
 require_relative 'rspec/shared_context'
 require_relative 'rspec/shared_examples'
 require_relative 'rspec/single_argument_message_chain'
+require_relative 'rspec/skip_block_inside_example'
 require_relative 'rspec/sort_metadata'
 require_relative 'rspec/stubbed_mock'
 require_relative 'rspec/subject_declaration'

data/lib/rubocop/rspec/example_group.rb

@@ -10,14 +10,12 @@ module RuboCop
       #
       #   Selectors which indicate that we should stop searching
       #
-      def_node_matcher :scope_change?,
-                       block_pattern(<<~PATTERN)
-                         {
-                           #SharedGroups.all
-                           #ExampleGroups.all
-                           #Includes.all
-                         }
-                       PATTERN
+      def_node_matcher :scope_change?, <<~PATTERN
+        (block {
+          (send #rspec? {#SharedGroups.all #ExampleGroups.all} ...)
+          (send nil? #Includes.all ...)
+        } ...)
+      PATTERN
 
       def lets
         find_all_in_scope(node, :let?)

data/lib/rubocop/rspec/language/node_pattern.rb

@@ -4,18 +4,44 @@ module RuboCop
   module RSpec
     module Language
       # Helper methods to detect RSpec DSL used with send and block
+      # @deprecated Prefer using Node Pattern directly
+      #   Use `'(block (send nil? #Example.all ...) ...)'` instead of
+      #   `block_pattern('#Example.all')`
       module NodePattern
+        # @deprecated Prefer using Node Pattern directly
         def send_pattern(string)
+          deprecation_warning __method__
           "(send #rspec? #{string} ...)"
         end
 
+        # @deprecated Prefer using Node Pattern directly
         def block_pattern(string)
+          deprecation_warning __method__
           "(block #{send_pattern(string)} ...)"
         end
 
+        # @deprecated Prefer using Node Pattern directly
         def numblock_pattern(string)
+          deprecation_warning __method__
           "(numblock #{send_pattern(string)} ...)"
         end
+
+        # @deprecated Prefer using Node Pattern directly
+        def block_or_numblock_pattern(string)
+          deprecation_warning __method__
+          "{#{block_pattern(string)} #{numblock_pattern(string)}}"
+        end
+
+        private
+
+        def deprecation_warning(method)
+          # Only warn in derived extensions' specs
+          return unless defined?(::RSpec)
+
+          Kernel.warn <<~MESSAGE, uplevel: 2
+            Usage of #{method} is deprecated. Use node pattern explicitly.
+          MESSAGE
+        end
       end
     end
   end

data/lib/rubocop/rspec/language.rb

@@ -20,52 +20,61 @@ module RuboCop
       end
 
       # @!method rspec?(node)
-      def_node_matcher :rspec?, '{(const {nil? cbase} :RSpec) nil?}'
+      def_node_matcher :rspec?, '{#explicit_rspec? nil?}'
+
+      # @!method explicit_rspec?(node)
+      def_node_matcher :explicit_rspec?, '(const {nil? cbase} :RSpec)'
 
       # @!method example_group?(node)
-      def_node_matcher :example_group?, block_pattern('#ExampleGroups.all')
+      def_node_matcher :example_group?, <<~PATTERN
+        ({block numblock} (send #rspec? #ExampleGroups.all ...) ...)
+      PATTERN
 
       # @!method shared_group?(node)
-      def_node_matcher :shared_group?, block_pattern('#SharedGroups.all')
+      def_node_matcher :shared_group?,
+                       '(block (send #rspec? #SharedGroups.all ...) ...)'
 
       # @!method spec_group?(node)
-      def_node_matcher :spec_group?,
-                       block_pattern('{#SharedGroups.all #ExampleGroups.all}')
+      def_node_matcher :spec_group?, <<~PATTERN
+        ({block numblock} (send #rspec?
+             {#SharedGroups.all #ExampleGroups.all}
+          ...) ...)
+      PATTERN
 
       # @!method example_group_with_body?(node)
       def_node_matcher :example_group_with_body?, <<-PATTERN
-        (block #{send_pattern('#ExampleGroups.all')} args !nil?)
+        (block (send #rspec? #ExampleGroups.all ...) args !nil?)
       PATTERN
 
       # @!method example?(node)
-      def_node_matcher :example?, block_pattern('#Examples.all')
+      def_node_matcher :example?, '(block (send nil? #Examples.all ...) ...)'
 
       # @!method hook?(node)
       def_node_matcher :hook?, <<-PATTERN
-        {
-          #{block_pattern('#Hooks.all')}
-          #{numblock_pattern('#Hooks.all')}
-        }
+      {
+        (numblock (send nil? #Hooks.all ...) ...)
+        (block (send nil? #Hooks.all ...) ...)
+      }
       PATTERN
 
       # @!method let?(node)
       def_node_matcher :let?, <<-PATTERN
         {
-          #{block_pattern('#Helpers.all')}
-          (send #rspec? #Helpers.all _ block_pass)
+          (block (send nil? #Helpers.all ...) ...)
+          (send nil? #Helpers.all _ block_pass)
         }
       PATTERN
 
       # @!method include?(node)
       def_node_matcher :include?, <<-PATTERN
         {
-          #{send_pattern('#Includes.all')}
-          #{block_pattern('#Includes.all')}
+          (block (send nil? #Includes.all ...) ...)
+          (send nil? #Includes.all ...)
         }
       PATTERN
 
       # @!method subject?(node)
-      def_node_matcher :subject?, block_pattern('#Subjects.all')
+      def_node_matcher :subject?, '(block (send nil? #Subjects.all ...) ...)'
 
       module ExampleGroups # :nodoc:
         class << self

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.18.1'
+      STRING = '2.19.0'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -20,6 +20,7 @@ require_relative 'rubocop/rspec/factory_bot/language'
 
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
+require_relative 'rubocop/cop/rspec/mixin/location_help'
 require_relative 'rubocop/cop/rspec/mixin/metadata'
 require_relative 'rubocop/cop/rspec/mixin/namespace'
 require_relative 'rubocop/cop/rspec/mixin/skip_or_pending'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.18.1
+  version: 2.19.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,6 +80,7 @@ files:
 - lib/rubocop/cop/rspec/capybara/visibility_matcher.rb
 - lib/rubocop/cop/rspec/change_by_zero.rb
 - lib/rubocop/cop/rspec/class_check.rb
+- lib/rubocop/cop/rspec/contain_exactly.rb
 - lib/rubocop/cop/rspec/context_method.rb
 - lib/rubocop/cop/rspec/context_wording.rb
 - lib/rubocop/cop/rspec/describe_class.rb
@@ -126,6 +127,7 @@ files:
 - lib/rubocop/cop/rspec/leaky_constant_declaration.rb
 - lib/rubocop/cop/rspec/let_before_examples.rb
 - lib/rubocop/cop/rspec/let_setup.rb
+- lib/rubocop/cop/rspec/match_array.rb
 - lib/rubocop/cop/rspec/message_chain.rb
 - lib/rubocop/cop/rspec/message_expectation.rb
 - lib/rubocop/cop/rspec/message_spies.rb
@@ -134,6 +136,7 @@ files:
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
 - lib/rubocop/cop/rspec/mixin/inside_example_group.rb
+- lib/rubocop/cop/rspec/mixin/location_help.rb
 - lib/rubocop/cop/rspec/mixin/metadata.rb
 - lib/rubocop/cop/rspec/mixin/namespace.rb
 - lib/rubocop/cop/rspec/mixin/skip_or_pending.rb
@@ -156,8 +159,10 @@ files:
 - lib/rubocop/cop/rspec/rails/http_status.rb
 - lib/rubocop/cop/rspec/rails/inferred_spec_type.rb
 - lib/rubocop/cop/rspec/rails/minitest_assertions.rb
+- lib/rubocop/cop/rspec/rails/travel_around.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_never.rb
+- lib/rubocop/cop/rspec/redundant_around.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
 - lib/rubocop/cop/rspec/repeated_example.rb
 - lib/rubocop/cop/rspec/repeated_example_group_body.rb
@@ -169,6 +174,7 @@ files:
 - lib/rubocop/cop/rspec/shared_context.rb
 - lib/rubocop/cop/rspec/shared_examples.rb
 - lib/rubocop/cop/rspec/single_argument_message_chain.rb
+- lib/rubocop/cop/rspec/skip_block_inside_example.rb
 - lib/rubocop/cop/rspec/sort_metadata.rb
 - lib/rubocop/cop/rspec/stubbed_mock.rb
 - lib/rubocop/cop/rspec/subject_declaration.rb
@@ -221,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files