commonmarker 1.1.4-x86_64-linux → 2.0.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76ac51301badf10cda7b9a70c0484e3bf04ff83410b98ea9f29548e50c7c7abd
-  data.tar.gz: f9d9c1d2d52a7e5192440e72c7a25f410ad916d3f1a1d103e5aedafc4142b329
+  metadata.gz: c7af2de1f3eb073bdb8810b2adf7dfbddba9ad1c26446d39f49eac5522254bdc
+  data.tar.gz: 4114572af5055bbe9771c4cf1c3128a9f0e9efa8efd14547510c1601e070789a
 SHA512:
-  metadata.gz: 55234cd8e79870d955fd9c1c0729288a9b9d4f90b046860cf799e6e2f4d6f1823db74f6350cdaf76f876117acad34ff2ade02618b71b7c6de2f035069894c2f5
-  data.tar.gz: e26d8a7e28782d590ad4b13cf9075f701b1d7df7e37671daac836c7b9fb3752e5250c88b69dadadcc42ec68d6eed1724a60777b3bde328ee0adade02514adb4f
+  metadata.gz: 82457a7e6eb05c0a2a158d88e25c5dc7c0539a61cc1de6d1f387c45de04494e8193377224401799536d99d5aa3663f8b9a4de344d436d3ead0ca999878af0afb
+  data.tar.gz: 313297b4ae94e4851d4b4a300f80f560eb8e7bbd619b2fbd8f3888bdba35fa054343262e699ddc4bd92576bbdc58fd80d3ea92dda9ddb116bcf209e4002023cc

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,15 +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_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
 
@@ -163,38 +167,48 @@ Note that there is a distinction in comrak for "parse" options and "render" opti
 | -------------------- | ------------------------------------------------------------------------------------------------------ | ------- |
 | `hardbreaks`         | [Soft line breaks](http://spec.commonmark.org/0.27/#soft-line-breaks) translate into hard line breaks. | `true`  |
 | `github_pre_lang`    | GitHub-style `<pre lang="xyz">` is used for fenced code blocks with info tags.                         | `true`  |
+| `full_info_string`   | Gives info string data after a space in a `data-meta` attribute on code blocks.                        | `false` |
 | `width`              | The wrap column when outputting CommonMark.                                                            | `80`    |
 | `unsafe`             | Allow rendering of raw HTML and potentially dangerous links.                                           | `false` |
 | `escape`             | Escape raw HTML instead of clobbering it.                                                              | `false` |
 | `sourcepos`          | Include source position attribute in HTML and XML output.                                              | `false` |
-| `escaped_char_spans` | Wrap escaped characters in span tags                                                                   | `true`  |
+| `escaped_char_spans` | Wrap escaped characters in span tags.                                                                  | `true`  |
+| `ignore_setext`      | Ignores setext-style headings.                                                                         | `false` |
+| `ignore_empty_links` | Ignores empty links, leaving the Markdown text in place.                                               | `false` |
+| `gfm_quirks`         | Outputs HTML with GFM-style quirks; namely, not nesting `<strong>` inlines.                            | `false` |
+| `prefer_fenced`      | Always output fenced code blocks, even where an indented one could be used.                            | `false` |
 
 As well, there are several extensions which you can toggle in the same manner:
 
 ```ruby
 Commonmarker.to_html('"Hi *there*"', options: {
     extension: { footnotes: true, description_lists: true },
-    render: { hardbreaks: false}
+    render: { hardbreaks: false }
 })
 ```
 
 ### 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`  |
-| `autolink`                  | Enables the [autolink extension](https://github.github.com/gfm/#autolinks-extension-) from the GFM spec.            | `true`  |
-| `tasklist`                  | Enables the [task list extension](https://github.github.com/gfm/#task-list-items-extension-) from the GFM spec.     | `true`  |
-| `superscript`               | Enables the superscript Comrak extension.                                                                           | `false` |
-| `header_ids`                | Enables the header IDs Comrak extension. from the GFM spec.                                                         | `""`    |
-| `footnotes`                 | Enables the footnotes extension per `cmark-gfm`.                                                                    | `false` |
-| `description_lists`         | Enables the description lists extension.                                                                            | `false` |
-| `front_matter_delimiter`    | Enables the front matter extension.                                                                                 | `""`    |
-| `shortcodes`                | Enables the shortcodes extension.                                                                                   | `true`  |
-| `multiline_block_quotes`    | Enables the multiline block quotes extension.                                                                       | `false` |
-| `math_dollars`, `math_code` | Enables the math extension.                                                                                         | `false` |
+| 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`  |
+| `autolink`                    | Enables the [autolink extension](https://github.github.com/gfm/#autolinks-extension-) from the GFM spec.            | `true`  |
+| `tasklist`                    | Enables the [task list extension](https://github.github.com/gfm/#task-list-items-extension-) from the GFM spec.     | `true`  |
+| `superscript`                 | Enables the superscript Comrak extension.                                                                           | `false` |
+| `header_ids`                  | Enables the header IDs Comrak extension. from the GFM spec.                                                         | `""`    |
+| `footnotes`                   | Enables the footnotes extension per `cmark-gfm`.                                                                    | `false` |
+| `description_lists`           | Enables the description lists extension.                                                                            | `false` |
+| `front_matter_delimiter`      | Enables the front matter extension.                                                                                 | `""`    |
+| `multiline_block_quotes`      | Enables the multiline block quotes extension.                                                                       | `false` |
+| `math_dollars`, `math_code`   | Enables the math extension.                                                                                         | `false` |
+| `shortcodes`                  | Enables the shortcodes extension.                                                                                   | `true`  |
+| `wikilinks_title_before_pipe` | Enables the wikilinks extension, placing the title before the dividing pipe.                                        | `false` |
+| `wikilinks_title_after_pipe`  | Enables the shortcodes extension, placing the title after the dividing pipe.                                        | `false` |
+| `underline`                   | Enables the underline extension.                                                                                    | `false` |
+| `spoiler`                     | Enables the spoiler extension.                                                                                      | `false` |
+| `greentext`                   | Enables the greentext extension.                                                                                    | `false` |
 
 For more information on these options, see [the comrak documentation](https://github.com/kivikakk/comrak#usage).
 

data/lib/commonmarker/config.rb

@@ -8,16 +8,22 @@ module Commonmarker
       parse: {
         smart: false,
         default_info_string: "",
+        relaxed_tasklist_matching: false,
         relaxed_autolinks: false,
       }.freeze,
       render: {
         hardbreaks: true,
         github_pre_lang: true,
+        full_info_string: false,
         width: 80,
         unsafe: false,
         escape: false,
         sourcepos: false,
         escaped_char_spans: true,
+        ignore_setext: false,
+        ignore_empty_links: false,
+        gfm_quirks: false,
+        prefer_fenced: false,
       }.freeze,
       extension: {
         strikethrough: true,
@@ -30,13 +36,17 @@ module Commonmarker
         footnotes: false,
         description_lists: false,
         front_matter_delimiter: "",
-        shortcodes: true,
         multiline_block_quotes: false,
         math_dollars: false,
         math_code: false,
+        shortcodes: true,
         wikilinks_title_before_pipe: false,
         wikilinks_title_after_pipe: false,
-      },
+        underline: false,
+        spoiler: false,
+        greentext: false,
+        subscript: false,
+      }.freeze,
       format: [:html].freeze,
     }.freeze
 
@@ -50,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]),
@@ -70,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.4"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0
 platform: x86_64-linux
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake