TreeStump

tree-sitter binding for MRI Ruby written by Rust.

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

tree_stump is a Rust native extension using magnus and rb-sys for Ruby bindings.

JRuby runs on the Java Virtual Machine and cannot load native C/Rust extensions (.so files). The rb-sys build system fails during extconf.rb because JRuby doesn't provide the platform detection APIs that native extensions require.

Alternative for JRuby: Use java-tree-sitter / jtreesitter directly, or use TreeHaver's Java backend which wraps it.

TruffleRuby implements Ruby on GraalVM, not as a C program. While it has a C API emulation layer (via Sulong/LLVM), this layer doesn't expose all of MRI's internal structures that magnus requires:

• Missing C API functions: rb_bug, rb_warning, rb_gc_writebarrier, rb_data_define, etc.
• Missing struct fields: RBasic.flags, RBasic.klass
• Missing constants: ruby_rvalue_flags, RUBY_ENC_CODERANGE_MASK

These are MRI implementation details that TruffleRuby doesn't need (and can't easily provide) because its objects are implemented completely differently.

Alternative for TruffleRuby: Use TreeHaver with non-tree-sitter backends (prism, psych, citrus) for parsing needs.

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)))))

• Rust Toolchain
• MRI Ruby (not JRuby or TruffleRuby)
• 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
5. Execute bundle exec rake compile

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