commonmarker 0.23.4 → 0.23.5

data/lib/commonmarker/config.rb

@@ -13,7 +13,7 @@ module CommonMarker
         SMART: (1 << 10),
         LIBERAL_HTML_TAG: (1 << 12),
         FOOTNOTES: (1 << 13),
-        STRIKETHROUGH_DOUBLE_TILDE: (1 << 14)
+        STRIKETHROUGH_DOUBLE_TILDE: (1 << 14),
       }.freeze,
       render: {
         DEFAULT: 0,
@@ -28,9 +28,9 @@ module CommonMarker
         FOOTNOTES: (1 << 13),
         STRIKETHROUGH_DOUBLE_TILDE: (1 << 14),
         TABLE_PREFER_STYLE_ATTRIBUTES: (1 << 15),
-        FULL_INFO_STRING: (1 << 16)
+        FULL_INFO_STRING: (1 << 16),
       }.freeze,
-      format: %i[html xml commonmark plaintext].freeze
+      format: [:html, :xml, :commonmark, :plaintext].freeze,
     }.freeze
 
     def self.process_options(option, type)

data/lib/commonmarker/node/inspect.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pp'
+require "pp"
 
 module CommonMarker
   class Node
@@ -8,33 +8,23 @@ module CommonMarker
       PP_INDENT_SIZE = 2
 
       def inspect
-        PP.pp(self, +'', Float::INFINITY)
+        PP.pp(self, +"", Float::INFINITY)
       end
 
       # @param printer [PrettyPrint] pp
       def pretty_print(printer)
-        printer.group(PP_INDENT_SIZE, "#<#{self.class}(#{type}):", '>') do
+        printer.group(PP_INDENT_SIZE, "#<#{self.class}(#{type}):", ">") do
           printer.breakable
 
-          attrs = %i[
-            sourcepos
-            string_content
-            url
-            title
-            header_level
-            list_type
-            list_start
-            list_tight
-            fence_info
-          ].map do |name|
+          attrs = [:sourcepos, :string_content, :url, :title, :header_level, :list_type, :list_start, :list_tight, :fence_info].map do |name|
             [name, __send__(name)]
           rescue NodeError
             nil
           end.compact
 
           printer.seplist(attrs) do |name, value|
-            printer.text "#{name}="
-            printer.pp value
+            printer.text("#{name}=")
+            printer.pp(value)
           end
 
           if first_child
@@ -46,8 +36,8 @@ module CommonMarker
                 children << node
                 node = node.next
               end
-              printer.text 'children='
-              printer.pp children
+              printer.text("children=")
+              printer.pp(children)
             end
           end
         end

data/lib/commonmarker/node.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'commonmarker/node/inspect'
+require "commonmarker/node/inspect"
 
 module CommonMarker
   class Node
@@ -27,7 +27,7 @@ module CommonMarker
     # Returns a {String}.
     def to_html(options = :DEFAULT, extensions = [])
       opts = Config.process_options(options, :render)
-      _render_html(opts, extensions).force_encoding('utf-8')
+      _render_html(opts, extensions).force_encoding("utf-8")
     end
 
     # Public: Convert the node to an XML string.
@@ -37,7 +37,7 @@ module CommonMarker
     # Returns a {String}.
     def to_xml(options = :DEFAULT)
       opts = Config.process_options(options, :render)
-      _render_xml(opts).force_encoding('utf-8')
+      _render_xml(opts).force_encoding("utf-8")
     end
 
     # Public: Convert the node to a CommonMark string.
@@ -48,7 +48,7 @@ module CommonMarker
     # Returns a {String}.
     def to_commonmark(options = :DEFAULT, width = 120)
       opts = Config.process_options(options, :render)
-      _render_commonmark(opts, width).force_encoding('utf-8')
+      _render_commonmark(opts, width).force_encoding("utf-8")
     end
 
     # Public: Convert the node to a plain text string.
@@ -59,7 +59,7 @@ module CommonMarker
     # Returns a {String}.
     def to_plaintext(options = :DEFAULT, width = 120)
       opts = Config.process_options(options, :render)
-      _render_plaintext(opts, width).force_encoding('utf-8')
+      _render_plaintext(opts, width).force_encoding("utf-8")
     end
 
     # Public: Iterate over the children (if any) of the current pointer.
@@ -76,7 +76,7 @@ module CommonMarker
 
     # Deprecated: Please use `each` instead
     def each_child(&block)
-      warn '[DEPRECATION] `each_child` is deprecated.  Please use `each` instead.'
+      warn("[DEPRECATION] `each_child` is deprecated.  Please use `each` instead.")
       each(&block)
     end
   end

data/lib/commonmarker/renderer/html_renderer.rb

@@ -9,8 +9,8 @@ module CommonMarker
 
     def header(node)
       block do
-        out('<h', node.header_level, "#{sourcepos(node)}>", :children,
-            '</h', node.header_level, '>')
+        out("<h", node.header_level, "#{sourcepos(node)}>", :children,
+          "</h", node.header_level, ">")
       end
     end
 
@@ -19,10 +19,10 @@ module CommonMarker
         out(:children)
       else
         block do
-          container("<p#{sourcepos(node)}>", '</p>') do
+          container("<p#{sourcepos(node)}>", "</p>") do
             out(:children)
             if node.parent.type == :footnote_definition && node.next.nil?
-              out(' ')
+              out(" ")
               out_footnote_backref
             end
           end
@@ -36,16 +36,16 @@ module CommonMarker
 
       block do
         if node.list_type == :bullet_list
-          container("<ul#{sourcepos(node)}>\n", '</ul>') do
+          container("<ul#{sourcepos(node)}>\n", "</ul>") do
             out(:children)
           end
         else
           start = if node.list_start == 1
-                    "<ol#{sourcepos(node)}>\n"
-                  else
-                    "<ol start=\"#{node.list_start}\"#{sourcepos(node)}>\n"
-                  end
-          container(start, '</ol>') do
+            "<ol#{sourcepos(node)}>\n"
+          else
+            "<ol start=\"#{node.list_start}\"#{sourcepos(node)}>\n"
+          end
+          container(start, "</ol>") do
             out(:children)
           end
         end
@@ -57,26 +57,26 @@ module CommonMarker
     def list_item(node)
       block do
         tasklist_data = tasklist(node)
-        container("<li#{sourcepos(node)}#{tasklist_data}>#{' ' if tasklist?(node)}", '</li>') do
+        container("<li#{sourcepos(node)}#{tasklist_data}>#{" " if tasklist?(node)}", "</li>") do
           out(:children)
         end
       end
     end
 
     def tasklist(node)
-      return '' unless tasklist?(node)
+      return "" unless tasklist?(node)
 
       state = if checked?(node)
-                'checked="" disabled=""'
-              else
-                'disabled=""'
-              end
+        'checked="" disabled=""'
+      else
+        'disabled=""'
+      end
       "><input type=\"checkbox\" #{state} /"
     end
 
     def blockquote(node)
       block do
-        container("<blockquote#{sourcepos(node)}>\n", '</blockquote>') do
+        container("<blockquote#{sourcepos(node)}>\n", "</blockquote>") do
           out(:children)
         end
       end
@@ -93,17 +93,17 @@ module CommonMarker
         if option_enabled?(:GITHUB_PRE_LANG)
           out("<pre#{sourcepos(node)}")
           out(' lang="', node.fence_info.split(/\s+/)[0], '"') if node.fence_info && !node.fence_info.empty?
-          out('><code>')
+          out("><code>")
         else
           out("<pre#{sourcepos(node)}><code")
           if node.fence_info && !node.fence_info.empty?
             out(' class="language-', node.fence_info.split(/\s+/)[0], '">')
           else
-            out('>')
+            out(">")
           end
         end
         out(escape_html(node.string_content))
-        out('</code></pre>')
+        out("</code></pre>")
       end
     end
 
@@ -112,7 +112,7 @@ module CommonMarker
         if option_enabled?(:UNSAFE)
           out(tagfilter(node.string_content))
         else
-          out('<!-- raw HTML omitted -->')
+          out("<!-- raw HTML omitted -->")
         end
       end
     end
@@ -121,22 +121,22 @@ module CommonMarker
       if option_enabled?(:UNSAFE)
         out(tagfilter(node.string_content))
       else
-        out('<!-- raw HTML omitted -->')
+        out("<!-- raw HTML omitted -->")
       end
     end
 
     def emph(_)
-      out('<em>', :children, '</em>')
+      out("<em>", :children, "</em>")
     end
 
     def strong(_)
-      out('<strong>', :children, '</strong>')
+      out("<strong>", :children, "</strong>")
     end
 
     def link(node)
-      out('<a href="', node.url.nil? ? '' : escape_href(node.url), '"')
+      out('<a href="', node.url.nil? ? "" : escape_href(node.url), '"')
       out(' title="', escape_html(node.title), '"') if node.title && !node.title.empty?
-      out('>', :children, '</a>')
+      out(">", :children, "</a>")
     end
 
     def image(node)
@@ -145,7 +145,7 @@ module CommonMarker
         out(' alt="', :children, '"')
       end
       out(' title="', escape_html(node.title), '"') if node.title && !node.title.empty?
-      out(' />')
+      out(" />")
     end
 
     def text(node)
@@ -153,9 +153,9 @@ module CommonMarker
     end
 
     def code(node)
-      out('<code>')
+      out("<code>")
       out(escape_html(node.string_content))
-      out('</code>')
+      out("</code>")
     end
 
     def linebreak(_node)
@@ -166,7 +166,7 @@ module CommonMarker
       if option_enabled?(:HARDBREAKS)
         out("<br />\n")
       elsif option_enabled?(:NOBREAKS)
-        out(' ')
+        out(" ")
       else
         out("\n")
       end
@@ -199,17 +199,17 @@ module CommonMarker
 
     def table_cell(node)
       align = case @alignments[@column_index]
-              when :left then ' align="left"'
-              when :right then ' align="right"'
-              when :center then ' align="center"'
-              else; ''
-              end
+      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")
       @column_index += 1
     end
 
     def strikethrough(_)
-      out('<del>', :children, '</del>')
+      out("<del>", :children, "</del>")
     end
 
     def footnote_reference(node)
@@ -242,7 +242,7 @@ module CommonMarker
     end
 
     def tasklist?(node)
-      node.type_string == 'tasklist'
+      node.type_string == "tasklist"
     end
 
     def checked?(node)

data/lib/commonmarker/renderer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'stringio'
+require "set"
+require "stringio"
 
 module CommonMarker
   class Renderer
@@ -9,9 +9,9 @@ module CommonMarker
 
     def initialize(options: :DEFAULT, extensions: [])
       @opts = Config.process_options(options, :render)
-      @stream = StringIO.new(+'')
+      @stream = StringIO.new(+"")
       @need_blocksep = false
-      @warnings = Set.new []
+      @warnings = Set.new([])
       @in_tight = false
       @in_plain = false
       @tagfilter = extensions.include?(:tagfilter)
@@ -121,7 +121,7 @@ module CommonMarker
     end
 
     def sourcepos(node)
-      return '' unless option_enabled?(:SOURCEPOS)
+      return "" unless option_enabled?(:SOURCEPOS)
 
       s = node.sourcepos
       " data-sourcepos=\"#{s[:start_line]}:#{s[:start_column]}-" \

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommonMarker
-  VERSION = '0.23.4'
+  VERSION = "0.23.5"
 end

data/lib/commonmarker.rb

@@ -1,15 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'commonmarker/commonmarker'
-require 'commonmarker/config'
-require 'commonmarker/node'
-require 'commonmarker/renderer'
-require 'commonmarker/renderer/html_renderer'
-require 'commonmarker/version'
+require "commonmarker/commonmarker"
+require "commonmarker/config"
+require "commonmarker/node"
+require "commonmarker/renderer"
+require "commonmarker/renderer/html_renderer"
+require "commonmarker/version"
 
 begin
-  require 'awesome_print'
+  require "awesome_print"
 rescue LoadError; end # rubocop:disable Lint/SuppressedException
 module CommonMarker
   # Public:  Parses a Markdown string into an HTML string.
@@ -23,7 +23,7 @@ module CommonMarker
     raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)
 
     opts = Config.process_options(options, :render)
-    Node.markdown_to_html(text.encode('UTF-8'), opts, extensions)
+    Node.markdown_to_html(text.encode("UTF-8"), opts, extensions)
   end
 
   # Public: Parses a Markdown string into a `document` node.
@@ -37,7 +37,7 @@ module CommonMarker
     raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)
 
     opts = Config.process_options(options, :parse)
-    text = text.encode('UTF-8')
+    text = text.encode("UTF-8")
     Node.parse_document(text, text.bytesize, opts, extensions)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.23.4
+  version: 0.23.5
 platform: ruby
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -224,38 +224,11 @@ 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
 - 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
@@ -282,34 +255,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
-test_files:
-- 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
+test_files: []

data/lib/commonmarker/errors.rb

@@ -1,12 +0,0 @@
-# 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/test/benchmark.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-require 'commonmarker'
-require 'redcarpet'
-require 'kramdown'
-require 'benchmark'
-
-benchinput = File.read('test/benchinput.md').freeze
-
-printf("input size = %<bytes>d bytes\n\n", { bytes: benchinput.bytesize })
-
-Benchmark.ips do |x|
-  x.report('redcarpet') do
-    Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: false, tables: false).render(benchinput)
-  end
-
-  x.report('commonmarker with to_html') do
-    CommonMarker.render_html(benchinput)
-  end
-
-  x.report('commonmarker with to_xml') do
-    CommonMarker.render_html(benchinput)
-  end
-
-  x.report('commonmarker with ruby HtmlRenderer') do
-    CommonMarker::HtmlRenderer.new.render(CommonMarker.render_doc(benchinput))
-  end
-
-  x.report('commonmarker with render_doc.to_html') do
-    CommonMarker.render_doc(benchinput, :DEFAULT, [:autolink]).to_html(:DEFAULT, [:autolink])
-  end
-
-  x.report('kramdown') do
-    Kramdown::Document.new(benchinput).to_html(benchinput)
-  end
-
-  x.compare!
-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 = %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