ruby_tree_sitter 1.3.0-x86_64-linux → 1.4.1-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0f7c51b289e769ad5701be586b28d61f41f0979ee6fd3c08f87481ae307f146
-  data.tar.gz: 988052e5b5b5c41e9a9d974398c6c6cae401f2068a2ad4013d80198f3437c029
+  metadata.gz: 70e2391699fd48cf5f18b50df59b7c5929c09e07f18a366a94c24ce381754fe0
+  data.tar.gz: b66813822fe232322d4e4e841975a68d42d6454dcaf47b3b814875bed4f009a9
 SHA512:
-  metadata.gz: 9ef62c5ea3bd4451b03b43e6efc2c3501191ffcd9ea96dfe12d2e66b249d1f16f58e82d6127d833a6c8105e3f910dda2ba898a138d5e6d2756615bf69fcb2e05
-  data.tar.gz: 5bd46cc66e845c9091005a5eadeccb3db2984e0bbc5bf6d12e9fc4e3fd126f9ab6f1d37970fbe6760eee096ec2c011d4d328d5610a9e873ed313df3842caceb3
+  metadata.gz: 37dcb03d0061b0a019167924f2ded1c0291463e3a08d7e6ff58c9e8e121fcafa484d8effe77907fde05b47a1c77f1d5f71bb234c2ce44bce29e5a3d9c6c4dac9
+  data.tar.gz: b099f9953c709cc9edf745309e9b8a155b668947bc59c2abfe13e4bee7d0ba7ac9211facf654b0123eb5750cd04aeefc261a6904cae596a9f466def182c9618e

data/README.md

@@ -200,4 +200,8 @@ To See a full list of the ruby-specific APIs, see [here](lib/README.md).
 
 ## Sponsors
 
-<img src="img/faveod.jpg" width="75%">
+- <a href="https://faveod.com">https://faveod.com</a>
+
+<a href="https://faveod.com">
+  <img src="img/faveod.jpg" width="66%" />
+</a>

data/lib/tree_sitter/mixins/language.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module TreeSitter
+  # A colon-separated list of paths pointing to directories that can contain parsers.
+  # Order matters.
+  # Takes precedence over default lookup paths.
+  ENV_PARSERS =
+    ENV['TREE_SITTER_PARSERS']
+      &.split(':')
+      &.map { |v| Pathname(v) }
+      .freeze
+
+  # The default paths we use to lookup parsers.
+  # Order matters.
+  LIBDIRS = [
+    '.vendor/parsers',
+    '.vendor/tree-sitter-parsers',
+    'vendor/parsers',
+    'vendor/tree-sitter-parsers',
+    'parsers',
+    'tree-sitter-parsers',
+    '/opt/local/lib',
+    '/opt/lib',
+    '/usr/local/lib',
+    '/usr/lib',
+  ].map { |p| Pathname(p) }.freeze
+
+  # Mixins.
+  module Mixins
+    # Language Mixin.
+    module Language
+      # Load a language from configuration or default lookup paths.
+      #
+      # @example Load java from default paths
+      #    # This will look for:
+      #    #
+      #    #   .vendor/tree-sitter-parsers/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   .vendor/parsers/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   vendor/tree-sitter-parsers/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   vendor/parsers/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   parsers/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   tree-sitter-parsers/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   /opt/local/lib/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   /opt/lib/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   /usr/local/lib/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   /usr/lib/(java/)?(libtree-sitter-)?java.{ext}
+      #    #
+      #    java = TreeSitter.language('java')
+      #
+      # @example (TreeStand) Load java from a configured path
+      #    # This will look for:
+      #    #
+      #    #   /my/path/(java/)?(libtree-sitter-)?java.{ext}
+      #    #
+      #    TreeStand.config.parser_path = '/my/path'
+      #    java = TreeStand::Parser.language('java')
+      #
+      # @example (TreeStand) Load java from environment variables
+      #    # This will look for:
+      #    #
+      #    #   /my/forced/env/path/(java/)?(libtree-sitter-)?java.{ext}
+      #    #   /my/path/(java/)?(libtree-sitter-)?java.{ext}
+      #    #
+      #    # … and the same works for the default paths if `TreeStand.config.parser_path`
+      #    # was `nil`
+      #    ENV['TREE_SITTER_PARSERS'] = '/my/forced/env/path'
+      #    TreeStand.config.parser_path = '/my/path'
+      #    java = TreeStand::Parser.language('java')
+      #
+      # @param name [String] the name of the parser.
+      #   This name is used to load the symbol from the compiled parser, replacing `-` with `_`.
+      #
+      # @return [TreeSitter:language] a language object to use in your parsers.
+      #
+      # @raise [RuntimeError] if the parser was not found.
+      #
+      # @see search_for_lib
+      def language(name)
+        lib = search_for_lib(name)
+
+        if lib.nil?
+          raise <<~MSG.chomp
+            Failed to load a parser for #{name}.
+
+            #{search_lib_message}
+          MSG
+        end
+
+        # We know that the bindings will accept `lib`, but I don't know how to tell sorbet
+        # the types in ext/tree_sitter where `load` is defined.
+        TreeSitter::Language.load(name.tr('-', '_'), T.unsafe(lib))
+      end
+
+      # The platform-specific extension of the parser.
+      # @return [String] `dylib` or `so` for mac or linux.
+      def ext
+        case Gem::Platform.local.os
+        in   /darwin/ then 'dylib'
+        else               'so'
+        end
+      end
+
+      private
+
+      # The library directories we need to look into.
+      #
+      # @return [Array<Pathname>] the list of candidate places to use when searching for parsers.
+      #
+      # @see ENV_PARSERS
+      # @see LIBDIRS
+      def lib_dirs = [*TreeSitter::ENV_PARSERS, *TreeSitter::LIBDIRS]
+
+      # Lookup a parser by name.
+      #
+      # Precedence:
+      # 1. `Env['TREE_SITTER_PARSERS]`.
+      # 2. {TreeStand::Config#parser_path} if using {TreeStand}.
+      # 3. {LIBDIRS}.
+      #
+      # If a {TreeStand::Config#parser_path} is `nil`, {LIBDIRS} is used.
+      # If a {TreeStand::Config#parser_path} is a {::Pathname}, {LIBDIRS} is ignored.
+      def search_for_lib(name)
+        files = [
+          name,
+          "tree-sitter-#{name}",
+          "libtree-sitter-#{name}",
+        ].map { |v| "#{v}.#{ext}" }
+
+        lib_dirs
+          .product(files)
+          .find do |dir, so|
+            path = dir / so
+            path = dir / name / so if !path.exist?
+            break path.expand_path if path.exist?
+          end
+      end
+
+      # Generates a string message on where parser lookup happens.
+      #
+      # @return [String] A pretty message.
+      def search_lib_message
+        indent = 2
+        pretty = ->(arr) {
+          if arr
+            arr
+              .compact
+              .map { |v| "#{' ' * indent}#{v.expand_path}" }
+              .join("\n")
+          end
+        }
+        <<~MSG.chomp
+          From ENV['TREE_SITTER_PARSERS']:
+          #{pretty.call(ENV_PARSERS)}
+
+          From Defaults:
+          #{pretty.call(lib_dirs)}
+        MSG
+      end
+    end
+  end
+end

data/lib/tree_sitter/node.rb

@@ -3,6 +3,8 @@
 module TreeSitter
   # Node is a wrapper around a tree-sitter node.
   class Node
+    include Enumerable
+
     # @return [Array<Symbol>] the node's named fields
     def fields
       return @fields if @fields
@@ -87,10 +89,10 @@ module TreeSitter
     # Iterate over a node's children.
     #
     # @yieldparam child [Node] the child
-    def each
+    def each(&_block)
       return enum_for __method__ if !block_given?
 
-      (0...(child_count)).each do |i|
+      (0...child_count).each do |i|
         yield child(i)
       end
     end

data/lib/tree_sitter/query_captures.rb

@@ -3,6 +3,8 @@
 module TreeSitter
   # A sequence of {TreeSitter::QueryCapture} associated with a given {TreeSitter::QueryCursor}.
   class QueryCaptures
+    include Enumerable
+
     def initialize(cursor, query, src)
       @cursor = cursor
       @query = query
@@ -13,7 +15,7 @@ module TreeSitter
     #
     # @yieldparam match [TreeSitter::QueryMatch]
     # @yieldparam capture_index [Integer]
-    def each
+    def each(&_block)
       return enum_for __method__ if !block_given?
 
       while (capture_index, match = @cursor.next_capture)

data/lib/tree_sitter/query_matches.rb

@@ -3,6 +3,8 @@
 module TreeSitter
   # A sequence of {QueryMatch} associated with a given {QueryCursor}.
   class QueryMatches
+    include Enumerable
+
     def initialize(cursor, query, src)
       @cursor = cursor
       @query = query
@@ -12,7 +14,7 @@ module TreeSitter
     # Iterator over matches.
     #
     # @yieldparam match [TreeSitter::QueryMatch]
-    def each
+    def each(&_block)
       return enum_for __method__ if !block_given?
 
       while match = @cursor.next_match
@@ -21,5 +23,17 @@ module TreeSitter
         end
       end
     end
+
+    # Iterate over all the results presented as hashes of `capture name => node`.
+    #
+    # @yieldparam match [Hash<String, TreeSitter::Node>]
+    def each_capture_hash(&_block)
+      # TODO: should we return [Array<Hash<Symbol, TreeSitter::Node]>>] instead?
+      return enum_for __method__ if !block_given?
+
+      each do |match|
+        yield match.captures.to_h { |cap| [@query.capture_name_for_id(cap.index), cap.node] }
+      end
+    end
   end
 end

data/lib/tree_sitter/version.rb

@@ -4,5 +4,5 @@ module TreeSitter
   # The version of the tree-sitter library.
   TREESITTER_VERSION = '0.22.6'
   # The current version of the gem.
-  VERSION = '1.3.0'
+  VERSION = '1.4.1'
 end

data/lib/tree_sitter.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-# TreeSitter is a Ruby interface to the tree-sitter parsing library.
-module TreeSitter
-end
-
 require 'set'
 
 require 'tree_sitter/tree_sitter'
 require 'tree_sitter/version'
 
+require 'tree_sitter/mixins/language'
+
 require 'tree_sitter/node'
 require 'tree_sitter/query'
 require 'tree_sitter/query_captures'
@@ -18,4 +16,13 @@ require 'tree_sitter/query_matches'
 require 'tree_sitter/query_predicate'
 require 'tree_sitter/text_predicate_capture'
 
+# TreeSitter is a Ruby interface to the tree-sitter parsing library.
+module TreeSitter
+  extend Mixins::Language
+
+  class << self
+    alias_method :lang, :language
+  end
+end
+
 ObjectSpace.define_finalizer(TreeSitter::Tree.class, proc { TreeSitter::Tree.finalizer })

data/lib/tree_stand/node.rb

@@ -97,19 +97,11 @@ module TreeStand
     sig { params(query_string: String).returns(T::Array[T::Hash[String, TreeStand::Node]]) }
     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 ts_match = ts_cursor.next_match
-        captures = {}
-
-        ts_match.captures.each do |ts_capture|
-          capture_name = ts_query.capture_name_for_id(ts_capture.index)
-          captures[capture_name] = TreeStand::Node.new(@tree, ts_capture.node)
-        end
-
-        matches << captures
-      end
-      matches
+      TreeSitter::QueryCursor
+        .new
+        .matches(ts_query, @tree.ts_tree.root_node, @tree.document)
+        .each_capture_hash
+        .map { |h| h.transform_values! { |n| TreeStand::Node.new(@tree, n) } }
     end
 
     # Returns the first captured node that matches the query string or nil if

data/lib/tree_stand/parser.rb

@@ -26,6 +26,7 @@ module TreeStand
   # @see LIBDIRS
   class Parser
     extend T::Sig
+    extend TreeSitter::Mixins::Language
 
     sig { returns(TreeSitter::Language) }
     attr_reader :ts_language
@@ -33,156 +34,6 @@ module TreeStand
     sig { returns(TreeSitter::Parser) }
     attr_reader :ts_parser
 
-    # A colon-seprated list of paths pointing to directories that can contain parsers.
-    # Order matters.
-    # Takes precedence over default lookup paths.
-    ENV_PARSERS =
-      ENV['TREE_SITTER_PARSERS']
-        &.split(':')
-        &.map { |v| Pathname(v) }
-        .freeze
-
-    # The default paths we use to lookup parsers when no specific
-    # {TreeStand::Config#parser_path} is `nil`.
-    # Order matters.
-    LIBDIRS = [
-      'tree-sitter-parsers',
-      '/opt/local/lib',
-      '/opt/lib',
-      '/usr/local/lib',
-      '/usr/lib',
-    ].map { |p| Pathname(p) }.freeze
-
-    # The library directories we need to look into.
-    #
-    # @return [Array<Pathname>] the list of candidate places to use when searching for parsers.
-    #
-    # @see ENV_PARSERS
-    # @see LIBDIRS
-    sig { returns(T::Array[Pathname]) }
-    def self.lib_dirs = [
-      *ENV_PARSERS,
-      *(TreeStand.config.parser_path ? [TreeStand.config.parser_path] : LIBDIRS),
-    ].compact
-
-    # The platform-specific extension of the parser.
-    # @return [String] `dylib` or `so` for mac or linux.
-    sig { returns(String) }
-    def self.ext
-      case Gem::Platform.local.os
-      in   /darwin/ then 'dylib'
-      else               'so'
-      end
-    end
-
-    # Lookup a parser by name.
-    #
-    # Precedence:
-    # 1. `Env['TREE_SITTER_PARSERS]`
-    # 2. {TreeStand::Config#parser_path}
-    # 3. {LIBDIRS}
-    #
-    # If a {TreeStand::Config#parser_path} is `nil`, {LIBDIRS} is used.
-    # If a {TreeStand::Config#parser_path} is a {::Pathname}, {LIBDIRS} is ignored.
-    sig { params(name: String).returns(T.nilable(Pathname)) }
-    def self.search_for_lib(name)
-      files = [
-        name,
-        "tree-sitter-#{name}",
-        "libtree-sitter-#{name}",
-      ].map { |v| "#{v}.#{ext}" }
-
-      res = lib_dirs
-        .product(files)
-        .find do |dir, so|
-          path = dir / so
-          path = dir / name / so if !path.exist?
-          break path.expand_path if path.exist?
-        end
-      res.is_a?(Array) ? nil : res
-    end
-
-    # Generates a string message on where parser lookup happens.
-    #
-    # @return [String] A pretty message.
-    sig { returns(String) }
-    def self.search_lib_message
-      indent = 2
-      pretty = ->(arr) {
-        if arr
-          arr
-            .compact
-            .map { |v| "#{' ' * indent}#{v.expand_path}" }
-            .join("\n")
-        end
-      }
-      <<~MSG
-        From ENV['TREE_SITTER_PARSERS']:
-        #{pretty.call(ENV_PARSERS)}
-
-        From TreeStand.config.parser_path:
-        #{pretty.call([TreeStand.config.parser_path])}
-
-        From Defaults:
-        #{pretty.call(LIBDIRS)}
-      MSG
-    end
-
-    # Load a language from configuration or default lookup paths.
-    #
-    # @example Load java from default paths
-    #    # This will look for:
-    #    #
-    #    #   tree-sitter-parsers/(java/)?(libtree-sitter-)?java.{ext}
-    #    #   /opt/local/lib/(java/)?(libtree-sitter-)?java.{ext}
-    #    #   /opt/lib/(java/)?(libtree-sitter-)?java.{ext}
-    #    #   /usr/local/lib/(java/)?(libtree-sitter-)?java.{ext}
-    #    #   /usr/lib/(java/)?(libtree-sitter-)?java.{ext}
-    #    #
-    #    java = TreeStand::Parser.language('java')
-    #
-    # @example Load java from a configured path
-    #    # This will look for:
-    #    #
-    #    #   /my/path/(java/)?(libtree-sitter-)?java.{ext}
-    #    #
-    #    TreeStand.config.parser_path = '/my/path'
-    #    java = TreeStand::Parser.language('java')
-    #
-    # @example Load java from environment variables
-    #    # This will look for:
-    #    #
-    #    #   /my/forced/env/path/(java/)?(libtree-sitter-)?java.{ext}
-    #    #   /my/path/(java/)?(libtree-sitter-)?java.{ext}
-    #    #
-    #    # … and the same works for the default paths if `TreeStand.config.parser_path`
-    #    # was `nil`
-    #    ENV['TREE_SITTER_PARSERS'] = '/my/forced/env/path'
-    #    TreeStand.config.parser_path = '/my/path'
-    #    java = TreeStand::Parser.language('java')
-    #
-    # @param name [String] the name of the parser.
-    #   This name is used to load the symbol from the compiled parser, replacing `-` with `_`.
-    # @return [TreeSitter:language] a language object to use in your parsers.
-    # @raise [RuntimeError] if the parser was not found.
-    # @see search_for_lib
-    sig { params(name: String).returns(TreeSitter::Language) }
-    def self.language(name)
-      lib = search_for_lib(name)
-
-      if lib.nil?
-        raise <<~MSG
-          Failed to load a parser for #{name}.
-
-          #{search_lib_message}
-        MSG
-      end
-
-      # We know that the bindings will accept `lib`, but I don't know how to tell sorbet
-      # the types in ext/tree_sitter where `load` is defined.
-      TreeSitter::Language.load(name.tr('-', '_'), T.unsafe(lib))
-    end
-
     # @param language [String]
     sig { params(language: String).void }
     def initialize(language)
@@ -192,6 +43,19 @@ module TreeStand
       end
     end
 
+    # The library directories we need to look into.
+    #
+    # @return [Array<Pathname>] the list of candidate places to use when searching for parsers.
+    #
+    # @see ENV_PARSERS
+    # @see LIBDIRS
+    def self.lib_dirs
+      [
+        *TreeSitter::ENV_PARSERS,
+        *(TreeStand.config.parser_path ? [TreeStand.config.parser_path] : TreeSitter::LIBDIRS),
+      ]
+    end
+
     # Parse the provided document with the TreeSitter parser.
     # @param tree [TreeStand::Tree, nil] providing the old tree will allow the
     #   parser to take advantage of incremental parsing and improve performance

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_tree_sitter
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: x86_64-linux
 authors:
 - Firas al-Khalil
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -75,6 +75,7 @@ files:
 - ext/tree_sitter/tree_sitter.h
 - lib/tree_sitter.rb
 - lib/tree_sitter/helpers.rb
+- lib/tree_sitter/mixins/language.rb
 - lib/tree_sitter/node.rb
 - lib/tree_sitter/query.rb
 - lib/tree_sitter/query_captures.rb
@@ -115,17 +116,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.3.dev
+      version: 3.4.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Tree-Sitter