tree_stand 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f39e746530204d0ac0304b61c77bc13e955c70691dfcadd3cc9c90a83f6240
-  data.tar.gz: e4266bbbaa896b7562a3c94c9366456aa4422339cea3481671c7c3ce4a655cc2
+  metadata.gz: 0dec13e65fde2c739a206944e34805122f065982b6a87bf5720baca17f0fb8a5
+  data.tar.gz: b00f3d2b463196d0336ec45ca38294d5f41bab931f546ce5224e1f695268448b
 SHA512:
-  metadata.gz: c9513cd144b7899a19938d742ad73efea3cd6ade65e0850d6c81f5a0c505929c31f56c1143ac18dd442cc208ef5ff91b1da2091258513cb22e8af3b476e1af1a
-  data.tar.gz: 1034636108f5e4b265b77c82202c5a9c17b9104d840599f3a1bee16bdfdd10c135f19ac82f43702d2bf421e3c629050debf9ae16c85753eb774458d6ed0a0536
+  metadata.gz: e00d9f5b809a264bb19672dc0a0b28b58ea37944004fd2c63ca76042eed15f1c1b9f0d539f627d0565a16492522a51cd69e30574cc540c60d66c66fc1484bb3b
+  data.tar.gz: b28e29fd57802ef79b0a9e88ff2fdaa9f0e79e33ef49173c56f109cdaf2737438f6bb2c23aa5a75fc6af2b4b2c96831a973e921bbcbcfd2f11c2735b525b4085

data/Gemfile

@@ -3,12 +3,3 @@ source "https://rubygems.org"
 gemspec
 
 gem 'tree_sitter', git: 'https://github.com/Faveod/ruby-tree-sitter'
-
-group :development do
-  gem "yard"
-end
-
-group :test do
-  gem "minitest-focus"
-  gem "minitest-reporters"
-end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 derekstride
+Copyright (c) 2022-present, Shopify Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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

@@ -9,6 +9,11 @@ module TreeStand
 
     def_delegators :@ts_node, :type, :start_byte, :end_byte, :start_point, :end_point
 
+    # @return [TreeStand::Tree]
+    attr_reader :tree
+    # @return [TreeSitter::Node]
+    attr_reader :ts_node
+
     # @api private
     def initialize(tree, ts_node)
       @tree = tree
@@ -16,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.1"
+  VERSION = "0.1.3"
 end

data/tree_stand.gemspec

@@ -31,8 +31,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "zeitwerk"
 
-  spec.add_development_dependency "bundler", "~> 2.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-focus"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tree_stand
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - derekstride
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -28,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - derek@stride.host