rubocop-rspec 2.0.0.pre → 2.3.0

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,21 @@
+# 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
+
+        # @!method variable_definition?(node)
+        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

@@ -53,6 +53,7 @@ module RuboCop
         ANYTHING = ->(_node) { true }
         TRUE = ->(node) { node.true_type? }
 
+        # @!method aggregate_failures?(node)
         def_node_matcher :aggregate_failures?, <<-PATTERN
           (block {
               (send _ _ <(sym :aggregate_failures) ...>)
@@ -60,7 +61,9 @@ module RuboCop
             } ...)
         PATTERN
 
-        def_node_matcher :expect?, Expectations::ALL.send_pattern
+        # @!method expect?(node)
+        def_node_matcher :expect?, send_pattern('#Expectations.all')
+        # @!method aggregate_failures_block?(node)
         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,23 @@ 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
+        # @!method example_or_hook_block?(node)
+        def_node_matcher :example_or_hook_block?,
+                         block_pattern('{#Examples.all #Hooks.all}')
 
-        def_node_matcher :shared_example?, <<-PATTERN
-          #{SharedGroups::EXAMPLES.block_pattern}
-        PATTERN
+        # @!method shared_example?(node)
+        def_node_matcher :shared_example?,
+                         block_pattern('#SharedGroups.examples')
 
+        # @!method subject_usage(node)
         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,7 +20,9 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         MSG = 'Prefer `%<replacement>s` over `%<original>s`.'
+        RESTRICT_ON_SEND = %i[not_to to_not].freeze
 
+        # @!method not_to_not_offense(node)
         def_node_matcher :not_to_not_offense, '(send _ % ...)'
 
         def on_send(node)

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

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

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

@@ -34,11 +34,13 @@ 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
+        # @!method skippable?(node)
+        def_node_matcher :skippable?,
+                         send_pattern(<<~PATTERN)
+                           {#ExampleGroups.regular #Examples.regular}
+                         PATTERN
 
+        # @!method skipped_in_metadata?(node)
         def_node_matcher :skipped_in_metadata?, <<-PATTERN
           {
             (send _ _ <#skip_or_pending? ...>)
@@ -46,8 +48,18 @@ module RuboCop
           }
         PATTERN
 
+        # @!method skip_or_pending?(node)
         def_node_matcher :skip_or_pending?, '{(sym :skip) (sym :pending)}'
-        def_node_matcher :pending_block?, PENDING.send_pattern
+
+        # @!method pending_block?(node)
+        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

@@ -25,19 +25,22 @@ module RuboCop
           end
         end
 
+        # @!method predicate_in_actual?(node)
         def_node_matcher :predicate_in_actual?, <<-PATTERN
           (send
             (send nil? :expect {
               (block $(send !nil? #predicate? ...) ...)
               $(send !nil? #predicate? ...)})
-            $#{Runners::ALL.node_pattern_union}
+            $#Runners.all
             $#boolean_matcher?)
         PATTERN
 
+        # @!method be_bool?(node)
         def_node_matcher :be_bool?, <<-PATTERN
           (send nil? {:be :eq :eql :equal} {true false})
         PATTERN
 
+        # @!method be_boolthy?(node)
         def_node_matcher :be_boolthy?, <<-PATTERN
           (send nil? {:be_truthy :be_falsey :be_falsy :a_truthy_value :a_falsey_value :a_falsy_value})
         PATTERN
@@ -152,19 +155,21 @@ module RuboCop
           end
         end
 
+        # @!method predicate_matcher?(node)
         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
 
+        # @!method predicate_matcher_block?(node)
         def_node_matcher :predicate_matcher_block?, <<-PATTERN
           (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,7 +33,9 @@ module RuboCop
         class HttpStatus < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
+          RESTRICT_ON_SEND = %i[have_http_status].freeze
 
+          # @!method http_status(node)
           def_node_matcher :http_status, <<-PATTERN
             (send nil? :have_http_status ${int sym})
           PATTERN

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

@@ -28,10 +28,14 @@ module RuboCop
 
         MSG = 'Use `%<alternative>s` instead of `%<original>s`.'
 
+        RESTRICT_ON_SEND = %i[times].freeze
+
+        # @!method receive_counts(node)
         def_node_matcher :receive_counts, <<-PATTERN
           (send $(send _ {:exactly :at_least :at_most} (int {1 2})) :times)
         PATTERN
 
+        # @!method stub?(node)
         def_node_search :stub?, '(send nil? :receive ...)'
 
         def on_send(node)

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

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

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

@@ -46,16 +46,23 @@ module RuboCop
       class RepeatedExampleGroupBody < Base
         MSG = 'Repeated %<group>s block body on line(s) %<loc>s'
 
+        # @!method several_example_groups?(node)
         def_node_matcher :several_example_groups?, <<-PATTERN
           (begin <#example_group_with_body? #example_group_with_body? ...>)
         PATTERN
 
+        # @!method metadata(node)
         def_node_matcher :metadata, '(block (send _ _ _ $...) ...)'
+
+        # @!method body(node)
         def_node_matcher :body, '(block _ args $...)'
+
+        # @!method const_arg(node)
         def_node_matcher :const_arg, '(block (send _ _ $const ...) ...)'
 
+        # @!method skip_or_pending?(node)
         def_node_matcher :skip_or_pending?, <<-PATTERN
-          (block <(send nil? {:skip :pending}) ...>)
+          (block <(send nil? {:skip :pending} ...) ...>)
         PATTERN
 
         def on_begin(node)

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

@@ -46,18 +46,22 @@ module RuboCop
       class RepeatedExampleGroupDescription < Base
         MSG = 'Repeated %<group>s block description on line(s) %<loc>s'
 
+        # @!method several_example_groups?(node)
         def_node_matcher :several_example_groups?, <<-PATTERN
           (begin <#example_group? #example_group? ...>)
         PATTERN
 
+        # @!method doc_string_and_metadata(node)
         def_node_matcher :doc_string_and_metadata, <<-PATTERN
           (block (send _ _ $_ $...) ...)
         PATTERN
 
+        # @!method skip_or_pending?(node)
         def_node_matcher :skip_or_pending?, <<-PATTERN
           (block <(send nil? {:skip :pending}) ...>)
         PATTERN
 
+        # @!method empty_description?(node)
         def_node_matcher :empty_description?, '(block (send _ _) ...)'
 
         def on_begin(node)

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

@@ -50,14 +50,18 @@ module RuboCop
         MSG = 'Repeated include of shared_examples %<name>s ' \
           'on line(s) %<repeat>s'
 
+        # @!method several_include_examples?(node)
         def_node_matcher :several_include_examples?, <<-PATTERN
           (begin <#include_examples? #include_examples? ...>)
         PATTERN
 
-        def_node_matcher :include_examples?, Includes::EXAMPLES.send_pattern
+        # @!method include_examples?(node)
+        def_node_matcher :include_examples?,
+                         send_pattern('#Includes.examples')
 
+        # @!method shared_examples_name(node)
         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,9 +39,15 @@ 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
 
+        # @!method contains_stub?(node)
         def_node_search :contains_stub?, '(send nil? :receive (...))'
+
+        # @!method stub_with_block?(node)
         def_node_matcher :stub_with_block?, '(block #contains_stub? ...)'
+
+        # @!method and_return_value(node)
         def_node_search :and_return_value, <<-PATTERN
           $(send _ :and_return $(...))
         PATTERN

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)

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

@@ -53,20 +53,31 @@ module RuboCop
       class SharedContext < Base
         extend AutoCorrector
 
-        MSG_EXAMPLES = "Use `shared_examples` when you don't "\
-                       'define context.'
+        MSG_EXAMPLES = "Use `shared_examples` when you don't define context."
+        MSG_CONTEXT  = "Use `shared_context` when you don't define examples."
 
-        MSG_CONTEXT  = "Use `shared_context` when you don't "\
-                       'define examples.'
+        # @!method examples?(node)
+        def_node_search :examples?,
+                        send_pattern('{#Includes.examples #Examples.all}')
 
-        examples = (Examples::ALL + Includes::EXAMPLES)
-        def_node_search :examples?, examples.send_pattern
+        # @!method context?(node)
+        def_node_search :context?, <<-PATTERN
+          (
+            send #rspec? {
+              #Subjects.all
+              #Helpers.all
+              #Includes.context
+              #Hooks.all
+            } ...
+          )
+        PATTERN
 
-        context = (Hooks::ALL + Helpers::ALL + Includes::CONTEXT + Subject::ALL)
-        def_node_search :context?, context.send_pattern
-
-        def_node_matcher :shared_context, SharedGroups::CONTEXT.block_pattern
-        def_node_matcher :shared_example, SharedGroups::EXAMPLES.block_pattern
+        # @!method shared_context(node)
+        def_node_matcher :shared_context,
+                         block_pattern('#SharedGroups.context')
+        # @!method shared_example(node)
+        def_node_matcher :shared_example,
+                         block_pattern('#SharedGroups.examples')
 
         def on_block(node)
           context_with_only_examples(node) do