motion-kramdown 0.6.0 → 1.16.2

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -13,7 +13,7 @@ module Kramdown::Converter::MathEngine
   module Ritex
 
     begin
-      # RM require 'ritex'
+      require 'ritex'
 
       # Ritex is available if this constant is +true+.
       AVAILABLE = true

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/pdf.rb

@@ -1,17 +1,17 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-# RM require 'prawn'
-# RM require 'prawn/table'
-# RM require 'kramdown/converter'
-# RM require 'kramdown/utils'
-# RM require 'open-uri'
+require 'prawn'
+require 'prawn/table'
+require 'kramdown/converter'
+require 'kramdown/utils'
+require 'open-uri'
 
 module Kramdown
 

data/lib/kramdown/converter/remove_html_tags.rb

@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-# RM require 'kramdown/converter'
+require 'kramdown/converter'
 
 module Kramdown
 
@@ -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.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -46,8 +46,11 @@ module Kramdown
     #                  :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!
+    #
+    #                  Also, a syntax highlighter should store the default highlighting language for
+    #                  the invocation in the +opts+ hash under the key :default_lang.
     module SyntaxHighlighter
     end
 
   end
-end
+end

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -13,7 +13,7 @@ module Kramdown::Converter::SyntaxHighlighter
   module Coderay
 
     begin
-      # RM require 'coderay'
+      require 'coderay'
 
       # Highlighting via coderay is available if this constant is +true+.
       # RM AVAILABLE = true
@@ -21,17 +21,20 @@ module Kramdown::Converter::SyntaxHighlighter
       AVAILABLE = false  # :nodoc:
     end
 
-    def self.call(converter, text, lang, type, _unused_opts)
+    def self.call(converter, text, lang, type, call_opts)
       return nil unless converter.options[:enable_coderay]
 
       if type == :span && lang
         ::CodeRay.scan(text, lang.to_sym).html(options(converter, :span)).chomp
       elsif type == :block && (lang || options(converter, :default_lang))
-        lang = (lang || options(converter, :default_lang)).to_sym
-        ::CodeRay.scan(text, lang).html(options(converter, :block)).chomp << "\n"
+        lang ||= call_opts[:default_lang] = options(converter, :default_lang)
+        ::CodeRay.scan(text, lang.to_s.gsub(/-/, '_').to_sym).html(options(converter, :block)).chomp << "\n"
       else
         nil
       end
+    rescue
+      converter.warning("There was an error using CodeRay: #{$!.message}")
+      nil
     end
 
     def self.options(converter, type)

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

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown::Converter::SyntaxHighlighter
+
+  # Uses Minted to highlight code blocks and code spans.
+  module Minted
+
+    def self.call(converter, text, lang, type, _opts)
+      opts = converter.options[:syntax_highlighter_opts]
+
+      # Fallback to default language
+      lang ||= opts[:default_lang]
+
+      options = []
+      options << "breaklines" if opts[:wrap]
+      options << "linenos" if opts[:line_numbers]
+      options << "frame=#{opts[:frame]}" if opts[:frame]
+
+      if lang && type == :block
+        "\\begin{minted}[#{options.join(',')}]{#{lang}}\n#{text}\n\\end{minted}"
+      elsif lang && type == :span
+        "\\mintinline{#{lang}}{#{text}}"
+      else
+        nil
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -13,23 +13,61 @@ module Kramdown::Converter::SyntaxHighlighter
   module Rouge
 
     begin
-      # RM require 'rouge'
+      require 'rouge'
 
       # Highlighting via Rouge is available if this constant is +true+.
-      # RM AVAILABLE = true
-    # RM rescue LoadError, SyntaxError
+      AVAILABLE = false # RM
+    rescue LoadError, SyntaxError
       AVAILABLE = false  # :nodoc:
     end
 
-    def self.call(converter, text, lang, type, _unused_opts)
-      opts = converter.options[:syntax_highlighter_opts].dup
+    def self.call(converter, text, lang, type, call_opts)
+      opts = options(converter, type)
+      call_opts[:default_lang] = opts[:default_lang]
       lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text)
-      return nil unless lexer
+      return nil if opts[:disable] || !lexer
+      opts[:css_class] ||= 'highlight' # For backward compatibility when using Rouge 2.0
+      formatter = formatter_class(opts).new(opts)
+      formatter.format(lexer.lex(text))
+    end
 
-      opts[:wrap] = false if type == :span
+    def self.options(converter, type)
+      prepare_options(converter)
+      converter.data[:syntax_highlighter_rouge][type]
+    end
 
-      formatter = (opts.delete(:formatter) || ::Rouge::Formatters::HTML).new(opts)
-      formatter.format(lexer.lex(text))
+    def self.prepare_options(converter)
+      return if converter.data.key?(:syntax_highlighter_rouge)
+
+      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)
+      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

data/lib/kramdown/converter/toc.rb

@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-# RM require 'kramdown/converter'
+require 'kramdown/converter'
 
 module Kramdown
 

data/lib/kramdown/document.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -29,31 +29,28 @@
 #
 #     Kramdown::Document.new(text).to_html
 #
-# For detailed information have a look at the Kramdown::Document class.
+# For detailed information have a look at the *\Kramdown::Document* class.
 #
 # == License
 #
 # MIT - see the COPYING file.
 
-
-# RM require 'kramdown/compatibility'
-#
-# RM require 'kramdown/version'
-# RM require 'kramdown/element'
-# RM require 'kramdown/error'
-# RM require 'kramdown/parser'
-# RM require 'kramdown/converter'
-# RM require 'kramdown/options'
-# RM require 'kramdown/utils'
+require 'kramdown/version'
+require 'kramdown/element'
+require 'kramdown/error'
+require 'kramdown/parser'
+require 'kramdown/converter'
+require 'kramdown/options'
+require 'kramdown/utils'
 
 module Kramdown
 
   # Return the data directory for kramdown.
   def self.data_dir
     unless defined?(@@data_dir)
-      # RM require 'rbconfig'
+      require 'rbconfig'
       @@data_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'data', 'kramdown'))
-      @@data_dir = File.expand_path(File.join(Config::CONFIG["datadir"], "kramdown")) if !File.exists?(@@data_dir)
+      @@data_dir = File.expand_path(File.join(RbConfig::CONFIG["datadir"], "kramdown")) if !File.exist?(@@data_dir)
       raise "kramdown data directory not found! This is a bug, please report it!" unless File.directory?(@@data_dir)
     end
     @@data_dir
@@ -100,13 +97,13 @@ module Kramdown
     # immediately available and the output can be generated.
     def initialize(source, options = {})
       @options = Options.merge(options).freeze
-      parser = (options[:input] || 'kramdown').to_s
+      parser = (@options[:input] || 'kramdown').to_s
       parser = parser[0..0].upcase + parser[1..-1]
       try_require('parser', parser)
       if Parser.const_defined?(parser)
         @root, @warnings = Parser.const_get(parser).parse(source, @options)
       else
-        raise Kramdown::Error.new("kramdown has no parser to handle the specified input format: #{options[:input]}")
+        raise Kramdown::Error.new("kramdown has no parser to handle the specified input format: #{@options[:input]}")
       end
     end
 
@@ -131,9 +128,9 @@ module Kramdown
 
     # Try requiring a parser or converter class and don't raise an error if the file is not found.
     def try_require(type, name)
-    # RM  require("kramdown/#{type}/#{Utils.snake_case(name)}")
-    # RM  true
-    # RM rescue LoadError
+      require("kramdown/#{type}/#{Utils.snake_case(name)}")
+      true
+    rescue LoadError
       true
     end
     protected :try_require