commonmarker 0.17.13 → 0.23.4

data/test/test_commands.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestCommands < Minitest::Test
+  def test_basic
+    out = make_bin('strong.md')
+    assert_equal('<p>I am <strong>strong</strong></p>', out)
+  end
+
+  def test_does_not_have_extensions
+    out = make_bin('table.md')
+    assert_includes out, '| a'
+    refute_includes out, '<p><del>hi</del>'
+    refute_includes out, '<table> <tr> <th> a </th> <td> c </td>'
+  end
+
+  def test_understands_extensions
+    out = make_bin('table.md', '--extension=table')
+    refute_includes out, '| a'
+    refute_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_multiple_extensions
+    out = make_bin('table.md', '--extension=table,strikethrough')
+    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_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_commonmark.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestCommonmark < Minitest::Test
-  HTML_COMMENT = %r[<!--.*?-->\s?]
+  HTML_COMMENT = /<!--.*?-->\s?/.freeze
 
   def setup
-    @markdown = <<-MD
-Hi *there*!
+    @markdown = <<~MD
+      Hi *there*!
 
-1. I am a numeric list.
-2. I continue the list.
-* Suddenly, an unordered list!
-* What fun!
+      1. I am a numeric list.
+      2. I continue the list.
+      * Suddenly, an unordered list!
+      * What fun!
 
-Okay, _enough_.
+      Okay, _enough_.
 
-| a   | b   |
-| --- | --- |
-| c   | d   |
+      | a   | b   |
+      | --- | --- |
+      | c   | d   |
     MD
   end
 
@@ -28,7 +30,7 @@ Okay, _enough_.
     compare = render_doc(@markdown).to_commonmark
 
     assert_equal \
-      render_doc(@markdown).to_html.gsub(/ +/, ' ').gsub(HTML_COMMENT, ''),
-      render_doc(compare).to_html.gsub(/ +/, ' ').gsub(HTML_COMMENT, '')
+      render_doc(@markdown).to_html.squeeze(' ').gsub(HTML_COMMENT, ''),
+      render_doc(compare).to_html.squeeze(' ').gsub(HTML_COMMENT, '')
   end
 end

data/test/test_doc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestDocNode < Minitest::Test
@@ -15,114 +17,114 @@ class TestDocNode < Minitest::Test
   end
 
   def test_get_type
-    assert_equal @doc.type, :document
+    assert_equal(:document, @doc.type)
   end
 
   def test_get_type_string
-    assert_equal @doc.type_string, 'document'
+    assert_equal('document', @doc.type_string)
   end
 
   def test_get_first_child
-    assert_equal @first_child.type, :paragraph
+    assert_equal(:paragraph, @first_child.type)
   end
 
   def test_get_next
-    assert_equal @first_child.first_child.next.type, :emph
+    assert_equal(:emph, @first_child.first_child.next.type)
   end
 
   def test_insert_before
     paragraph = Node.new(:paragraph)
-    assert_equal @first_child.insert_before(paragraph), true
+    assert(@first_child.insert_before(paragraph))
     assert_match "<p></p>\n<p>Hi <em>there</em>.", @doc.to_html
   end
 
   def test_insert_after
     paragraph = Node.new(:paragraph)
-    assert_equal @first_child.insert_after(paragraph), true
+    assert(@first_child.insert_after(paragraph))
     assert_match "<strong>many nodes</strong>!</p>\n<p></p>\n", @doc.to_html
   end
 
   def test_prepend_child
     code = Node.new(:code)
-    assert_equal @first_child.prepend_child(code), true
+    assert(@first_child.prepend_child(code))
     assert_match '<p><code></code>Hi <em>there</em>.', @doc.to_html
   end
 
   def test_append_child
     strong = Node.new(:strong)
-    assert_equal @first_child.append_child(strong), true
+    assert(@first_child.append_child(strong))
     assert_match "!<strong></strong></p>\n", @doc.to_html
   end
 
   def test_get_last_child
-    assert_equal @last_child.type, :paragraph
+    assert_equal(:paragraph, @last_child.type)
   end
 
   def test_get_parent
-    assert_equal @first_child.first_child.next.parent.type, :paragraph
+    assert_equal(:paragraph, @first_child.first_child.next.parent.type)
   end
 
   def test_get_previous
-    assert_equal @first_child.first_child.next.previous.type, :text
+    assert_equal(:text, @first_child.first_child.next.previous.type)
   end
 
   def test_get_url
-    assert_equal @link.url, 'https://www.github.com'
+    assert_equal('https://www.github.com', @link.url)
   end
 
   def test_set_url
-    assert_equal @link.url = 'https://www.mozilla.org', 'https://www.mozilla.org'
+    assert_equal('https://www.mozilla.org', @link.url = 'https://www.mozilla.org')
   end
 
   def test_get_title
-    assert_equal @image.title, 'Favicon'
+    assert_equal('Favicon', @image.title)
   end
 
   def test_set_title
-    assert_equal @image.title = 'Octocat', 'Octocat'
+    assert_equal('Octocat', @image.title = 'Octocat')
   end
 
   def test_get_header_level
-    assert_equal @header.header_level, 3
+    assert_equal(3, @header.header_level)
   end
 
   def test_set_header_level
-    assert_equal @header.header_level = 6, 6
+    assert_equal(6, @header.header_level = 6)
   end
 
   def test_get_list_type
-    assert_equal @ul_list.list_type, :bullet_list
-    assert_equal @ol_list.list_type, :ordered_list
+    assert_equal(:bullet_list, @ul_list.list_type)
+    assert_equal(:ordered_list, @ol_list.list_type)
   end
 
   def test_set_list_type
-    assert_equal @ul_list.list_type = :ordered_list, :ordered_list
-    assert_equal @ol_list.list_type = :bullet_list, :bullet_list
+    assert_equal(:ordered_list, @ul_list.list_type = :ordered_list)
+    assert_equal(:bullet_list, @ol_list.list_type = :bullet_list)
   end
 
   def test_get_list_start
-    assert_equal @ol_list.list_start, 1
+    assert_equal(1, @ol_list.list_start)
   end
 
   def test_set_list_start
-    assert_equal @ol_list.list_start = 8, 8
+    assert_equal(8, @ol_list.list_start = 8)
   end
 
   def test_get_list_tight
-    assert_equal @ul_list.list_tight, true
-    assert_equal @ol_list.list_tight, true
+    assert(@ul_list.list_tight)
+    assert(@ol_list.list_tight)
   end
 
   def test_set_list_tight
-    assert_equal @ul_list.list_tight = false, false
-    assert_equal @ol_list.list_tight = false, false
+    refute(@ul_list.list_tight = false)
+    refute(@ol_list.list_tight = false)
   end
 
   def test_get_fence_info
-    assert_equal @fence.fence_info, 'ruby'
+    assert_equal('ruby', @fence.fence_info)
   end
 
   def test_set_fence_info
-    assert_equal @fence.fence_info = 'javascript', 'javascript'
+    assert_equal('javascript', @fence.fence_info = 'javascript')
   end
 end

data/test/test_encoding.rb

@@ -1,19 +1,23 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestEncoding < Minitest::Test
   # see http://git.io/vq4FR
   def test_encoding
-    contents = File.read(File.join(FIXTURES_DIR, 'curly.md'), encoding: 'utf-8')
+    contents = fixtures_file('curly.md')
     doc = CommonMarker.render_doc(contents, :SMART)
     render = doc.to_html
-    assert_equal render.rstrip, '<p>This curly quote “makes commonmarker throw an exception”.</p>'
+    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
     doc = CommonMarker.render_doc('Hi *there*')
     text = doc.first_child.last_child.first_child
-    assert_equal text.string_content, 'there'
-    assert_equal text.string_content.encoding.name, 'UTF-8'
+    assert_equal('there', text.string_content)
+    assert_equal('UTF-8', text.string_content.encoding.name)
   end
 end

data/test/test_extensions.rb

@@ -1,123 +1,116 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestExtensions < Minitest::Test
   def setup
-    @markdown = <<-MD
-One extension:
-
-| a   | b   |
-| --- | --- |
-| c   | d   |
-| **x** | |
-
-Another extension:
-
-~~hi~~
-    MD
+    @markdown = fixtures_file('table.md')
   end
 
   def test_uses_specified_extensions
     CommonMarker.render_html(@markdown, :DEFAULT, %i[]).tap do |out|
-      assert out.include?("| a")
-      assert out.include?("| <strong>x</strong>")
-      assert out.include?("~~hi~~")
+      assert_includes out, '| a'
+      assert_includes out, '| <strong>x</strong>'
+      assert_includes out, '~~hi~~'
     end
 
     CommonMarker.render_html(@markdown, :DEFAULT, %i[table]).tap do |out|
-      refute out.include?("| a")
-      %w(<table> <tr> <th> a </th> <td> c </td> <strong>x</strong>).each {|html| assert out.include?(html) }
-      assert out.include?("~~hi~~")
+      refute_includes out, '| a'
+      %w[<table> <tr> <th> a </th> <td> c </td> <strong>x</strong>].each { |html| assert_includes out, html }
+      assert_includes out, '~~hi~~'
     end
 
     CommonMarker.render_html(@markdown, :DEFAULT, %i[strikethrough]).tap do |out|
-      assert out.include?("| a")
-      refute out.include?("~~hi~~")
-      assert out.include?("<del>hi</del>")
+      assert_includes out, '| a'
+      refute_includes out, '~~hi~~'
+      assert_includes out, '<del>hi</del>'
     end
 
-    doc = CommonMarker.render_doc("~a~ ~~b~~ ~~~c~~~", :STRIKETHROUGH_DOUBLE_TILDE, [:strikethrough])
-    assert_equal doc.to_html, "<p>~a~ <del>b</del> ~~~c~~~</p>\n"
+    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 out.include?("| a")
-      refute out.include?("| <strong>x</strong>")
-      refute out.include?("~~hi~~")
+      refute_includes out, '| a'
+      refute_includes out, '| <strong>x</strong>'
+      refute_includes out, '~~hi~~'
     end
-
   end
 
   def test_extensions_with_renderers
     doc = CommonMarker.render_doc(@markdown, :DEFAULT, %i[table])
 
     doc.to_html.tap do |out|
-      refute out.include?("| a")
-      %w(<table> <tr> <th> a </th> <td> c </td> <strong>x</strong>).each {|html| assert out.include?(html) }
-      assert out.include?("~~hi~~")
+      refute_includes out, '| a'
+      %w[<table> <tr> <th> a </th> <td> c </td> <strong>x</strong>].each { |html| assert_includes out, html }
+      assert_includes out, '~~hi~~'
     end
 
     HtmlRenderer.new.render(doc).tap do |out|
-      refute out.include?("| a")
-      %w(<table> <tr> <th> a </th> <td> c </td> <strong>x</strong>).each {|html| assert out.include?(html) }
-      assert out.include?("~~hi~~")
+      refute_includes out, '| a'
+      %w[<table> <tr> <th> a </th> <td> c </td> <strong>x</strong>].each { |html| assert_includes out, html }
+      assert_includes out, '~~hi~~'
     end
 
-    doc = CommonMarker.render_doc("~a~ ~~b~~ ~~~c~~~", :STRIKETHROUGH_DOUBLE_TILDE, [:strikethrough])
-    assert_equal HtmlRenderer.new.render(doc), "<p>~a~ <del>b</del> ~~~c~~~</p>\n"
+    doc = CommonMarker.render_doc('~a~ ~~b~~ ~~~c~~~', :STRIKETHROUGH_DOUBLE_TILDE, [:strikethrough])
+    assert_equal("<p>~a~ <del>b</del> ~~~c~~~</p>\n", HtmlRenderer.new.render(doc))
   end
 
   def test_bad_extension_specifications
-    assert_raises(TypeError) { CommonMarker.render_html(@markdown, :DEFAULT, "nope") }
-    assert_raises(TypeError) { CommonMarker.render_html(@markdown, :DEFAULT, ["table"]) }
+    assert_raises(TypeError) { CommonMarker.render_html(@markdown, :DEFAULT, 'nope') }
+    assert_raises(TypeError) { CommonMarker.render_html(@markdown, :DEFAULT, ['table']) }
     assert_raises(ArgumentError) { CommonMarker.render_html(@markdown, :DEFAULT, %i[table bad]) }
   end
 
   def test_comments_are_kept_as_expected
     assert_equal "<!--hello--> <blah> &lt;xmp>\n",
-      CommonMarker.render_html("<!--hello--> <blah> <xmp>\n", :DEFAULT, %i[tagfilter])
+                 CommonMarker.render_html("<!--hello--> <blah> <xmp>\n", :UNSAFE, %i[tagfilter])
   end
 
   def test_table_prefer_style_attributes
-      assert_equal(<<-HTML, CommonMarker.render_html(<<-MD, :TABLE_PREFER_STYLE_ATTRIBUTES, %i[table]))
-<table>
-<thead>
-<tr>
-<th style="text-align: left">aaa</th>
-<th>bbb</th>
-<th style="text-align: center">ccc</th>
-<th>ddd</th>
-<th style="text-align: right">eee</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td style="text-align: left">fff</td>
-<td>ggg</td>
-<td style="text-align: center">hhh</td>
-<td>iii</td>
-<td style="text-align: right">jjj</td>
-</tr>
-</tbody>
-</table>
-      HTML
-aaa | bbb | ccc | ddd | eee
-:-- | --- | :-: | --- | --:
-fff | ggg | hhh | iii | jjj
-      MD
+    assert_equal(<<~HTML, CommonMarker.render_html(<<~MD, :TABLE_PREFER_STYLE_ATTRIBUTES, %i[table]))
+      <table>
+      <thead>
+      <tr>
+      <th style="text-align: left">aaa</th>
+      <th>bbb</th>
+      <th style="text-align: center">ccc</th>
+      <th>ddd</th>
+      <th style="text-align: right">eee</th>
+      </tr>
+      </thead>
+      <tbody>
+      <tr>
+      <td style="text-align: left">fff</td>
+      <td>ggg</td>
+      <td style="text-align: center">hhh</td>
+      <td>iii</td>
+      <td style="text-align: right">jjj</td>
+      </tr>
+      </tbody>
+      </table>
+    HTML
+      aaa | bbb | ccc | ddd | eee
+      :-- | --- | :-: | --- | --:
+      fff | ggg | hhh | iii | jjj
+    MD
   end
 
   def test_plaintext
-    assert_equal(<<-HTML, CommonMarker.render_doc(<<-MD, :DEFAULT, %i[table strikethrough]).to_plaintext)
-Hello ~there~.
+    assert_equal(<<~HTML, CommonMarker.render_doc(<<~MD, :DEFAULT, %i[table strikethrough]).to_plaintext)
+      Hello ~there~.
 
-| a |
-| --- |
-| b |
+      | a |
+      | --- |
+      | b |
     HTML
-Hello ~~there~~.
+      Hello ~~there~~.
 
-| a |
-| - |
-| b |
+      | a |
+      | - |
+      | b |
     MD
   end
 end

data/test/test_footnotes.rb

@@ -1,25 +1,60 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestFootnotes < Minitest::Test
   def setup
     @doc = CommonMarker.render_doc("Hello[^hi].\n\n[^hi]: Hey!\n", :FOOTNOTES)
-    @expected = <<-HTML
-<p>Hello<sup class="footnote-ref"><a href="#fn1" id="fnref1">1</a></sup>.</p>
-<section class="footnotes">
-<ol>
-<li id="fn1">
-<p>Hey! <a href="#fnref1" class="footnote-backref">↩</a></p>
-</li>
-</ol>
-</section>
-    HTML
   end
 
   def test_to_html
-    assert_equal @expected, @doc.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
-    assert_equal @expected, CommonMarker::HtmlRenderer.new.render(@doc)
+    expected = <<~HTML
+      <p>Hello<sup class="footnote-ref"><a href="#fn1" id="fnref1">1</a></sup>.</p>
+      <section class="footnotes">
+      <ol>
+      <li id="fn1">
+      <p>Hey! <a href="#fnref1" class="footnote-backref">↩</a></p>
+      </li>
+      </ol>
+      </section>
+    HTML
+
+    assert_equal expected, CommonMarker::HtmlRenderer.new.render(@doc)
+  end
+
+  def test_render_html
+    md = <<~MARKDOWN
+      # footnotes
+      Let's render some footnotes[^1]
+
+      [^1]: This is a footnote
+    MARKDOWN
+    expected = <<~HTML
+      <h1>footnotes</h1>
+      <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="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>
+    HTML
+    assert_equal expected, CommonMarker.render_html(md, :FOOTNOTES)
   end
 end

data/test/test_gc.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/UselessAssignment
 require 'test_helper'
 
 class TestNode < Minitest::Test
@@ -11,7 +14,7 @@ class TestNode < Minitest::Test
     doc = nil
     GC.start
     # Test that doc has not been freed.
-    assert_equal "there", text.string_content
+    assert_equal 'there', text.string_content
   end
 
   def test_drop_child_reference
@@ -21,7 +24,7 @@ class TestNode < Minitest::Test
     GC.start
     # Test that the cached child object is still valid.
     text = doc.first_child.last_child.first_child
-    assert_equal "there", text.string_content
+    assert_equal 'there', text.string_content
   end
 
   def test_remove_parent
@@ -41,3 +44,4 @@ class TestNode < Minitest::Test
     # free.
   end
 end
+# rubocop:enable Lint/UselessAssignment

data/test/test_helper.rb

@@ -1,12 +1,22 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'commonmarker'
 require 'minitest/autorun'
 require 'minitest/pride'
+require 'minitest/focus'
 
-include CommonMarker
+include CommonMarker # rubocop:disable Style/MixinUsage
 
 FIXTURES_DIR = File.join(File.dirname(__FILE__), 'fixtures')
 
+def fixtures_file(file)
+  File.read(File.join(FIXTURES_DIR, file), encoding: 'utf-8')
+end
+
+def make_bin(file, args = '')
+  `ruby bin/commonmarker #{File.join(FIXTURES_DIR, file)} #{args}`.chomp
+end
+
 def open_spec_file(filename)
   line_number = 0
   start_line = 0
@@ -22,25 +32,25 @@ def open_spec_file(filename)
   header_re = Regexp.new('#+ ')
   filepath = File.join('ext', 'commonmarker', 'cmark-upstream', 'test', filename)
 
-  File.readlines(filepath, encoding: "utf-8").each do |line|
+  File.readlines(filepath, encoding: 'utf-8').each do |line|
     line_number += 1
 
     l = line.strip
     if l =~ /^`{32} example(.*)$/
       state = 1
-      extensions = $1.split
+      extensions = Regexp.last_match(1).split
     elsif l == '`' * 32
       state = 0
       example_number += 1
       end_line = line_number
       tests << {
-        :markdown => markdown_lines.join('').tr('→', "\t"),
-        :html => html_lines.join('').tr('→', "\t").rstrip,
-        :example => example_number,
-        :start_line => start_line,
-        :end_line => end_line,
-        :section => headertext,
-        :extensions => extensions.map(&:to_sym),
+        markdown: markdown_lines.join.tr('→', "\t"),
+        html: html_lines.join.tr('→', "\t").rstrip,
+        example: example_number,
+        start_line: start_line,
+        end_line: end_line,
+        section: headertext,
+        extensions: extensions.map(&:to_sym)
       }
       start_line = 0
       markdown_lines = []
@@ -48,11 +58,11 @@ def open_spec_file(filename)
     elsif l == '.'
       state = 2
     elsif state == 1
-      start_line = line_number - 1 if start_line == 0
-      markdown_lines << "#{line}"
+      start_line = line_number - 1 if start_line.zero?
+      markdown_lines << line.to_s
     elsif state == 2
-      html_lines << "#{line}"
-    elsif state == 0 && header_re.match(line)
+      html_lines << line.to_s
+    elsif state.zero? && header_re.match(line)
       headertext = line.sub(header_re, '').strip
     end
   end