kramdown 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e61a5f6dbf5b13bfcf0164acaf6a0c6e8fa2cd2c39fc7368bf9f54be38e0552
-  data.tar.gz: e03352fce83854b256596c7718dd2c48251b5851f7e1ca06012d433526b6015b
+  metadata.gz: eae4381ea8cc119f4cc1422de0b8c78baad5fc08b930111f66addb73776b7f81
+  data.tar.gz: 75c9f3f7a2385990fa9b490e073bd8d0f34efbb30e1f1b2fe80d4592c3668648
 SHA512:
-  metadata.gz: 3bf07ed2b152212b8aa8e50383b7cfc7a38a16d11441f6c5b2790c834020e3ef8ab82e6978bd86b3334740cc4b23a407f66b744ded4ee22bb6e75b210d3668cc
-  data.tar.gz: 0206cd73d6c8d75470701c197fb89d151e6f3c2c694b20af1068f8c4d03386f065194e92c2c3cea5ec37e72c5f52132ce282d2c80888f229811cefc62f2049ed
+  metadata.gz: 64dfda6f14d6080a968682c5a5f0209a0455733ffbc8bfb7caf8519971cef64a553b4fcc0e18c63812dee4ed3e703dd512abd99cdf8714c9b921e9f93c618026
+  data.tar.gz: bcb900ad8208a1faf047c486015b8ff45fea819e5a45716f6a3a7c04a1958301e5a499bf6baa54988890425fa4fed79fe6c414c4a68493db8a82a5be887935aa

data/CONTRIBUTERS

@@ -1,17 +1,19 @@
   Count Name
 ======= ====
-    909 Thomas Leitner <t_leitner@gmx.at>
+    944 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 Arne Brasseur <arne@arnebrasseur.net>
       3 Henning Perl <perl@fast-sicher.de>
       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>
@@ -25,20 +27,25 @@
       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>
       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>
+      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>
@@ -55,14 +62,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 Ashwin Maroli <ashmaroli@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/README.md

@@ -7,8 +7,14 @@ requests it is now released under the MIT license and therefore can easily be us
 projects, too.
 
 However, if you use kramdown in a commercial setting, please consider **contributing back any
-changes** for the benefit of the community and/or
-[**becoming a patron**](https://www.patreon.com/gettalong) - thanks!
+changes** for the benefit of the community and/or [**becoming a
+sponsor**](https://github.com/sponsors/gettalong/) or [**a
+patron**](https://www.patreon.com/gettalong) - thanks!
+
+Sponsors:
+
+* **GROSSWEBER** provides <a href="http://grossweber.com/b/kramdown" target="_blank">software
+  development consulting and training services</a>.
 
 
 ## Introduction

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.3.0

data/bin/kramdown

@@ -13,6 +13,37 @@ require 'rbconfig'
 require 'yaml'
 require 'kramdown'
 
+def add_kramdown_options(opts, parsed_options, banner: [], ignore: [])
+  banner_shown = false
+  defined_options = []
+  Kramdown::Options.definitions.sort.each do |n, definition|
+    next if ignore.include?(n)
+
+    unless banner_shown
+      opts.separator("")
+      banner.each {|part| opts.separator(part) }
+      opts.separator("")
+      banner_shown = true
+    end
+
+    defined_options << n
+    no = n.to_s.tr('_', '-')
+    if definition.type == Kramdown::Options::Boolean
+      opts.on("--[no-]#{no}") {|v| parsed_options[n] = Kramdown::Options.parse(n, v) }
+    else
+      type = definition.type
+      type = String if type == Symbol || type == Object
+      opts.on("--#{no} ARG", type) {|v| parsed_options[n] = Kramdown::Options.parse(n, v) }
+    end
+
+    definition.desc.split(/\n/).each do |line|
+      opts.separator opts.summary_indent + ' ' * 6 + line
+    end
+    opts.separator ''
+  end
+  defined_options
+end
+
 config_file = nil
 begin
   config_dir = case RbConfig::CONFIG['host_os']
@@ -30,6 +61,7 @@ end
 options = {}
 format = ['html']
 
+defined_options = []
 OptionParser.new do |opts|
   opts.banner = "Usage: kramdown [options] [FILE FILE ...]"
   opts.summary_indent = ' ' * 4
@@ -42,6 +74,20 @@ OptionParser.new do |opts|
           "html, or markdown") {|v| options[:input] = v }
   opts.on("-o", "--output ARG", Array, "Specify one or more output formats separated by commas: " \
           "html (default),", "kramdown, latex, man or remove_html_tags") {|v| format = v }
+  opts.on("-x", "--extension EXT", Array, "Load one or more extensions (without the 'kramdown-' " \
+          "prefix) separated", "by commas (e.g. parser-gfm,syntax-coderay)",
+          "Note: Use this option before other options!") do |exts|
+    exts.each do |ext|
+      begin
+        require "kramdown-#{ext}"
+        new_options = add_kramdown_options(opts, options, banner: ["#{ext} options:"],
+                                           ignore: defined_options)
+        defined_options.concat(new_options)
+      rescue LoadError
+        $stderr.puts "Couldn't load extension #{ext}, ignoring"
+      end
+    end
+  end
   opts.separator ""
   opts.on("--no-config-file", "Do not read any configuration file. Default behavior is to check " \
           "for a", "configuration file and read it if it exists.") { config_file = nil }
@@ -59,25 +105,8 @@ OptionParser.new do |opts|
     exit
   end
 
-  opts.separator ""
-  opts.separator "kramdown options:"
-  opts.separator ""
-
-  Kramdown::Options.definitions.sort.each do |n, definition|
-    no = n.to_s.tr('_', '-')
-    if definition.type == Kramdown::Options::Boolean
-      opts.on("--[no-]#{no}") {|v| options[n] = Kramdown::Options.parse(n, v) }
-    else
-      type = definition.type
-      type = String if type == Symbol || type == Object
-      opts.on("--#{no} ARG", type) {|v| options[n] = Kramdown::Options.parse(n, v) }
-    end
-
-    definition.desc.split(/\n/).each do |line|
-      opts.separator opts.summary_indent + ' ' * 6 + line
-    end
-    opts.separator ''
-  end
+  new_options = add_kramdown_options(opts, options, banner: ["kramdown options:"])
+  defined_options.concat(new_options)
 end.parse!
 
 begin

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,15 +46,16 @@ module Kramdown
         @toc_code = nil
         @indent = 2
         @stack = []
-      end
 
-      # The mapping of element type to conversion method.
-      DISPATCHER = Hash.new {|h, k| h[k] = "convert_#{k}" }
+        # 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
 
       # 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
@@ -67,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
@@ -78,7 +79,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)
@@ -86,21 +88,23 @@ module Kramdown
           inner(el, indent)
         elsif el.children.size == 1 && el.children.first.type == :img &&
             el.children.first.options[:ial]&.[](:refs)&.include?('standalone')
-          convert_standalone_image(el.children.first, indent)
+          convert_standalone_image(el, 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
 
       # Helper method used by +convert_p+ to convert a paragraph that only contains a single :img
       # element.
       def convert_standalone_image(el, indent)
-        attr = el.attr.dup
-        figure_attr = {}
-        figure_attr['class'] = attr.delete('class') if attr.key?('class')
-        figure_attr['id'] = attr.delete('id') if attr.key?('id')
-        body = "#{' ' * (indent + @indent)}<img#{html_attributes(attr)} />\n" \
-          "#{' ' * (indent + @indent)}<figcaption>#{attr['alt']}</figcaption>\n"
+        figure_attr = el.attr.dup
+        image_attr = el.children.first.attr.dup
+
+        figure_attr['class'] = image_attr.delete('class') if image_attr.key?('class') and not figure_attr.key?('class')
+        figure_attr['id'] = image_attr.delete('id') if image_attr.key?('id') and not figure_attr.key?('id')
+
+        body = "#{' ' * (indent + @indent)}<img#{html_attributes(image_attr)} />\n" \
+          "#{' ' * (indent + @indent)}<figcaption>#{image_attr['alt']}</figcaption>\n"
         format_as_indented_block_html("figure", figure_attr, body, indent)
       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]
+        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')
-          @footnote_location = (0..128).to_a.map { rand(36).to_s(36) }.join
+        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)
         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,8 +303,8 @@ module Kramdown
           @footnotes << [name, el.value, number, 0]
           @footnotes_by_name[name] = @footnotes.last
         end
-        "<sup id=\"fnref:#{name}#{repeat}\">" \
-          "<a href=\"#fn:#{name}\" class=\"footnote\">" \
+        "<sup id=\"fnref:#{name}#{repeat}\" role=\"doc-noteref\">" \
+          "<a href=\"#fn:#{name}\" class=\"footnote\" rel=\"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
 
@@ -475,9 +482,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 +492,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 +527,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])
@@ -182,12 +182,17 @@ module Kramdown
         result << inner(el, opts) << "\n"
       end
 
-      HTML_TAGS_WITH_BODY = ['div', 'script', 'iframe', 'textarea']
+      HTML_TAGS_WITH_BODY = ['div', 'script', 'iframe', 'textarea', 'th', 'td']
+
+      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] || \
@@ -421,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
@@ -517,7 +517,7 @@ module Kramdown
         8194 => ['\hskip .5em\relax'],
         8195 => ['\quad'],
       } # :nodoc:
-      ENTITY_CONV_TABLE.each_value {|v| v[0] = "{}#{v[0]}" }
+      ENTITY_CONV_TABLE.each_value {|v| v[0] = "#{v[0]}{}" }
 
       def entity_to_latex(entity)
         text, package = ENTITY_CONV_TABLE[entity.code_point]

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