commonmarker 0.21.2 → 0.23.2

data/lib/commonmarker/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'commonmarker/node/inspect'
+
+module CommonMarker
+  class RenderError < StandardError
+    PREAMBLE = 'There was an error rendering'
+    def initialize(error)
+      super("#{PREAMBLE}: #{error.class} #{error.message}")
+    end
+  end
+end

data/lib/commonmarker/node/inspect.rb

@@ -27,11 +27,9 @@ module CommonMarker
             list_tight
             fence_info
           ].map do |name|
-            begin
-              [name, __send__(name)]
-            rescue NodeError
-              nil
-            end
+            [name, __send__(name)]
+          rescue NodeError
+            nil
           end.compact
 
           printer.seplist(attrs) do |name, value|

data/lib/commonmarker/node.rb

@@ -30,6 +30,16 @@ module CommonMarker
       _render_html(opts, extensions).force_encoding('utf-8')
     end
 
+    # 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')
+    end
+
     # Public: Convert the node to a CommonMark string.
     #
     # options - A {Symbol} or {Array of Symbol}s indicating the render options

data/lib/commonmarker/renderer.rb

@@ -129,7 +129,7 @@ module CommonMarker
     end
 
     def option_enabled?(opt)
-      (@opts & CommonMarker::Config::Render.value(opt)) != 0
+      (@opts & CommonMarker::Config::OPTS.dig(:render, opt)) != 0
     end
   end
 end

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommonMarker
-  VERSION = '0.21.2'
+  VERSION = '0.23.2'
 end

data/test/test_basics.rb

@@ -15,4 +15,21 @@ class TestBasics < Minitest::Test
     html = CommonMarker.render_html('Hi *there*')
     assert_equal "<p>Hi <em>there</em></p>\n", html
   end
+
+  # basic test that just checks if every option is accepted & no errors are thrown
+  def test_accept_every_option
+    text = "Hello **world** -- how are _you_ today? I'm ~~fine~~, ~yourself~?"
+    parse_opt = %i[SOURCEPOS UNSAFE VALIDATE_UTF8 SMART LIBERAL_HTML_TAG FOOTNOTES STRIKETHROUGH_DOUBLE_TILDE]
+    render_opt = parse_opt + %i[HARDBREAKS NOBREAKS GITHUB_PRE_LANG TABLE_PREFER_STYLE_ATTRIBUTES FULL_INFO_STRING]
+
+    extensions = %i[table tasklist strikethrough autolink tagfilter]
+
+    assert_equal "<p>Hello <strong>world</strong> – how are <em>you</em> today? I’m <del>fine</del>, ~yourself~?</p>\n", CommonMarker.render_doc(text, parse_opt, extensions).to_html
+
+    # NOTE: how tho the doc returned has sourcepos info, by default the renderer
+    # won't emit it. for that we need to pass in the render opt
+    assert_equal "<p data-sourcepos=\"1:1-1:65\">Hello <strong>world</strong> – how are <em>you</em> today? I’m <del>fine</del>, ~yourself~?</p>\n", CommonMarker.render_doc(text, parse_opt, extensions).to_html(render_opt, extensions)
+
+    assert_equal "<p data-sourcepos=\"1:1-1:65\">Hello <strong>world</strong> – how are <em>you</em> today? I’m <del>fine</del>, ~yourself~?</p>\n", CommonMarker.render_html(text, parse_opt, extensions)
+  end
 end

data/test/test_commands.rb

@@ -28,4 +28,45 @@ class TestCommands < Minitest::Test
     assert_includes out, '<p><del>hi</del>'
     %w[<table> <tr> <th> a </th> <td> c </td>].each { |html| assert_includes out, html }
   end
+
+  def test_understands_html_format_with_renderer_and_extensions
+    out = make_bin('table.md', '--to=html --extension=table,strikethrough --html-renderer')
+    refute_includes out, '| a'
+    assert_includes out, '<p><del>hi</del>'
+    %w[<table> <tr> <th> a </th> <td> c </td>].each { |html| assert_includes out, html }
+  end
+
+  def test_understands_xml_format
+    out = make_bin('strong.md', '--to=xml')
+    assert_includes out, '<?xml version="1.0" encoding="UTF-8"?>'
+    assert_includes out, '<text xml:space="preserve">strong</text>'
+  end
+
+  def test_understands_commonmark_format
+    out = make_bin('strong.md', '--to=commonmark')
+    assert_equal('I am **strong**', out)
+  end
+
+  def test_understands_plaintext_format
+    out = make_bin('strong.md', '--to=plaintext')
+    assert_equal('I am strong', out)
+  end
+
+  def test_aborts_invalid_format
+    _out, err = capture_subprocess_io do
+      make_bin('strong.md', '--to=unknown')
+    end
+
+    assert_match "format 'unknown' not found", err
+  end
+
+  def test_aborts_format_and_html_renderer_combinations
+    (CommonMarker::Config::OPTS[:format] - [:html]).each do |format|
+      _out, err = capture_subprocess_io do
+        make_bin('strong.md', "--to=#{format} --html-renderer")
+      end
+
+      assert_match "format '#{format}' does not support using the HtmlRenderer renderer", err
+    end
+  end
 end

data/test/test_encoding.rb

@@ -9,6 +9,9 @@ class TestEncoding < Minitest::Test
     doc = CommonMarker.render_doc(contents, :SMART)
     render = doc.to_html
     assert_equal('<p>This curly quote “makes commonmarker throw an exception”.</p>', render.rstrip)
+
+    render = doc.to_xml
+    assert_includes(render, '<text xml:space="preserve">This curly quote “makes commonmarker throw an exception”.</text>')
   end
 
   def test_string_content_is_utf8

data/test/test_extensions.rb

@@ -29,6 +29,9 @@ class TestExtensions < Minitest::Test
     doc = CommonMarker.render_doc('~a~ ~~b~~ ~~~c~~~', :STRIKETHROUGH_DOUBLE_TILDE, [:strikethrough])
     assert_equal("<p>~a~ <del>b</del> ~~~c~~~</p>\n", doc.to_html)
 
+    html = CommonMarker.render_html('~a~ ~~b~~ ~~~c~~~', :STRIKETHROUGH_DOUBLE_TILDE, [:strikethrough])
+    assert_equal("<p>~a~ <del>b</del> ~~~c~~~</p>\n", html)
+
     CommonMarker.render_html(@markdown, :DEFAULT, %i[table strikethrough]).tap do |out|
       refute_includes out, '| a'
       refute_includes out, '| <strong>x</strong>'

data/test/test_footnotes.rb

@@ -5,7 +5,25 @@ require 'test_helper'
 class TestFootnotes < Minitest::Test
   def setup
     @doc = CommonMarker.render_doc("Hello[^hi].\n\n[^hi]: Hey!\n", :FOOTNOTES)
-    @expected = <<~HTML
+  end
+
+  def test_to_html
+    expected = <<~HTML
+      <p>Hello<sup class="footnote-ref"><a href="#fn-hi" id="fnref-hi" data-footnote-ref>1</a></sup>.</p>
+      <section class="footnotes" data-footnotes>
+      <ol>
+      <li id="fn-hi">
+      <p>Hey! <a href="#fnref-hi" class="footnote-backref" data-footnote-backref aria-label="Back to content">↩</a></p>
+      </li>
+      </ol>
+      </section>
+    HTML
+
+    assert_equal expected, @doc.to_html
+  end
+
+  def test_html_renderer
+    expected = <<~HTML
       <p>Hello<sup class="footnote-ref"><a href="#fn1" id="fnref1">1</a></sup>.</p>
       <section class="footnotes">
       <ol>
@@ -15,14 +33,8 @@ class TestFootnotes < Minitest::Test
       </ol>
       </section>
     HTML
-  end
-
-  def test_to_html
-    assert_equal @expected, @doc.to_html
-  end
 
-  def test_html_renderer
-    assert_equal @expected, CommonMarker::HtmlRenderer.new.render(@doc)
+    assert_equal expected, CommonMarker::HtmlRenderer.new.render(@doc)
   end
 
   def test_render_html
@@ -34,11 +46,11 @@ class TestFootnotes < Minitest::Test
     MARKDOWN
     expected = <<~HTML
       <h1>footnotes</h1>
-      <p>Let's render some footnotes<sup class="footnote-ref"><a href="#fn1" id="fnref1">1</a></sup></p>
-      <section class="footnotes">
+      <p>Let's render some footnotes<sup class="footnote-ref"><a href="#fn-1" id="fnref-1" data-footnote-ref>1</a></sup></p>
+      <section class="footnotes" data-footnotes>
       <ol>
-      <li id="fn1">
-      <p>This is a footnote <a href="#fnref1" class="footnote-backref">↩</a></p>
+      <li id="fn-1">
+      <p>This is a footnote <a href="#fnref-1" class="footnote-backref" data-footnote-backref aria-label="Back to content">↩</a></p>
       </li>
       </ol>
       </section>

data/test/test_maliciousness.rb

@@ -67,11 +67,6 @@ module CommonMarker
         CommonMarker.render_html(nil)
       end
 
-      err = assert_raises TypeError do
-        CommonMarker.render_html("foo \n baz", [:SMART])
-      end
-      assert_equal('option \':SMART\' does not exist for CommonMarker::Config::Render', err.message)
-
       assert_raises TypeError do
         CommonMarker.render_doc("foo \n baz", 123)
       end
@@ -79,7 +74,7 @@ module CommonMarker
       err = assert_raises TypeError do
         CommonMarker.render_doc("foo \n baz", :safe)
       end
-      assert_equal('option \':safe\' does not exist for CommonMarker::Config::Parse', err.message)
+      assert_equal('option \':safe\' does not exist for CommonMarker::Config::OPTS[:parse]', err.message)
 
       assert_raises TypeError do
         CommonMarker.render_doc("foo \n baz", :totes_fake)

data/test/test_renderer.rb

@@ -27,4 +27,21 @@ class TestRenderer < Minitest::Test
     results = CommonMarker::HtmlRenderer.new.render(doc)
     assert_equal 2, results.scan(/<tbody>/).size
   end
+
+  def test_escape_html_encoding
+    my_renderer = Class.new(HtmlRenderer) do
+      attr_reader :input_encoding, :output_encoding
+
+      def text(node)
+        @input_encoding = node.string_content.encoding
+        escape_html(node.string_content).tap do |escaped|
+          @output_encoding = escaped.encoding
+        end
+      end
+    end
+
+    renderer = my_renderer.new
+    assert_equal Encoding::UTF_8, renderer.render(@doc).encoding
+    assert_equal renderer.input_encoding, renderer.output_encoding
+  end
 end

data/test/test_smartpunct.rb

@@ -7,11 +7,14 @@ class SmartPunctTest < Minitest::Test
 
   smart_punct.each do |testcase|
     doc = CommonMarker.render_doc(testcase[:markdown], :SMART)
+    html = CommonMarker.render_html(testcase[:markdown], :SMART)
 
     define_method("test_smart_punct_example_#{testcase[:example]}") do
-      actual = doc.to_html.strip
+      doc_rendered = doc.to_html.strip
+      html_rendered = html.strip
 
-      assert_equal testcase[:html], actual, testcase[:markdown]
+      assert_equal testcase[:html], doc_rendered, testcase[:markdown]
+      assert_equal testcase[:html], html_rendered, testcase[:markdown]
     end
   end
 

data/test/test_xml.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestXml < Minitest::Test
+  def setup
+    @markdown = <<~MD
+      Hi *there*!
+
+      1. I am a numeric list.
+      2. I continue the list.
+      * Suddenly, an unordered list!
+      * What fun!
+
+      Okay, _enough_.
+
+      | a   | b   |
+      | --- | --- |
+      | c   | d   |
+    MD
+  end
+
+  def render_doc(doc)
+    CommonMarker.render_doc(doc, :DEFAULT, [:table])
+  end
+
+  def test_to_xml
+    compare = render_doc(@markdown).to_xml(:SOURCEPOS)
+
+    assert_equal <<~XML, compare
+      <?xml version="1.0" encoding="UTF-8"?>
+      <!DOCTYPE document SYSTEM "CommonMark.dtd">
+      <document sourcepos="1:1-12:13" xmlns="http://commonmark.org/xml/1.0">
+        <paragraph sourcepos="1:1-1:11">
+          <text sourcepos="1:1-1:3" xml:space="preserve">Hi </text>
+          <emph sourcepos="1:4-1:10">
+            <text sourcepos="1:5-1:9" xml:space="preserve">there</text>
+          </emph>
+          <text sourcepos="1:11-1:11" xml:space="preserve">!</text>
+        </paragraph>
+        <list sourcepos="3:1-4:23" type="ordered" start="1" delim="period" tight="true">
+          <item sourcepos="3:1-3:23">
+            <paragraph sourcepos="3:4-3:23">
+              <text sourcepos="3:4-3:23" xml:space="preserve">I am a numeric list.</text>
+            </paragraph>
+          </item>
+          <item sourcepos="4:1-4:23">
+            <paragraph sourcepos="4:4-4:23">
+              <text sourcepos="4:4-4:23" xml:space="preserve">I continue the list.</text>
+            </paragraph>
+          </item>
+        </list>
+        <list sourcepos="5:1-7:0" type="bullet" tight="true">
+          <item sourcepos="5:1-5:30">
+            <paragraph sourcepos="5:3-5:30">
+              <text sourcepos="5:3-5:30" xml:space="preserve">Suddenly, an unordered list!</text>
+            </paragraph>
+          </item>
+          <item sourcepos="6:1-7:0">
+            <paragraph sourcepos="6:3-6:11">
+              <text sourcepos="6:3-6:11" xml:space="preserve">What fun!</text>
+            </paragraph>
+          </item>
+        </list>
+        <paragraph sourcepos="8:1-8:15">
+          <text sourcepos="8:1-8:6" xml:space="preserve">Okay, </text>
+          <emph sourcepos="8:7-8:14">
+            <text sourcepos="8:8-8:13" xml:space="preserve">enough</text>
+          </emph>
+          <text sourcepos="8:15-8:15" xml:space="preserve">.</text>
+        </paragraph>
+        <table sourcepos="10:1-12:13">
+          <table_header sourcepos="10:1-10:13">
+            <table_cell sourcepos="10:2-10:6">
+              <text sourcepos="10:3-10:3" xml:space="preserve">a</text>
+            </table_cell>
+            <table_cell sourcepos="10:8-10:12">
+              <text sourcepos="10:9-10:9" xml:space="preserve">b</text>
+            </table_cell>
+          </table_header>
+          <table_row sourcepos="12:1-12:13">
+            <table_cell sourcepos="12:2-12:6">
+              <text sourcepos="12:3-12:3" xml:space="preserve">c</text>
+            </table_cell>
+            <table_cell sourcepos="12:8-12:12">
+              <text sourcepos="12:9-12:9" xml:space="preserve">d</text>
+            </table_cell>
+          </table_row>
+        </table>
+      </document>
+    XML
+  end
+
+  def test_to_xml_with_quotes
+    compare = render_doc('"quotes" should be escaped').to_xml(:DEFAULT)
+
+    assert_equal <<~XML, compare
+      <?xml version="1.0" encoding="UTF-8"?>
+      <!DOCTYPE document SYSTEM "CommonMark.dtd">
+      <document xmlns="http://commonmark.org/xml/1.0">
+        <paragraph>
+          <text xml:space="preserve">&quot;quotes&quot; should be escaped</text>
+        </paragraph>
+      </document>
+    XML
+  end
+end

metadata

@@ -1,30 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.21.2
+  version: 0.23.2
 platform: ruby
 authors:
 - Garen Torikian
 - Ashe Connor
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ruby-enum
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +139,7 @@ dependencies:
         version: '0'
 description: A fast, safe, extensible parser for CommonMark. This wraps the official
   libcmark library.
-email: 
+email:
 executables:
 - commonmarker
 extensions:
@@ -238,6 +224,7 @@ files:
 - ext/commonmarker/xml.c
 - lib/commonmarker.rb
 - lib/commonmarker/config.rb
+- lib/commonmarker/errors.rb
 - lib/commonmarker/node.rb
 - lib/commonmarker/node/inspect.rb
 - lib/commonmarker/renderer.rb
@@ -268,11 +255,12 @@ files:
 - test/test_smartpunct.rb
 - test/test_spec.rb
 - test/test_tasklists.rb
+- test/test_xml.rb
 homepage: https://github.com/gjtorikian/commonmarker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "-x"
 - ext/commonmarker/cmark/.*
@@ -283,7 +271,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.10
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.0'
@@ -294,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
 test_files:
@@ -320,6 +308,7 @@ test_files:
 - test/test_helper.rb
 - test/test_options.rb
 - test/benchmark.rb
+- test/test_xml.rb
 - test/test_basics.rb
 - test/test_renderer.rb
 - test/test_gc.rb