tree_stand 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c800b4009161889917105434b7f93ec8f75e678edf643cc4705e9a4e98da8aef
-  data.tar.gz: 6313e2c9035433aae6023ffa1d49fff987ae4d13addcfe097684e4a73c2ceab5
+  metadata.gz: 0dec13e65fde2c739a206944e34805122f065982b6a87bf5720baca17f0fb8a5
+  data.tar.gz: b00f3d2b463196d0336ec45ca38294d5f41bab931f546ce5224e1f695268448b
 SHA512:
-  metadata.gz: d4c2690b25d485b36e0e1d9718295dd7d5e941fa40cb127fc908ab8b11b2fd5bab94d0d396f0d0db6955dd9299c7750364d747246fcd514466a2b3570bff4632
-  data.tar.gz: acc8c9ef231e3c4a05f64c33c26871a9ca7cbb41b54319ab43db2f99dd9bc3fc3c263c038315df751cbf7595528fd814340ad6e26f149eee3354586c77bd072a
+  metadata.gz: e00d9f5b809a264bb19672dc0a0b28b58ea37944004fd2c63ca76042eed15f1c1b9f0d539f627d0565a16492522a51cd69e30574cc540c60d66c66fc1484bb3b
+  data.tar.gz: b28e29fd57802ef79b0a9e88ff2fdaa9f0e79e33ef49173c56f109cdaf2737438f6bb2c23aa5a75fc6af2b4b2c96831a973e921bbcbcfd2f11c2735b525b4085

data/lib/tree_stand/capture.rb

@@ -1,6 +1,7 @@
 module TreeStand
   # Wrapper around a TreeSitter capture.
   # @see TreeStand::Tree#query
+  # @see TreeStand::Node#query
   # @see TreeStand::Match
   class Capture
     # @return [TreeStand::Match]

data/lib/tree_stand/match.rb

@@ -1,6 +1,7 @@
 module TreeStand
   # Wrapper around a TreeSitter match.
   # @see TreeStand::Tree#query
+  # @see TreeStand::Node#query
   # @see TreeStand::Capture
   class Match
     # @return [TreeStand::Tree]
@@ -9,6 +10,8 @@ module TreeStand
     attr_reader :ts_query
     # @return [TreeSitter::Match]
     attr_reader :ts_match
+    # @return [Array<TreeStand::Capture>]
+    attr_reader :captures
 
     # @api private
     def initialize(tree, ts_query, ts_match)
@@ -16,9 +19,14 @@ module TreeStand
       @ts_query = ts_query
       @ts_match = ts_match
 
-      # TODO: This is a hack to get the captures to be populated.
+      # It's important to load all of the captures when a Match is
+      # instantiated, otherwise the ts_match will be invalid after
+      # TreeSitter::Cursor#next_match is called.
+      #
       # See: https://github.com/Faveod/ruby-tree-sitter/pull/16
-      captures
+      @captures = @ts_match.captures.map do |capture|
+        TreeStand::Capture.new(self, capture)
+      end
     end
 
     # Looks up a capture by name. TreeSitter strips the `@` from the capture name.
@@ -34,13 +42,6 @@ module TreeStand
       captures.find { |capture| capture.name == capture_name }
     end
 
-    # @return [Array<TreeStand::Capture>]
-    def captures
-      @captures ||= @ts_match.captures.map do |capture|
-        TreeStand::Capture.new(self, capture)
-      end
-    end
-
     # @param other [Object]
     # @return [bool]
     def ==(other)

data/lib/tree_stand/node.rb

@@ -21,6 +21,38 @@ module TreeStand
       @fields = @ts_node.each_field.to_a.map(&:first)
     end
 
+    # TreeSitter uses a `TreeSitter::Cursor` to iterate over matches by calling
+    # `curser#next_match` repeatedly until it returns `nil`.
+    #
+    # This method does all of that for you and collects all of the
+    # {TreeStand::Match matches} into an array.
+    #
+    # @example
+    #   # This will return a match for each identifier nodes in the tree.
+    #   tree_matches = tree.query(<<~QUERY)
+    #     (identifier) @identifier
+    #   QUERY
+    #
+    #   # It is equivalent to:
+    #   tree.root_node.query(<<~QUERY)
+    #     (identifier) @identifier
+    #   QUERY
+    #
+    # @see TreeStand::Match
+    # @see TreeStand::Capture
+    #
+    # @param query_string [String]
+    # @return [Array<TreeStand::Match>]
+    def query(query_string)
+      ts_query = TreeSitter::Query.new(@tree.parser.ts_language, query_string)
+      ts_cursor = TreeSitter::QueryCursor.exec(ts_query, ts_node)
+      matches = []
+      while match = ts_cursor.next_match
+        matches << TreeStand::Match.new(@tree, ts_query, match)
+      end
+      matches
+    end
+
     # @return [TreeStand::Range]
     def range
       TreeStand::Range.new(

data/lib/tree_stand/tree.rb

@@ -26,6 +26,8 @@ module TreeStand
     attr_reader :document
     # @return [TreeSitter::Tree]
     attr_reader :ts_tree
+    # @return [TreeStand::Parser]
+    attr_reader :parser
 
     # @api private
     def initialize(parser, tree, document)
@@ -39,24 +41,12 @@ module TreeStand
       TreeStand::Node.new(self, @ts_tree.root_node)
     end
 
-    # TreeSitter uses a `TreeSitter::Cursor` to iterate over matches by calling
-    # `curser#next_match` repeatedly until it returns `nil`.
-    #
-    # This method does all of that for you and collects them into an array.
-    #
-    # @see TreeStand::Match
-    # @see TreeStand::Capture
-    #
-    # @param query_string [String]
-    # @return [Array<TreeStand::Match>]
+    # (see TreeStand::Node#query)
+    # @note This is a convenience method that calls {TreeStand::Node#query} on
+    #   {#root_node}.
+    # @see TreeStand::Node#query
     def query(query_string)
-      ts_query = TreeSitter::Query.new(@parser.ts_language, query_string)
-      ts_cursor = TreeSitter::QueryCursor.exec(ts_query, @ts_tree.root_node)
-      matches = []
-      while match = ts_cursor.next_match
-        matches << TreeStand::Match.new(self, ts_query, match)
-      end
-      matches
+      root_node.query(query_string)
     end
 
     # This method replaces the section of the document specified by range and

data/lib/tree_stand/version.rb

@@ -1,4 +1,4 @@
 module TreeStand
   # The current version of the gem.
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tree_stand
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - derekstride