ruby_tree_sitter 0.20.6.3-x86_64-linux

data/test/tree_sitter/parser_test.rb

@@ -0,0 +1,140 @@
+# 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
+
+# NOTE: I was trying to parse invalid programs and see what happens.
+#
+# What happens = undefined behavior with the ruby parsers.
+#
+# Sometimes it would parse normally and return an instance of Tree, and
+# sometimes it would return nil.  That goes for both `parse_string` and
+# `parse_string_encoded`.
+#
+# I suspect the same thing would happen with `parse`
+
+# margorp = <<~YBUR
+#   fibfast n = fib' 0 1 n
+#     where fib' a b n | n <= 1 = b
+#                      | otherwise = fib' b (a+b) (n-1)
+# YBUR
+
+program16 = program.encode('utf-16')
+# margorp_16 = margorp.encode('utf-16')
+
+describe 'loading a language' do
+  before do
+    parser.reset
+  end
+
+  it 'must set/get the same language' do
+    parser.language = ruby
+    assert_equal ruby, 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
+
+describe 'parse_string_encoding' do
+  before do
+    parser.reset
+  end
+
+  it 'must parse nil' do
+    res = parser.parse_string_encoding(nil, nil, :utf8)
+    assert_nil res
+    res = parser.parse_string_encoding(nil, nil, :utf16)
+    assert_nil res
+  end
+
+  [
+    ['empty', '', 0, :utf8],
+    ['valid', program, 1, :utf8],
+    # ['invalid', margorp, 3, :utf8],
+    ['empty', ''.encode('utf-16'), 0, :utf16],
+    ['valid', program16, 1, :utf16],
+    # ['invalid', margorp_16, 1, :utf16]
+  ].each do |q, p, c, e|
+    it "must parse #{q} programs in #{e}" do
+      res = parser.parse_string_encoding(nil, p, e)
+      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
+
+describe 'print_dot_graphs' do
+  before do
+    parser.reset
+  end
+
+  it 'must save its debug info to a file' do
+    dot = File.expand_path('tmp/debug-dot.gv', FileUtils.getwd)
+    parser.print_dot_graphs(dot)
+    parser.parse_string(nil, program)
+
+    assert File.exist?(dot), 'dot file must be exist'
+    assert File.file?(dot), 'dot file must be a file'
+    refute_equal 0, File.size(dot)
+  end
+end
+
+describe 'canecalation_flags' do
+  it 'must get/set cancellation_flah' do
+    parser.cancellation_flag = 1
+    assert_equal 1, parser.cancellation_flag
+  end
+end
+
+describe 'timeout_micros' do
+  it 'must get/set timeout_micros' do
+    parser.timeout_micros = 1
+    assert_equal 1, parser.timeout_micros
+  end
+end
+
+# TODO: included_ranges for parsing partial documents.
+
+# TODO: parsing with non-nil tree.
+
+# TODO: parsing Input streams.  We're currently just hading the callback from
+#       C-space to Ruby-space At some point we might need to implement a
+#       buffered input reader and we should test it here.

data/test/tree_sitter/query_test.rb

@@ -0,0 +1,153 @@
+# 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
+
+pattern = '(method_parameters)'
+capture = '(method_parameters (_)+ @args)'
+predicate = '(method_parameters (_)+ @args (#match? @args "\w"))'
+combined = "#{pattern} #{capture}"
+# string = '(method_parameters (_)+ @args)'
+
+# NOTE: It' still unclear to me what a captured string is.
+
+describe 'pattern/capture/string' do
+  it 'must return an Integer for pattern count' do
+    query = TreeSitter::Query.new(ruby, pattern)
+    assert_equal 1, query.pattern_count
+    assert_equal 0, query.capture_count
+    assert_equal 0, query.string_count
+  end
+
+  it 'must return an Integer for pattern count' do
+    query = TreeSitter::Query.new(ruby, capture)
+    assert_equal 1, query.pattern_count
+    assert_equal 1, query.capture_count
+    assert_equal 0, query.string_count
+  end
+
+  it 'must return an Integer for combined patterns' do
+    query = TreeSitter::Query.new(ruby, combined)
+    assert_equal 2, query.pattern_count
+    assert_equal 1, query.capture_count
+    assert_equal 0, query.string_count
+  end
+
+  it 'must return an Integer for pattern start byte' do
+    query = TreeSitter::Query.new(ruby, combined)
+    assert_equal 0, query.start_byte_for_pattern(0)
+    assert_equal pattern.bytesize + 1, query.start_byte_for_pattern(1)
+  end
+
+  it 'must return an array of predicates for a pattern' do
+    query = TreeSitter::Query.new(ruby, combined)
+
+    preds0 = query.predicates_for_pattern(0)
+    assert_instance_of Array, preds0
+    assert_equal 0, preds0.size
+
+    preds1 = query.predicates_for_pattern(1)
+    assert_instance_of Array, preds1
+    assert_equal 0, preds1.size
+
+    query = TreeSitter::Query.new(ruby, predicate)
+    preds2 = query.predicates_for_pattern(0)
+    assert_instance_of Array, preds2
+    assert_equal 4, preds2.size
+  end
+
+  it 'must return string names, quanitfier, and string value for capture id' do
+    query = TreeSitter::Query.new(ruby, predicate)
+    query.predicates_for_pattern(0).each do |step|
+      next if step.type != TreeSitter::QueryPredicateStep::CAPTURE
+
+      assert_equal 'args', query.capture_name_for_id(step.value_id)
+      assert_equal TreeSitter::Quantifier::ONE_OR_MORE, query.capture_quantifier_for_id(0, step.value_id)
+      assert_equal 'match?', query.string_value_for_id(step.value_id)
+    end
+  end
+
+  it 'must disable captures but keep it in count' do
+    query = TreeSitter::Query.new(ruby, capture)
+    query.disable_capture('@args')
+    assert_equal 1, query.capture_count
+  end
+
+  it 'must disable captures but keep it in count' do
+    query = TreeSitter::Query.new(ruby, capture)
+    query.disable_pattern(0)
+    assert_equal 1, query.pattern_count
+  end
+  # TODO: pattern guaranteed at step
+end
+
+describe 'query_cursor' do
+  before do
+    @query = TreeSitter::Query.new(ruby, capture)
+    @cursor = TreeSitter::QueryCursor.exec(@query, root)
+  end
+
+  it 'must work with limits' do
+    @cursor.match_limit = 1
+    assert_equal 1, @cursor.match_limit
+    refute @cursor.exceed_match_limit?
+    refute_nil @cursor.next_capture
+    assert @cursor.exceed_match_limit?
+  end
+
+  it 'must work with byte range' do
+    child = root.child(0).child(0)
+    @cursor.set_byte_range(child.start_byte, child.end_byte)
+    assert_nil @cursor.next_capture
+  end
+
+  it 'must work with point range' do
+    child = root.child(0).child(0)
+    @cursor.set_point_range(child.start_point, child.end_point)
+    assert_nil @cursor.next_capture
+  end
+
+  it 'must work with next/remove' do
+    assert_equal 0, @cursor.next_match.id
+    @cursor.remove_match(1)
+    assert_nil @cursor.next_match
+  end
+end
+
+describe 'querying anonymous nodes' do
+  it 'must match & capture the correct nodes' do
+    binary = '(binary left: (identifier) operator: "*" right: (identifier)) @binary'
+    prog = <<~RUBY
+      c + d
+      a * b
+      e / f
+    RUBY
+    prog_tree = parser.parse_string(nil, prog)
+    prog_root = prog_tree.root_node
+    query = TreeSitter::Query.new(ruby, binary)
+    cursor = TreeSitter::QueryCursor.exec(query, prog_root)
+
+    while match = cursor.next_match
+      refute_nil(match)
+      assert_equal(1, match.captures.size)
+
+      node = match.captures.first.node
+      assert_equal 'a * b', prog[node.start_byte...node.end_byte]
+    end
+    assert_nil(match)
+  end
+end

data/test/tree_sitter/tree_cursor_test.rb

@@ -0,0 +1,83 @@
+# 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
+
+describe 'TreeCursor should work properly' do
+  before do
+    @cursor = TreeSitter::TreeCursor.new(root)
+  end
+
+  it 'must return root node when created' do
+    assert_equal root, @cursor.current_node
+  end
+
+  it 'must return root node when reset after creation' do
+    @cursor.reset(root)
+    assert_equal root, @cursor.current_node
+  end
+
+  it 'must reset to an arbitrary node' do
+    @cursor.reset(root.child(0).child(0))
+    assert_equal root.child(0).child(0), @cursor.current_node
+  end
+
+  it 'must move on the tree properly' do
+    @cursor.goto_first_child
+    assert_equal root.child(0), @cursor.current_node
+
+    @cursor.goto_first_child
+    @cursor.goto_next_sibling
+    assert_equal root.child(0).child(0).next_sibling, @cursor.current_node
+
+    @cursor.goto_parent
+    assert_equal root.child(0), @cursor.current_node
+
+    @cursor.reset(root)
+    assert_equal root, @cursor.current_node
+  end
+
+  it 'must return a String when current_field_name is called on a named child, or nil otherwise' do
+    assert_nil @cursor.current_field_name
+
+    @cursor.goto_first_child
+    @cursor.goto_first_child
+    @cursor.goto_next_sibling
+
+    assert_equal 'name', @cursor.current_field_name
+    assert_instance_of Integer, @cursor.current_field_id
+  end
+
+  it 'must return proper child for given byte' do
+    @cursor.goto_first_child_for_byte(0)
+    assert_equal root.child(0), @cursor.current_node
+  end
+
+  it 'must return proper child for given point' do
+    @cursor.goto_first_child_for_point(root.start_point)
+    assert_equal root.child(0), @cursor.current_node
+  end
+
+  it 'must return proper child for given point' do
+    @cursor.goto_first_child_for_point(root.start_point)
+    assert_equal root.child(0), @cursor.current_node
+  end
+
+  it 'must return a distinct copy on copy' do
+    refute_equal @cursor, @cursor.copy
+  end
+end

data/test/tree_sitter/tree_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper.rb'
+
+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)
+
+describe 'copy' do
+  it 'must make a new copy' do
+    copy = tree.copy
+    refute_equal tree, copy
+  end
+end
+
+describe 'root_node' do
+  it 'must be of type TreeSitter::Node' do
+    root = tree.root_node
+    assert_instance_of TreeSitter::Node, root
+  end
+end
+
+describe 'language' do
+  it 'must be identical to parser language' do
+    assert_equal parser.language, tree.language
+  end
+end
+
+describe 'print_dot_graph' do
+  it 'must save to disk' do
+    dot = File.expand_path('tmp/tree-dot.gv', FileUtils.getwd)
+    tree.print_dot_graph(dot)
+
+    assert File.exist?(dot), 'dot file must be exist'
+    assert File.file?(dot), 'dot file must be a file'
+    refute_equal 0, File.size(dot)
+  end
+end
+
+# TODO: edit
+# TODO: changed_ranges

data/tree_sitter.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'tree_sitter/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.authors       = ['Firas al-Khalil']
+  spec.email         = ['firasalkhalil@gmail.com']
+  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.extensions    = %(ext/tree_sitter/extconf.rb)
+  spec.files         = %w(LICENSE README.md tree_sitter.gemspec)
+  spec.files        += Dir.glob('ext/**/*.[ch]')
+  spec.files        += Dir.glob('lib/**/*.rb')
+  spec.test_files    = Dir.glob('test/**/*')
+
+  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')
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: ruby_tree_sitter
+version: !ruby/object:Gem::Version
+  version: 0.20.6.3
+platform: x86_64-linux
+authors:
+- Firas al-Khalil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: minitest-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  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'
+description: 
+email:
+- firasalkhalil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- ext/tree_sitter/encoding.c
+- ext/tree_sitter/extconf.rb
+- ext/tree_sitter/input.c
+- ext/tree_sitter/input_edit.c
+- ext/tree_sitter/language.c
+- ext/tree_sitter/logger.c
+- ext/tree_sitter/macros.h
+- ext/tree_sitter/node.c
+- ext/tree_sitter/parser.c
+- ext/tree_sitter/point.c
+- ext/tree_sitter/quantifier.c
+- ext/tree_sitter/query.c
+- ext/tree_sitter/query_capture.c
+- ext/tree_sitter/query_cursor.c
+- ext/tree_sitter/query_error.c
+- ext/tree_sitter/query_match.c
+- ext/tree_sitter/query_predicate_step.c
+- ext/tree_sitter/range.c
+- ext/tree_sitter/symbol_type.c
+- ext/tree_sitter/tree.c
+- ext/tree_sitter/tree_cursor.c
+- ext/tree_sitter/tree_sitter.c
+- ext/tree_sitter/tree_sitter.h
+- lib/tree_sitter.rb
+- lib/tree_sitter/node.rb
+- lib/tree_sitter/tree_sitter.so
+- lib/tree_sitter/version.rb
+- test/README.md
+- test/test_helper.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
+- tree_sitter.gemspec
+homepage: https://www.github.com/Faveod/ruby-tree-sitter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.3.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for Tree-Sitter
+test_files:
+- test/README.md
+- test/test_helper.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