Change to improved performance AST matching algorithm

Changelog.md

@@ -1,4 +1,10 @@
-# v0.11.14 2022-07-25
+# v0.11.14 2022-07-31
+
+* [#1348](https://github.com/mbj/mutant/pull/1348)
+
+  Change to improved AST matching performance. Mutant boot performance
+  is positively affected mostly on larger projects with larger AST node
+  count per file.
 
 * [#1347](https://github.com/mbj/mutant/pull/1347/files)
 

lib/mutant/ast.rb

@@ -1,41 +1,43 @@
 # frozen_string_literal: true
 
 module Mutant
-  # AST helpers
-  module AST
-
-    # Find last node satisfying predicate (as block)
-    #
-    # @return [Parser::AST::Node]
-    #   if satisfying node is found
-    #
-    # @yield [Parser::AST::Node]
-    #
-    # @yieldreturn [Boolean]
-    #   true in case node satisfies predicate
-    #
-    # @return [nil]
-    #   otherwise
-    def self.find_last_path(node, &predicate)
-      fail ArgumentError, 'block expected' unless block_given?
-      path = []
-      walk(node, [node]) do |candidate, stack|
-        if predicate.call(candidate)
-          path = stack.dup
-        end
+  class AST
+    include Adamantium, Anima.new(
+      :node,
+      :comment_associations
+    )
+
+    class View
+      include Adamantium, Anima.new(:node, :path)
+    end
+
+    def view(symbol)
+      type_map.fetch(symbol, EMPTY_HASH).map do |node, path|
+        View.new(node: node, path: path)
+      end
+    end
+
+  private
+
+    def type_map
+      type_map = {}
+
+      walk_path(node) do |node, path|
+        path_map = type_map[node.type] ||= {}.tap(&:compare_by_identity)
+        path_map[node] = path
       end
-      path
+
+      type_map
     end
+    memoize :type_map
 
-    def self.walk(node, stack, &block)
-      block.call(node, stack)
+    def walk_path(node, stack = [node.type], &block)
+      block.call(node, stack.dup)
       node.children.grep(::Parser::AST::Node) do |child|
-        stack.push(child)
-        walk(child, stack, &block)
+        stack.push(child.type)
+        walk_path(child, stack, &block)
         stack.pop
       end
     end
-    private_class_method :walk
-
   end # AST
 end # Mutant

lib/mutant/ast/find_metaclass_containing.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Given an AST, finds the sclass that directly(-ish) contains the provided
     # node.
     # This won't match arbitrarily complex structures - it only searches the
@@ -10,7 +10,7 @@ module AST
     # Descending into 'begin' nodes is supported because these are generated for
     # the one-line syntax class << self; def foo; end
     class FindMetaclassContaining
-      include NodePredicates, Concord.new(:root, :target), Procto
+      include NodePredicates, Concord.new(:ast, :target), Procto
 
       SCLASS_BODY_INDEX = 1
 
@@ -22,7 +22,7 @@ class FindMetaclassContaining
       #
       # @api private
       def call
-        Structure.for(root.type).each_node(root) do |current|
+        Structure.for(ast.node.type).each_node(ast.node) do |current|
           return current if n_sclass?(current) && metaclass_of?(current)
         end
 

lib/mutant/ast/meta.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Node meta information mixin
     module Meta
     end # Meta

lib/mutant/ast/meta/const.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Node meta information mixin
     module Meta
 

lib/mutant/ast/meta/optarg.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Node meta information mixin
     module Meta
 

lib/mutant/ast/meta/resbody.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Node meta information mixin
     module Meta
 

lib/mutant/ast/meta/send.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Node meta information mixin
     module Meta
 

lib/mutant/ast/meta/symbol.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Node meta information mixin
     module Meta
 

lib/mutant/ast/named_children.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
 
     # Helper methods to define named children
     module NamedChildren

lib/mutant/ast/node_predicates.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Module for node predicates
     module NodePredicates
 

lib/mutant/ast/nodes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Singleton nodes
     module Nodes
       extend Sexp

lib/mutant/ast/pattern.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     class Pattern
       include Adamantium
 

lib/mutant/ast/pattern/lexer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     class Pattern
       # rubocop:disable Metrics/ClassLength
       class Lexer

lib/mutant/ast/pattern/parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # rubocop:disable Metrics/ClassLength
     # rubocop:disable Metrics/MethodLength
     class Pattern

lib/mutant/ast/pattern/source.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     class Pattern
       class Source
         include Anima.new(:string)

lib/mutant/ast/pattern/token.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     class Pattern
       class Token
         include Anima.new(:type, :value, :location)

lib/mutant/ast/regexp.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Regexp source mapper
     module Regexp
       # Parse regex string into expression

lib/mutant/ast/regexp/transformer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       # Regexp bijective mapper
       #

lib/mutant/ast/regexp/transformer/direct.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       class Transformer
         # Transformer for nodes which map directly to other domain

lib/mutant/ast/regexp/transformer/named_group.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       class Transformer
         # Transformer for named groups

lib/mutant/ast/regexp/transformer/options_group.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       class Transformer
         # Transformer for option groups

lib/mutant/ast/regexp/transformer/quantifier.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       class Transformer
         # Transformer for regexp quantifiers

lib/mutant/ast/regexp/transformer/recursive.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       class Transformer
         # Transformer for nodes with children

lib/mutant/ast/regexp/transformer/root.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       class Transformer
         # Transformer for root nodes

lib/mutant/ast/regexp/transformer/text.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     module Regexp
       class Transformer
         # Regexp AST transformer for nodes that encode a text value

lib/mutant/ast/sexp.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Mixin for node sexp syntax
     module Sexp
 

lib/mutant/ast/structure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # AST Structure metadata
     # rubocop:disable Metrics/ModuleLength
     module Structure

lib/mutant/ast/types.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutant
-  module AST
+  class AST
     # Groups of node types
     module Types # rubocop:disable Metrics/ModuleLength
       ASSIGNABLE_VARIABLES = Set.new(%i[ivasgn lvasgn cvasgn gvasgn]).freeze

lib/mutant/matcher/method.rb

@@ -51,11 +51,9 @@ def call
         def skip?
           location = source_location
 
-          file = location&.first
-
-          if location.nil? || !file.end_with?('.rb')
+          if location.nil? || !location.first.end_with?('.rb')
             env.warn(SOURCE_LOCATION_WARNING_FORMAT % target_method)
-          elsif matched_node_path.any?(&method(:n_block?))
+          elsif matched_view&.path&.any?(&:block.public_method(:equal?))
             env.warn(CLOSURE_WARNING_FORMAT % target_method)
           end
         end
@@ -96,7 +94,7 @@ def sorbet_signature
         end
 
         def subject
-          node = matched_node_path.last || return
+          node = matched_view&.node || return
 
           self.class::SUBJECT_CLASS.new(
             config:     subject_config(node),
@@ -113,10 +111,13 @@ def subject_config(node)
           )
         end
 
-        def matched_node_path
-          AST.find_last_path(ast.node, &method(:match?))
+        def matched_view
+          ast
+            .view(self.class::MATCH_NODE_TYPE)
+            .select { |view| match?(view.node) }
+            .last
         end
-        memoize :matched_node_path
+        memoize :matched_view
 
         def visibility
           # This can be cleaned up once we are on >ruby-3.0

lib/mutant/matcher/method/instance.rb

@@ -30,8 +30,9 @@ def self.memoized_method?(scope, method_name)
 
         # Instance method specific evaluator
         class Evaluator < Evaluator
-          SUBJECT_CLASS = Subject::Method::Instance
-          NAME_INDEX    = 0
+          MATCH_NODE_TYPE = :def
+          NAME_INDEX      = 0
+          SUBJECT_CLASS   = Subject::Method::Instance
 
         private