rubocop-rspec 1.44.1 → 2.2.0

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

@@ -29,14 +29,14 @@ module RuboCop
 
         MSG_RECEIVE = 'Prefer `receive` for setting message expectations.'
 
-        MSG_HAVE_RECEIVED = 'Prefer `have_received` for setting message '\
-                            'expectations. Setup `%<source>s` as a spy using '\
+        MSG_HAVE_RECEIVED = 'Prefer `have_received` for setting message ' \
+                            'expectations. Setup `%<source>s` as a spy using ' \
                             '`allow` or `instance_spy`.'
 
         SUPPORTED_STYLES = %w[have_received receive].freeze
 
         def_node_matcher :message_expectation, %(
-          (send (send nil? :expect $_) #{Runners::ALL.node_pattern_union} ...)
+          (send (send nil? :expect $_) #Runners.all ...)
         )
 
         def_node_search :receive_message, %(

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Help methods for working with nodes containing comments.
+      module CommentsHelp
+        include FinalEndLocation
+
+        def source_range_with_comment(node)
+          begin_pos = begin_pos_with_comment(node).begin_pos
+          end_pos = end_line_position(node).end_pos
+
+          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+        end
+
+        def begin_pos_with_comment(node)
+          first_comment = processed_source.ast_with_comments[node].first
+
+          start_line_position(first_comment || node)
+        end
+
+        def start_line_position(node)
+          buffer.line_range(node.loc.line)
+        end
+
+        def end_line_position(node)
+          end_line = buffer.line_for_position(final_end_location(node).end_pos)
+          buffer.line_range(end_line)
+        end
+
+        def buffer
+          processed_source.buffer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps determine the offending location if there is not an empty line
+      # following the node. Allows comments to follow directly after.
+      module EmptyLineSeparation
+        include FinalEndLocation
+        include RangeHelp
+
+        def missing_separating_line_offense(node)
+          return if last_child?(node)
+
+          missing_separating_line(node) do |location|
+            msg = yield(node.method_name)
+            add_offense(location, message: msg) do |corrector|
+              corrector.insert_after(location.end, "\n")
+            end
+          end
+        end
+
+        def missing_separating_line(node)
+          line = final_end_location(node).line
+
+          line += 1 while comment_line?(processed_source[line])
+
+          return if processed_source[line].blank?
+
+          yield offending_loc(line)
+        end
+
+        def offending_loc(last_line)
+          offending_line = processed_source[last_line - 1]
+
+          content_length = offending_line.lstrip.length
+          start          = offending_line.length - content_length
+
+          source_range(processed_source.buffer,
+                       last_line, start, content_length)
+        end
+
+        def last_child?(node)
+          return true unless node.parent&.begin_type?
+
+          node.equal?(node.parent.children.last)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps find the true end location of nodes which might contain heredocs.
+      module FinalEndLocation
+        def final_end_location(start_node)
+          heredoc_endings =
+            start_node.each_node(:str, :dstr, :xstr)
+              .select(&:heredoc?)
+              .map { |node| node.loc.heredoc_end }
+
+          [start_node.loc.end, *heredoc_endings].max_by(&:line)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helper methods for top level example group cops
+      module TopLevelGroup
+        extend RuboCop::NodePattern::Macros
+
+        def on_new_investigation
+          super
+
+          top_level_groups.each do |node|
+            on_top_level_example_group(node) if example_group?(node)
+            on_top_level_group(node)
+          end
+        end
+
+        def top_level_groups
+          @top_level_groups ||=
+            top_level_nodes(root_node).select { |n| spec_group?(n) }
+        end
+
+        private
+
+        # Dummy methods to be overridden in the consumer
+        def on_top_level_example_group(_node); end
+
+        def on_top_level_group(_node); end
+
+        def top_level_group?(node)
+          top_level_groups.include?(node)
+        end
+
+        def top_level_nodes(node)
+          return [] if node.nil?
+
+          case node.type
+          when :begin
+            node.children
+          when :module, :class
+            top_level_nodes(node.body)
+          else
+            [node]
+          end
+        end
+
+        def root_node
+          processed_source.ast
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps check offenses with variable definitions
+      module Variable
+        extend RuboCop::NodePattern::Macros
+
+        Subjects = RuboCop::RSpec::Language::Subjects
+        Helpers = RuboCop::RSpec::Language::Helpers
+
+        def_node_matcher :variable_definition?, <<~PATTERN
+          (send nil? {#Subjects.all #Helpers.all}
+            $({sym str dsym dstr} ...) ...)
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -23,10 +23,9 @@ module RuboCop
       #     end
       #   end
       class MultipleDescribes < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
-        MSG = 'Do not use multiple top-level example groups - '\
-              'try to nest them.'
+        MSG = 'Do not use multiple top-level example groups - try to nest them.'
 
         def on_top_level_group(node)
           top_level_example_groups =

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

@@ -60,7 +60,7 @@ module RuboCop
             } ...)
         PATTERN
 
-        def_node_matcher :expect?, Expectations::ALL.send_pattern
+        def_node_matcher :expect?, send_pattern('#Expectations.all')
         def_node_matcher :aggregate_failures_block?, <<-PATTERN
           (block (send nil? :aggregate_failures ...) ...)
         PATTERN

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

@@ -85,7 +85,7 @@ module RuboCop
       #
       class MultipleMemoizedHelpers < Base
         include ConfigurableMax
-        include RuboCop::RSpec::Variable
+        include Variable
 
         MSG = 'Example group has too many memoized helpers [%<count>d/%<max>d]'
 
@@ -101,6 +101,7 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           @example_group_memoized_helpers = {}
         end
 
@@ -128,6 +129,7 @@ module RuboCop
 
         def variable_nodes(node)
           example_group = RuboCop::RSpec::ExampleGroup.new(node)
+
           if allow_subject?
             example_group.lets
           else

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

@@ -42,24 +42,20 @@ module RuboCop
       #     it { is_expected.to be_valid }
       #   end
       class NamedSubject < Base
-        MSG = 'Name your test subject if you need '\
-              'to reference it explicitly.'
+        MSG = 'Name your test subject if you need to reference it explicitly.'
 
-        def_node_matcher :rspec_block?, <<-PATTERN
-          {
-            #{Examples::ALL.block_pattern}
-            #{Hooks::ALL.block_pattern}
-          }
-        PATTERN
+        def_node_matcher :example_or_hook_block?,
+                         block_pattern('{#Examples.all #Hooks.all}')
 
-        def_node_matcher :shared_example?, <<-PATTERN
-          #{SharedGroups::EXAMPLES.block_pattern}
-        PATTERN
+        def_node_matcher :shared_example?,
+                         block_pattern('#SharedGroups.examples')
 
         def_node_search :subject_usage, '$(send nil? :subject)'
 
         def on_block(node)
-          return if !rspec_block?(node) || ignored_shared_example?(node)
+          if !example_or_hook_block?(node) || ignored_shared_example?(node)
+            return
+          end
 
           subject_usage(node) do |subject_node|
             add_offense(subject_node.loc.selector)

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

@@ -87,7 +87,7 @@ module RuboCop
       #
       class NestedGroups < Base
         include ConfigurableMax
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
         MSG = 'Maximum example group nesting exceeded [%<total>d/%<max>d].'
 

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

@@ -20,6 +20,7 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         MSG = 'Prefer `%<replacement>s` over `%<original>s`.'
+        RESTRICT_ON_SEND = %i[not_to to_not].freeze
 
         def_node_matcher :not_to_not_offense, '(send _ % ...)'
 

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

@@ -24,7 +24,8 @@ module RuboCop
       class OverwritingSetup < Base
         MSG = '`%<name>s` is already defined.'
 
-        def_node_matcher :setup?, (Helpers::ALL + Subject::ALL).block_pattern
+        def_node_matcher :setup?, block_pattern('{#Helpers.all #Subjects.all}')
+
         def_node_matcher :first_argument_name, '(send _ _ ({str sym} $_))'
 
         def on_block(node)

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

@@ -34,10 +34,10 @@ module RuboCop
       class Pending < Base
         MSG = 'Pending spec found.'
 
-        PENDING = Examples::PENDING + Examples::SKIPPED + ExampleGroups::SKIPPED
-        SKIPPABLE = ExampleGroups::GROUPS + Examples::EXAMPLES
-
-        def_node_matcher :skippable?, SKIPPABLE.send_pattern
+        def_node_matcher :skippable?,
+                         send_pattern(<<~PATTERN)
+                           {#ExampleGroups.regular #Examples.regular}
+                         PATTERN
 
         def_node_matcher :skipped_in_metadata?, <<-PATTERN
           {
@@ -47,7 +47,15 @@ module RuboCop
         PATTERN
 
         def_node_matcher :skip_or_pending?, '{(sym :skip) (sym :pending)}'
-        def_node_matcher :pending_block?, PENDING.send_pattern
+
+        def_node_matcher :pending_block?,
+                         send_pattern(<<~PATTERN)
+                           {
+                             #ExampleGroups.skipped
+                             #Examples.skipped
+                             #Examples.pending
+                           }
+                         PATTERN
 
         def on_send(node)
           return unless pending_block?(node) || skipped?(node)

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

@@ -30,7 +30,7 @@ module RuboCop
             (send nil? :expect {
               (block $(send !nil? #predicate? ...) ...)
               $(send !nil? #predicate? ...)})
-            $#{Runners::ALL.node_pattern_union}
+            $#Runners.all
             $#boolean_matcher?)
         PATTERN
 
@@ -155,7 +155,7 @@ module RuboCop
         def_node_matcher :predicate_matcher?, <<-PATTERN
           (send
             (send nil? :expect $!nil?)
-            #{Runners::ALL.node_pattern_union}
+            #Runners.all
             {$(send nil? #predicate_matcher_name? ...)
               (block $(send nil? #predicate_matcher_name? ...) ...)})
         PATTERN
@@ -164,7 +164,7 @@ module RuboCop
           (block
             (send
               (send nil? :expect $!nil?)
-              #{Runners::ALL.node_pattern_union}
+              #Runners.all
               $(send nil? #predicate_matcher_name?))
             ...)
         PATTERN

data/lib/rubocop/cop/rspec/rails/http_status.rb

@@ -33,6 +33,7 @@ module RuboCop
         class HttpStatus < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
+          RESTRICT_ON_SEND = %i[have_http_status].freeze
 
           def_node_matcher :http_status, <<-PATTERN
             (send nil? :have_http_status ${int sym})

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

@@ -28,6 +28,8 @@ module RuboCop
 
         MSG = 'Use `%<alternative>s` instead of `%<original>s`.'
 
+        RESTRICT_ON_SEND = %i[times].freeze
+
         def_node_matcher :receive_counts, <<-PATTERN
           (send $(send _ {:exactly :at_least :at_most} (int {1 2})) :times)
         PATTERN

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

@@ -16,6 +16,7 @@ module RuboCop
       class ReceiveNever < Base
         extend AutoCorrector
         MSG = 'Use `not_to receive` instead of `never`.'
+        RESTRICT_ON_SEND = %i[never].freeze
 
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 

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

@@ -54,10 +54,11 @@ module RuboCop
           (begin <#include_examples? #include_examples? ...>)
         PATTERN
 
-        def_node_matcher :include_examples?, Includes::EXAMPLES.send_pattern
+        def_node_matcher :include_examples?,
+                         send_pattern('#Includes.examples')
 
         def_node_matcher :shared_examples_name, <<-PATTERN
-          (send _ #{Includes::EXAMPLES.node_pattern_union} $_ ...)
+          (send _ #Includes.examples $_ ...)
         PATTERN
 
         def on_begin(node)

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

@@ -39,6 +39,7 @@ module RuboCop
 
         MSG_AND_RETURN = 'Use `and_return` for static values.'
         MSG_BLOCK = 'Use block for static values.'
+        RESTRICT_ON_SEND = %i[and_return].freeze
 
         def_node_search :contains_stub?, '(send nil? :receive (...))'
         def_node_matcher :stub_with_block?, '(block #contains_stub? ...)'

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

@@ -23,7 +23,7 @@ module RuboCop
       #   end
       #
       class ScatteredSetup < Base
-        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same '\
+        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same ' \
               'example group (also defined on %<lines>s).'
 
         def on_block(node)