Project

tree_stump

0.0
The project is in a healthy, maintained state
Ruby bindings for Tree-sitter written in Rust
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
 Project Readme

TreeStump

RSpec

tree-sitter binding for Ruby written by Rust.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add tree_stump

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install tree_stump

Usage

require "tree_stump"
require "rouge"

TreeStump.register_lang("ruby", "./libtree-sitter-ruby.so")

parser = TreeStump::Parser.new
parser.set_language("ruby")

source = File.read("./sample.rb")

formatter = Rouge::Formatters::Terminal256.new
lexer = Rouge::Lexers::Ruby.new

puts "== Source =="
puts formatter.format(lexer.lex(source))

puts "\n"

puts "==  Tree  =="
tree = parser.parse(source)

puts tree.root_node.to_sexp
(program (class name: (constant) superclass: (superclass (constant)) body: (body_statement (call method: (identifier) arguments: (argument_list (simple_symbol) (pair key: (hash_key_symbol) value: (true)))) (singleton_method object: (self) name: (identifier) parameters: (method_parameters (identifier)) body: (body_statement (call receiver: (constant) method: (identifier) arguments: (argument_list (pair key: (hash_key_symbol) value: (identifier)))))))) (call receiver: (constant) method: (identifier) arguments: (argument_list (string (string_content)))))

Development

Requirements

  • Rust Toolchain
  • tree-sitter-ruby
  1. Download source of tree-sitter-ruby from GitHub Repository.
  2. Extract tree-sitter-ruby source
  3. mv tree-sitter-ruby-v{version_num} to tree_stump/tree-sitter-ruby
  4. Execute make in tree-sitter-ruby directory

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/joker1007/tree_stump.