commonmarker 0.23.10 → 2.8.0

data/lib/commonmarker/node.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require "commonmarker/node/ast"
 require "commonmarker/node/inspect"
 
-module CommonMarker
+module Commonmarker
   class Node
     include Enumerable
     include Inspect
@@ -19,65 +20,46 @@ module CommonMarker
       end
     end
 
-    # Public: Convert the node to an HTML string.
-    #
-    # options - A {Symbol} or {Array of Symbol}s indicating the render options
-    # extensions - An {Array of Symbol}s indicating the extensions to use
-    #
-    # Returns a {String}.
-    def to_html(options = :DEFAULT, extensions = [])
-      opts = Config.process_options(options, :render)
-      _render_html(opts, extensions).force_encoding("utf-8")
-    end
+    # Public: Iterate over the children (if any) of the current pointer.
+    def each
+      return enum_for(:each) unless block_given?
 
-    # Public: Convert the node to an XML string.
-    #
-    # options - A {Symbol} or {Array of Symbol}s indicating the render options
-    #
-    # Returns a {String}.
-    def to_xml(options = :DEFAULT)
-      opts = Config.process_options(options, :render)
-      _render_xml(opts).force_encoding("utf-8")
+      child = first_child
+      while child
+        next_child = child.next_sibling
+        yield child
+        child = next_child
+      end
     end
 
-    # Public: Convert the node to a CommonMark string.
+    # Public: Converts a node to an HTML string.
     #
-    # options - A {Symbol} or {Array of Symbol}s indicating the render options
-    # width - Column to wrap the output at
+    # options - A {Hash} of render, parse, and extension options to transform the text.
+    # plugins - A {Hash} of additional plugins.
     #
-    # Returns a {String}.
-    def to_commonmark(options = :DEFAULT, width = 120)
-      opts = Config.process_options(options, :render)
-      _render_commonmark(opts, width).force_encoding("utf-8")
+    # 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(render: opts[:render], parse: opts[:parse], extension: opts[:extension], plugins: plugins).force_encoding("utf-8")
     end
 
-    # Public: Convert the node to a plain text string.
+    # Public: Convert the node to a CommonMark string.
     #
     # options - A {Symbol} or {Array of Symbol}s indicating the render options
-    # width - Column to wrap the output at
+    # plugins - A {Hash} of additional plugins.
     #
     # Returns a {String}.
-    def to_plaintext(options = :DEFAULT, width = 120)
-      opts = Config.process_options(options, :render)
-      _render_plaintext(opts, width).force_encoding("utf-8")
-    end
-
-    # Public: Iterate over the children (if any) of the current pointer.
-    def each
-      return enum_for(:each) unless block_given?
+    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)
 
-      child = first_child
-      while child
-        nextchild = child.next
-        yield child
-        child = nextchild
-      end
-    end
+      opts = Config.process_options(options)
+      plugins = Config.process_plugins(plugins)
 
-    # Deprecated: Please use `each` instead
-    def each_child(&block)
-      warn("[DEPRECATION] `each_child` is deprecated.  Please use `each` instead.")
-      each(&block)
+      node_to_commonmark(render: opts[:render], parse: opts[:parse], extension: opts[:extension], plugins: plugins).force_encoding("utf-8")
     end
   end
 end

data/lib/commonmarker/renderer.rb

@@ -3,133 +3,7 @@
 require "set"
 require "stringio"
 
-module CommonMarker
+module Commonmarker
   class Renderer
-    attr_accessor :in_tight, :warnings, :in_plain
-
-    def initialize(options: :DEFAULT, extensions: [])
-      @opts = Config.process_options(options, :render)
-      @stream = StringIO.new(+"")
-      @need_blocksep = false
-      @warnings = Set.new([])
-      @in_tight = false
-      @in_plain = false
-      @tagfilter = extensions.include?(:tagfilter)
-    end
-
-    def out(*args)
-      args.each do |arg|
-        case arg
-        when :children
-          @node.each { |child| out(child) }
-        when Array
-          arg.each { |x| render(x) }
-        when Node
-          render(arg)
-        else
-          @stream.write(arg)
-        end
-      end
-    end
-
-    def render(node)
-      @node = node
-      if node.type == :document
-        document(node)
-        @stream.string
-      elsif @in_plain && node.type != :text && node.type != :softbreak
-        node.each { |child| render(child) }
-      else
-        begin
-          send(node.type, node)
-        rescue NoMethodError => e
-          @warnings.add("WARNING: #{node.type} not implemented.")
-          raise e
-        end
-      end
-    end
-
-    def document(_node)
-      out(:children)
-    end
-
-    def code_block(node)
-      code_block(node)
-    end
-
-    def reference_def(_node); end
-
-    def cr
-      return if @stream.string.empty? || @stream.string[-1] == "\n"
-
-      out("\n")
-    end
-
-    def blocksep
-      out("\n")
-    end
-
-    def containersep
-      cr unless @in_tight
-    end
-
-    def block
-      cr
-      yield
-      cr
-    end
-
-    def container(starter, ender)
-      out(starter)
-      yield
-      out(ender)
-    end
-
-    def plain
-      old_in_plain = @in_plain
-      @in_plain = true
-      yield
-      @in_plain = old_in_plain
-    end
-
-    private
-
-    def escape_href(str)
-      @node.html_escape_href(str)
-    end
-
-    def escape_html(str)
-      @node.html_escape_html(str)
-    end
-
-    def tagfilter(str)
-      if @tagfilter
-        str.gsub(
-          %r{
-            <
-            (
-            title|textarea|style|xmp|iframe|
-            noembed|noframes|script|plaintext
-            )
-            (?=\s|>|/>)
-          }xi,
-          '&lt;\1',
-        )
-      else
-        str
-      end
-    end
-
-    def sourcepos(node)
-      return "" unless option_enabled?(:SOURCEPOS)
-
-      s = node.sourcepos
-      " data-sourcepos=\"#{s[:start_line]}:#{s[:start_column]}-" \
-        "#{s[:end_line]}:#{s[:end_column]}\""
-    end
-
-    def option_enabled?(opt)
-      (@opts & CommonMarker::Config::OPTS.dig(:render, opt)) != 0
-    end
   end
 end

data/lib/commonmarker/utils.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "commonmarker/constants"
+
+module Commonmarker
+  module Utils
+    include Commonmarker::Constants
+
+    def fetch_kv(options, key, value, type)
+      value_klass = value.class
+
+      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 #{options[key].class}"
+      end
+    end
+  end
+end

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module CommonMarker
-  VERSION = "0.23.10"
+module Commonmarker
+  VERSION = "2.8.0"
 end

data/lib/commonmarker.rb

@@ -1,45 +1,47 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "commonmarker/commonmarker"
-require "commonmarker/config"
+require_relative "commonmarker/extension"
+
+require "commonmarker/utils"
 require "commonmarker/node"
+require "commonmarker/config"
 require "commonmarker/renderer"
-require "commonmarker/renderer/html_renderer"
 require "commonmarker/version"
 
-begin
-  require "awesome_print"
-rescue LoadError; end # rubocop:disable Lint/SuppressedException
-module CommonMarker
+module Commonmarker
   class << self
-    # Public:  Parses a Markdown string into an HTML string.
+    # Public: Parses a CommonMark string into an HTML string.
     #
     # text - A {String} of text
-    # option - Either a {Symbol} or {Array of Symbol}s indicating the render options
-    # extensions - An {Array of Symbol}s indicating the extensions to use
+    # options - A {Hash} of render, parse, and extension options to transform the text.
     #
-    # Returns a {String} of converted HTML.
-    def render_html(text, options = :DEFAULT, extensions = [])
+    # 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)
 
-      opts = Config.process_options(options, :render)
-      Node.markdown_to_html(text.encode("UTF-8"), opts, extensions)
+      commonmark_parse(text, parse: opts.fetch(:parse, {}), render: opts.fetch(:render, {}), extension: opts.fetch(:extension, {}))
     end
 
-    # Public: Parses a Markdown string into a `document` node.
+    # Public: Parses a CommonMark string into an HTML string.
     #
-    # string - {String} to be parsed
-    # option - A {Symbol} or {Array of Symbol}s indicating the parse options
-    # extensions - An {Array of Symbol}s indicating the extensions to use
+    # text - A {String} of text
+    # options - A {Hash} of render, parse, and extension options to transform the text.
+    # plugins - A {Hash} of additional plugins.
     #
-    # Returns the `document` node.
-    def render_doc(text, options = :DEFAULT, extensions = [])
+    # Returns a {String} of converted HTML.
+    def to_html(text, options: Commonmarker::Config::OPTIONS, plugins: Commonmarker::Config::PLUGINS)
       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, :parse)
-      text = text.encode("UTF-8")
-      Node.parse_document(text, text.bytesize, opts, extensions)
+      opts = Config.process_options(options)
+      plugins = Config.process_plugins(plugins)
+
+      commonmark_to_html(text, parse: opts.fetch(:parse, {}), render: opts.fetch(:render, {}), extension: opts.fetch(:extension, {}), plugins: plugins)
     end
-end
+  end
 end

metadata

@@ -1,262 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.23.10
+  version: 2.8.0
 platform: ruby
 authors:
 - Garen Torikian
 - Ashe Connor
-autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: json
+  name: rb_sys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
+        version: '0.9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A fast, safe, extensible parser for CommonMark. This wraps the official
-  libcmark library.
-email: 
-executables:
-- commonmarker
+        version: '1.2'
+description: A fast, safe, extensible parser for CommonMark. This wraps the comrak
+  Rust crate.
+executables: []
 extensions:
 - ext/commonmarker/extconf.rb
 extra_rdoc_files: []
 files:
+- Cargo.lock
+- Cargo.toml
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/commonmarker
-- commonmarker.gemspec
-- ext/commonmarker/arena.c
-- ext/commonmarker/autolink.c
-- ext/commonmarker/autolink.h
-- ext/commonmarker/blocks.c
-- ext/commonmarker/buffer.c
-- ext/commonmarker/buffer.h
-- ext/commonmarker/case_fold_switch.inc
-- ext/commonmarker/chunk.h
-- ext/commonmarker/cmark-gfm-core-extensions.h
-- ext/commonmarker/cmark-gfm-extension_api.h
-- ext/commonmarker/cmark-gfm-extensions_export.h
-- ext/commonmarker/cmark-gfm.h
-- ext/commonmarker/cmark-gfm_export.h
-- ext/commonmarker/cmark-gfm_version.h
-- ext/commonmarker/cmark.c
-- ext/commonmarker/cmark_ctype.c
-- ext/commonmarker/cmark_ctype.h
-- ext/commonmarker/commonmark.c
-- ext/commonmarker/commonmarker.c
-- ext/commonmarker/commonmarker.h
-- ext/commonmarker/config.h
-- ext/commonmarker/core-extensions.c
-- ext/commonmarker/entities.inc
-- ext/commonmarker/ext_scanners.c
-- ext/commonmarker/ext_scanners.h
+- ext/commonmarker/Cargo.toml
+- ext/commonmarker/build.rs
 - ext/commonmarker/extconf.rb
-- ext/commonmarker/footnotes.c
-- ext/commonmarker/footnotes.h
-- ext/commonmarker/houdini.h
-- ext/commonmarker/houdini_href_e.c
-- ext/commonmarker/houdini_html_e.c
-- ext/commonmarker/houdini_html_u.c
-- ext/commonmarker/html.c
-- ext/commonmarker/html.h
-- ext/commonmarker/inlines.c
-- ext/commonmarker/inlines.h
-- ext/commonmarker/iterator.c
-- ext/commonmarker/iterator.h
-- ext/commonmarker/latex.c
-- ext/commonmarker/linked_list.c
-- ext/commonmarker/man.c
-- ext/commonmarker/map.c
-- ext/commonmarker/map.h
-- ext/commonmarker/node.c
-- ext/commonmarker/node.h
-- ext/commonmarker/parser.h
-- ext/commonmarker/plaintext.c
-- ext/commonmarker/plugin.c
-- ext/commonmarker/plugin.h
-- ext/commonmarker/references.c
-- ext/commonmarker/references.h
-- ext/commonmarker/registry.c
-- ext/commonmarker/registry.h
-- ext/commonmarker/render.c
-- ext/commonmarker/render.h
-- ext/commonmarker/scanners.c
-- ext/commonmarker/scanners.h
-- ext/commonmarker/scanners.re
-- ext/commonmarker/strikethrough.c
-- ext/commonmarker/strikethrough.h
-- ext/commonmarker/syntax_extension.c
-- ext/commonmarker/syntax_extension.h
-- ext/commonmarker/table.c
-- ext/commonmarker/table.h
-- ext/commonmarker/tagfilter.c
-- ext/commonmarker/tagfilter.h
-- ext/commonmarker/tasklist.c
-- ext/commonmarker/tasklist.h
-- ext/commonmarker/utf8.c
-- ext/commonmarker/utf8.h
-- ext/commonmarker/xml.c
+- 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
+- ext/commonmarker/src/utils.rs
 - lib/commonmarker.rb
 - 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/renderer/html_renderer.rb
+- lib/commonmarker/utils.rb
 - lib/commonmarker/version.rb
 homepage: https://github.com/gjtorikian/commonmarker
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
+  funding_uri: https://github.com/sponsors/gjtorikian/
+  source_code_uri: https://github.com/gjtorikian/commonmarker
   rubygems_mfa_required: 'true'
-post_install_message: 
-rdoc_options:
-- "-x"
-- ext/commonmarker/cmark/.*
+rdoc_options: []
 require_paths:
 - lib
-- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '4.0'
+      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
-summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
+summary: CommonMark parser and renderer. Written in Rust, wrapped in Ruby.
 test_files: []