Use AST arguments instead of runtime matchers

sl4vr · sl4vr · commit 6cc63e5f9b9f · 2020-08-04T11:44:31.000+03:00
diff --git a/lib/rubocop-rspec.rb b/lib/rubocop-rspec.rb
@@ -12,7 +12,6 @@
 require_relative 'rubocop/rspec/top_level_describe'
 require_relative 'rubocop/rspec/wording'
 require_relative 'rubocop/rspec/language'
-require_relative 'rubocop/rspec/language/runtime_macros'
 require_relative 'rubocop/rspec/language/node_pattern'
 require_relative 'rubocop/rspec/top_level_group'
 require_relative 'rubocop/rspec/concept'
diff --git a/lib/rubocop/cop/rspec/base.rb b/lib/rubocop/cop/rspec/base.rb
@@ -20,7 +20,6 @@ module RSpec
       class Base < ::RuboCop::Cop::Base
         include RuboCop::RSpec::Language
         include RuboCop::RSpec::Language::NodePattern
-        extend RuboCop::RSpec::Language::RuntimeMacros
 
         DEFAULT_CONFIGURATION =
           RuboCop::RSpec::CONFIG.fetch('AllCops').fetch('RSpec')
diff --git a/lib/rubocop/cop/rspec/described_class.rb b/lib/rubocop/cop/rspec/described_class.rb
@@ -65,10 +65,6 @@ class DescribedClass < Base
           (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
-        def_runtime_node_matcher :rspec_block? do
-          all_selectors.block_pattern
-        end
-
         def_node_matcher :scope_changing_syntax?, '{def class module}'
 
         def_node_matcher :described_constant, <<-PATTERN
@@ -132,7 +128,7 @@ def scope_change?(node)
         end
 
         def skippable_block?(node)
-          node.block_type? && !rspec_block?(node) && cop_config['SkipBlocks']
+          node.block_type? && !block_pattern?(node, rspec_all) && cop_config['SkipBlocks']
         end
 
         def offensive?(node)
diff --git a/lib/rubocop/cop/rspec/dialect.rb b/lib/rubocop/cop/rspec/dialect.rb
@@ -47,16 +47,14 @@ class Dialect < Base
 
         MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
 
-        def_runtime_node_matcher :rspec_method? do
-          all_selectors.send_pattern
-        end
-
         def on_send(node)
-          return unless rspec_method?(node)
-          return unless preferred_methods[node.method_name]
+          return unless send_pattern?(node, rspec_all)
+
+          method_name = node.method_name
+          return unless preferred_methods[method_name]
 
-          msg = format(MSG, prefer: preferred_method(node.method_name),
-                            current: node.method_name)
+          msg = format(MSG, prefer: preferred_method(method_name),
+                            current: method_name)
 
           add_offense(node, message: msg) do |corrector|
             current = node.loc.selector
diff --git a/lib/rubocop/cop/rspec/empty_hook.rb b/lib/rubocop/cop/rspec/empty_hook.rb
@@ -29,8 +29,8 @@ class EmptyHook < Base
         MSG = 'Empty hook detected.'
 
         def on_block(node)
-          return unless hook?(node)
-          return unless node.body.nil?
+          return unless block_pattern?(node, rspec_hooks)
+          return if node.body
 
           add_offense(node.send_node) do |corrector|
             range = range_with_surrounding_space(range: node.loc.expression)
diff --git a/lib/rubocop/cop/rspec/empty_line_after_hook.rb b/lib/rubocop/cop/rspec/empty_line_after_hook.rb
@@ -40,7 +40,7 @@ class EmptyLineAfterHook < Base
         MSG = 'Add an empty line after `%<hook>s`.'
 
         def on_block(node)
-          return unless hook?(node)
+          return unless block_pattern?(node, rspec_hooks)
 
           missing_separating_line_offense(node) do |method|
             format(MSG, hook: method)
diff --git a/lib/rubocop/cop/rspec/expect_in_hook.rb b/lib/rubocop/cop/rspec/expect_in_hook.rb
@@ -26,7 +26,7 @@ class ExpectInHook < Base
         def_node_search :expectation, Expectations::ALL.send_pattern
 
         def on_block(node)
-          return unless hook?(node)
+          return unless block_pattern?(node, rspec_hooks)
           return if node.body.nil?
 
           expectation(node.body) do |expect|
diff --git a/lib/rubocop/cop/rspec/expect_output.rb b/lib/rubocop/cop/rspec/expect_output.rb
@@ -42,7 +42,9 @@ def on_gvasgn(node)
         def inside_example_scope?(node)
           return false if node.nil? || example_group?(node)
           return true if example?(node)
-          return RuboCop::RSpec::Hook.new(node).example? if hook?(node)
+          if block_pattern?(node, rspec_hooks)
+            return RuboCop::RSpec::Hook.new(node).example?
+          end
 
           inside_example_scope?(node.parent)
         end
diff --git a/lib/rubocop/cop/rspec/hook_argument.rb b/lib/rubocop/cop/rspec/hook_argument.rb
@@ -64,17 +64,11 @@ class HookArgument < Base
         IMPLICIT_MSG = 'Omit the default `%<scope>p` argument for RSpec hooks.'
         EXPLICIT_MSG = 'Use `%<scope>p` for RSpec hooks.'
 
-        def_node_matcher :hook?, hook_selectors.node_pattern_union
+        def_node_matcher :scoped_block, <<-PATTERN
+          (block $(send _ %1 (sym ${:each :example})) ...)
+        PATTERN
 
-        def_runtime_node_matcher :scoped_hook do
-          <<-PATTERN
-            (block $(send _ #hook? (sym ${:each :example})) ...)
-          PATTERN
-        end
-
-        def_runtime_node_matcher :unscoped_hook do
-          "(block $(send _ #hook?) ...)"
-        end
+        def_node_matcher :unscoped_block, '(block $(send _ %1) ...)'
 
         def on_block(node)
           hook(node) do |method_send, scope_name|
@@ -116,7 +110,8 @@ def implicit_style?
         end
 
         def hook(node, &block)
-          scoped_hook(node, &block) || unscoped_hook(node, &block)
+          scoped_block(node, rspec_hooks, &block) ||
+            unscoped_block(node, rspec_hooks, &block)
         end
 
         def argument_range(send_node)
diff --git a/lib/rubocop/cop/rspec/hooks_before_examples.rb b/lib/rubocop/cop/rspec/hooks_before_examples.rb
@@ -53,7 +53,7 @@ def check_hooks(node)
 
           node.each_child_node do |child|
             next if child.sibling_index < first_example.sibling_index
-            next unless hook?(child)
+            next unless block_pattern?(child, rspec_hooks)
 
             msg = format(MSG, hook: child.method_name)
             add_offense(child, message: msg) do |corrector|
diff --git a/lib/rubocop/cop/rspec/leading_subject.rb b/lib/rubocop/cop/rspec/leading_subject.rb
@@ -69,7 +69,7 @@ def autocorrect(corrector, node, sibling)
 
         def offending?(node)
           let?(node) ||
-            hook?(node) ||
+            block_pattern?(node, rspec_hooks) ||
             example?(node) ||
             spec_group?(node) ||
             include?(node)
diff --git a/lib/rubocop/cop/rspec/named_subject.rb b/lib/rubocop/cop/rspec/named_subject.rb
@@ -45,23 +45,17 @@ class NamedSubject < Base
         MSG = 'Name your test subject if you need '\
               'to reference it explicitly.'
 
-        def_runtime_node_matcher :rspec_block? do
-          <<-PATTERN
-            {
-              #{Examples::ALL.block_pattern}
-              #{hook_selectors.block_pattern}
-            }
-          PATTERN
-        end
-
         def_node_matcher :shared_example?, <<-PATTERN
           #{SharedGroups::EXAMPLES.block_pattern}
         PATTERN
 
         def_node_search :subject_usage, '$(send nil? :subject)'
 
         def on_block(node)
-          return if !rspec_block?(node) || ignored_shared_example?(node)
+          if !block_pattern?(node, rspec_examles_and_hooks) ||
+              ignored_shared_example?(node)
+            return
+          end
 
           subject_usage(node) do |subject_node|
             add_offense(subject_node.loc.selector)
@@ -72,6 +66,18 @@ def ignored_shared_example?(node)
           cop_config['IgnoreSharedExamples'] &&
             node.each_ancestor(:block).any?(&method(:shared_example?))
         end
+
+        private
+
+        def rspec_examles_and_hooks
+          ->(keyword) { rspec_rspec_examle_and_hook_keywords.include?(keyword) }
+        end
+
+        def rspec_rspec_examle_and_hook_keywords
+          selectors = Examples::ALL + hook_selectors
+          @rspec_rspec_examle_and_hook_keywords ||=
+            Set.new(selectors.send(:selectors))
+        end
       end
     end
   end
diff --git a/lib/rubocop/cop/rspec/scattered_setup.rb b/lib/rubocop/cop/rspec/scattered_setup.rb
@@ -43,7 +43,7 @@ def on_block(node)
 
         def repeated_hooks(node)
           hooks = RuboCop::RSpec::ExampleGroup.new(node, self)
-            .hooks
+            .block_pattern(rspec_hooks)
             .select(&:knowable_scope?)
             .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
             .values
diff --git a/lib/rubocop/cop/rspec/shared_context.rb b/lib/rubocop/cop/rspec/shared_context.rb
@@ -61,14 +61,7 @@ class SharedContext < Base
 
         examples = (Examples::ALL + Includes::EXAMPLES)
         def_node_search :examples?, examples.send_pattern
-        def_runtime_node_search :context? do
-          (
-            hook_selectors    +
-            Helpers::ALL      +
-            Includes::CONTEXT +
-            Subject::ALL
-          ).send_pattern
-        end
+        def_node_search :send_pattern_search?, SEND_PATTERN
 
         def_node_matcher :shared_context, SharedGroups::CONTEXT.block_pattern
         def_node_matcher :shared_example, SharedGroups::EXAMPLES.block_pattern
@@ -90,11 +83,32 @@ def on_block(node)
         private
 
         def context_with_only_examples(node)
-          shared_context(node) { yield if examples?(node) && !context?(node) }
+          shared_context(node) do
+            if examples?(node) && !send_pattern_search?(node, context_nodes)
+              yield
+            end
+          end
         end
 
         def examples_with_only_context(node)
-          shared_example(node) { yield if context?(node) && !examples?(node) }
+          shared_example(node) do
+            if send_pattern_search?(node, context_nodes) && !examples?(node)
+              yield
+            end
+          end
+        end
+
+        def context_nodes
+          ->(keyword) { context_node_keywords.include?(keyword) }
+        end
+
+        def context_node_keywords
+          selectors =
+            hook_selectors    +
+            Helpers::ALL      +
+            Includes::CONTEXT +
+            Subject::ALL
+          @context_node_keywords ||= Set.new(selectors.send(:selectors))
         end
       end
     end
diff --git a/lib/rubocop/rspec/example_group.rb b/lib/rubocop/rspec/example_group.rb
@@ -37,8 +37,9 @@ def examples
         find_all_in_scope(node, :example?).map(&Example.public_method(:new))
       end
 
-      def hooks
-        find_all_in_scope(node, :hook?).map(&Hook.public_method(:new))
+      def block_pattern(*args)
+        find_all_in_scope(node, :block_pattern?, *args)
+          .map(&Hook.public_method(:new))
       end
 
       private
@@ -51,21 +52,23 @@ def hooks
       #
       # @param node [RuboCop::AST::Node] node to recursively search
       # @param predicate [Symbol] method to call with node as argument
+      # @param *args [Array<Object>] parameters which must be supplied
+      # to #match at matching time
       #
       # @return [Array<RuboCop::AST::Node>] discovered nodes
-      def find_all_in_scope(node, predicate)
+      def find_all_in_scope(node, predicate, *args)
         node.each_child_node.flat_map do |child|
-          find_all(child, predicate)
+          find_all(child, predicate, *args)
         end
       end
 
-      def find_all(node, predicate)
-        if predicate_receiver.public_send(predicate, node)
+      def find_all(node, predicate, *args)
+        if predicate_receiver.public_send(predicate, node, *args)
           [node]
         elsif scope_change?(node) || example?(node)
           []
         else
-          find_all_in_scope(node, predicate)
+          find_all_in_scope(node, predicate, *args)
         end
       end
     end
diff --git a/lib/rubocop/rspec/language.rb b/lib/rubocop/rspec/language.rb
@@ -4,6 +4,13 @@ module RuboCop
   module RSpec
     # RSpec public API methods that are commonly used in cops
     module Language
+      BLOCK_PATTERN = <<-PATTERN
+        (block (send {(const {nil? cbase} :RSpec) nil?} %1 ...) ...)
+      PATTERN
+      SEND_PATTERN = <<-PATTERN
+        (send {(const {nil? cbase} :RSpec) nil?} %1 ...)
+      PATTERN
+
       # Set of method selectors
       class SelectorSet
         def initialize(selectors)
diff --git a/lib/rubocop/rspec/language/node_pattern.rb b/lib/rubocop/rspec/language/node_pattern.rb
@@ -6,7 +6,6 @@ module Language
       # Common node matchers used for matching against the rspec DSL
       module NodePattern
         extend RuboCop::NodePattern::Macros
-        extend RuntimeMacros
 
         def_node_matcher :rspec?, '{(const {nil? cbase} :RSpec) nil?}'
 
@@ -29,8 +28,26 @@ module NodePattern
 
         def_node_matcher :subject?, Subject::ALL.block_pattern
 
-        def_runtime_node_matcher :hook? do
-          hook_selectors.block_pattern
+        def_node_matcher :block_pattern?, BLOCK_PATTERN
+
+        def_node_matcher :send_pattern?, SEND_PATTERN
+
+        def rspec_hooks
+          ->(keyword) { hooks_set.include?(keyword) }
+        end
+
+        def rspec_all
+          ->(keyword) { all_set.include?(keyword) }
+        end
+
+        protected
+
+        def hooks_set
+          @hooks_set ||= Set.new(hook_selectors.send(:selectors))
+        end
+
+        def all_set
+          @all_set ||= Set.new(all_selectors.send(:selectors))
         end
 
         def hook_selectors
@@ -48,8 +65,6 @@ def all_selectors
             Runners::ALL
         end
 
-        protected
-
         def selectors(*keys)
           SelectorSet.new(
             BuiltIn.language_elements_for(*keys) + rspec_language_config(*keys)
diff --git a/lib/rubocop/rspec/language/runtime_macros.rb b/lib/rubocop/rspec/language/runtime_macros.rb
