ruby_tree_sitter 0.20.8.3 → 1.0.0

data/lib/tree_stand/visitors/tree_walker.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# typed: true
+
+module TreeStand
+  # A collection of useful visitors for traversing trees.
+  module Visitors
+    # Walks the tree depth-first and yields each node to the provided block.
+    #
+    # @example Create a list of all the nodes in the tree.
+    #   list = []
+    #   TreeStand::Visitors::TreeWalker.new(root) do |node|
+    #     list << node
+    #   end.visit
+    #
+    # @see TreeStand::Node#walk
+    # @see TreeStand::Tree#walk
+    class TreeWalker < Visitor
+      extend T::Sig
+
+      # @param block [Proc] A block that will be called for
+      #   each node in the tree.
+      sig do
+        params(
+          node: TreeStand::Node,
+          block: T.proc.params(node: TreeStand::Node).void,
+        ).void
+      end
+      def initialize(node, &block)
+        super(node)
+        @block = block
+      end
+
+      sig { override.params(node: TreeStand::Node).void }
+      def on(node) = @block.call(node)
+    end
+  end
+end

data/lib/tree_stand.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'forwardable'
+require 'sorbet-runtime'
+require 'stringio'
+require 'tree_sitter'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/tree_sitter")
+loader.ignore("#{__dir__}/tree_sitter.rb")
+loader.setup
+
+# TreeStand is a high-level Ruby wrapper for {https://tree-sitter.github.io/tree-sitter tree-sitter} bindings. It makes
+# it easier to configure the parsers, and work with the underlying syntax tree.
+module TreeStand
+  # Common Ancestor for all TreeStand errors.
+  class Error < StandardError; end
+  # Raised when the parsed document contains errors.
+  class InvalidDocument < Error; end
+  # Raised when performing a search on a tree where a return value is expected,
+  # but no match is found.
+  class NodeNotFound < Error; end
+
+  class << self
+    extend T::Sig
+
+    # Easy configuration of the gem.
+    #
+    # @example
+    #   TreeStand.configure do
+    #     config.parser_path = "path/to/parser/folder/"
+    #   end
+    #
+    #   sql_parser = TreeStand::Parser.new("sql")
+    #   ruby_parser = TreeStand::Parser.new("ruby")
+    sig { params(block: T.proc.void).void }
+    def configure(&block)
+      instance_eval(&block)
+    end
+
+    sig { returns(TreeStand::Config) }
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/tree_sitter.gemspec

@@ -6,27 +6,30 @@ $LOAD_PATH.unshift(lib) if !$LOAD_PATH.include?(lib)
 require 'tree_sitter/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
 
-  spec.authors       = ['Firas al-Khalil']
-  spec.email         = ['firasalkhalil@gmail.com']
+  spec.authors       = ['Firas al-Khalil', 'Derek Stride']
+  spec.email         = ['firasalkhalil@gmail.com', 'derek@stride.host']
   spec.homepage      = 'https://www.github.com/Faveod/ruby-tree-sitter'
   spec.license       = 'MIT'
   spec.name          = 'ruby_tree_sitter'
   spec.summary       = 'Ruby bindings for Tree-Sitter'
   spec.version       = TreeSitter::VERSION
 
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => spec.homepage,
+    'changelog_uri' => spec.homepage,
+    'documentation_uri' => 'https://faveod.github.io/ruby-tree-sitter/',
+  }
+
   spec.extensions    = %(ext/tree_sitter/extconf.rb)
   spec.files         = %w[LICENSE README.md tree_sitter.gemspec]
   spec.files        += Dir.glob('ext/**/*.{c,h,rb}')
   spec.files        += Dir.glob('lib/**/*.rb')
-  spec.test_files    = Dir.glob('test/**/*')
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency('minitest', '~> 5.16')
-  spec.add_development_dependency('minitest-color', '~> 0.0.2')
-  spec.add_development_dependency('pry', '~> 0.14')
-  spec.add_development_dependency('rake', '~> 13.0')
-  spec.add_development_dependency('rake-compiler', '~> 1.2')
-  spec.add_development_dependency('rake-compiler-dock', '~> 1.2')
-  spec.add_development_dependency('ruby_memcheck', '~> 1.0')
+  spec.add_dependency 'sorbet-runtime'
+  spec.add_dependency 'zeitwerk'
 end

metadata

@@ -1,116 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: ruby_tree_sitter
 version: !ruby/object:Gem::Version
-  version: 0.20.8.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Firas al-Khalil
+- Derek Stride
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-color
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler-dock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: ruby_memcheck
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description:
 email:
 - firasalkhalil@gmail.com
+- derek@stride.host
 executables: []
 extensions:
 - ext/tree_sitter/extconf.rb
@@ -145,21 +77,28 @@ files:
 - lib/tree_sitter.rb
 - lib/tree_sitter/node.rb
 - lib/tree_sitter/version.rb
-- test/README.md
-- test/test_helper.rb
-- test/tree_sitter/js_test.rb
-- test/tree_sitter/language_test.rb
-- test/tree_sitter/logger_test.rb
-- test/tree_sitter/node_test.rb
-- test/tree_sitter/parser_test.rb
-- test/tree_sitter/query_test.rb
-- test/tree_sitter/tree_cursor_test.rb
-- test/tree_sitter/tree_test.rb
+- lib/tree_stand.rb
+- lib/tree_stand/ast_modifier.rb
+- lib/tree_stand/breadth_first_visitor.rb
+- lib/tree_stand/config.rb
+- lib/tree_stand/node.rb
+- lib/tree_stand/parser.rb
+- lib/tree_stand/range.rb
+- lib/tree_stand/tree.rb
+- lib/tree_stand/utils/printer.rb
+- lib/tree_stand/version.rb
+- lib/tree_stand/visitor.rb
+- lib/tree_stand/visitors/tree_walker.rb
 - tree_sitter.gemspec
 homepage: https://www.github.com/Faveod/ruby-tree-sitter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.github.com/Faveod/ruby-tree-sitter
+  source_code_uri: https://www.github.com/Faveod/ruby-tree-sitter
+  changelog_uri: https://www.github.com/Faveod/ruby-tree-sitter
+  documentation_uri: https://faveod.github.io/ruby-tree-sitter/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -168,25 +107,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Ruby bindings for Tree-Sitter
-test_files:
-- test/README.md
-- test/test_helper.rb
-- test/tree_sitter/js_test.rb
-- test/tree_sitter/language_test.rb
-- test/tree_sitter/logger_test.rb
-- test/tree_sitter/node_test.rb
-- test/tree_sitter/parser_test.rb
-- test/tree_sitter/query_test.rb
-- test/tree_sitter/tree_cursor_test.rb
-- test/tree_sitter/tree_test.rb
+test_files: []

data/test/README.md

@@ -1,15 +0,0 @@
-# Unit testing
-
-Since we don't have languages bundled in ruby gems, we have to load the dynamic
-libraries from disk.
-
-We're using the `bin/get` scripts to do so.
-
-Since not all languages have a Makefile in their root dir, and we don't want to
-mess with copying Makefiles, we're going to rely on languages that do have a
-Makefile in their root.
-
-So for the time being we're sticking with `ruby`.
-
-We might need to change this strategy in the future if we're to test some
-multilang parsing.

data/test/test_helper.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-at_exit { GC.start }
-
-require 'minitest/autorun'
-require 'minitest/color'
-require 'tree_sitter'
-
-require_relative '../examples/helpers'

data/test/tree_sitter/js_test.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../test_helper'
-
-js = TreeSitter.lang('javascript')
-parser = TreeSitter::Parser.new
-parser.language = js
-
-program = <<~JS
-  let a = 42;
-JS
-
-describe 'loading a language' do
-  before do
-    parser.reset
-  end
-
-  it 'must set/get the same language' do
-    parser.language = js
-    assert_equal js, parser.language
-  end
-end
-
-describe 'parse_string' do
-  before do
-    parser.reset
-  end
-
-  it 'must parse nil' do
-    res = parser.parse_string(nil, nil)
-    assert_nil res
-  end
-
-  [
-    ['empty', '', 0],
-    ['valid', program, 1],
-    # ['invalid', margorp, 3]
-  ].each do |q, p, c|
-    it "must parse #{q} programs" do
-      res = parser.parse_string(nil, p)
-      assert_instance_of TreeSitter::Tree, res
-
-      root = res.root_node
-      assert_instance_of TreeSitter::Node, root
-      assert_equal c, root.child_count
-    end
-  end
-end

data/test/tree_sitter/language_test.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../test_helper'
-
-ruby = TreeSitter.lang('ruby')
-parser = TreeSitter::Parser.new
-parser.language = ruby
-
-program = <<~RUBY
-  def mul(a, b)
-    res = a * b
-    puts res.inspect
-    return res
-  end
-RUBY
-
-tree = parser.parse_string(nil, program)
-root = tree.root_node
-
-# NOTE: one should be weary of testing with data structures that are owned by
-# parsers.   They are not reliable and we should expect them to break when these
-# parsers evolve.
-
-describe 'language' do
-  it 'must be able to load a library from `Pathname` (or any object that has `to_s`)' do
-    path =
-      if p = ENV.fetch('TREE_SITTER_PARSERS', nil)
-        Pathname(p) / "libtree-sitter-ruby.#{TreeSitter.ext}"
-      else
-        downloaded = Pathname('tree-sitter-parsers') / "libtree-sitter-ruby.#{TreeSitter.ext}"
-        if !downloaded.exist?
-          Pathname('tree-sitter-parsers') / "ruby" / "libtree-sitter-ruby.#{TreeSitter.ext}"
-        else
-          downloaded
-        end
-      end
-    ll = TreeSitter::Language.load('ruby', path)
-    assert ll.field_count.positive?
-  end
-
-  it 'must return symbol count' do
-    assert ruby.symbol_count.positive?
-  end
-
-  it 'must return symbol name' do
-    assert_equal 'end', ruby.symbol_name(0)
-  end
-
-  it 'must return symbol id for string name' do
-    assert ruby.symbol_for_name(root.type, root.named?).positive?
-  end
-
-  it 'must return field count' do
-    assert ruby.field_count.positive?
-  end
-
-  it 'must return field name for id' do
-    assert_equal 'alias', ruby.field_name_for_id(1)
-  end
-
-  it 'must return field name for id' do
-    assert_equal 1, ruby.field_id_for_name('alias')
-  end
-
-  it 'must return field symbol type' do
-    assert_equal TreeSitter::SymbolType::AUXILIARY, ruby.symbol_type(0)
-  end
-
-  it 'must be of correct version' do
-    assert ruby.version <= TreeSitter::LANGUAGE_VERSION \
-           && ruby.version >= TreeSitter::MIN_COMPATIBLE_LANGUAGE_VERSION
-  end
-end

data/test/tree_sitter/logger_test.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../test_helper'
-require 'stringio'
-
-ruby = TreeSitter.lang('ruby')
-parser = TreeSitter::Parser.new
-parser.language = ruby
-
-program = <<~RUBY
-  def mul(a, b)
-    res = a * b
-    puts res.inspect
-    return res
-  end
-RUBY
-
-# Use with fork.
-#
-# Minitest on ruby 2.7 was failing sometimes for no particular reason,
-# complaining about some random number not having a `write` method.
-#
-# My assumption is that the global var $stderr is not playing nice when
-# we try to replace it and other minitest stuff are going alongside.
-#
-# If this theory holds, then forking should solve any race conditions that
-# minitest could introduce. Let's wait and see.
-def capture_stderr
-  # The output stream must be an IO-like object. In this case we capture it in
-  # an in-memory IO object so we can return the string value. You can assign any
-  # IO object here.
-  previous_stderr = $stderr
-  $stderr = StringIO.new
-  yield
-  $stderr.string
-ensure
-  # Restore the previous value of stderr (typically equal to STDERR).
-  $stderr = previous_stderr
-end
-
-describe 'logging' do
-  it 'should log to stderr by default' do
-    fork do
-      captured_output = capture_stderr do
-        # Does not output anything directly.
-        parser.logger = TreeSitter::Logger.new
-        parser.parse_string(nil, program)
-      end
-      refute_equal 0, captured_output.length
-    end
-  end
-
-  it 'should log to IO objects' do
-    backend = StringIO.new
-    parser.logger = TreeSitter::Logger.new(backend)
-    parser.parse_string(nil, program)
-    refute_equal 0, backend.length
-  end
-
-  it 'should format output when a format string is passed' do
-    delim = '~~~~~'
-    backend = StringIO.new
-    parser.logger = TreeSitter::Logger.new(backend, "%s#{delim}%s")
-    parser.parse_string(nil, program)
-    refute_empty backend.string, 'the backend should be filled with logs'
-    backend.each_line do |l|
-      assert (/#{delim}/ =~ l), 'delimiter must be in every single line'
-    end
-  end
-end