commonmarker 0.20.1 → 0.22.0

data/lib/commonmarker/renderer/html_renderer.rb

@@ -2,15 +2,9 @@
 
 module CommonMarker
   class HtmlRenderer < Renderer
-    def render(node)
-      super(node)
-    end
-
     def document(_)
       super
-      if @written_footnote_ix
-        out("</ol>\n</section>\n")
-      end
+      out("</ol>\n</section>\n") if @written_footnote_ix
     end
 
     def header(node)
@@ -71,12 +65,13 @@ module CommonMarker
 
     def tasklist(node)
       return '' unless tasklist?(node)
+
       state = if checked?(node)
-        'checked="" disabled=""'
-      else
-        'disabled=""'
-      end
-      return "><input type=\"checkbox\" #{state} /"
+                'checked="" disabled=""'
+              else
+                'disabled=""'
+              end
+      "><input type=\"checkbox\" #{state} /"
     end
 
     def blockquote(node)
@@ -97,9 +92,7 @@ module CommonMarker
       block do
         if option_enabled?(:GITHUB_PRE_LANG)
           out("<pre#{sourcepos(node)}")
-          if node.fence_info && !node.fence_info.empty?
-            out(' lang="', node.fence_info.split(/\s+/)[0], '"')
-          end
+          out(' lang="', node.fence_info.split(/\s+/)[0], '"') if node.fence_info && !node.fence_info.empty?
           out('><code>')
         else
           out("<pre#{sourcepos(node)}><code")
@@ -142,9 +135,7 @@ module CommonMarker
 
     def link(node)
       out('<a href="', node.url.nil? ? '' : escape_href(node.url), '"')
-      if node.title && !node.title.empty?
-        out(' title="', escape_html(node.title), '"')
-      end
+      out(' title="', escape_html(node.title), '"') if node.title && !node.title.empty?
       out('>', :children, '</a>')
     end
 
@@ -153,9 +144,7 @@ module CommonMarker
       plain do
         out(' alt="', :children, '"')
       end
-      if node.title && !node.title.empty?
-        out(' title="', escape_html(node.title), '"')
-      end
+      out(' title="', escape_html(node.title), '"') if node.title && !node.title.empty?
       out(' />')
     end
 
@@ -169,7 +158,7 @@ module CommonMarker
       out('</code>')
     end
 
-    def linebreak(node)
+    def linebreak(_node)
       out("<br />\n")
     end
 
@@ -210,9 +199,9 @@ module CommonMarker
 
     def table_cell(node)
       align = case @alignments[@column_index]
-              when :left; ' align="left"'
-              when :right; ' align="right"'
-              when :center; ' align="center"'
+              when :left then ' align="left"'
+              when :right then ' align="right"'
+              when :center then ' align="center"'
               else; ''
               end
       out(@in_header ? "<th#{align}#{sourcepos(node)}>" : "<td#{align}#{sourcepos(node)}>", :children, @in_header ? "</th>\n" : "</td>\n")
@@ -228,28 +217,27 @@ module CommonMarker
     end
 
     def footnote_definition(_)
-      if !@footnote_ix
+      unless @footnote_ix
         out("<section class=\"footnotes\">\n<ol>\n")
         @footnote_ix = 0
       end
 
       @footnote_ix += 1
-      out("<li id=\"fn#@footnote_ix\">\n", :children)
-      if out_footnote_backref
-        out("\n")
-      end
+      out("<li id=\"fn#{@footnote_ix}\">\n", :children)
+      out("\n") if out_footnote_backref
       out("</li>\n")
-#</ol>
-#</section>
+      # </ol>
+      # </section>
     end
 
     private
 
     def out_footnote_backref
       return false if @written_footnote_ix == @footnote_ix
+
       @written_footnote_ix = @footnote_ix
 
-      out("<a href=\"#fnref#@footnote_ix\" class=\"footnote-backref\">↩</a>")
+      out("<a href=\"#fnref#{@footnote_ix}\" class=\"footnote-backref\">↩</a>")
       true
     end
 
@@ -258,8 +246,7 @@ module CommonMarker
     end
 
     def checked?(node)
-      node.tasklist_state == 'checked'
+      node.tasklist_item_checked?
     end
-
   end
 end

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommonMarker
-  VERSION = '0.20.1'.freeze
+  VERSION = '0.22.0'
 end

data/test/benchmark.rb

@@ -13,16 +13,12 @@ end
 
 benchinput = File.open('test/benchinput.md', 'r').read
 
-printf("input size = %d bytes\n\n", benchinput.bytesize)
+printf("input size = %<bytes>d bytes\n\n", benchinput.bytesize)
 
 dobench('redcarpet') do
   Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: false, tables: false).render(benchinput)
 end
 
-dobench('github-markdown') do
-  GitHub::Markdown.render(benchinput)
-end
-
 dobench('commonmarker with to_html') do
   CommonMarker.render_html(benchinput)
 end

data/test/fixtures/strong.md

@@ -0,0 +1 @@
+I am **strong**

data/test/fixtures/table.md

@@ -0,0 +1,10 @@
+One extension:
+
+| a   | b   |
+| --- | --- |
+| c   | d   |
+| **x** | |
+
+Another extension:
+
+~~hi~~

data/test/test_attributes.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 class TestAttributes < Minitest::Test
   def setup
-    contents = File.read(File.join(FIXTURES_DIR, 'dingus.md'))
+    contents = fixtures_file('dingus.md')
     @doc = CommonMarker.render_doc(contents.strip)
   end
 
@@ -15,9 +15,9 @@ class TestAttributes < Minitest::Test
       sourcepos << node.sourcepos
     end
 
-    sourcepos.delete_if { |h| h.values.all? { |v| v == 0 } }
+    sourcepos.delete_if { |h| h.values.all?(&:zero?) }
 
-    result = [{start_line: 1, start_column: 1, end_line: 10, end_column: 12}, {start_line: 1, start_column: 1, end_line: 1, end_column: 17}, {start_line: 1, start_column: 4, end_line: 1, end_column: 17}, {start_line: 3, start_column: 1, end_line: 5, end_column: 36}, {start_line: 3, start_column: 1, end_line: 3, end_column: 55}, {start_line: 4, start_column: 1, end_line: 4, end_column: 53}, {start_line: 4, start_column: 2, end_line: 4, end_column: 14}, {start_line: 4, start_column: 54, end_line: 4, end_column: 58}, {start_line: 5, start_column: 1, end_line: 5, end_column: 36}, {start_line: 7, start_column: 1, end_line: 10, end_column: 12}, {start_line: 7, start_column: 1, end_line: 7, end_column: 11}, {start_line: 7, start_column: 4, end_line: 7, end_column: 11}, {start_line: 7, start_column: 4, end_line: 7, end_column: 11}, {start_line: 8, start_column: 1, end_line: 10, end_column: 12}, {start_line: 8, start_column: 4, end_line: 8, end_column: 11}, {start_line: 8, start_column: 4, end_line: 8, end_column: 11}, {start_line: 9, start_column: 4, end_line: 10, end_column: 12}, {start_line: 9, start_column: 4, end_line: 9, end_column: 12}, {start_line: 9, start_column: 6, end_line: 9, end_column: 12}, {start_line: 9, start_column: 6, end_line: 9, end_column: 12}, {start_line: 10, start_column: 4, end_line: 10, end_column: 12}, {start_line: 10, start_column: 6, end_line: 10, end_column: 12}, {start_line: 10, start_column: 6, end_line: 10, end_column: 12}]
+    result = [{ start_line: 1, start_column: 1, end_line: 10, end_column: 12 }, { start_line: 1, start_column: 1, end_line: 1, end_column: 17 }, { start_line: 1, start_column: 4, end_line: 1, end_column: 17 }, { start_line: 3, start_column: 1, end_line: 5, end_column: 36 }, { start_line: 3, start_column: 1, end_line: 3, end_column: 55 }, { start_line: 4, start_column: 1, end_line: 4, end_column: 53 }, { start_line: 4, start_column: 2, end_line: 4, end_column: 14 }, { start_line: 4, start_column: 54, end_line: 4, end_column: 58 }, { start_line: 5, start_column: 1, end_line: 5, end_column: 36 }, { start_line: 7, start_column: 1, end_line: 10, end_column: 12 }, { start_line: 7, start_column: 1, end_line: 7, end_column: 11 }, { start_line: 7, start_column: 4, end_line: 7, end_column: 11 }, { start_line: 7, start_column: 4, end_line: 7, end_column: 11 }, { start_line: 8, start_column: 1, end_line: 10, end_column: 12 }, { start_line: 8, start_column: 4, end_line: 8, end_column: 11 }, { start_line: 8, start_column: 4, end_line: 8, end_column: 11 }, { start_line: 9, start_column: 4, end_line: 10, end_column: 12 }, { start_line: 9, start_column: 4, end_line: 9, end_column: 12 }, { start_line: 9, start_column: 6, end_line: 9, end_column: 12 }, { start_line: 9, start_column: 6, end_line: 9, end_column: 12 }, { start_line: 10, start_column: 4, end_line: 10, end_column: 12 }, { start_line: 10, start_column: 6, end_line: 10, end_column: 12 }, { start_line: 10, start_column: 6, end_line: 10, end_column: 12 }]
 
     assert_equal result, sourcepos
   end

data/test/test_commands.rb

@@ -0,0 +1,31 @@
+# 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
+end

data/test/test_commonmark.rb

@@ -3,22 +3,22 @@
 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
 
@@ -30,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

@@ -17,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,4 +1,3 @@
-# coding: utf-8
 # frozen_string_literal: true
 
 require 'test_helper'
@@ -6,16 +5,16 @@ 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)
   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

@@ -4,67 +4,55 @@ 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"
+    assert_equal("<p>~a~ <del>b</del> ~~~c~~~</p>\n", doc.to_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"
+    assert_equal("<p>~a~ <del>b</del> ~~~c~~~</p>\n", HtmlRenderer.new.render(doc))
   end
 
   def test_bad_extension_specifications
@@ -75,51 +63,51 @@ Another extension:
 
   def test_comments_are_kept_as_expected
     assert_equal "<!--hello--> <blah> &lt;xmp>\n",
-      CommonMarker.render_html("<!--hello--> <blah> <xmp>\n", :UNSAFE, %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