Merge pull request #321 from gjtorikian/dependabot/cargo/comrak-0.30.0

Bump comrak from 0.29.0 to 0.30.0
gjtorikian · Nov 25, 2024 · f3cfd2c · f3cfd2c
2 parents 3a76383 + 4a2cdbe
commit f3cfd2c
Show file tree

Hide file tree

Showing 8 changed files with 79 additions and 42 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/ext/commonmarker/Cargo.toml b/ext/commonmarker/Cargo.toml
@@ -10,7 +10,7 @@ magnus = { version = "0.7", features = ["rb-sys"] }
 rb-sys = { version = "*", default-features = false, features = [
     "stable-api-compiled-fallback",
 ] }
-comrak = { version = "0.29", features = ["shortcodes"] }
+comrak = { version = "0.30", features = ["shortcodes"] }
 syntect = { version = "5.2", features = ["plist-load"] }
 typed-arena = "2.0"
 rctree = "0.6"

diff --git a/ext/commonmarker/src/lib.rs b/ext/commonmarker/src/lib.rs
@@ -76,7 +76,7 @@ fn commonmark_to_html(args: &[Value]) -> Result<String, magnus::Error> {
     ))
 }
 
-fn format_options<'c>(rb_options: Option<RHash>) -> Result<comrak::Options<'c>, magnus::Error> {
+fn format_options(rb_options: Option<RHash>) -> Result<comrak::Options, magnus::Error> {
     let mut comrak_options = ComrakOptions::default();
 
     if let Some(rb_options) = rb_options {

diff --git a/ext/commonmarker/src/node.rs b/ext/commonmarker/src/node.rs
@@ -66,6 +66,7 @@ impl CommonmarkerNode {
                         Option<String>,
                         Option<u8>,
                         Option<bool>,
+                        Option<bool>,
                     ),
                     (),
                 >(
@@ -78,11 +79,12 @@ impl CommonmarkerNode {
                         "delimiter",
                         "bullet_char",
                         "tight",
+                        "task_list",
                     ],
                 )?;
 
                 let (list_type,) = kwargs.required;
-                let (marker_offset, padding, start, delimiter, bullet_char, tight) =
+                let (marker_offset, padding, start, delimiter, bullet_char, tight, task_list) =
                     kwargs.optional;
 
                 let commonmark_list_type = list_type.to_string();
@@ -121,6 +123,7 @@ impl CommonmarkerNode {
                     // Whether the list is [tight](https://github.github.com/gfm/#tight), i.e. whether the
                     // paragraphs are wrapped in `<p>` tags when formatted as HTML.
                     tight: tight.unwrap_or(false),
+                    is_task_list: task_list.unwrap_or(false),
                 })
             }
             "description_list" => ComrakNodeValue::DescriptionList,
@@ -335,6 +338,7 @@ impl CommonmarkerNode {
             "strong" => ComrakNodeValue::Strong,
             "strikethrough" => ComrakNodeValue::Strikethrough,
             "superscript" => ComrakNodeValue::Superscript,
+            "subscript" => ComrakNodeValue::Subscript,
             "link" => {
                 let kwargs = scan_args::get_kwargs::<_, (String,), (Option<String>,), ()>(
                     args.keywords,
@@ -462,6 +466,7 @@ impl CommonmarkerNode {
 
                 ComrakNodeValue::WikiLink(NodeWikiLink { url })
             }
+
             _ => panic!("unknown node type {}", node_type),
         };
 
@@ -550,6 +555,7 @@ impl CommonmarkerNode {
             ComrakNodeValue::Math(..) => Symbol::new("math"),
             ComrakNodeValue::WikiLink(..) => Symbol::new("wikilink"),
             ComrakNodeValue::Underline => Symbol::new("underline"),
+            ComrakNodeValue::Subscript => Symbol::new("subscript"),
             ComrakNodeValue::SpoileredText => Symbol::new("spoilered_text"),
             ComrakNodeValue::EscapedTag(_) => Symbol::new("escaped_tag"),
         }

diff --git a/ext/commonmarker/src/options.rs b/ext/commonmarker/src/options.rs
@@ -116,6 +116,7 @@ const EXTENSION_WIKILINKS_TITLE_BEFORE_PIPE: &str = "wikilinks_title_before_pipe
 const EXTENSION_UNDERLINE: &str = "underline";
 const EXTENSION_SPOILER: &str = "spoiler";
 const EXTENSION_GREENTEXT: &str = "greentext";
+const EXTENSION_SUBSCRIPT: &str = "subscript";
 
 fn iterate_extension_options(comrak_options: &mut ComrakOptions, options_hash: RHash) {
     options_hash
@@ -185,6 +186,9 @@ fn iterate_extension_options(comrak_options: &mut ComrakOptions, options_hash: R
                 Ok(Cow::Borrowed(EXTENSION_GREENTEXT)) => {
                     comrak_options.extension.greentext = TryConvert::try_convert(value)?;
                 }
+                Ok(Cow::Borrowed(EXTENSION_SUBSCRIPT)) => {
+                    comrak_options.extension.subscript = TryConvert::try_convert(value)?;
+                }
                 _ => {}
             }
             Ok(ForEach::Continue)

diff --git a/lib/commonmarker/config.rb b/lib/commonmarker/config.rb
@@ -45,6 +45,7 @@ module Config
         underline: false,
         spoiler: false,
         greentext: false,
+        subscript: false,
       }.freeze,
       format: [:html].freeze,
     }.freeze

diff --git a/test/extensions_test.rb b/test/extensions_test.rb
@@ -76,4 +76,20 @@ def test_can_disable_emoji_renders
       Commonmarker.to_html("Happy Friday! :smile:", options: options),
     )
   end
+
+  def test_subscript_disabled_by_default
+    assert_equal(
+      "<p><del>H<del>2</del>O</del></p>\n",
+      Commonmarker.to_html("~~H~2~O~~"),
+    )
+  end
+
+  def test_can_support_subscript
+    options = { extension: { subscript: true } }
+
+    assert_equal(
+      "<p><del>H<sub>2</sub>O</del></p>\n",
+      Commonmarker.to_html("~~H~2~O~~", options: options),
+    )
+  end
 end
diff --git a/test/node_test.rb b/test/node_test.rb
@@ -74,7 +74,7 @@ def test_can_render_back_to_commonmark
 
     assert(@document.first_child.first_child.replace(strikethrough_node))
 
-    assert_match(/~bazinga~\*there\*/, @document.to_commonmark)
+    assert_match(/~~bazinga~~\*there\*/, @document.to_commonmark)
   end
 
   def test_last_child