kramdown 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43c55f31bbce7153d1d863ab7c90bb24aee7741e7df3a0f6d89064286fe2344
-  data.tar.gz: c53d7af0318896bae6bdcb9123eb714f9572e4c9918f04d093c7d228c2431b0e
+  metadata.gz: 0d90f86f716aa82f4766f16683887407deb66f637dd997f8b38114b8a48dfc34
+  data.tar.gz: e0de118de20cfdfc45027fccd10af6dfc71a109f62fc769b0de9540c7839b4ed
 SHA512:
-  metadata.gz: 351a0939690de3cf44107f5cad613d8d3dc945b6d47d0e78f8bf676081b7887f696e738fb9200779a6821a870161a3110a7e42911e7705cc7d79af59ff061da6
-  data.tar.gz: dbd73556bc863c0d6a937705662909440fd1dea33415da9e98ac681e5cd33fbedde37a7311b1082c2bcd556aec2896c10ec1d203ca992783f05eae8e7572aea0
+  metadata.gz: 0dd3de9b72e755fe43ed33adc136eaba941e4675d739fa318eedf7e0f63e6db37f92b3564e6ac897014269f1aff48c7e2ad3b70abae490ee92795e830c94d776
+  data.tar.gz: 3710cd52ea508e2ffca6fd6ab1c84efca4308f91540ceb7169fe5e78f09cd33161ad07b287ad716c5b95e295e61018f3957196d6cc597afa197a2d6641d9061f

data/CONTRIBUTERS

@@ -1,13 +1,13 @@
   Count Name
 ======= ====
-    913 Thomas Leitner <t_leitner@gmx.at>
+    930 Thomas Leitner <t_leitner@gmx.at>
+     18 Ashwin Maroli <ashmaroli@gmail.com>
       7 Christian Cornelssen <ccorn@1tein.de>
       6 Gioele Barabucci <gioele@svario.it>
+      5 Gleb Mazovetskiy <glex.spb@gmail.com>
       4 Ted Pak <powerpak006@gmail.com>
       4 Shuanglei Tao <tsl0922@gmail.com>
-      4 Gleb Mazovetskiy <glex.spb@gmail.com>
       4 Dan Allen <dan.j.allen@gmail.com>
-      4 Ashwin Maroli <ashmaroli@gmail.com>
       4 Arne Brasseur <arne@arnebrasseur.net>
       3 Henning Perl <perl@fast-sicher.de>
       3 gettalong <t_leitner@gmx.at>
@@ -26,12 +26,15 @@
       1 utenmiki <utenmiki@gmail.com>
       1 Trevor Wennblom <trevor@well.com>
       1 tomykaira <tomykaira@gmail.com>
+      1 tom93 <tomlevy93@gmail.com>
       1 Tim Blair <tim@bla.ir>
       1 Tim Besard <tim.besard@gmail.com>
       1 Tim Bates <tim@rumpuslabs.com>
       1 Sun Yaozhu <yzyzsun@gmail.com>
+      1 Stephen <stephengroat@users.noreply.github.com>
       1 Stephen Crosby <stevecrozz@gmail.com>
       1 Simon Lydell <simon.lydell@gmail.com>
+      1 Simon Coffey <simon.coffey@futurelearn.com>
       1 Shusaku NAKAZATO <cu393uc@gmail.com>
       1 Sebastian Boehm <sebastian@sometimesfood.org>
       1 scherr <maximilianscherr@gmail.com>
@@ -40,6 +43,7 @@
       1 myqlarson <myqlarson@gmail.com>
       1 milo.simpson <milo.simpson@bazaarvoice.com>
       1 Michal Till <michal.till@gmail.com>
+      1 Maxime Kjaer <maxime.kjaer@gmail.com>
       1 Matt Hickford <matt.hickford@gmail.com>
       1 Martyn Chamberlin <martyn@perfectioncoding.com>
       1 Marek Tuchowski <marek@tuchowski.com.pl>
@@ -56,13 +60,17 @@
       1 Hector Correa <hector@hectorcorrea.com>
       1 Florian Klampfer <f.klampfer@gmail.com>
       1 Floreal Morandat florealm@gmail.com <florealm@gmail.com>
+      1 Fangyi Zhou <me@fangyi.io>
       1 Diego Galeota <diegobg123@gmail.com>
+      1 David Rodríguez <deivid.rodriguez@riseup.net>
       1 Damien Pollet <damien.pollet@gmail.com>
       1 Christopher Jefferson <caj21@st-andrews.ac.uk>
       1 Cédric Boutillier <cedric.boutillier@gmail.com>
+      1 Bob Lail <lail@squareup.com>
       1 Ashe Connor <ashe@kivikakk.ee>
       1 Antoine Cotten <hello@acotten.com>
       1 Andrew <andrew.dale.wylie@gmail.com>
       1 Alpha Chen <alpha.chen@gmail.com>
       1 Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>
       1 Alexey Vasiliev <le0pard@users.noreply.github.com>
+      1 284km <k.furuhashi10@gmail.com>

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.0

data/lib/kramdown/converter/base.rb

@@ -106,7 +106,8 @@ module Kramdown
         end
         result = converter.convert(tree)
         if result.respond_to?(:encode!) && result.encoding != Encoding::BINARY
-          result.encode!(tree.options[:encoding])
+          result.encode!(tree.options[:encoding] ||
+                         (raise ::Kramdown::Error, "Missing encoding option on root element"))
         end
         if !converter.options[:template].empty? && converter.apply_template_after?
           result = apply_template(converter, result)

data/lib/kramdown/converter/html.rb

@@ -46,6 +46,9 @@ module Kramdown
         @toc_code = nil
         @indent = 2
         @stack = []
+
+        # stash string representation of symbol to avoid allocations from multiple interpolations.
+        @highlighter_class = " highlighter-#{options[:syntax_highlighter]}"
       end
 
       # The mapping of element type to conversion method.
@@ -78,7 +81,8 @@ module Kramdown
       end
 
       def convert_text(el, _indent)
-        escape_html(el.value, :text)
+        escaped = escape_html(el.value, :text)
+        @options[:remove_line_breaks_for_cjk] ? fix_cjk_line_break(escaped) : escaped
       end
 
       def convert_p(el, indent)
@@ -88,7 +92,7 @@ module Kramdown
             el.children.first.options[:ial]&.[](:refs)&.include?('standalone')
           convert_standalone_image(el.children.first, indent)
         else
-          format_as_block_html(el.type, el.attr, inner(el, indent), indent)
+          format_as_block_html("p", el.attr, inner(el, indent), indent)
         end
       end
 
@@ -135,7 +139,7 @@ module Kramdown
       end
 
       def convert_blockquote(el, indent)
-        format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
+        format_as_indented_block_html("blockquote", el.attr, inner(el, indent), indent)
       end
 
       def convert_header(el, indent)
@@ -152,12 +156,15 @@ module Kramdown
         "#{' ' * indent}<hr#{html_attributes(el.attr)} />\n"
       end
 
+      ZERO_TO_ONETWENTYEIGHT = (0..128).to_a.freeze
+      private_constant :ZERO_TO_ONETWENTYEIGHT
+
       def convert_ul(el, indent)
         if !@toc_code && (el.options[:ial][:refs].include?('toc') rescue nil)
-          @toc_code = [el.type, el.attr, (0..128).to_a.map { rand(36).to_s(36) }.join]
+          @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')
-          @footnote_location = (0..128).to_a.map { rand(36).to_s(36) }.join
+          @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)
         end
@@ -165,7 +172,7 @@ module Kramdown
       alias convert_ol convert_ul
 
       def convert_dl(el, indent)
-        format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
+        format_as_indented_block_html("dl", el.attr, inner(el, indent), indent)
       end
 
       def convert_li(el, indent)
@@ -188,7 +195,7 @@ module Kramdown
             break
           end
         end if !attr['id'] && @stack.last.options[:ial] && @stack.last.options[:ial][:refs]
-        format_as_block_html(el.type, attr, inner(el, indent), indent)
+        format_as_block_html("dt", attr, inner(el, indent), indent)
       end
 
       def convert_html_element(el, indent)
@@ -263,7 +270,7 @@ module Kramdown
       end
 
       def convert_a(el, indent)
-        format_as_span_html(el.type, el.attr, inner(el, indent))
+        format_as_span_html("a", el.attr, inner(el, indent))
       end
 
       def convert_img(el, _indent)
@@ -296,7 +303,7 @@ module Kramdown
           @footnotes << [name, el.value, number, 0]
           @footnotes_by_name[name] = @footnotes.last
         end
-        "<sup id=\"fnref:#{name}#{repeat}\">" \
+        "<sup id=\"fnref:#{name}#{repeat}\" role=\"doc-noteref\">" \
           "<a href=\"#fn:#{name}\" class=\"footnote\">" \
           "#{number}</a></sup>"
       end
@@ -400,7 +407,7 @@ module Kramdown
       # Add the syntax highlighter name to the 'class' attribute of the given attribute hash. And
       # overwrites or add a "language-LANG" part using the +lang+ parameter if +lang+ is not nil.
       def add_syntax_highlighter_to_class_attr(attr, lang = nil)
-        (attr['class'] = (attr['class'] || '') + " highlighter-#{@options[:syntax_highlighter]}").lstrip!
+        (attr['class'] = (attr['class'] || '') + @highlighter_class).lstrip!
         attr['class'].sub!(/\blanguage-\S+|(^)/) { "language-#{lang}#{$1 ? ' ' : ''}" } if lang
       end
 
@@ -408,6 +415,7 @@ module Kramdown
       def generate_toc_tree(toc, type, attr)
         sections = Element.new(type, nil, attr.dup)
         sections.attr['id'] ||= 'markdown-toc'
+        sections.attr['role'] ||= 'doc-toc'
         stack = []
         toc.each do |level, id, children|
           li = Element.new(:li, nil, nil, level: level)
@@ -475,9 +483,9 @@ module Kramdown
         result
       end
 
-      FOOTNOTE_BACKLINK_FMT = "%s<a href=\"#fnref:%s\" class=\"reversefootnote\">%s</a>"
+      FOOTNOTE_BACKLINK_FMT = "%s<a href=\"#fnref:%s\" class=\"reversefootnote\" role=\"doc-backlink\">%s</a>"
 
-      # Return a HTML ordered list with the footnote content for the used footnotes.
+      # Return an HTML ordered list with the footnote content for the used footnotes.
       def footnote_content
         ol = Element.new(:ol)
         ol.attr['start'] = @footnote_start if @footnote_start != 1
@@ -485,7 +493,7 @@ module Kramdown
         backlink_text = escape_html(@options[:footnote_backlink], :text)
         while i < @footnotes.length
           name, data, _, repeat = *@footnotes[i]
-          li = Element.new(:li, nil, 'id' => "fn:#{name}")
+          li = Element.new(:li, nil, 'id' => "fn:#{name}", 'role' => 'doc-endnote')
           li.children = Marshal.load(Marshal.dump(data.children))
 
           para = nil
@@ -520,7 +528,7 @@ module Kramdown
         if ol.children.empty?
           ''
         else
-          format_as_indented_block_html('div', {class: "footnotes"}, convert(ol, 2), 0)
+          format_as_indented_block_html('div', {class: "footnotes", role: "doc-endnotes"}, convert(ol, 2), 0)
         end
       end
 

data/lib/kramdown/converter/kramdown.rb

@@ -34,13 +34,13 @@ module Kramdown
         res = res.dup if res.frozen?
         if ![:html_element, :li, :dt, :dd, :td].include?(el.type) && (ial = ial_for_element(el))
           res << ial
-          res << "\n\n" if Element.category(el) == :block
+          res << "\n\n" if el.block?
         elsif [:ul, :dl, :ol, :codeblock].include?(el.type) && opts[:next] &&
             ([el.type, :codeblock].include?(opts[:next].type) ||
              (opts[:next].type == :blank && opts[:nnext] &&
               [el.type, :codeblock].include?(opts[:nnext].type)))
           res << "^\n\n"
-        elsif Element.category(el) == :block &&
+        elsif el.block? &&
             ![:li, :dd, :dt, :td, :th, :tr, :thead, :tbody, :tfoot, :blank].include?(el.type) &&
             (el.type != :html_element || @stack.last.type != :html_element) &&
             (el.type != :p || !el.options[:transparent])
@@ -184,10 +184,15 @@ module Kramdown
 
       HTML_TAGS_WITH_BODY = ['div', 'script', 'iframe', 'textarea']
 
+      HTML_ELEMENT_TYPES = [:entity, :text, :html_element].freeze
+      private_constant :HTML_ELEMENT_TYPES
+
       def convert_html_element(el, opts)
         markdown_attr = el.options[:category] == :block && el.children.any? do |c|
-          c.type != :html_element && (c.type != :p || !c.options[:transparent]) &&
-            Element.category(c) == :block
+          c.type != :html_element &&
+            (c.type != :p || !c.options[:transparent] ||
+             c.children.any? {|t| !HTML_ELEMENT_TYPES.member?(t.type) }) &&
+            c.block?
         end
         opts[:force_raw_text] = true if %w[script pre code].include?(el.value)
         opts[:raw_text] = opts[:force_raw_text] || opts[:block_raw_text] || \

data/lib/kramdown/converter/math_engine/mathjax.rb

@@ -16,40 +16,14 @@ module Kramdown::Converter::MathEngine
   module Mathjax
 
     def self.call(converter, el, opts)
-      type = el.options[:category]
-      text = (el.value =~ /<|&/ ? "% <![CDATA[\n#{el.value} %]]>" : el.value).dup
-      text.gsub!(/<\/?script>?/, '')
-
-      preview = preview_string(converter, el, opts).dup
-
-      attr = {type: "math/tex#{type == :block ? '; mode=display' : ''}"}
-      preview << if type == :block
-                   converter.format_as_block_html('script', attr, text, opts[:indent])
-                 else
-                   converter.format_as_span_html('script', attr, text)
-                 end
-    end
-
-    def self.preview_string(converter, el, opts)
-      preview = converter.options[:math_engine_opts][:preview]
-      return '' unless preview
-
-      preview = (preview == true ? converter.escape_html(el.value) : preview.to_s)
-
-      preview_as_code = converter.options[:math_engine_opts][:preview_as_code]
-
-      if el.options[:category] == :block
-        if preview_as_code
-          converter.format_as_block_html('pre', {'class' => 'MathJax_Preview'},
-                                         converter.format_as_span_html('code', {}, preview),
-                                         opts[:indent])
-        else
-          converter.format_as_block_html('div', {'class' => 'MathJax_Preview'}, preview,
-                                         opts[:indent])
-        end
+      value = converter.escape_html(el.value)
+      result = el.options[:category] == :block ?  "\\[#{value}\\]\n" : "\\(#{value}\\)"
+      if el.attr.empty?
+        result
+      elsif el.options[:category] == :block
+        converter.format_as_block_html('div', el.attr, result, opts[:indent])
       else
-        converter.format_as_span_html(preview_as_code ? 'code' : 'span',
-                                      {'class' => 'MathJax_Preview'}, preview)
+        converter.format_as_span_html('span', el.attr, "$#{el.value}$")
       end
     end
 

data/lib/kramdown/converter/syntax_highlighter.rb

@@ -42,7 +42,7 @@ module Kramdown
     #
     # == Special Implementation Details
     #
-    # HTML converter:: If the syntax highlighter is used with a HTML converter, it should return
+    # HTML converter:: If the syntax highlighter is used with an HTML converter, it should return
     #                  :block type text correctly wrapped (i.e. normally inside a pre-tag, but may
     #                  also be a table-tag or just a div-tag) but :span type text *without* a
     #                  code-tag!

data/lib/kramdown/element.rb

@@ -522,6 +522,22 @@ module Kramdown
       CATEGORY[el.type] || el.options[:category]
     end
 
+    # syntactic sugar to simplify calls such as +Kramdown::Element.category(el) == :block+ with
+    # +el.block?+.
+    #
+    # Returns boolean true or false.
+    def block?
+      (CATEGORY[type] || options[:category]) == :block
+    end
+
+    # syntactic sugar to simplify calls such as +Kramdown::Element.category(el) == :span+ with
+    # +el.span?+.
+    #
+    # Returns boolean true or false.
+    def span?
+      (CATEGORY[type] || options[:category]) == :span
+    end
+
   end
 
 end

data/lib/kramdown/options.rb

@@ -328,7 +328,11 @@ module Kramdown
       Used by: HTML converter, kramdown converter
     EOF
 
-    define(:toc_levels, Object, (1..6).to_a, <<~EOF) do |val|
+    TOC_LEVELS_RANGE = (1..6).freeze
+    TOC_LEVELS_ARRAY = TOC_LEVELS_RANGE.to_a.freeze
+    private_constant :TOC_LEVELS_RANGE, :TOC_LEVELS_ARRAY
+
+    define(:toc_levels, Object, TOC_LEVELS_ARRAY, <<~EOF) do |val|
       Defines the levels that are used for the table of contents
 
       The individual levels can be specified by separating them with commas
@@ -347,12 +351,20 @@ module Kramdown
         else
           raise Kramdown::Error, "Invalid syntax for option toc_levels"
         end
-      when Array, Range
-        val = val.map(&:to_i).uniq
+      when Array
+        unless val.eql?(TOC_LEVELS_ARRAY)
+          val = val.map(&:to_i).uniq
+        end
+      when Range
+        if val.eql?(TOC_LEVELS_RANGE)
+          val = TOC_LEVELS_ARRAY
+        else
+          val = val.map(&:to_i).uniq
+        end
       else
         raise Kramdown::Error, "Invalid type #{val.class} for option toc_levels"
       end
-      if val.any? {|i| !(1..6).cover?(i) }
+      if val.any? {|i| !TOC_LEVELS_RANGE.cover?(i) }
         raise Kramdown::Error, "Level numbers for option toc_levels have to be integers from 1 to 6"
       end
       val
@@ -377,7 +389,11 @@ module Kramdown
       simple_array_validator(val, :latex_headers, 6)
     end
 
-    define(:smart_quotes, Object, %w[lsquo rsquo ldquo rdquo], <<~EOF) do |val|
+    SMART_QUOTES_ENTITIES = %w[lsquo rsquo ldquo rdquo].freeze
+    SMART_QUOTES_STR = SMART_QUOTES_ENTITIES.join(',').freeze
+    private_constant :SMART_QUOTES_ENTITIES, :SMART_QUOTES_STR
+
+    define(:smart_quotes, Object, SMART_QUOTES_ENTITIES, <<~EOF) do |val|
       Defines the HTML entity names or code points for smart quote output
 
       The entities identified by entity name or code point that should be
@@ -388,9 +404,13 @@ module Kramdown
       Default: lsquo,rsquo,ldquo,rdquo
       Used by: HTML/Latex converter
     EOF
-      val = simple_array_validator(val, :smart_quotes, 4)
-      val.map! {|v| Integer(v) rescue v }
-      val
+      if val == SMART_QUOTES_STR || val == SMART_QUOTES_ENTITIES
+        SMART_QUOTES_ENTITIES
+      else
+        val = simple_array_validator(val, :smart_quotes, 4)
+        val.map! {|v| Integer(v) rescue v }
+        val
+      end
     end
 
     define(:typographic_symbols, Object, {}, <<~EOF) do |val|
@@ -562,6 +582,13 @@ module Kramdown
       Used by: HTML
     EOF
 
+    define(:remove_line_breaks_for_cjk, Boolean, false, <<~EOF)
+      Specifies whether line breaks should be removed between CJK characters
+
+      Default: false
+      Used by: HTML converter
+    EOF
+
   end
 
 end

data/lib/kramdown/parser/base.rb

@@ -93,7 +93,9 @@ module Kramdown
           raise "The source text contains invalid characters for the used encoding #{source.encoding}"
         end
         source = source.encode('UTF-8')
-        source.gsub(/\r\n?/, "\n").chomp + "\n"
+        source.gsub!(/\r\n?/, "\n")
+        source.chomp!
+        source << "\n"
       end
 
       # This helper method adds the given +text+ either to the last element in the +tree+ if it is a

data/lib/kramdown/parser/html.rb

@@ -16,7 +16,7 @@ module Kramdown
 
   module Parser
 
-    # Used for parsing a HTML document.
+    # Used for parsing an HTML document.
     #
     # The parsing code is in the Parser module that can also be used by other parsers.
     class Html < Base
@@ -286,7 +286,7 @@ module Kramdown
           src = Kramdown::Utils::StringScanner.new(raw)
           result = []
           until src.eos?
-            if (tmp = src.scan_until(/(?=#{HTML_ENTITY_RE})/))
+            if (tmp = src.scan_until(/(?=#{HTML_ENTITY_RE})/o))
               result << Element.new(:text, tmp)
               src.scan(HTML_ENTITY_RE)
               val = src[1] || (src[2]&.to_i) || src[3].hex
@@ -324,7 +324,7 @@ module Kramdown
           tmp = []
           last_is_p = false
           el.children.each do |c|
-            if Element.category(c) != :block || c.type == :text
+            if !c.block? || c.type == :text
               unless last_is_p
                 tmp << Element.new(:p, nil, nil, transparent: true)
                 last_is_p = true
@@ -354,8 +354,8 @@ module Kramdown
           el.children = el.children.reject do |c|
             i += 1
             c.type == :text && c.value.strip.empty? &&
-              (i == 0 || i == el.children.length - 1 || (Element.category(el.children[i - 1]) == :block &&
-                                                         Element.category(el.children[i + 1]) == :block))
+              (i == 0 || i == el.children.length - 1 || ((el.children[i - 1]).block? &&
+                                                         (el.children[i + 1]).block?))
           end
         end
 
@@ -581,11 +581,11 @@ module Kramdown
         @src = Kramdown::Utils::StringScanner.new(adapt_source(source))
 
         while true
-          if (result = @src.scan(/\s*#{HTML_INSTRUCTION_RE}/))
+          if (result = @src.scan(/\s*#{HTML_INSTRUCTION_RE}/o))
             @tree.children << Element.new(:xml_pi, result.strip, nil, category: :block)
-          elsif (result = @src.scan(/\s*#{HTML_DOCTYPE_RE}/))
+          elsif (result = @src.scan(/\s*#{HTML_DOCTYPE_RE}/o))
             # ignore the doctype
-          elsif (result = @src.scan(/\s*#{HTML_COMMENT_RE}/))
+          elsif (result = @src.scan(/\s*#{HTML_COMMENT_RE}/o))
             @tree.children << Element.new(:xml_comment, result.strip, nil, category: :block)
           else
             break