commonmarker 0.23.1 → 0.23.5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.23.5
 platform: ruby
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -229,36 +229,11 @@ files:
 - lib/commonmarker/renderer.rb
 - lib/commonmarker/renderer/html_renderer.rb
 - lib/commonmarker/version.rb
-- test/benchmark.rb
-- test/fixtures/curly.md
-- test/fixtures/dingus.md
-- test/fixtures/strong.md
-- test/fixtures/table.md
-- test/test_attributes.rb
-- test/test_basics.rb
-- test/test_commands.rb
-- test/test_commonmark.rb
-- test/test_doc.rb
-- test/test_encoding.rb
-- test/test_extensions.rb
-- test/test_footnotes.rb
-- test/test_gc.rb
-- test/test_helper.rb
-- test/test_linebreaks.rb
-- test/test_maliciousness.rb
-- test/test_node.rb
-- test/test_options.rb
-- test/test_pathological_inputs.rb
-- test/test_plaintext.rb
-- test/test_renderer.rb
-- 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: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options:
 - "-x"
@@ -280,34 +255,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
-test_files:
-- test/test_attributes.rb
-- test/test_linebreaks.rb
-- test/test_doc.rb
-- test/test_plaintext.rb
-- test/test_pathological_inputs.rb
-- test/test_node.rb
-- test/test_maliciousness.rb
-- test/test_commands.rb
-- test/test_tasklists.rb
-- test/test_commonmark.rb
-- test/test_encoding.rb
-- test/test_smartpunct.rb
-- test/test_spec.rb
-- test/test_footnotes.rb
-- test/test_extensions.rb
-- test/fixtures/dingus.md
-- test/fixtures/strong.md
-- test/fixtures/table.md
-- test/fixtures/curly.md
-- 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
+test_files: []

data/test/benchmark.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'commonmarker'
-require 'github/markdown'
-require 'redcarpet'
-require 'kramdown'
-require 'benchmark'
-
-def dobench(name, &blk)
-  puts name
-  puts Benchmark.measure(&blk)
-end
-
-benchinput = File.open('test/benchinput.md', 'r').read
-
-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('commonmarker with to_html') do
-  CommonMarker.render_html(benchinput)
-end
-
-dobench('commonmarker with ruby HtmlRenderer') do
-  CommonMarker::HtmlRenderer.new.render(CommonMarker.render_doc(benchinput))
-end
-
-dobench('kramdown') do
-  Kramdown::Document.new(benchinput).to_html(benchinput)
-end

data/test/fixtures/curly.md

@@ -1 +0,0 @@
-This curly quote “makes commonmarker throw an exception”.

data/test/fixtures/dingus.md

@@ -1,10 +0,0 @@
-## Try CommonMark
-
-You can try CommonMark here.  This dingus is powered by
-[commonmark.js](https://github.com/jgm/commonmark.js), the
-JavaScript reference implementation.
-
-1. item one
-2. item two
-   - sublist
-   - sublist

data/test/fixtures/strong.md

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

data/test/fixtures/table.md

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

data/test/test_attributes.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestAttributes < Minitest::Test
-  def setup
-    contents = fixtures_file('dingus.md')
-    @doc = CommonMarker.render_doc(contents.strip)
-  end
-
-  def test_sourcepos
-    sourcepos = []
-
-    @doc.walk do |node|
-      sourcepos << node.sourcepos
-    end
-
-    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 }]
-
-    assert_equal result, sourcepos
-  end
-end

data/test/test_basics.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestBasics < Minitest::Test
-  def setup
-    @doc = CommonMarker.render_doc('Hi *there*')
-  end
-
-  def test_to_html
-    assert_equal "<p>Hi <em>there</em></p>\n", @doc.to_html
-  end
-
-  def test_markdown_to_html
-    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 = [:SOURCEPOS, :UNSAFE, :VALIDATE_UTF8, :SMART, :LIBERAL_HTML_TAG, :FOOTNOTES, :STRIKETHROUGH_DOUBLE_TILDE]
-    render_opt = parse_opt + [: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

@@ -1,72 +0,0 @@
-# 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,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestCommonmark < Minitest::Test
-  HTML_COMMENT = /<!--.*?-->\s?/.freeze
-
-  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, %i[table])
-  end
-
-  def test_to_commonmark
-    compare = render_doc(@markdown).to_commonmark
-
-    assert_equal \
-      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,130 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestDocNode < Minitest::Test
-  def setup
-    @doc = CommonMarker.render_doc('Hi *there*. This has __many nodes__!')
-    @first_child = @doc.first_child
-    @last_child = @doc.last_child
-    @link = CommonMarker.render_doc('[GitHub](https://www.github.com)').first_child.first_child
-    @image = CommonMarker.render_doc('![alt text](https://github.com/favicon.ico "Favicon")')
-    @image = @image.first_child.first_child
-    @header = CommonMarker.render_doc('### Header Three').first_child
-    @ul_list = CommonMarker.render_doc("* Bullet\n*Bullet").first_child
-    @ol_list = CommonMarker.render_doc("1. One\n2. Two").first_child
-    @fence = CommonMarker.render_doc("``` ruby\nputs 'wow'\n```").first_child
-  end
-
-  def test_get_type
-    assert_equal(:document, @doc.type)
-  end
-
-  def test_get_type_string
-    assert_equal('document', @doc.type_string)
-  end
-
-  def test_get_first_child
-    assert_equal(:paragraph, @first_child.type)
-  end
-
-  def test_get_next
-    assert_equal(:emph, @first_child.first_child.next.type)
-  end
-
-  def test_insert_before
-    paragraph = Node.new(:paragraph)
-    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(@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(@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(@first_child.append_child(strong))
-    assert_match "!<strong></strong></p>\n", @doc.to_html
-  end
-
-  def test_get_last_child
-    assert_equal(:paragraph, @last_child.type)
-  end
-
-  def test_get_parent
-    assert_equal(:paragraph, @first_child.first_child.next.parent.type)
-  end
-
-  def test_get_previous
-    assert_equal(:text, @first_child.first_child.next.previous.type)
-  end
-
-  def test_get_url
-    assert_equal('https://www.github.com', @link.url)
-  end
-
-  def test_set_url
-    assert_equal('https://www.mozilla.org', @link.url = 'https://www.mozilla.org')
-  end
-
-  def test_get_title
-    assert_equal('Favicon', @image.title)
-  end
-
-  def test_set_title
-    assert_equal('Octocat', @image.title = 'Octocat')
-  end
-
-  def test_get_header_level
-    assert_equal(3, @header.header_level)
-  end
-
-  def test_set_header_level
-    assert_equal(6, @header.header_level = 6)
-  end
-
-  def test_get_list_type
-    assert_equal(:bullet_list, @ul_list.list_type)
-    assert_equal(:ordered_list, @ol_list.list_type)
-  end
-
-  def test_set_list_type
-    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(1, @ol_list.list_start)
-  end
-
-  def test_set_list_start
-    assert_equal(8, @ol_list.list_start = 8)
-  end
-
-  def test_get_list_tight
-    assert(@ul_list.list_tight)
-    assert(@ol_list.list_tight)
-  end
-
-  def test_set_list_tight
-    refute(@ul_list.list_tight = false)
-    refute(@ol_list.list_tight = false)
-  end
-
-  def test_get_fence_info
-    assert_equal('ruby', @fence.fence_info)
-  end
-
-  def test_set_fence_info
-    assert_equal('javascript', @fence.fence_info = 'javascript')
-  end
-end

data/test/test_encoding.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestEncoding < Minitest::Test
-  # see http://git.io/vq4FR
-  def test_encoding
-    contents = fixtures_file('curly.md')
-    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
-    doc = CommonMarker.render_doc('Hi *there*')
-    text = doc.first_child.last_child.first_child
-    assert_equal('there', text.string_content)
-    assert_equal('UTF-8', text.string_content.encoding.name)
-  end
-end

data/test/test_extensions.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestExtensions < Minitest::Test
-  def setup
-    @markdown = fixtures_file('table.md')
-  end
-
-  def test_uses_specified_extensions
-    CommonMarker.render_html(@markdown, :DEFAULT, %i[]).tap do |out|
-      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_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_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("<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>'
-      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_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_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("<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(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", :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
-  end
-
-  def test_plaintext
-    assert_equal(<<~HTML, CommonMarker.render_doc(<<~MD, :DEFAULT, %i[table strikethrough]).to_plaintext)
-      Hello ~there~.
-
-      | a |
-      | --- |
-      | b |
-    HTML
-      Hello ~~there~~.
-
-      | a |
-      | - |
-      | b |
-    MD
-  end
-end

data/test/test_footnotes.rb

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