kramdown 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a71580a92ad22dcb405e134d54fd2bf8dc9256574211e85e637ad018aa962160
-  data.tar.gz: 3071848d3d1967ff4682373cfd2824f142354759a23bb386ade7f341ddacfb63
+  metadata.gz: 2a893196013756c877e4baa3d62eb2d3b862684748ed4f329a9723779e30bbeb
+  data.tar.gz: abfac14092805a87a5bdb0c7210ddb157b35a22391a8393a8401fdc547d2f902
 SHA512:
-  metadata.gz: 11c7cf78f53700f9b2a7ece59eb9cf105ecd14e646bcfa47c24aa5b676deaec991479ef3ffd91139799ee97903b3deefd98da6963a58ac32a05bb9e9a0636e95
-  data.tar.gz: c1a3635873ee7cc6a0274734c6bc558fb4043bf3987943043c3a58ec836f4b1487a27f6129729a1662127af73293721cb5af1df79aefacc49983a0d5a3e535d8
+  metadata.gz: 2fdb47e22271964a0a5caef5dc9054a6a5d50cfd81c01665ddfe9aa8e66539ce97125019bea46700ff54227602ce45fd3af98bd48824fe3460aefd6ce6ec3828
+  data.tar.gz: 9927a0d0fe778ac799dcd499727623c7bb35cc2a46a5745042c88d65685502d7bc04384c265155af214f046a2a27f72cf4b73b2d3ddba6a987de85939b6cfe56

data/CONTRIBUTERS

@@ -1,6 +1,6 @@
   Count Name
 ======= ====
-    932 Thomas Leitner <t_leitner@gmx.at>
+    943 Thomas Leitner <t_leitner@gmx.at>
      18 Ashwin Maroli <ashmaroli@gmail.com>
       7 Christian Cornelssen <ccorn@1tein.de>
       6 Gioele Barabucci <gioele@svario.it>
@@ -13,6 +13,7 @@
       3 gettalong <t_leitner@gmx.at>
       3 Brandur <brandur@mutelight.org>
       3 Ben Armston <ben.armston@googlemail.com>
+      3 Ashwin Maroli <ashmaroli@users.noreply.github.com>
       3 Alex Marandon <contact@alexmarandon.com>
       2 Tom Thorogood <me+github@tomthorogood.co.uk>
       2 Parker Moore <parkrmoore@gmail.com>
@@ -40,6 +41,7 @@
       1 scherr <maximilianscherr@gmail.com>
       1 Postmodern <postmodern.mod3@gmail.com>
       1 Pete Michaud <michaudp@gmail.com>
+      1 Noah Doersing <doersino@gmail.com>
       1 myqlarson <myqlarson@gmail.com>
       1 milo.simpson <milo.simpson@bazaarvoice.com>
       1 Michal Till <michal.till@gmail.com>

data/VERSION

@@ -1 +1 @@
-2.2.1
+2.3.0

data/lib/kramdown/converter/html.rb

@@ -49,15 +49,13 @@ module Kramdown
 
         # stash string representation of symbol to avoid allocations from multiple interpolations.
         @highlighter_class = " highlighter-#{options[:syntax_highlighter]}"
+        @dispatcher = Hash.new {|h, k| h[k] = :"convert_#{k}" }
       end
 
-      # The mapping of element type to conversion method.
-      DISPATCHER = Hash.new {|h, k| h[k] = "convert_#{k}" }
-
       # Dispatch the conversion of the element +el+ to a +convert_TYPE+ method using the +type+ of
       # the element.
       def convert(el, indent = -@indent)
-        send(DISPATCHER[el.type], el, indent)
+        send(@dispatcher[el.type], el, indent)
       end
 
       # Return the converted content of the children of +el+ as a string. The parameter +indent+ has
@@ -70,7 +68,7 @@ module Kramdown
         indent += @indent
         @stack.push(el)
         el.children.each do |inner_el|
-          result << send(DISPATCHER[inner_el.type], inner_el, indent)
+          result << send(@dispatcher[inner_el.type], inner_el, indent)
         end
         @stack.pop
         result
@@ -160,10 +158,10 @@ module Kramdown
       private_constant :ZERO_TO_ONETWENTYEIGHT
 
       def convert_ul(el, indent)
-        if !@toc_code && (el.options[:ial][:refs].include?('toc') rescue nil)
+        if !@toc_code && el.options.dig(:ial, :refs)&.include?('toc')
           @toc_code = [el.type, el.attr, ZERO_TO_ONETWENTYEIGHT.map { rand(36).to_s(36) }.join]
           @toc_code.last
-        elsif !@footnote_location && el.options[:ial] && (el.options[:ial][:refs] || []).include?('footnotes')
+        elsif !@footnote_location && el.options.dig(:ial, :refs)&.include?('footnotes')
           @footnote_location = ZERO_TO_ONETWENTYEIGHT.map { rand(36).to_s(36) }.join
         else
           format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)

data/lib/kramdown/converter/kramdown.rb

@@ -426,9 +426,9 @@ module Kramdown
           end
         end.compact.join('')
         res = "toc" + (res.strip.empty? ? '' : " #{res}") if (el.type == :ul || el.type == :ol) &&
-          (el.options[:ial][:refs].include?('toc') rescue nil)
+          el.options.dig(:ial, :refs)&.include?('toc')
         res = "footnotes" + (res.strip.empty? ? '' : " #{res}") if (el.type == :ul || el.type == :ol) &&
-          (el.options[:ial][:refs].include?('footnotes') rescue nil)
+          el.options.dig(:ial, :refs)&.include?('footnotes')
         if el.type == :dl && el.options[:ial] && el.options[:ial][:refs]
           auto_ids = el.options[:ial][:refs].select {|ref| ref.start_with?('auto_ids') }.join(" ")
           res = auto_ids << (res.strip.empty? ? '' : " #{res}") unless auto_ids.empty?

data/lib/kramdown/converter/latex.rb

@@ -127,7 +127,7 @@ module Kramdown
       end
 
       def convert_ul(el, opts)
-        if !@data[:has_toc] && (el.options[:ial][:refs].include?('toc') rescue nil)
+        if !@data[:has_toc] && el.options.dig(:ial, :refs)&.include?('toc')
           @data[:has_toc] = true
           '\tableofcontents'
         else

data/lib/kramdown/converter/syntax_highlighter/rouge.rb

@@ -45,18 +45,26 @@ module Kramdown::Converter::SyntaxHighlighter
       cache = converter.data[:syntax_highlighter_rouge] = {}
 
       opts = converter.options[:syntax_highlighter_opts].dup
-      span_opts = (opts.delete(:span) || {}).dup
-      block_opts = (opts.delete(:block) || {}).dup
-      [span_opts, block_opts].each do |hash|
-        hash.keys.each do |k|
-          hash[k.kind_of?(String) ? Kramdown::Options.str_to_sym(k) : k] = hash.delete(k)
-        end
-      end
 
-      cache[:span] = opts.merge(span_opts).update(wrap: false)
+      span_opts = opts.delete(:span)&.dup || {}
+      block_opts = opts.delete(:block)&.dup || {}
+      normalize_keys(span_opts)
+      normalize_keys(block_opts)
+
+      cache[:span] = opts.merge(span_opts)
+      cache[:span][:wrap] = false
+
       cache[:block] = opts.merge(block_opts)
     end
 
+    def self.normalize_keys(hash)
+      return if hash.empty?
+
+      hash.keys.each do |k|
+        hash[k.kind_of?(String) ? Kramdown::Options.str_to_sym(k) : k] = hash.delete(k)
+      end
+    end
+
     def self.formatter_class(opts = {})
       case formatter = opts[:formatter]
       when Class

data/lib/kramdown/element.rb

@@ -14,6 +14,14 @@ module Kramdown
   # kramdown only uses this one class for representing all available elements in an element tree
   # (paragraphs, headers, emphasis, ...). The type of element can be set via the #type accessor.
   #
+  # The root of a kramdown element tree has to be an element of type :root. It needs to have certain
+  # option keys set so that conversions work correctly. If only a part of a tree should be
+  # converted, duplicate the root node and assign the #children appropriately, e.g:
+  #
+  #   root = doc.root
+  #   new_root = root.dup
+  #   new_root.children = [root.children[0]]  # assign new array with elements to convert
+  #
   # Following is a description of all supported element types.
   #
   # Note that the option :location may contain the start line number of an element in the source

data/lib/kramdown/options.rb

@@ -589,6 +589,16 @@ module Kramdown
       Used by: HTML converter
     EOF
 
+    define(:forbidden_inline_options, Object, %w[template], <<~EOF) do |val|
+      Defines the options that may not be set using the {::options} extension
+
+      Default: template
+      Used by: HTML converter
+    EOF
+      val.map! {|item| item.kind_of?(String) ? str_to_sym(item) : item }
+      simple_array_validator(val, :forbidden_inline_options)
+    end
+
   end
 
 end

data/lib/kramdown/parser/kramdown/extensions.rb

@@ -110,6 +110,12 @@ module Kramdown
           opts.select do |k, v|
             k = k.to_sym
             if Kramdown::Options.defined?(k)
+              if @options[:forbidden_inline_options].include?(k) ||
+                  k == :forbidden_inline_options
+                warning("Option #{k} may not be set inline")
+                next false
+              end
+
               begin
                 val = Kramdown::Options.parse(k, v)
                 @options[k] = val

data/lib/kramdown/parser/kramdown/header.rb

@@ -8,6 +8,7 @@
 #
 
 require 'kramdown/parser/kramdown/block_boundary'
+require 'rexml/xmltokens'
 
 module Kramdown
   module Parser
@@ -40,7 +41,7 @@ module Kramdown
 
       protected
 
-      HEADER_ID = /[\t ]{#(?<id>[A-Za-z][\w:-]*)}\z/
+      HEADER_ID = /[\t ]{#(?<id>#{REXML::XMLTokens::NAME_START_CHAR}#{REXML::XMLTokens::NAME_CHAR}*)}\z/
 
       # Returns header text and optional ID.
       def parse_header_contents

data/lib/kramdown/parser/kramdown/html.rb

@@ -65,7 +65,7 @@ module Kramdown
         end
       end
 
-      HTML_BLOCK_START = /^#{OPT_SPACE}<(#{REXML::Parsers::BaseParser::UNAME_STR}|\?|!--|\/)/
+      HTML_BLOCK_START = /^#{OPT_SPACE}<(#{REXML::Parsers::BaseParser::UNAME_STR}|!--|\/)/
 
       # Parse the HTML at the current position as block-level HTML.
       def parse_block_html
@@ -74,10 +74,6 @@ module Kramdown
           @tree.children << Element.new(:xml_comment, result, nil, category: :block, location: line)
           @src.scan(TRAILING_WHITESPACE)
           true
-        elsif (result = @src.scan(HTML_INSTRUCTION_RE))
-          @tree.children << Element.new(:xml_pi, result, nil, category: :block, location: line)
-          @src.scan(TRAILING_WHITESPACE)
-          true
         else
           if @src.check(/^#{OPT_SPACE}#{HTML_TAG_RE}/o) && !HTML_SPAN_ELEMENTS.include?(@src[1].downcase)
             @src.pos += @src.matched_size
@@ -100,15 +96,13 @@ module Kramdown
       end
       define_parser(:block_html, HTML_BLOCK_START)
 
-      HTML_SPAN_START = /<(#{REXML::Parsers::BaseParser::UNAME_STR}|\?|!--|\/)/
+      HTML_SPAN_START = /<(#{REXML::Parsers::BaseParser::UNAME_STR}|!--|\/)/
 
       # Parse the HTML at the current position as span-level HTML.
       def parse_span_html
         line = @src.current_line_number
         if (result = @src.scan(HTML_COMMENT_RE))
           @tree.children << Element.new(:xml_comment, result, nil, category: :span, location: line)
-        elsif (result = @src.scan(HTML_INSTRUCTION_RE))
-          @tree.children << Element.new(:xml_pi, result, nil, category: :span, location: line)
         elsif (result = @src.scan(HTML_TAG_CLOSE_RE))
           warning("Found invalidly used HTML closing tag for '#{@src[1]}' on line #{line}")
           add_text(result)

data/lib/kramdown/utils/html.rb

@@ -42,6 +42,8 @@ module Kramdown
 
       # Return the HTML representation of the attributes +attr+.
       def html_attributes(attr)
+        return '' if attr.empty?
+
         attr.map do |k, v|
           v.nil? || (k == 'id' && v.strip.empty?) ? '' : " #{k}=\"#{escape_html(v.to_s, :attribute)}\""
         end.join('')

data/lib/kramdown/version.rb

@@ -10,6 +10,6 @@
 module Kramdown
 
   # The kramdown version.
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 
 end

data/man/man1/kramdown.1

@@ -118,6 +118,13 @@ This option can be used to set a prefix for footnote IDs\. This is useful when r
 Default: \[u2018]\[u2019] Used by: HTML
 .RE
 .TP
+\fB\-\-forbidden\-inline\-options\fP \fIARG\fP
+Defines the options that may not be set using the {::options} extension
+.RS
+.P
+Default: template Used by: HTML converter
+.RE
+.TP
 \fB\-\-header\-offset\fP \fIARG\fP
 Sets the output offset for headers
 .RS

data/test/test_files.rb

@@ -231,6 +231,7 @@ class TestFiles < Minitest::Test
       'test/testcases/block/15_math/gh_128.html', # bc of mathjax and HTML parser
       'test/testcases/span/04_footnote/backlink_inline.html', # bc of mathjax
       'test/testcases/block/09_html/standalone_image_in_div.html', # bc of standalone image
+      'test/testcases/block/09_html/processing_instruction.html', # bc of PI
     ].compact
     Dir[File.dirname(__FILE__) + '/testcases/**/*.html'].each do |html_file|
       next if EXCLUDE_HTML_KD_FILES.any? {|f| html_file =~ /#{f}$/ }

data/test/test_location.rb

@@ -18,7 +18,7 @@ describe 'location' do
   def check_element_for_location(element)
     if (match = /^line-(\d+)/.match(element.attr['class'] || ''))
       expected_line = match[1].to_i
-      element.options[:location].must_equal(expected_line)
+      assert_equal(expected_line, element.options[:location])
     end
     element.children.each do |child|
       check_element_for_location(child)
@@ -187,7 +187,7 @@ describe 'location' do
 *[duplicate]: The second definition
     )
     doc = Kramdown::Document.new(test_string.strip)
-    doc.warnings.must_equal ["Duplicate abbreviation ID 'duplicate' on line 4 - overwriting"]
+    assert_equal(["Duplicate abbreviation ID 'duplicate' on line 4 - overwriting"], doc.warnings)
   end
 
   it 'handles abbreviations' do

data/test/test_string_scanner_kramdown.rb

@@ -21,7 +21,7 @@ describe Kramdown::Utils::StringScanner do
     it "computes the correct current_line_number for example ##{i + 1}" do
       str_sc = Kramdown::Utils::StringScanner.new(test_string)
       scan_regexes.each {|scan_re| str_sc.scan_until(scan_re) }
-      str_sc.current_line_number.must_equal expect
+      assert_equal(expect, str_sc.current_line_number)
     end
   end
 end

data/test/testcases/block/09_html/processing_instruction.html

@@ -1,13 +1,12 @@
-<?xml version="1.0"?>
+<p>&lt;?xml version=”1.0”?&gt;</p>
 
 <p>para</p>
 
-<?  test  ?>
-<p>para</p>
+<p>&lt;?  test  ?&gt; para</p>
 
 <p>other</p>
 
-<?
-multiline *text*
+<p>&lt;?
+multiline <em>text</em>
 is allowed
-?>
+?&gt;</p>

data/test/testcases/block/12_extension/options.text

@@ -19,3 +19,5 @@ some *para*
 Some text[^ab].
 
 [^ab]: Some text.
+
+{::options template="/etc/passwd" /}

data/test/testcases/span/05_html/normal.html

@@ -2,7 +2,7 @@
 
 <p><a href="test">title</a> is a title.</p>
 
-<p>This is <? a PI ?>.</p>
+<p>This is &lt;? a PI ?&gt;.</p>
 
 <p>This is <!-- a --> comment.</p>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml