commonmarker 1.1.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68467a1bf2ae449bfb07febbb6559778974b81d6c6df5a2a1a7022efff846000
-  data.tar.gz: a97250f78127cb2277e5727c573ca41482971f25df88e8516f6ba0176ea49ebd
+  metadata.gz: 7824257cc0655cb8eb286333f015e6542cc4666602675e86d969a4c565f8d4d9
+  data.tar.gz: 8eb3a39a2d10fc90e0cea2a578e4040a43a16771586bf8bb09a3706fe45b8eda
 SHA512:
-  metadata.gz: 72709d354fc8d476285642e9a32ed575189f318941e736f4829470bf7bf42fc47506a6f2912d1f3c5a5f1b436f56c81ce251cd94937eb2907b659837621573a7
-  data.tar.gz: bedc677e77ce171e5f0f8d40493178598af42aa27a59b5939adba35d1022f8cca957ab8153c2362d406d8df8962a558e88a8a2d52f4e7d30829c99be37ea4d0e
+  metadata.gz: b84b895cc30fc1817fc96639c774878127b82ff1e36e7cfc5ace170497bc2167bc734e212aab70cd6986df74ed7a223853e324c00bd51846a46107911da0f725
+  data.tar.gz: 723eef2b963100c97af949dd9b2db1b21bdd5a52b0dfb82f18b23c181c7b128681b96358dcb792554afd79b13cc2829bef543e26d506f7d803dfc62db8a598dd

data/Cargo.lock

@@ -128,6 +128,31 @@ version = "2.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de"
 
+[[package]]
+name = "bon"
+version = "3.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a636f83af97c6946f3f5cf5c268ec02375bf5efd371110292dfd57961f57a509"
+dependencies = [
+ "bon-macros",
+ "rustversion",
+]
+
+[[package]]
+name = "bon-macros"
+version = "3.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a7eaf1bfaa5b8d512abfd36d0c432591fef139d3de9ee54f1f839ea109d70d33"
+dependencies = [
+ "darling",
+ "ident_case",
+ "prettyplease",
+ "proc-macro2",
+ "quote",
+ "rustversion",
+ "syn",
+]
+
 [[package]]
 name = "bumpalo"
 version = "3.16.0"
@@ -237,13 +262,13 @@ dependencies = [
 
 [[package]]
 name = "comrak"
-version = "0.26.0"
+version = "0.30.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "395ab67843c57df5a4ee29d610740828dbc928cc64ecf0f2a1d5cd0e98e107a9"
+checksum = "949f8e6b02ebac005a8be2df9ec0876cafc83fdb9c510796c37f0fadf92dcd0e"
 dependencies = [
+ "bon",
  "caseless",
  "clap",
- "derive_builder",
  "emojis",
  "entities",
  "memchr",
@@ -310,37 +335,6 @@ dependencies = [
  "powerfmt",
 ]
 
-[[package]]
-name = "derive_builder"
-version = "0.20.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0350b5cb0331628a5916d6c5c0b72e97393b8b6b03b47a9284f4e7f5a405ffd7"
-dependencies = [
- "derive_builder_macro",
-]
-
-[[package]]
-name = "derive_builder_core"
-version = "0.20.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d48cda787f839151732d396ac69e3473923d54312c070ee21e9effcaa8ca0b1d"
-dependencies = [
- "darling",
- "proc-macro2",
- "quote",
- "syn",
-]
-
-[[package]]
-name = "derive_builder_macro"
-version = "0.20.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "206868b8242f27cecce124c19fd88157fbd0dd334df2587f36417bafbc85097b"
-dependencies = [
- "derive_builder_core",
- "syn",
-]
-
 [[package]]
 name = "deunicode"
 version = "1.6.0"
@@ -642,11 +636,21 @@ version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "439ee305def115ba05938db6eb1644ff94165c5ab5e9420d1c1bcedbba909391"
 
+[[package]]
+name = "prettyplease"
+version = "0.2.25"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "64d1ec885c64d0457d564db4ec299b2dae3f9c02808b8ad9c3a089c591b18033"
+dependencies = [
+ "proc-macro2",
+ "syn",
+]
+
 [[package]]
 name = "proc-macro2"
-version = "1.0.86"
+version = "1.0.92"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77"
+checksum = "37d3544b3f2748c54e147655edb5025752e2303145b5aefb3c3ea2c78b973bb0"
 dependencies = [
  "unicode-ident",
 ]
@@ -671,18 +675,18 @@ dependencies = [
 
 [[package]]
 name = "rb-sys"
-version = "0.9.99"
+version = "0.9.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d83151cfea2b67db2444f68c53b119ff77cff235ad711c765072e4daf8f3185b"
+checksum = "91dbe37ab6ac2fba187480fb6544b92445e41e5c6f553bf0c33743f3c450a1df"
 dependencies = [
  "rb-sys-build",
 ]
 
 [[package]]
 name = "rb-sys-build"
-version = "0.9.99"
+version = "0.9.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "32d038214c118ad4a75db555ccb78672e17e1c5c10f344456cd129008dbaa7de"
+checksum = "c4d56a49dcb646b70b758789c0d16c055a386a4f2a3346333abb69850fa860ce"
 dependencies = [
  "bindgen",
  "lazy_static",
@@ -753,6 +757,12 @@ dependencies = [
  "windows-sys 0.52.0",
 ]
 
+[[package]]
+name = "rustversion"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0e819f2bc632f285be6d7cd36e25940d45b2391dd6d9b939e79de557f7014248"
+
 [[package]]
 name = "ryu"
 version = "1.0.18"
@@ -842,9 +852,9 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
 
 [[package]]
 name = "syn"
-version = "2.0.72"
+version = "2.0.89"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dc4b9b9bf2add8093d3f2c0204471e951b2285580335de42f9d2534f3ae7a8af"
+checksum = "44d46482f1c1c87acd84dea20c1bf5ebff4c757009ed6bf19cfd36fb10e92c4e"
 dependencies = [
  "proc-macro2",
  "quote",

data/README.md

@@ -4,7 +4,10 @@ Ruby wrapper for Rust's [comrak](https://github.com/kivikakk/comrak) crate.
 
 It passes all of the CommonMark test suite, and is therefore spec-complete. It also includes extensions to the CommonMark spec as documented in the [GitHub Flavored Markdown spec](http://github.github.com/gfm/), such as support for tables, strikethroughs, and autolinking.
 
-For more information on available extensions, see [the documentation below](#extension-options).
+> [!NOTE]
+> By default, several extensions not in any spec have been enabled, for the sake of end user convenience when generating HTML.
+>
+> For more information on the available options and extensions, see [the documentation below](#options-and-plugins).
 
 ## Installation
 
@@ -86,7 +89,7 @@ You can also modify the following attributes:
 You can use `walk` or `each` to iterate over nodes:
 
 - `walk` will iterate on a node and recursively iterate on a node's children.
-- `each` will iterate on a node and its children, but no further.
+- `each` will iterate on a node's direct children, but no further.
 
 ```ruby
 require 'commonmarker'
@@ -147,16 +150,16 @@ Commonmarker.to_html('"Hi *there*"', options:{
 })
 ```
 
-Note that there is a distinction in comrak for "parse" options and "render" options, which are represented in the tables below.
+Note that there is a distinction in comrak for "parse" options and "render" options, which are represented in the tables below. As well, if you wish to disable any-non boolean option, pass in `nil`.
 
 ### Parse options
 
-| Name                          | Description                                                                                                                                 | Default |
-| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| `smart`                       | Punctuation (quotes, full-stops and hyphens) are converted into 'smart' punctuation.                                                        | `false` |
-| `default_info_string`         | The default info string for fenced code blocks.                                                                                             | `""`    |
-| `relaxed_tasklist_matching`   | Enables relaxing of the tasklist extension matching, allowing any non-space to be used for the "checked" state instead of only `x` and `X`. | `false` |
-| `relaxed_autolinks`           | Enable relaxing of the autolink extension parsing, allowing links to be recognized when in brackets, as well as permitting any url scheme.  | `false` |
+| Name                        | Description                                                                                                                                 | Default |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `smart`                     | Punctuation (quotes, full-stops and hyphens) are converted into 'smart' punctuation.                                                        | `false` |
+| `default_info_string`       | The default info string for fenced code blocks.                                                                                             | `""`    |
+| `relaxed_tasklist_matching` | Enables relaxing of the tasklist extension matching, allowing any non-space to be used for the "checked" state instead of only `x` and `X`. | `false` |
+| `relaxed_autolinks`         | Enable relaxing of the autolink extension parsing, allowing links to be recognized when in brackets, as well as permitting any url scheme.  | `false` |
 
 ### Render options
 
@@ -187,7 +190,7 @@ Commonmarker.to_html('"Hi *there*"', options: {
 ### Extension options
 
 | Name                          | Description                                                                                                         | Default |
-| ---------------------------   | ------------------------------------------------------------------------------------------------------------------- | ------- |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------- |
 | `strikethrough`               | Enables the [strikethrough extension](https://github.github.com/gfm/#strikethrough-extension-) from the GFM spec.   | `true`  |
 | `tagfilter`                   | Enables the [tagfilter extension](https://github.github.com/gfm/#disallowed-raw-html-extension-) from the GFM spec. | `true`  |
 | `table`                       | Enables the [table extension](https://github.github.com/gfm/#tables-extension-) from the GFM spec.                  | `true`  |

data/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.26", features = ["shortcodes"] }
+comrak = { version = "0.30", features = ["shortcodes"] }
 syntect = { version = "5.2", features = ["plist-load"] }
 typed-arena = "2.0"
 rctree = "0.6"

data/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 {

data/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"),
         }

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

data/lib/commonmarker/config.rb

@@ -45,7 +45,8 @@ module Commonmarker
         underline: false,
         spoiler: false,
         greentext: false,
-      },
+        subscript: false,
+      }.freeze,
       format: [:html].freeze,
     }.freeze
 
@@ -59,10 +60,6 @@ module Commonmarker
     class << self
       include Commonmarker::Utils
 
-      def merged_with_defaults(options)
-        Commonmarker::Config::OPTIONS.merge(process_options(options))
-      end
-
       def process_options(options)
         {
           parse: process_parse_options(options[:parse]),
@@ -79,37 +76,30 @@ module Commonmarker
     end
 
     [:parse, :render, :extension].each do |type|
-      define_singleton_method :"process_#{type}_options" do |option|
+      define_singleton_method :"process_#{type}_options" do |options|
         Commonmarker::Config::OPTIONS[type].each_with_object({}) do |(key, value), hash|
-          if option.nil? # option not provided, go for the default
+          if options.nil? || !options.key?(key) # option not provided, use the default
             hash[key] = value
             next
           end
 
-          # option explicitly not included, remove it
-          next if option[key].nil?
+          if options[key].nil? # # option explicitly not included, remove it
+            options.delete(key)
+            next
+          end
 
-          hash[key] = fetch_kv(option, key, value, type)
+          hash[key] = fetch_kv(options, key, value, type)
         end
       end
     end
 
-    [:syntax_highlighter].each do |type|
-      define_singleton_method :"process_#{type}_plugin" do |plugin|
-        return if plugin.nil? # plugin explicitly nil, remove it
+    define_singleton_method :process_syntax_highlighter_plugin do |options|
+      return if options.nil? # plugin explicitly nil, remove it
 
-        Commonmarker::Config::PLUGINS[type].each_with_object({}) do |(key, value), hash|
-          if plugin.nil? # option not provided, go for the default
-            hash[key] = value
-            next
-          end
+      raise TypeError, "Expected a Hash for syntax_highlighter plugin, got #{options.class}" unless options.is_a?(Hash)
+      raise TypeError, "Expected a Hash for syntax_highlighter plugin, got nothing" if options.empty?
 
-          # option explicitly not included, remove it
-          next if plugin[key].nil?
-
-          hash[key] = fetch_kv(plugin, key, value, type)
-        end
-      end
+      Commonmarker::Config::PLUGINS[:syntax_highlighter].merge(options)
     end
   end
 end

data/lib/commonmarker/utils.rb

@@ -6,16 +6,16 @@ module Commonmarker
   module Utils
     include Commonmarker::Constants
 
-    def fetch_kv(option, key, value, type)
+    def fetch_kv(options, key, value, type)
       value_klass = value.class
 
-      if Constants::BOOLS.include?(value) && BOOLS.include?(option[key])
-        option[key]
-      elsif option[key].is_a?(value_klass)
-        option[key]
+      if Constants::BOOLS.include?(value) && BOOLS.include?(options[key])
+        options[key]
+      elsif options[key].is_a?(value_klass)
+        options[key]
       else
         expected_type = Constants::BOOLS.include?(value) ? "Boolean" : value_klass.to_s
-        raise TypeError, "#{type} option `:#{key}` must be #{expected_type}; got #{option[key].class}"
+        raise TypeError, "#{type} option `:#{key}` must be #{expected_type}; got #{options[key].class}"
       end
     end
   end

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commonmarker
-  VERSION = "1.1.5"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys