commonmarker 0.21.1 → 0.21.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a1380e99f120ae24a27bae6244ffeab5b0b3fe828155828cf8c092d8c83471a
-  data.tar.gz: 92c85125c0e4d6f8673312e64e67feda6993a4fc1250661fad3714836bc96454
+  metadata.gz: ac3365deb1dd8288503331626fc20ec583a5f96a23e25d330f4ff47e526bfc54
+  data.tar.gz: 975bcb958eb2e994a15090311088ff95870af95b1fc2d73bc1c4eb216fe69388
 SHA512:
-  metadata.gz: 5f136c3413348cea8e3a0f3e8b0242ffc8bba92b9004278170ee7d2532e87b6c5d6af73c952d2c31d509143ae2cfe63d96aeca6ff4749a599fefbcad7580214e
-  data.tar.gz: 4d33d9cb161d0b484ed9bc353c9c01dd3f8715f533c05a2f7f61a16792433153d19324d1b62a0ae6b6750441917843495349a1140e93d2b1960794ea0346e444
+  metadata.gz: 531cda0280a75a40c139969287106646c8b2cef181b48249055f3a896bc4329485a0f70ac59f6f3a85eed00247c15f4a6785f478b957ebd3594be3074a9d25a9
+  data.tar.gz: 3bb88a326ea1e0e7f99da2b459b90cac2ea748e57d933029c11278f230064a433a00889c93d65851dfef4b131ba46562a33d4597ef677f3e382325a712b0ffe6

data/README.md

@@ -139,16 +139,17 @@ CommonMarker accepts the same options that CMark does, as symbols. Note that the
 
 ### Render options
 
-| Name                             | Description                                                    |
-| ------------------               | -----------                                                    |
-| `:DEFAULT`                       | The default rendering system.                                  |
-| `:UNSAFE`                        | Allow raw/custom HTML and unsafe links.                        |
-| `:GITHUB_PRE_LANG`               | Use GitHub-style `<pre lang>` for fenced code blocks.          |
-| `:HARDBREAKS`                    | Treat `\n` as hardbreaks (by adding `<br/>`).                  |
-| `:NOBREAKS`                      | Translate `\n` in the source to a single whitespace.           |
-| `:SOURCEPOS`                     | Include source position in rendered HTML.                      |
-| `:TABLE_PREFER_STYLE_ATTRIBUTES` | Use `style` insted of `align` for table cells                  |
-| `:FULL_INFO_STRING`              | Include full info strings of code blocks in separate attribute |
+| Name                             | Description                                                     |
+| ------------------               | -----------                                                     |
+| `:DEFAULT`                       | The default rendering system.                                   |
+| `:UNSAFE`                        | Allow raw/custom HTML and unsafe links.                         |
+| `:GITHUB_PRE_LANG`               | Use GitHub-style `<pre lang>` for fenced code blocks.           |
+| `:HARDBREAKS`                    | Treat `\n` as hardbreaks (by adding `<br/>`).                   |
+| `:NOBREAKS`                      | Translate `\n` in the source to a single whitespace.            |
+| `:SOURCEPOS`                     | Include source position in rendered HTML.                       |
+| `:TABLE_PREFER_STYLE_ATTRIBUTES` | Use `style` insted of `align` for table cells.                  |
+| `:FULL_INFO_STRING`              | Include full info strings of code blocks in separate attribute. |
+| `:FOOTNOTES`                     | Render footnotes.                                               |
 
 ### Passing options
 

data/bin/commonmarker

@@ -92,7 +92,7 @@ doc = CommonMarker.render_doc(ARGF.read, options.active_parse_options, options.a
 
 if options.renderer
   renderer = CommonMarker::HtmlRenderer.new(extensions: options.active_extensions)
-  STDOUT.write(renderer.render(doc))
+  $stdout.write(renderer.render(doc))
 else
-  STDOUT.write(doc.to_html(options.active_render_options, options.active_extensions))
+  $stdout.write(doc.to_html(options.active_render_options, options.active_extensions))
 end

data/commonmarker.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   s.executables = ['commonmarker']
   s.require_paths = %w[lib ext]
+  s.required_ruby_version = ['>= 2.4.10', '< 4.0']
 
   s.rdoc_options += ['-x', 'ext/commonmarker/cmark/.*']
 

data/lib/commonmarker/config.rb

@@ -27,14 +27,16 @@ module CommonMarker
       define :TABLE_PREFER_STYLE_ATTRIBUTES, (1 << 15)
       define :FULL_INFO_STRING, (1 << 16)
       define :UNSAFE, (1 << 17)
+      define :FOOTNOTES, (1 << 13)
     end
 
     def self.process_options(option, type)
       type = Config.const_get(type.capitalize)
-      if option.is_a?(Symbol)
+      case option
+      when Symbol
         check_option(option, type)
         type.to_h[option]
-      elsif option.is_a?(Array)
+      when Array
         option = [nil] if option.empty?
         # neckbearding around. the map will both check the opts and then bitwise-OR it
         option.map do |o|

data/lib/commonmarker/node.rb

@@ -11,7 +11,7 @@ module CommonMarker
     #
     # blk - A {Proc} representing the action to take for each child
     def walk(&block)
-      return enum_for(:walk) unless block_given?
+      return enum_for(:walk) unless block
 
       yield self
       each do |child|

data/lib/commonmarker/renderer.rb

@@ -6,6 +6,7 @@ require 'stringio'
 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(+'')
@@ -18,11 +19,12 @@ module CommonMarker
 
     def out(*args)
       args.each do |arg|
-        if arg == :children
+        case arg
+        when :children
           @node.each { |child| out(child) }
-        elsif arg.is_a?(Array)
+        when Array
           arg.each { |x| render(x) }
-        elsif arg.is_a?(Node)
+        when Node
           render(arg)
         else
           @stream.write(arg)

data/lib/commonmarker/version.rb

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

data/test/test_commands.rb

@@ -5,27 +5,27 @@ require 'test_helper'
 class TestCommands < Minitest::Test
   def test_basic
     out = make_bin('strong.md')
-    assert_equal out, '<p>I am <strong>strong</strong></p>'
+    assert_equal('<p>I am <strong>strong</strong></p>', out)
   end
 
   def test_does_not_have_extensions
     out = make_bin('table.md')
-    assert out.include?('| a')
-    refute out.include?('<p><del>hi</del>')
-    refute out.include?('<table> <tr> <th> a </th> <td> c </td>')
+    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 out.include?('| a')
-    refute out.include?('<p><del>hi</del>')
-    %w[<table> <tr> <th> a </th> <td> c </td>].each { |html| assert out.include?(html) }
+    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 out.include?('| a')
-    assert out.include?('<p><del>hi</del>')
-    %w[<table> <tr> <th> a </th> <td> c </td>].each { |html| assert out.include?(html) }
+    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

@@ -30,7 +30,7 @@ class TestCommonmark < Minitest::Test
     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

@@ -8,13 +8,13 @@ class TestEncoding < Minitest::Test
     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

@@ -9,30 +9,30 @@ class TestExtensions < Minitest::Test
 
   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
 
@@ -40,19 +40,19 @@ class TestExtensions < Minitest::Test
     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

data/test/test_footnotes.rb

@@ -24,4 +24,25 @@ class TestFootnotes < Minitest::Test
   def test_html_renderer
     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="#fn1" id="fnref1">1</a></sup></p>
+      <section class="footnotes">
+      <ol>
+      <li id="fn1">
+      <p>This is a footnote <a href="#fnref1" class="footnote-backref">↩</a></p>
+      </li>
+      </ol>
+      </section>
+    HTML
+    assert_equal expected, CommonMarker.render_html(md, :FOOTNOTES)
+  end
 end

data/test/test_helper.rb

@@ -44,8 +44,8 @@ def open_spec_file(filename)
       example_number += 1
       end_line = line_number
       tests << {
-        markdown: markdown_lines.join('').tr('→', "\t"),
-        html: html_lines.join('').tr('→', "\t").rstrip,
+        markdown: markdown_lines.join.tr('→', "\t"),
+        html: html_lines.join.tr('→', "\t").rstrip,
         example: example_number,
         start_line: start_line,
         end_line: end_line,

data/test/test_maliciousness.rb

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

data/test/test_pathological_inputs.rb

@@ -10,7 +10,7 @@ end
 # list of pairs consisting of input and a regex that must match the output.
 pathological = {
   'nested strong emph' =>
-              [('*a **a ' * 65_000) + 'b' + (' a** a*' * 65_000),
+              ["#{'*a **a ' * 65_000}b#{' a** a*' * 65_000}",
                Regexp.compile('(<em>a <strong>a ){65_000}b( a</strong> a</em>){65_000}')],
   'many emph closers with no openers' =>
                [('a_ ' * 65_000),
@@ -34,10 +34,10 @@ pathological = {
                ['**x [a*b**c*](d)',
                 Regexp.compile('\\*\\*x <a href=\'d\'>a<em>b</em><em>c</em></a>')],
   'nested brackets' =>
-               [('[' * 50_000) + 'a' + (']' * 50_000),
+               ["#{'[' * 50_000}a#{']' * 50_000}",
                 Regexp.compile('\[{50000}a\]{50000}')],
   'nested block quotes' =>
-               [(('> ' * 50_000) + 'a'),
+               ["#{'> ' * 50_000}a",
                 Regexp.compile('(<blockquote>\n){50000}')],
   'U+0000 in input' =>
                ['abc\u0000de\u0000',
@@ -53,41 +53,41 @@ end
 
 if ENV['BENCH']
   class PathologicalInputsPerformanceTest < Minitest::Benchmark
-    def bench_pathological_1
+    def test_bench_pathological_one
       assert_performance_linear 0.99 do |n|
         star = '*' * (n * 10)
         markdown("#{star}#{star}hi#{star}#{star}")
       end
     end
 
-    def bench_pathological_2
+    def test_bench_pathological_two
       assert_performance_linear 0.99 do |n|
         c = '`t`t`t`t`t`t' * (n * 10)
         markdown(c)
       end
     end
 
-    def bench_pathological_3
+    def test_bench_pathological_three
       assert_performance_linear 0.99 do |n|
         markdown(" [a]: #{'A' * n}\n\n#{'[a][]' * n}\n")
       end
     end
 
-    def bench_pathological_4
+    def test_bench_pathological_four
       assert_performance_linear 0.5 do |n|
         markdown("#{'[' * n}a#{']' * n}")
       end
     end
 
-    def bench_pathological_5
+    def test_bench_pathological_five
       assert_performance_linear 0.99 do |n|
         markdown("#{'**a *a ' * n}#{'a* a**' * n}")
       end
     end
 
-    def bench_unbound_recursion
+    def test_bench_unbound_recursion
       assert_performance_linear 0.99 do |n|
-        markdown(('[' * n) + 'foo' + ('](bar)' * n))
+        markdown("#{'[' * n}foo#{'](bar)' * n}")
       end
     end
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.21.2
 platform: ruby
 authors:
 - Garen Torikian
 - Ashe Connor
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-enum
@@ -153,7 +153,7 @@ dependencies:
         version: '0'
 description: A fast, safe, extensible parser for CommonMark. This wraps the official
   libcmark library.
-email:
+email: 
 executables:
 - commonmarker
 extensions:
@@ -272,7 +272,7 @@ homepage: https://github.com/gjtorikian/commonmarker
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "-x"
 - ext/commonmarker/cmark/.*
@@ -283,7 +283,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.10
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -291,7 +294,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: