ruby_tree_sitter 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b2cf41f13a89341d5baceb421b53cb7cdd849044bb703d74d139b29d7768da
-  data.tar.gz: 15bad1e7513b73efe382ce880fe8e26af6b64707777dd47de39829559b290e9b
+  metadata.gz: e0488c0541ab1295e21de7a53a3af6bbfb0d2e5a2340874803037b00956e16e3
+  data.tar.gz: 9e5b5d202e3857ee5840322c1899684e12aa8469faa3c199f0cb8b1d1d183913
 SHA512:
-  metadata.gz: 34388882b92dbf3dd48be897a57c841e837fabc044c0928782b3b03f424b29657bfc3a1d718a5677a5174187710b884952f07072fe79f73bb92cadcfdd84508a
-  data.tar.gz: 1a0cf18288d39254beabea8f72522e349a127eab2c4baecd1ba709139fa90629f231760d2eb3f90adcda057f116044abc001fa47bd47d100f292f2d012829e47
+  metadata.gz: b0d6108292ce09bed1aca0d83899df812019c5689901c762b0b8f54b951f68dc4256495b1e10ad2faf64523f0cfad7262fd07aad7dab1666d599a0453dd40b20
+  data.tar.gz: 6d84ad3d549c81a18a64509d826ae86d12bf90da60cdb0bcff40d5a85008c80ec309afe2d3190707601586d814f8a07ee919887f67c3103ebf352585b69b1e44

data/README.md

@@ -25,6 +25,10 @@ require 'tree_sitter'
 
 parser = TreeSitter::Parser.new
 language = TreeSitter::Language.load('javascript', 'path/to/libtree-sitter-javascript.{so,dylib}')
+# Or simply
+language = TreeSitter.lang('javascript')
+# Which will try to look in your local directory and the system for installed parsers.
+# See TreeSitter::Mixin::Language#lib_dirs
 
 src = "[1, null]"
 
@@ -64,12 +68,23 @@ TreeStand provides an idiomatic Ruby interface to work with tree-sitter parsers.
 
 ## Dependencies
 
-This gem is a binding for `tree-sitter`. It doesn't have a version of
-`tree-sitter` baked in it by default.
+This gem is a binding for `tree-sitter`, and comes with a pre-built version
+of `tree-sitter` bundled with it, so you can start using it without any
+special configuration.
 
-You must install `tree-sitter` and make sure that their dynamic library is
-accessible from `$PATH`, or build the gem with `--disable-sys-libs`, which will
-download the latest tagged `tree-sitter` and build against it (see [Build from source](docs/Contributing.md#build-from-source) .)
+We support the following platforms:
+
+- `aarch64-linux-gnu`
+- `aarch64-linux-musl`
+- `arm-linux-gnu`
+- `arm-linux-musl`
+- `x86_64-linux-gnu`
+- `x86_64-linux-musl`
+- `x86-linux-musl`
+- `arm64-darwin`
+- `x86_64-darwin`
+
+(see [Build from source](docs/Contributing.md#build-from-source)).
 
 You can either install `tree-sitter` from source or through your go-to package manager.
 
@@ -104,7 +119,7 @@ brew install tree-sitter
 From [rubygems](https://rubygems.org/gems/ruby_tree_sitter), in your `Gemfile`:
 
 ```ruby
-gem 'ruby_tree_sitter', '~> 1.0'
+gem 'ruby_tree_sitter', '~> 1.6'
 ```
 
 Or manually:
@@ -119,18 +134,19 @@ Or from `git` sources, which will compile on installation:
 gem 'ruby_tree_sitter', git: 'https://github.com/Faveod/ruby-tree-sitter'
 ```
 
-### Disable system libraries
+### Enable system libraries
 
-To install with `--disable-sys-lib`, you can either:
+To install with `--enable-sys-libs`, you can either:
 
 ```sh
-gem install ruby_tree_sitter -- --disable-sys-libs
+gem install ruby_tree_sitter --platform=ruby -- --enable-sys-libs
 ```
 
 Or via bundle:
 
 ```sh
-bundle config set build.ruby_tree_sitter --disable-sys-libs
+bundle config force_ruby_platform true
+bundle config set build.ruby_tree_sitter --enable-sys-libs
 ```
 
 ### No compilation
@@ -159,16 +175,6 @@ You will have to install parsers yourself, either by:
    [Faveod/tree-sitter-parsers](https://github.com/Faveod/tree-sitter-parsers)
    which supports numerous architectures.
 
-### A note on static vs dynamic linking
-
-This extension will statically link against a downloaded version of
-`tree-sitter` when you use the `--disable-sys-lib`.  So any installed version of
-`tree-sitter` will not be loaded.
-
-The native gems are also statically linked.
-
-All other methods will dynamically link against the installed `tree-sitter`.
-
 ## Examples
 
 See `examples` directory.

data/ext/tree_sitter/extconf.rb

@@ -15,7 +15,7 @@ cflags = []
 ldflags = []
 
 def system_tree_sitter?
-  enable_config('sys-libs', true)
+  enable_config('sys-libs', false)
 end
 
 def env_var_on?(var)
@@ -26,6 +26,8 @@ end
 #    System lib vs Downloaded lib    #
 # ################################## #
 
+repo = TreeSitter::Repo.new
+
 dir_include, dir_lib =
   if system_tree_sitter?
     [
@@ -33,7 +35,6 @@ dir_include, dir_lib =
       %w[/opt/lib /opt/local/lib /usr/lib /usr/local/lib],
     ]
   else
-    repo = TreeSitter::Repo.new
     if !repo.download
       msg = <<~MSG
 
@@ -48,19 +49,19 @@ dir_include, dir_lib =
     # We need to make sure we're selecting the proper toolchain.
     # Especially needed for corss-compilation.
     ENV.store('CC', RbConfig::CONFIG['CC'])
+    repo.patch
     repo.compile
-    repo.keep_static_lib
     repo.include_and_lib_dirs
   end
 
+dir_config('tree-sitter', dir_include&.first, dir_lib&.first)
+
 # ################################## #
 #          Generate Makefile         #
 # ################################## #
 
-header = find_header('tree_sitter/api.h', *dir_include)
-library = find_library('tree-sitter',   # libtree-sitter
-                       'ts_parser_new', # a symbol
-                       *dir_lib)
+header = find_header('tree_sitter/api.h')
+library = find_library('tree-sitter', 'ts_parser_new')
 
 if !header || !library
   abort <<~MSG
@@ -144,6 +145,5 @@ cflags.concat %w[-std=c99 -fPIC -Wall]
 append_cflags(cflags)
 append_ldflags(ldflags)
 
-dir_config('tree-sitter')
 create_header
 create_makefile('tree_sitter/tree_sitter')

data/ext/tree_sitter/language.c

@@ -54,7 +54,7 @@ static VALUE language_load(VALUE self, VALUE name, VALUE path) {
     dlclose(lib);
     rb_raise(rb_eRuntimeError,
              "Could not load symbol `%s' from library `%s'.\nReason:%s",
-             StringValueCStr(name), StringValueCStr(path), err);
+             StringValueCStr(name), path_cstr, err);
   }
 
   TSLanguage *lang = make_ts_language();
@@ -63,7 +63,7 @@ static VALUE language_load(VALUE self, VALUE name, VALUE path) {
     rb_raise(rb_eRuntimeError,
              "TSLanguage = NULL for language `%s' in library `%s'.\nCall your "
              "local TSLanguage supplier.",
-             StringValueCStr(name), StringValueCStr(path));
+             StringValueCStr(name), path_cstr);
   }
 
   uint32_t version = ts_language_version(lang);
@@ -71,7 +71,7 @@ static VALUE language_load(VALUE self, VALUE name, VALUE path) {
     rb_raise(rb_eRuntimeError,
              "Language %s (v%d) from `%s' is old.\nMinimum supported ABI: "
              "v%d.\nCurrent ABI: v%d.",
-             StringValueCStr(name), version, StringValueCStr(path),
+             StringValueCStr(name), version, path_cstr,
              TREE_SITTER_MIN_COMPATIBLE_LANGUAGE_VERSION,
              TREE_SITTER_LANGUAGE_VERSION);
   }

data/ext/tree_sitter/repo.rb

@@ -29,7 +29,9 @@ module TreeSitter
     def compile
       # We need to clean because the same folder is used over and over
       # by rake-compiler-dock
-      sh "cd #{src} && make clean && make"
+      ar = RbConfig::MAKEFILE_CONFIG['AR']
+      ar = " AR=#{ar}" if ar
+      sh "cd #{src} && make clean &&#{ar} make libtree-sitter.a"
     end
 
     def exe?(name)
@@ -59,14 +61,14 @@ module TreeSitter
     end
 
     def include_and_lib_dirs
-      [[src / 'lib' / 'include'], [src.to_s]]
+      [[(src / 'lib' / 'include').to_s], [src.to_s]]
     end
 
-    def keep_static_lib
-      src
-        .children
-        .filter { |f| /\.(dylib|so)/ =~ f.basename.to_s }
-        .each(&:unlink)
+    def patch
+      root = Pathname.new(File.expand_path(__dir__)).realpath.parent.parent
+      patch = root / 'patches' / 'cross-compile.patch'
+
+      sh "patch --forward #{src / 'Makefile'} #{patch}"
     end
 
     def sh(cmd)
@@ -98,9 +100,14 @@ module TreeSitter
     def sources_from_git
       return false if !exe?(:git)
 
-      sh "git clone #{url[:git]} #{src}"
-      sh "cd #{src} && git checkout tags/v#{version}"
-
+      sh <<~SHELL.chomp
+        mkdir #{src} \\
+        && cd #{src} \\
+        && git init \\
+        && git remote add origin "#{url[:git]}" \\
+        && git fetch origin --depth 1 tags/v#{version} \\
+        && git reset --hard FETCH_HEAD
+      SHELL
       true
     end
 

data/lib/tree_sitter/mixins/language.rb

@@ -19,6 +19,7 @@ module TreeSitter
     'vendor/tree-sitter-parsers',
     'parsers',
     'tree-sitter-parsers',
+    '.',
     '/opt/local/lib',
     '/opt/lib',
     '/usr/local/lib',
@@ -67,6 +68,9 @@ module TreeSitter
       #    TreeStand.config.parser_path = '/my/path'
       #    java = TreeStand::Parser.language('java')
       #
+      # @note the name is case sensitive, but library lookup is not: if your parser is defined as `COBOL`,
+      #   then you have to call `language('COBOL')`, but the parser can be `cobol.so/COBOL.so/…`.
+      #
       # @param name [String] the name of the parser.
       #   This name is used to load the symbol from the compiled parser, replacing `-` with `_`.
       #
@@ -120,11 +124,13 @@ module TreeSitter
       # 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}" }
+        files =
+          [name, name.upcase, name.downcase]
+            .uniq
+            .flat_map do |n|
+              base = "#{n}.#{ext}"
+              [base, "tree-sitter-#{base}", "libtree-sitter-#{base}"]
+            end
 
         lib_dirs
           .product(files)

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.5.0'
+  VERSION = '1.6.0'
 end

data/lib/tree_sitter.rb

@@ -2,7 +2,13 @@
 
 require 'set'
 
-require 'tree_sitter/tree_sitter'
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "tree_sitter/#{Regexp.last_match(1)}/tree_sitter"
+rescue LoadError
+  require 'tree_sitter/tree_sitter'
+end
+
 require 'tree_sitter/version'
 
 require 'tree_sitter/mixins/language'

data/tree_sitter.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
   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,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_tree_sitter
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Firas al-Khalil
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-04 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -103,7 +103,6 @@ homepage: https://www.github.com/Faveod/ruby-tree-sitter
 licenses:
 - MIT
 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
@@ -123,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Tree-Sitter