commonmarker 1.0.4 → 1.1.0

data/ext/commonmarker/src/options.rs

@@ -10,6 +10,7 @@ use crate::utils::try_convert_string;
 
 const PARSE_SMART: &str = "smart";
 const PARSE_DEFAULT_INFO_STRING: &str = "default_info_string";
+const PARSE_RELAXED_AUTOLINKS: &str = "relaxed_autolinks";
 
 fn iterate_parse_options(comrak_options: &mut ComrakOptions, options_hash: RHash) {
     options_hash
@@ -21,6 +22,9 @@ fn iterate_parse_options(comrak_options: &mut ComrakOptions, options_hash: RHash
                 Ok(Cow::Borrowed(PARSE_DEFAULT_INFO_STRING)) => {
                     comrak_options.parse.default_info_string = try_convert_string(value);
                 }
+                Ok(Cow::Borrowed(PARSE_RELAXED_AUTOLINKS)) => {
+                    comrak_options.parse.relaxed_autolinks = TryConvert::try_convert(value)?;
+                }
                 _ => {}
             }
             Ok(ForEach::Continue)
@@ -34,6 +38,7 @@ const RENDER_WIDTH: &str = "width";
 const RENDER_UNSAFE: &str = "unsafe";
 const RENDER_ESCAPE: &str = "escape";
 const RENDER_SOURCEPOS: &str = "sourcepos";
+const RENDER_ESCAPED_CHAR_SPANS: &str = "escaped_char_spans";
 
 fn iterate_render_options(comrak_options: &mut ComrakOptions, options_hash: RHash) {
     options_hash
@@ -57,6 +62,9 @@ fn iterate_render_options(comrak_options: &mut ComrakOptions, options_hash: RHas
                 Ok(Cow::Borrowed(RENDER_SOURCEPOS)) => {
                     comrak_options.render.sourcepos = TryConvert::try_convert(value)?;
                 }
+                Ok(Cow::Borrowed(RENDER_ESCAPED_CHAR_SPANS)) => {
+                    comrak_options.render.escaped_char_spans = TryConvert::try_convert(value)?;
+                }
                 _ => {}
             }
             Ok(ForEach::Continue)
@@ -75,6 +83,9 @@ const EXTENSION_FOOTNOTES: &str = "footnotes";
 const EXTENSION_DESCRIPTION_LISTS: &str = "description_lists";
 const EXTENSION_FRONT_MATTER_DELIMITER: &str = "front_matter_delimiter";
 const EXTENSION_SHORTCODES: &str = "shortcodes";
+const EXTENSION_MULTILINE_BLOCK_QUOTES: &str = "multiline_block_quotes";
+const EXTENSION_MATH_DOLLARS: &str = "math_dollars";
+const EXTENSION_MATH_CODE: &str = "math_code";
 
 fn iterate_extension_options(comrak_options: &mut ComrakOptions, options_hash: RHash) {
     options_hash
@@ -117,6 +128,16 @@ fn iterate_extension_options(comrak_options: &mut ComrakOptions, options_hash: R
                 Ok(Cow::Borrowed(EXTENSION_SHORTCODES)) => {
                     comrak_options.extension.shortcodes = TryConvert::try_convert(value)?;
                 }
+                Ok(Cow::Borrowed(EXTENSION_MULTILINE_BLOCK_QUOTES)) => {
+                    comrak_options.extension.multiline_block_quotes =
+                        TryConvert::try_convert(value)?;
+                }
+                Ok(Cow::Borrowed(EXTENSION_MATH_DOLLARS)) => {
+                    comrak_options.extension.math_dollars = TryConvert::try_convert(value)?;
+                }
+                Ok(Cow::Borrowed(EXTENSION_MATH_CODE)) => {
+                    comrak_options.extension.math_code = TryConvert::try_convert(value)?;
+                }
                 _ => {}
             }
             Ok(ForEach::Continue)

data/lib/commonmarker/config.rb

@@ -8,6 +8,7 @@ module Commonmarker
       parse: {
         smart: false,
         default_info_string: "",
+        relaxed_autolinks: false,
       }.freeze,
       render: {
         hardbreaks: true,
@@ -16,6 +17,7 @@ module Commonmarker
         unsafe: false,
         escape: false,
         sourcepos: false,
+        escaped_char_spans: true,
       }.freeze,
       extension: {
         strikethrough: true,
@@ -29,6 +31,9 @@ module Commonmarker
         description_lists: false,
         front_matter_delimiter: "",
         shortcodes: true,
+        multiline_block_quotes: false,
+        math_dollars: false,
+        math_code: false,
       },
       format: [:html].freeze,
     }.freeze

data/lib/commonmarker/node/ast.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Commonmarker
+  class Node
+    class Ast
+    end
+  end
+end

data/lib/commonmarker/node/inspect.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "pp"
+
+module Commonmarker
+  class Node
+    module Inspect
+      PP_INDENT_SIZE = 2
+
+      def inspect
+        PP.pp(self, +"", Float::INFINITY)
+      end
+
+      # @param printer [PrettyPrint] pp
+      def pretty_print(printer)
+        printer.group(PP_INDENT_SIZE, "#<#{self.class}(#{type}):", ">") do
+          printer.breakable
+
+          attrs = [
+            :source_position,
+            :string_content,
+            :url,
+            :title,
+            :header_level,
+            :list_type,
+            :list_start,
+            :list_tight,
+            :fence_info,
+          ].filter_map do |name|
+            [name, __send__(name)]
+          rescue StandardError
+            nil
+          end.compact
+
+          printer.seplist(attrs) do |name, value|
+            printer.text("#{name}=")
+            printer.pp(value)
+          end
+
+          if first_child
+            printer.breakable
+            printer.group(PP_INDENT_SIZE) do
+              children = []
+              node = first_child
+              while node
+                children << node
+                node = node.next_sibling
+              end
+              printer.text("children=")
+              printer.pp(children)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/commonmarker/node.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "commonmarker/node/ast"
+require "commonmarker/node/inspect"
+
+module Commonmarker
+  class Node
+    include Enumerable
+    include Inspect
+
+    # Public: An iterator that "walks the tree," descending into children recursively.
+    #
+    # blk - A {Proc} representing the action to take for each child
+    def walk(&block)
+      return enum_for(:walk) unless block
+
+      yield self
+      each do |child|
+        child.walk(&block)
+      end
+    end
+
+    # Public: Iterate over the children (if any) of the current pointer.
+    def each
+      return enum_for(:each) unless block_given?
+
+      child = first_child
+      while child
+        next_child = child.next_sibling
+        yield child
+        child = next_child
+      end
+    end
+
+    # Public: Converts a node to an HTML string.
+    #
+    # options - A {Hash} of render, parse, and extension options to transform the text.
+    # plugins - A {Hash} of additional plugins.
+    #
+    # Returns a {String} of HTML.
+    def to_html(options: Commonmarker::Config::OPTIONS, plugins: Commonmarker::Config::PLUGINS)
+      raise TypeError, "options must be a Hash; got a #{options.class}!" unless options.is_a?(Hash)
+
+      opts = Config.process_options(options)
+      plugins = Config.process_plugins(plugins)
+
+      node_to_html(options: opts, plugins: plugins).force_encoding("utf-8")
+    end
+
+    # Public: Convert the node to a CommonMark string.
+    #
+    # options - A {Symbol} or {Array of Symbol}s indicating the render options
+    # plugins - A {Hash} of additional plugins.
+    #
+    # Returns a {String}.
+    def to_commonmark(options: Commonmarker::Config::OPTIONS, plugins: Commonmarker::Config::PLUGINS)
+      raise TypeError, "options must be a Hash; got a #{options.class}!" unless options.is_a?(Hash)
+
+      opts = Config.process_options(options)
+      plugins = Config.process_plugins(plugins)
+
+      node_to_commonmark(options: opts, plugins: plugins).force_encoding("utf-8")
+    end
+  end
+end

data/lib/commonmarker/version.rb

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

data/lib/commonmarker.rb

@@ -3,12 +3,29 @@
 require_relative "commonmarker/extension"
 
 require "commonmarker/utils"
+require "commonmarker/node"
 require "commonmarker/config"
 require "commonmarker/renderer"
 require "commonmarker/version"
 
 module Commonmarker
   class << self
+    # Public: Parses a CommonMark string into an HTML string.
+    #
+    # text - A {String} of text
+    # options - A {Hash} of render, parse, and extension options to transform the text.
+    #
+    # Returns the `parser` node.
+    def parse(text, options: Commonmarker::Config::OPTIONS)
+      raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)
+      raise TypeError, "text must be UTF-8 encoded; got #{text.encoding}!" unless text.encoding.name == "UTF-8"
+      raise TypeError, "options must be a Hash; got a #{options.class}!" unless options.is_a?(Hash)
+
+      opts = Config.process_options(options)
+
+      commonmark_parse(text, options: opts)
+    end
+
     # Public: Parses a CommonMark string into an HTML string.
     #
     # text - A {String} of text

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-03 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -69,6 +69,7 @@ files:
 - ext/commonmarker/Cargo.toml
 - ext/commonmarker/extconf.rb
 - ext/commonmarker/src/lib.rs
+- ext/commonmarker/src/node.rs
 - ext/commonmarker/src/options.rs
 - ext/commonmarker/src/plugins.rs
 - ext/commonmarker/src/plugins/syntax_highlighting.rs
@@ -77,6 +78,9 @@ files:
 - lib/commonmarker/config.rb
 - lib/commonmarker/constants.rb
 - lib/commonmarker/extension.rb
+- lib/commonmarker/node.rb
+- lib/commonmarker/node/ast.rb
+- lib/commonmarker/node/inspect.rb
 - lib/commonmarker/renderer.rb
 - lib/commonmarker/utils.rb
 - lib/commonmarker/version.rb