kramdown-syntax_tree_sitter 0.4.0 → 0.6.0

data/ext/tree_sitter_adapter/Cargo.toml

@@ -9,8 +9,8 @@ crate-type = ["cdylib"]
 
 [dependencies]
 anyhow = "*"
+magnus = { version = "*", features = ["embed"] }
 tree-sitter = "*"
 tree-sitter-cli = "*"
 tree-sitter-highlight = "*"
 tree-sitter-loader = "*"
-rutie = "*"

data/ext/tree_sitter_adapter/src/lib.rs

@@ -1,69 +1,19 @@
-#[macro_use]
-extern crate rutie;
-
-use rutie::{AnyException, Boolean, Class, Exception, Object, RString, VM};
+use magnus::{exception, function, Error, Ruby};
 
 mod tree_sitter_adapter;
 
-class!(TreeSitterAdapter);
-
-#[rustfmt::skip]
-methods!(
-    TreeSitterAdapter,
-    _rtself,
-    fn pub_highlight(
-        raw_code: RString,
-        raw_parsers_dir: RString,
-        raw_scope: RString,
-        css_classes: Boolean
-    ) -> RString {
-        VM::unwrap_or_raise_ex(
-            tree_sitter_adapter::highlight(
-                &raw_code.unwrap().to_string(),
-                &raw_parsers_dir.unwrap().to_string(),
-                &raw_scope.unwrap().to_string(),
-                css_classes.unwrap().to_bool(),
-            )
-            .as_ref()
-            .map(String::as_str)
-            .map(RString::new_utf8)
-            .map_err(String::as_str)
-            .map_err(AnyException::new_runtime_error),
-        )
-    }
-);
-
-#[no_mangle]
-pub extern "C" fn Init_tree_sitter_adapter() {
-    Class::new("TreeSitterAdapter", None).define(|class_| {
-        class_.def_self("highlight", pub_highlight);
-    });
-}
-
-pub trait VMExt {
-    fn unwrap_or_raise_ex<T, E>(x: Result<T, E>) -> T
-    where
-        E: Into<AnyException>;
-}
-
-impl VMExt for VM {
-    fn unwrap_or_raise_ex<T, E>(result: Result<T, E>) -> T
-    where
-        E: Into<AnyException>,
-    {
-        result.unwrap_or_else(|e| {
-            VM::raise_ex(e);
-            unreachable!();
-        })
-    }
-}
-
-pub trait AnyExceptionExt {
-    fn new_runtime_error(message: &str) -> Self;
+fn pub_highlight(
+    code: String,
+    parsers_dir: String,
+    scope: String,
+    css_classes: bool,
+) -> Result<String, Error> {
+    tree_sitter_adapter::highlight(&code, &parsers_dir, &scope, css_classes)
+        .map_err(|message| Error::new(exception::runtime_error(), message))
 }
 
-impl AnyExceptionExt for AnyException {
-    fn new_runtime_error(message: &str) -> Self {
-        AnyException::new("RuntimeError", Some(message))
-    }
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    ruby.define_module("TreeSitterAdapter")?
+        .define_module_function("highlight", function!(pub_highlight, 4))
 }

data/ext/tree_sitter_adapter/src/tree_sitter_adapter.rs

@@ -9,6 +9,8 @@ use tree_sitter_highlight::{Error as TSError, HighlightEvent};
 use tree_sitter_highlight::{Highlight, HighlightConfiguration, Highlighter, HtmlRenderer};
 use tree_sitter_loader::{Config, LanguageConfiguration, Loader};
 
+use std::collections::HashSet;
+
 const LOADER_ERROR_MSG: &str = "Error loading Tree-sitter parsers from directory";
 const NO_LANGUAGE_ERROR_MSG: &str = "Error retrieving language configuration for scope";
 const NO_HIGHLIGHT_ERROR_MSG: &str = "Error retrieving highlight configuration for scope";
@@ -58,7 +60,7 @@ fn highlight_configuration<'a>(
     scope: &'a str,
 ) -> Result<&'a HighlightConfiguration> {
     config
-        .highlight_config(language)
+        .highlight_config(language, None)
         .transpose()
         .with_context(|| format!("{NO_HIGHLIGHT_ERROR_MSG} '{scope}'"))
         .flatten_()
@@ -105,10 +107,26 @@ fn render_html(
     Ok(renderer.lines().collect())
 }
 
-fn highlight_names(scope: &str, loader: &Loader) -> Result<Vec<String>> {
+fn highlight_names_for_language(scope: &str, loader: &Loader) -> Result<Vec<String>> {
     let (language, config) = language_and_configuration(loader, scope)?;
     let highlight_config = highlight_configuration(language, config, scope)?;
-    Ok(highlight_config.names().iter().map(String::from).collect())
+    Ok(highlight_config
+        .names()
+        .iter()
+        .map(ToString::to_string)
+        .collect())
+}
+
+fn highlight_names(parser_directory: PathBuf) -> Result<Vec<String>> {
+    let loader = loader(parser_directory)?;
+    let highlight_names = loader
+        .get_all_language_configurations()
+        .into_iter()
+        .flat_map(|(config, _)| config.scope.clone())
+        .flat_map(|scope| highlight_names_for_language(&scope, &loader))
+        .flat_map(Vec::into_iter)
+        .collect::<HashSet<_>>();
+    Ok(highlight_names.into_iter().collect())
 }
 
 fn highlight_name_styles() -> HashMap<String, Style> {
@@ -116,7 +134,7 @@ fn highlight_name_styles() -> HashMap<String, Style> {
     theme
         .highlight_names
         .into_iter()
-        .zip(theme.styles.into_iter())
+        .zip(theme.styles)
         .collect()
 }
 
@@ -146,8 +164,8 @@ fn highlight_adapter(
     css_classes: bool,
 ) -> Result<String> {
     let parsers_dir = PathBuf::from(parsers_dir);
-    let mut loader = loader(parsers_dir)?;
-    let highlight_names = highlight_names(scope, &loader)?;
+    let mut loader = loader(parsers_dir.clone())?;
+    let highlight_names = highlight_names(parsers_dir)?;
     loader.configure_highlights(&highlight_names);
     let (language, config) = language_and_configuration(&loader, scope)?;
     let highlight_config = highlight_configuration(language, config, scope)?;

data/lib/kramdown/syntax_tree_sitter/languages.rb

@@ -45,7 +45,7 @@ module Kramdown
             'source.toml' => %w[toml],
             'source.ts' => %w[ts typescript],
             'source.vhd' => %w[vhdl],
-            'text.html.basic' => %w[html],
+            'source.html' => %w[html],
             'text.html.erb' => %w[erb eruby rhtml]
           }
           .map { |scope, aliases| aliases.map { |alias_| [alias_, scope] } }

data/lib/kramdown/syntax_tree_sitter/version.rb

@@ -5,7 +5,7 @@ module Kramdown
     module SyntaxHighlighter
       module TreeSitter
         # Version of kramdown-syntax_tree_sitter gem
-        VERSION = '0.4.0'
+        VERSION = '0.6.0'
       end
     end
   end

data/lib/tree_sitter_adapter.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Even though this project uses Magnus to handle interoperabilty between Ruby and Rust,
+# the Ruby support library for Rutie still happens to work very well for initializing
+# the internal Rust extension for use by this Ruby library
 require 'rutie'
 
 Rutie.new(:tree_sitter_adapter).init(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-syntax_tree_sitter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew T. Biehl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -52,77 +52,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.18.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.18.0
-- !ruby/object:Gem::Dependency
-  name: rouge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.1.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.50.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.50.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.30.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.30.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-description: 
+description: |-
+  This is a syntax highlighter plugin for Kramdown that leverages Tree-sitter's native syntax highlighter to highlight code blocks (and spans) when rendering HTML.
+
+  Tree-sitter is a modern, general-purpose parsing library that outclasses many existing tools at the task of syntax highlighting. This plugin adapts Tree-sitter's native highlighter for Kramdown, so that Tree-sitter's superior highlighting capabilities can be easily leveraged in the context of rendering Markdown.
 email: 
 executables: []
 extensions:
@@ -147,6 +80,11 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter
+  source_code_uri: https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter
+  documentation_uri: https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter/blob/main/README.md
+  changelog_uri: https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/andrewtbiehl/kramdown-syntax_tree_sitter/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -155,14 +93,19 @@ 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.1
+requirements:
+- |-
+  This plugin is essentially an adapter for the Tree-sitter highlight library and hence requires a compatible Rust installation to function. It is officially compatible with the following environments:
+
+  - Rust: 1.75, 1.76, 1.77, 1.78
+  - Platforms: MacOS, Linux
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Syntax highlight code with Tree-sitter via Kramdown.