kramdown 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c006f3143fcd067cb7c1a27f80baf39870e3e7
-  data.tar.gz: 88ae530383c5a4cacf7791cfb8c451a2fac49355
+  metadata.gz: e02d6b5a2bd270dd4a2801062964c3ce3de48443
+  data.tar.gz: d24931a4f74b44f4fcfa5f7a5a69b37de51a77c6
 SHA512:
-  metadata.gz: 603752731df3717905665935bd5b3e412943a09de2b5d776f18d6fe1cecca18e210541e81c7863f43a42b469e2a3e5e232b4bce43671abdbfa9a557f01eb78e5
-  data.tar.gz: 8d62fd7e8905d385fb1d269b03f09abb237e8953830d1e01e7ee5e56b10ec796a47fd03c7ac7c3d87dbcdfe4cfc11a2bbf3f04bef1c25b3a5d5b17aa0ae70048
+  metadata.gz: 6a8cf65af4b448aa37056b05c643b0f7af403f7b175e953036d4becea7910e2d111bc715670571e452d241fb6a773ddbb4e00e8f2e8a2045d6a90d4b436411d5
+  data.tar.gz: f5848f1db7010a58de4afd1a05b36215e07250110d37a9e8f3e15aa13dbc90cd298e74d1b3a1f9884e3f574db748a8648853ee8966a97b9373f5c2dcb0a7aeb4

data/CONTRIBUTERS

@@ -1,6 +1,6 @@
   Count Name
 ======= ====
-    861 Thomas Leitner <t_leitner@gmx.at>
+    872 Thomas Leitner <t_leitner@gmx.at>
       6 Gioele Barabucci <gioele@svario.it>
       4 Ted Pak <powerpak006@gmail.com>
       4 Shuanglei Tao <tsl0922@gmail.com>
@@ -15,9 +15,11 @@
       2 Nathanael Jones <nathanael.jones@gmail.com>
       2 Max Meyer <dev@fedux.org>
       2 Jo Hund <jhund@clearcove.ca>
+      2 Christian Cornelssen <ccorn@1tein.de>
       2 Bran <m.versum@gmail.com>
       1 winniehell <git@winniehell.de>
       1 William <suttonwilliamd@gmail.com>
+      1 Uwe Kubosch <donv@users.noreply.github.com>
       1 utenmiki <utenmiki@gmail.com>
       1 Trevor Wennblom <trevor@well.com>
       1 tomykaira <tomykaira@gmail.com>
@@ -28,6 +30,7 @@
       1 Simon Lydell <simon.lydell@gmail.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 myqlarson <myqlarson@gmail.com>
@@ -38,6 +41,7 @@
       1 Marcus Stollsteimer <sto.mar@web.de>
       1 Luca Barbato <luca.barbato@gmail.com>
       1 l3kn <hello@l3kn.de>
+      1 Kir Kolyshkin <kolyshkin@gmail.com>
       1 Jonathan Hooper <jonathan.hooper@gsa.gov>
       1 John Croisant <jacius@gmail.com>
       1 Joe Fiorini <joe@faithfulgeek.org>
@@ -50,5 +54,7 @@
       1 Damien Pollet <damien.pollet@gmail.com>
       1 Christopher Jefferson <caj21@st-andrews.ac.uk>
       1 Cédric Boutillier <cedric.boutillier@gmail.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>

data/Rakefile

@@ -185,6 +185,8 @@ EOF
       s.add_development_dependency 'prawn-table', '~> 0.2.2'
       s.add_development_dependency 'ritex', '~> 1.0'
       s.add_development_dependency 'itextomml', '~> 1.5'
+      s.add_development_dependency 'execjs', '~> 2.7'
+      s.add_development_dependency 'sskatex', '>= 0.9.23'
 
       #### Documentation
 
@@ -266,6 +268,39 @@ EOF
     puts "Look through the above mentioned files and correct all problems" if inserted
   end
 
+  desc "Check for SsKaTeX availability"
+  task :test_sskatex_deps do
+    katexjs = 'katex/katex.min.js'
+    raise (<<TKJ) unless File.exists? katexjs
+Cannot find file '#{katexjs}'.
+You need to download KaTeX e.g. from https://github.com/Khan/KaTeX/releases/
+and extract at least '#{katexjs}'.
+Alternatively, if you have a copy of KaTeX unpacked somewhere else,
+you can create a symbolic link 'katex' pointing to that KaTeX directory.
+TKJ
+    html = %x{echo '$$a$$' | #{RbConfig.ruby} -Ilib bin/kramdown --math-engine sskatex}
+    raise (<<KTC) unless $?.success?
+Some requirement by SsKaTeX or the employed JS engine has not been satisfied.
+Cf. the above error messages.
+KTC
+    raise (<<XJS) unless / class="katex"/ === html
+Some static dependency of SsKaTeX, probably the 'sskatex' or the 'execjs' gem,
+is not available.
+If you 'gem install sskatex', also make sure that some JS engine is available,
+e.g. by installing one of the gems 'duktape', 'therubyracer', or 'therubyrhino'.
+XJS
+    puts "SsKaTeX is available, and its default configuration works."
+  end
+
+  desc "Update kramdown SsKaTeX test reference outputs"
+  task update_katex_tests: [:test_sskatex_deps] do
+    # Not framed in terms of rake file tasks to prevent accidental overwrites.
+    stems = ['test/testcases/block/15_math/sskatex',
+             'test/testcases/span/math/sskatex']
+    stems.each do |stem|
+      ruby "-Ilib bin/kramdown --math-engine sskatex #{stem}.text >#{stem}.html.19"
+    end
+  end
 end
 
 task :gemspec => ['dev:gemspec']

data/VERSION

@@ -1 +1 @@
-1.15.0
+1.16.0

data/bin/kramdown

@@ -9,10 +9,31 @@
 #
 
 require 'optparse'
+require 'rbconfig'
+require 'yaml'
 require 'kramdown'
 
-options = {}
+config_file = nil
+begin
+  config_dir = case RbConfig::CONFIG['host_os']
+               when /bccwin|cygwin|djgpp|mingw|mswin|wince/i
+                 File.expand_path((ENV['HOME'] || ENV['USERPROFILE'] || "~") + "/AppData/Local")
+               when /darwin|mac os/
+                 File.expand_path("~/Library/Preferences/")
+               else
+                 File.expand_path(ENV['XDG_CONFIG_HOME'] || '~/.config')
+               end
+  config_file = File.join(config_dir, "kramdownrc")
+rescue
+end
+
+options = if config_file && File.exist?(config_file)
+            YAML.safe_load(File.read(config_file), [Symbol])
+          else
+            {}
+          end
 format = ['html']
+
 OptionParser.new do |opts|
   opts.banner = "Usage: kramdown [options] [FILE FILE ...]"
   opts.summary_indent = ' '*4

data/doc/default.template

@@ -8,7 +8,7 @@
     <meta name="keywords" content="ruby, kramdown, markdown, text markup" />
     <link href="{relocatable: default.css}" type="text/css" rel="stylesheet" media="screen,projection" />
     <link href="{relocatable: news.atom}" type="application/atom+xml" rel="alternate" />
-    <script src="//kramdown.gettalong.org/MathJax/MathJax.js" type="text/javascript"></script>
+    <script src="//kramdown.gettalong.org/MathJax/MathJax.js?config=default.js" type="text/javascript"></script>
     <title>{title:} | kramdown</title>
   </head>
   <body>

data/doc/documentation.template

@@ -24,6 +24,7 @@
   * [Ritex](math_engine/ritex.html)
   * [itex2MML](math_engine/itex2mml.html)
   * [Mathjax-Node](math_engine/mathjaxnode.html)
+  * [SsKaTeX](math_engine/sskatex.html)
 * [Configuration Options](options.html)
 * [Tests](tests.html)
 

data/doc/index.page

@@ -97,8 +97,8 @@ extensions that have been made popular by the [PHP Markdown Extra] package and [
 It is probably the fastest pure-Ruby Markdown converter available (September 2014), being about 3x
 faster than [Maruku] and about 4.5x faster than [BlueFeather].
 
-Version **1.15.0**{:itemprop="softwareVersion"} released on
-**2017-09-08**{:itemprop="datePublished"}, [more news](news.html)
+Version **1.16.0**{:itemprop="softwareVersion"} released on
+**2017-11-27**{:itemprop="datePublished"}, [more news](news.html)
 {: style="text-align: center; font-size: 80%"}
 
 </div>

data/doc/installation.page

@@ -8,7 +8,7 @@ sort_info: 5
 ## Dependencies
 
 Since kramdown is written in Ruby, you just need the [Ruby interpreter](http://www.ruby-lang.org),
-version 1.8.5, 1.8.6, 1.8.7, 1.9.2, 1.9.3 or 2.x. There are no other dependencies.
+version 2.x. There are no other dependencies.
 
 
 ## Compatibility Notes
@@ -16,7 +16,7 @@ version 1.8.5, 1.8.6, 1.8.7, 1.9.2, 1.9.3 or 2.x. There are no other dependencie
 kramdown should work on any platform which supports Ruby. It has been successfully tested on the
 following platforms:
 
-* Linux with Ruby 1.8.7, 1.9.3, 2.x, jruby 1.7.19 and jruby 9.0.0.0.
+* Linux with Ruby 2.x and jruby 9.0.0.0.
 
 See the platform specific installation notes for more information!
 
@@ -25,13 +25,15 @@ See the platform specific installation notes for more information!
 
 ### Linux
 
-There are a variety of Linux distributions out there with different package management systems. So
-we will focus on instructions for Ubuntu 15.04 here (which should probably also work for any newer
-Ubuntu version or any recent Debian based distribution).
-
-After running the following commands, kramdown is installed and ready to use:
+You need to make sure that Ruby is installed. If it isn't, consult the documentation of the Linux
+distribution you are using on how to install it. For example, in case of Ubuntu 17.10 (this should
+probably also work for any newer Ubuntu version or any recent Debian based distribution) all you
+need to do is:
 
     sudo apt-get install ruby
+
+Once you have Ruby installed, you need to execute the following command to install kramdown:
+
     sudo gem install kramdown
 
 

data/lib/kramdown/converter.rb

@@ -50,7 +50,7 @@ module Kramdown
 
     configurable(:math_engine)
 
-    ['Mathjax', "MathjaxNode", "Ritex", "Itex2MML"].each do |klass_name|
+    ['Mathjax', "MathjaxNode", "SsKaTeX", "Ritex", "Itex2MML"].each do |klass_name|
       kn_down = klass_name.downcase.intern
       add_math_engine(kn_down) do |converter, el, opts|
         require "kramdown/converter/math_engine/#{kn_down}"

data/lib/kramdown/converter/html.rb

@@ -305,7 +305,11 @@ module Kramdown
         :raquo => [::Kramdown::Utils::Entities.entity('raquo')]
       } # :nodoc:
       def convert_typographic_sym(el, indent)
-        TYPOGRAPHIC_SYMS[el.value].map {|e| entity_to_str(e)}.join('')
+        if (result = @options[:typographic_symbols][el.value])
+          escape_html(result, :text)
+        else
+          TYPOGRAPHIC_SYMS[el.value].map {|e| entity_to_str(e)}.join('')
+        end
       end
 
       def convert_smart_quote(el, indent)
@@ -459,10 +463,17 @@ module Kramdown
           li = Element.new(:li, nil, {'id' => "fn:#{name}"})
           li.children = Marshal.load(Marshal.dump(data.children))
 
-          if li.children.last.type == :p
-            para = li.children.last
+          para = nil
+          if li.children.last.type == :p || @options[:footnote_backlink_inline]
+            parent = li
+            while !parent.children.empty? && ![:p, :header].include?(parent.children.last.type)
+              parent = parent.children.last
+            end
+            para = parent.children.last
             insert_space = true
-          else
+          end
+
+          unless para
             li.children << (para = Element.new(:p))
             insert_space = false
           end

data/lib/kramdown/converter/kramdown.rb

@@ -292,14 +292,15 @@ module Kramdown
 
       def convert_img(el, opts)
         alt_text = el.attr['alt'].to_s.gsub(ESCAPED_CHAR_RE) { $1 ? "\\#{$1}" : $2 }
-        if el.attr['src'].empty?
+        src = el.attr['src'].to_s
+        if src.empty?
           "![#{alt_text}]()"
         else
           title = parse_title(el.attr['title'])
-          link = if el.attr['src'].count("()") > 0
-                   "<#{el.attr['src']}>"
+          link = if src.count("()") > 0
+                   "<#{src}>"
                  else
-                   el.attr['src']
+                   src
                  end
           "![#{alt_text}](#{link}#{title})"
         end

data/lib/kramdown/converter/latex.rb

@@ -534,7 +534,11 @@ module Kramdown
         :laquo => '\guillemotleft{}', :raquo => '\guillemotright{}'
       } # :nodoc:
       def convert_typographic_sym(el, opts)
-        TYPOGRAPHIC_SYMS[el.value]
+        if (result = @options[:typographic_symbols][el.value])
+          escape(result)
+        else
+          TYPOGRAPHIC_SYMS[el.value]
+        end
       end
 
       def convert_smart_quote(el, opts)

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

@@ -9,27 +9,27 @@
 
 module Kramdown::Converter::MathEngine
 
-  # Uses the mathjax-node library for converting math formulas to MathML.
+  # Uses the mathjax-node-cli library for converting math formulas to MathML.
   module MathjaxNode
 
     # MathjaxNode is available if this constant is +true+.
-    AVAILABLE = RUBY_VERSION >= '1.9' && begin
-      %x{node --version}[1..-2] >= '4.0'
+    AVAILABLE = begin
+      %x{node --version}[1..-2] >= '4.5'
     rescue
       begin
-        %x{nodejs --version}[1..-2] >= '4.0'
+        %x{nodejs --version}[1..-2] >= '4.5'
       rescue
         false
       end
     end && begin
-      npm = %x{npm --global --depth=1 list mathjax-node 2>&1}
+      npm = %x{npm --global --depth=1 list mathjax-node-cli 2>&1}
 
-      unless /mathjax-node@/ === npm.lines.drop(1).join("\n")
-        npm = %x{npm --depth=1 list mathjax-node 2>&1}
+      unless /mathjax-node-cli@/ === npm.lines.drop(1).join("\n")
+        npm = %x{npm --depth=1 list mathjax-node-cli 2>&1}
       end
 
-      T2MPATH = File.join(npm.lines.first.strip, "node_modules/mathjax-node/bin/tex2mml")
-      /mathjax-node@/ === npm.lines.drop(1).join("\n") && File.exist?(T2MPATH)
+      T2MPATH = File.join(npm.lines.first.strip, "node_modules/mathjax-node-cli/bin/tex2mml")
+      /mathjax-node-cli@/ === npm.lines.drop(1).join("\n") && File.exist?(T2MPATH)
     rescue
       false
     end

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

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2017 Christian Cornelssen <ccorn@1tein.de>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+
+module Kramdown::Converter::MathEngine
+
+  # Consider this a lightweight alternative to MathjaxNode. Uses KaTeX and ExecJS (via ::SsKaTeX)
+  # instead of MathJax and Node.js. Javascript execution context initialization is done only once.
+  # As a result, the performance is reasonable.
+  module SsKaTeX
+
+    # Indicate whether SsKaTeX may be available.
+    #
+    # This test is incomplete; it cannot test the existence of _katex_js_ nor the availability of a
+    # specific _js_run_ because those depend on configuration not given here. This test mainly
+    # indicates whether static dependencies such as the +sskatex+ and +execjs+ gems are available.
+    AVAILABLE = begin
+      require 'sskatex'
+      # No test for any JS engine availability here; specifics are config-dependent anyway
+      true
+    rescue LoadError
+      false
+    end
+
+    if AVAILABLE
+
+      # Class-level cache for ::SsKaTeX converter state, queried by configuration. Note: KTXC
+      # contents may become stale if the contents of used JS files change while the configuration
+      # remains unchanged.
+      KTXC = ::Kramdown::Utils::LRUCache.new(10)
+
+      # A logger that routes messages to the debug channel only. No need to create this dynamically.
+      DEBUG_LOGGER = lambda { |level, &expr| warn(expr.call) }
+
+      class << self
+        private
+
+        # Given a Kramdown::Converter::Base object _converter_, retrieves the logging options and
+        # builds an object usable for ::SsKaTeX#logger. The result is either +nil+ (no logging) or a
+        # +Proc+ object which, when given a _level_ (either +:verbose+ or +:debug+) and a block,
+        # decides whether logging is enabled, and if so, evaluates the given block for the message
+        # and routes that message to the appropriate channels. With <tt>level == :verbose+</tt>,
+        # messages are passed to _converter_.warning if the _converter_'s +:verbose+ option is set.
+        # All messages are passed to +warn+ if the _converter_'s +:debug+ option is set.
+        #
+        # Note that the returned logger may contain references to the given _converter_ and is not
+        # affected by subsequent changes in the _converter_'s logging options.
+        def logger(converter)
+          config = converter.options[:math_engine_opts]
+          debug = config[:debug]
+          if config[:verbose]
+            # Need a closure
+            lambda do |level, &expr|
+              verbose = (level == :verbose)
+              msg = expr.call if debug || verbose
+              warn(msg) if debug
+              converter.warning(msg) if verbose
+            end
+          elsif debug
+            DEBUG_LOGGER
+          end
+        end
+
+        # Given a Kramdown::Converter::Base object _converter_, return a ::SsKaTeX converter _sktx_
+        # that has been configured with _converter_'s +math_engine_opts+, but not for logging. Cache
+        # _sktx_ for reuse, without references to _converter_.
+        def katex_conv(converter)
+          config = converter.options[:math_engine_opts]
+            # Could .reject { |key, _| [:verbose, :debug].include?(key.to_sym) }
+            # because the JS engine setup can be reused for different logging settings.
+            # But then the +math_engine_opts+ dict would be essentially dup'ed every time,
+            # and late activation of logging would miss the initialization if the engine is reused.
+          KTXC[config] ||= ::SsKaTeX.new(config)
+        end
+
+        public
+
+        # The function used by kramdown for rendering TeX math to HTML
+        def call(converter, el, opts)
+          display_mode = el.options[:category]
+          ans = katex_conv(converter).call(el.value, display_mode == :block, &logger(converter))
+          attr = el.attr.dup
+          attr.delete('xmlns')
+          attr.delete('display')
+          ans.insert(ans =~ /[[:space:]>]/, converter.html_attributes(attr))
+          ans = ' ' * opts[:indent] << ans << "\n" if display_mode == :block
+          ans
+        end
+
+      end
+    end
+  end
+end

data/lib/kramdown/converter/remove_html_tags.rb

@@ -30,6 +30,8 @@ module Kramdown
       end
 
       def convert(el)
+        real_el, el = el, el.value if el.type == :footnote
+
         children = el.children.dup
         index = 0
         while index < children.length
@@ -46,7 +48,7 @@ module Kramdown
           end
         end
         el.children = children
-        el
+        real_el || el
       end
 
     end

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

@@ -17,14 +17,6 @@ module Kramdown::Converter::SyntaxHighlighter
 
       # Highlighting via Rouge is available if this constant is +true+.
       AVAILABLE = true
-
-      begin
-        # Rouge::Formatters::HTMLLegacy is available on Rouge 2.0 or later
-        FORMATTER_CLASS = ::Rouge::Formatters::HTMLLegacy
-      rescue NameError
-        # Fallbacks to Rouge 1.x formatter if Rouge::Formatters::HTMLLegacy is not available
-        FORMATTER_CLASS = ::Rouge::Formatters::HTML
-      end
     rescue LoadError, SyntaxError
       AVAILABLE = false  # :nodoc:
     end
@@ -35,7 +27,7 @@ module Kramdown::Converter::SyntaxHighlighter
       lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text)
       return nil if opts[:disable] || !lexer
       opts[:css_class] ||= 'highlight' # For backward compatibility when using Rouge 2.0
-      formatter = (opts.fetch(:formatter, FORMATTER_CLASS)).new(opts)
+      formatter = formatter_class(opts).new(opts)
       formatter.format(lexer.lex(text))
     end
 
@@ -62,6 +54,21 @@ module Kramdown::Converter::SyntaxHighlighter
       cache[:block] = opts.merge(block_opts)
     end
 
+    def self.formatter_class(opts = {})
+      case formatter = opts[:formatter]
+      when Class
+        formatter
+      when /\A[[:upper:]][[:alnum:]_]*\z/
+        ::Rouge::Formatters.const_get(formatter)
+      else
+        # Available in Rouge 2.0 or later
+        ::Rouge::Formatters::HTMLLegacy
+      end
+    rescue NameError
+      # Fallback to Rouge 1.x
+      ::Rouge::Formatters::HTML
+    end
+
   end
 
 end