tree_stand 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e5005eed3acbb6399f68c0edf358ba15f4565eb4d99e20652158dbd1c2594e
-  data.tar.gz: 8fee6e5e40b9db6adcd72cf72e2705124b9a7e6fcc90ad4673600c1f5074cd69
+  metadata.gz: 7d9ecce5098c654a026b3f08bd8e5dc0a87b696d5e56102f11a40540a7b45d72
+  data.tar.gz: 41b5bc8b68fb82183e1d641e735fa9083365c5077402193cbf2128c026b1140e
 SHA512:
-  metadata.gz: 1801ffc4ecfa3e7693009267a8a22225f53d04668ca5ddf4c59ba7e0bd2fc5c9e5b5ecfde771aa9631911bd19a0d0e198abcfd18cfe476d3c64ffb7df4480662
-  data.tar.gz: 1fec3247f8836c5bf8175530efe0cb51e692e922c431d2f7d81b4f7dd22d895849cfe1af57996c4dff4a18a29bfdecbd30d0bdba24a94dffc4540609f24c3830
+  metadata.gz: e1a91dcfa898f9341ed7d8493204cec0ff1170b157e8598226a41858faa96de9f4df45b6e1e449c5c817b3edc7b44efa9bfb7bbfae6a1f4a031580ff0663a0e3
+  data.tar.gz: 23cc338e725309b833f1b9200101f191772798e3a85d1610c41237522096a7454013fcf6252de8b161c62f7831a263f2ec94603aff4be47739b4a78cc4fdcedc

data/README.md

@@ -37,9 +37,10 @@ ruby_parser = TreeStand::Parser.new("ruby")
 ### API Conventions
 
 TreeStand aims to provide APIs similar to TreeSitter when possible. For example, the TreeSitter parser exposes a
-`#parse_string(tree, document)` method. TreeStand replicates this behaviour but augments it to return a
-`TreeStand::Tree` instead of the underlying `TreeSitter::Tree`. Similarly, `TreeStand::Tree#root_node` returns a
-`TreeStand::Node` & `TreeSitter::Tree#root_node` returns a `TreeSitter::Node`.
+`#parse_string(tree, document)` method. TreeStand replicates this behaviour closely with it's `#parse_string(document,
+tree: nil)` method but augments it to return a `TreeStand::Tree` instead of the underlying `TreeSitter::Tree`.
+Similarly, `TreeStand::Tree#root_node` returns a `TreeStand::Node` & `TreeSitter::Tree#root_node` returns a
+`TreeSitter::Node`.
 
 The underlying objects are accessible via a `ts_` prefixed attribute, e.g. `ts_parser`, `ts_tree`, `ts_node`, etc.
 

data/lib/tree_stand/node.rb

@@ -159,7 +159,7 @@ module TreeStand
     end
 
     # A convience method for getting the text of the node. Each {TreeStand::Node}
-    # wraps the parent {#tree} and has access to the source document.
+    # wraps the parent {TreeStand::Tree #tree} and has access to the source document.
     # @return [String]
     def text
       @tree.document[@ts_node.start_byte...@ts_node.end_byte]

data/lib/tree_stand/parser.rb

@@ -30,11 +30,13 @@ module TreeStand
     end
 
     # Parse the provided document with the TreeSitter parser.
-    # @param tree [TreeStand::Tree]
+    # @param tree [TreeStand::Tree, nil] providing the old tree will allow the
+    #   parser to take advantage of incremental parsing and improve performance
+    #   by re-useing nodes from the old tree.
     # @param document [String]
     # @return [TreeStand::Tree]
-    def parse_string(tree, document)
-      # There's a bug with passing a non-nil tree
+    def parse_string(document, tree: nil)
+      # @todo There's a bug with passing a non-nil tree
       ts_tree = @ts_parser.parse_string(nil, document)
       TreeStand::Tree.new(self, ts_tree, document)
     end
@@ -45,8 +47,8 @@ module TreeStand
     #
     # @see #parse_string
     # @raise [TreeStand::InvalidDocument]
-    def parse_string!(tree, document)
-      tree = parse_string(tree, document)
+    def parse_string!(document, tree: nil)
+      tree = parse_string(document, tree: tree)
       return tree unless tree.any?(&:error?)
 
       raise(InvalidDocument, <<~ERROR)

data/lib/tree_stand/tree.rb

@@ -109,7 +109,7 @@ module TreeStand
 
     def replace_with_new_doc(new_document)
       @document = new_document
-      new_tree = @parser.parse_string(@ts_tree, @document)
+      new_tree = @parser.parse_string(@document, tree: self)
       @ts_tree = new_tree.ts_tree
     end
   end

data/lib/tree_stand/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tree_stand
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - derekstride
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk