kramdown 0.14.2 → 2.3.0

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

@@ -0,0 +1,32 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown::Converter::MathEngine
+
+  # Uses the MathJax javascript library for displaying math.
+  #
+  # Note that the javascript library itself is not include or linked, this has to be done
+  # separately. Only the math content is marked up correctly.
+  module Mathjax
+
+    def self.call(converter, el, opts)
+      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('span', el.attr, "$#{el.value}$")
+      end
+    end
+
+  end
+
+end

data/lib/kramdown/converter/remove_html_tags.rb

@@ -1,25 +1,14 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
+require 'kramdown/converter'
+
 module Kramdown
 
   module Converter
@@ -41,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
@@ -57,7 +48,7 @@ module Kramdown
           end
         end
         el.children = children
-        el
+        real_el || el
       end
 
     end

data/lib/kramdown/converter/syntax_highlighter.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown
+  module Converter
+
+    # == Container for Syntax Highlighters
+    #
+    # This module serves as container for the syntax highlighters that can be used together with
+    # kramdown.
+    #
+    # A syntax highlighter should not store any data itself but should use the provided converter
+    # object to do so (See Kramdown::Converter::Base#data).
+    #
+    # == Implementing a Syntax Highlighter
+    #
+    # Implementing a new syntax highlighter is easy because it is just an object that needs to
+    # respond to #call.
+    #
+    # The method #call needs to take the following arguments:
+    #
+    # converter:: This argument contains the converter object that calls the syntax highlighter. It
+    #             can be used, for example, to store data in Kramdown::Converter::Base#data for one
+    #             conversion run.
+    #
+    # text:: The raw text that should be highlighted.
+    #
+    # lang:: The language that the text should be highlighted for (e.g. ruby, python, ...).
+    #
+    # type:: The type of text, either :span for span-level code or :block for a codeblock.
+    #
+    # opts:: A Hash with options that may be passed from the converter.
+    #
+    # The return value of the method should be the highlighted text, suitable for the given
+    # converter (e.g. HTML for the HTML converter).
+    #
+    # == Special Implementation Details
+    #
+    # 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!
+    #
+    #                  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

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

@@ -0,0 +1,35 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2009-2019 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

@@ -0,0 +1,85 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown::Converter::SyntaxHighlighter
+
+  # Uses Rouge which is CSS-compatible to Pygments to highlight code blocks and code spans.
+  module Rouge
+
+    begin
+      require 'rouge'
+
+      # Highlighting via Rouge is available if this constant is +true+.
+      AVAILABLE = true
+    rescue LoadError, SyntaxError
+      AVAILABLE = false # :nodoc:
+    end
+
+    def self.call(converter, text, lang, type, call_opts)
+      opts = options(converter, type)
+      call_opts[:default_lang] = opts[:default_lang]
+      return nil unless lang || opts[:default_lang] || opts[:guess_lang]
+
+      lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text)
+      return nil if opts[:disable] || !lexer || (lexer.tag == "plaintext" && !opts[:guess_lang])
+
+      opts[:css_class] ||= 'highlight' # For backward compatibility when using Rouge 2.0
+      formatter = formatter_class(opts).new(opts)
+      formatter.format(lexer.lex(text))
+    end
+
+    def self.options(converter, type)
+      prepare_options(converter)
+      converter.data[:syntax_highlighter_rouge][type]
+    end
+
+    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 || {}
+      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
+        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

data/lib/kramdown/converter/toc.rb

@@ -1,26 +1,13 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-require 'rexml/parsers/baseparser'
+require 'kramdown/converter'
 
 module Kramdown
 
@@ -50,7 +37,7 @@ module Kramdown
           attr['id'] = generate_id(el.options[:raw_text]) if @options[:auto_ids] && !attr['id']
           add_to_toc(el, attr['id']) if attr['id']
         else
-          el.children.each {|child| convert(child)}
+          el.children.each {|child| convert(child) }
         end
         @toc
       end
@@ -58,10 +45,10 @@ module Kramdown
       private
 
       def add_to_toc(el, id)
-        toc_element = Element.new(:toc, el, :id => id)
+        toc_element = Element.new(:toc, el, id: id)
 
         success = false
-        while !success
+        until success
           if @stack.empty?
             @toc.children << toc_element
             @stack << toc_element

data/lib/kramdown/document.rb

@@ -1,55 +1,39 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 # = kramdown
 #
-# kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
+# kramdown is fast, pure Ruby Markdown superset converter, using a strict syntax definition and
 # supporting several common extensions.
 #
 # The kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However,
 # due to its flexibility it supports other input and output formats as well. Here is a list of the
 # supported formats:
 #
-# * input formats: kramdown (a Markdown superset), Markdown, HTML
-# * output formats: HTML, kramdown, LaTeX (and therefore PDF)
+# * input formats: kramdown (a Markdown superset), Markdown, GFM, HTML
+# * output formats: HTML, kramdown, LaTeX (and therefore PDF), PDF via Prawn
 #
 # All the documentation on the available input and output formats is available at
-# http://kramdown.rubyforge.org.
+# http://kramdown.gettalong.org.
 #
 # == Usage
 #
-# kramdown has a basic *Cloth API, so using kramdown is as easy as
+# kramdown has a simple API, so using kramdown is as easy as
 #
 #     require 'kramdown'
 #
 #     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
 #
-# GPLv3 - see the COPYING file.
-
-
-require 'kramdown/compatibility'
+# MIT - see the COPYING file.
 
 require 'kramdown/version'
 require 'kramdown/element'
@@ -63,16 +47,15 @@ module Kramdown
 
   # Return the data directory for kramdown.
   def self.data_dir
-    unless defined?(@@data_dir)
+    unless defined?(@data_dir)
       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)
-      raise "kramdown data directory not found! This is a bug, please report it!" unless File.directory?(@@data_dir)
+      @data_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'data', 'kramdown'))
+      @data_dir = File.expand_path(File.join(RbConfig::CONFIG["datadir"], "kramdown")) unless 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
+    @data_dir
   end
 
-
   # The main interface to kramdown.
   #
   # This class provides a one-stop-shop for using kramdown to convert text into various output
@@ -100,7 +83,6 @@ module Kramdown
     # ::new) and the conversion phase.
     attr_reader :warnings
 
-
     # Create a new Kramdown document from the string +source+ and use the provided +options+. The
     # options that can be used are defined in the Options module.
     #
@@ -113,12 +95,14 @@ 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, "kramdown has no parser to handle the specified " \
+          "input format: #{@options[:input]}"
       end
     end
 
@@ -127,7 +111,8 @@ module Kramdown
     #
     # For example, +to_html+ would instantiate the Kramdown::Converter::Html class.
     def method_missing(id, *attr, &block)
-      if id.to_s =~ /^to_(\w+)$/ && (name = Utils.camelize($1)) && Converter.const_defined?(name)
+      if id.to_s =~ /^to_(\w+)$/ && (name = Utils.camelize($1)) &&
+          try_require('converter', name) && Converter.const_defined?(name)
         output, warnings = Converter.const_get(name).convert(@root, @options)
         @warnings.concat(warnings)
         output
@@ -140,7 +125,15 @@ module Kramdown
       "<KD:Document: options=#{@options.inspect} root=#{@root.inspect} warnings=#{@warnings.inspect}>"
     end
 
+    # Try requiring a parser or converter class and don't raise an error if the file is not found.
+    def try_require(type, name)
+      require("kramdown/#{type}/#{Utils.snake_case(name)}")
+      true
+    rescue LoadError
+      true
+    end
+    protected :try_require
+
   end
 
 end
-