kramdown 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d76ec0e7087a62788b9eb1d27027b1d4b4a2610e
-  data.tar.gz: 4b6fcefcd89fd851be053d975cdd825e07278c58
+  metadata.gz: 7dfcfddc0bd28ea18be74a4f72d5a0f9549fdbfa
+  data.tar.gz: 419c886d8df8aa564eae484b89f3c7faceb259a7
 SHA512:
-  metadata.gz: 9c34e8bb6438d78c04d45c4237856530669933add8620ce12e3847729d6a49429b114be6dc00dcefe3ff2b450a4f947bfc36c2854dbb6c43799437f5429efbb8
-  data.tar.gz: 902838d7ee4add0e5dc66e67899b75fd9f44dddfff181eb6c99b20ffebd1af97c920f15bf6a87317c410ffef89f57ba28d9b6e48bbf1bc7de714389833ffee6a
+  metadata.gz: 93aba2d37108f5e0651d66ee8ac3361440616414fb48e88c80fe20bdc46b93d5f6a8e392800c6c00bfc91aaf473501cbfb246d4f63985f6fafa366e18af80529
+  data.tar.gz: b50d2da0703b9fabc8a81064ea019038d85bf8e61986b411bbec27af28024c53701dfa06126294f1ef1c3aa1dc175d699253f5d892c19fb8cacaa34ac56ddd24

data/CONTRIBUTERS

@@ -1,6 +1,6 @@
   Count Name
 ======= ====
-    700 Thomas Leitner <t_leitner@gmx.at>
+    720 Thomas Leitner <t_leitner@gmx.at>
       6 Gioele Barabucci <gioele@svario.it>
       4 Ted Pak <powerpak006@gmail.com>
       4 Arne Brasseur <arne@arnebrasseur.net>
@@ -30,5 +30,6 @@
       1 Luca Barbato <luca.barbato@gmail.com>
       1 John Croisant <jacius@gmail.com>
       1 Joe Fiorini <joe@faithfulgeek.org>
+      1 Floreal Morandat florealm@gmail.com <florealm@gmail.com>
       1 Damien Pollet <damien.pollet@gmail.com>
       1 Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>

data/Rakefile

@@ -177,8 +177,11 @@ EOF
       s.default_executable = 'kramdown'
       s.add_development_dependency 'minitest', '~> 5.0'
       s.add_development_dependency 'coderay', '~> 1.0.0'
+      s.add_development_dependency 'rouge', '~> 1.7'
       s.add_development_dependency 'stringex', '~> 1.5.1'
       s.add_development_dependency 'prawn', '~> 0.13'
+      s.add_development_dependency 'ritex', '~> 1.0'
+      s.add_development_dependency 'itextomml', '~> 1.5'
 
       #### Documentation
 

data/VERSION

@@ -1 +1 @@
-1.4.2
+1.5.0

data/doc/documentation.template

@@ -11,6 +11,13 @@
   * [LaTeX](converter/latex.html)
   * [kramdown](converter/kramdown.html)
   * [RemoveHtmlTags](converter/remove_html_tags.html)
+* Syntax Highlighters
+  * [Coderay](syntax_highlighter/coderay.html)
+  * [Rouge](syntax_highlighter/rouge.html)
+* Math Engines
+  * [MathJax](math_engine/mathjax.html)
+  * [Ritex](math_engine/ritex.html)
+  * [itex2MML](math_engine/itex2mml.html)
 * [Configuration Options](options.html)
 * [Tests](tests.html)
 

data/doc/sidebar.template

@@ -1,7 +1,7 @@
 <h2>News</h2>
 
-<p>The latest version of kramdown is <span class="inline-important">1.4.2</span> and it was released
-on <span class="inline-important">2014-09-16</span></p>
+<p>The latest version of kramdown is <span class="inline-important">1.5.0</span> and it was released
+on <span class="inline-important">2014-10-25</span></p>
 
 <p>More <a href="{relocatable: news.html}">news</a>…</p>
 

data/doc/virtual

@@ -1,2 +1,11 @@
 rdoc/index.html:
   title: API Documentation
+
+/options.en.html#option-syntax-highlighter:
+  dest_path: options.html#option-syntax-highlighter
+
+/options.en.html#option-syntax-highlighter-opts:
+  dest_path: options.html#option-syntax-highlighter-opts
+
+/options.en.html#option-math-engine:
+  dest_path: options.html#option-math-engine

data/lib/kramdown/converter.rb

@@ -7,6 +7,8 @@
 #++
 #
 
+require 'kramdown/utils'
+
 module Kramdown
 
   # This module contains all available converters, i.e. classes that take a root Element and convert
@@ -25,6 +27,43 @@ module Kramdown
     autoload :RemoveHtmlTags, 'kramdown/converter/remove_html_tags'
     autoload :Pdf, 'kramdown/converter/pdf'
 
+    extend ::Kramdown::Utils::Configurable
+
+    configurable(:syntax_highlighter)
+
+    ["Coderay", "Rouge"].each do |klass_name|
+      kn_down = klass_name.downcase.intern
+      add_syntax_highlighter(kn_down) do |converter, text, lang, type, opts|
+        require "kramdown/converter/syntax_highlighter/#{kn_down}"
+        klass = ::Kramdown::Utils.deep_const_get("::Kramdown::Converter::SyntaxHighlighter::#{klass_name}")
+        if klass::AVAILABLE
+          add_syntax_highlighter(kn_down, klass)
+        else
+          add_syntax_highlighter(kn_down) {|*args| nil}
+        end
+        syntax_highlighter(kn_down).call(converter, text, lang, type, opts)
+      end
+    end
+
+    configurable(:math_engine)
+
+    require 'kramdown/converter/math_engine/mathjax'
+    add_math_engine(:mathjax, ::Kramdown::Converter::MathEngine::Mathjax)
+
+    ["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}"
+        klass = ::Kramdown::Utils.deep_const_get("::Kramdown::Converter::MathEngine::#{klass_name}")
+        if klass::AVAILABLE
+          add_math_engine(kn_down, klass)
+        else
+          add_math_engine(kn_down) {|*args| nil}
+        end
+        math_engine(kn_down).call(converter, el, opts)
+      end
+    end
+
   end
 
 end

data/lib/kramdown/converter/base.rb

@@ -196,6 +196,34 @@ module Kramdown
         lang
       end
 
+      # Highlight the given +text+ in the language +lang+ with the syntax highlighter configured
+      # through the option 'syntax_highlighter'.
+      def highlight_code(text, lang, type, opts = {})
+        return nil unless @options[:syntax_highlighter]
+
+        highlighter = ::Kramdown::Converter.syntax_highlighter(@options[:syntax_highlighter])
+        if highlighter
+          highlighter.call(self, text, lang, type, opts)
+        else
+          warning("The configured syntax highlighter #{@options[:syntax_highlighter]} is not available.")
+          nil
+        end
+      end
+
+      # Format the given math element with the math engine configured through the option
+      # 'math_engine'.
+      def format_math(el, opts = {})
+        return nil unless @options[:math_engine]
+
+        engine = ::Kramdown::Converter.math_engine(@options[:math_engine])
+        if engine
+          engine.call(self, el, opts)
+        else
+          warning("The configured math engine #{@options[:math_engine]} is not available.")
+          nil
+        end
+      end
+
       # Generate an unique alpha-numeric ID from the the string +str+ for use as a header ID.
       #
       # Uses the option +auto_id_prefix+: the value of this option is prepended to every generated

data/lib/kramdown/converter/html.rb

@@ -28,15 +28,6 @@ module Kramdown
     # HTML element.
     class Html < Base
 
-      begin
-        require 'coderay'
-
-        # Highlighting via coderay is available if this constant is +true+.
-        HIGHLIGHTING_AVAILABLE = true
-      rescue LoadError
-        HIGHLIGHTING_AVAILABLE = false  # :nodoc:
-      end
-
       include ::Kramdown::Utils::Html
       include ::Kramdown::Parser::Html::Constants
 
@@ -54,7 +45,6 @@ module Kramdown
         @toc_code = nil
         @indent = 2
         @stack = []
-        @coderay_enabled = @options[:enable_coderay] && HIGHLIGHTING_AVAILABLE
       end
 
       # The mapping of element type to conversion method.
@@ -101,13 +91,11 @@ module Kramdown
       def convert_codeblock(el, indent)
         attr = el.attr.dup
         lang = extract_code_language!(attr)
-        if @coderay_enabled && (lang || @options[:coderay_default_lang])
-          opts = {:wrap => @options[:coderay_wrap], :line_numbers => @options[:coderay_line_numbers],
-            :line_number_start => @options[:coderay_line_number_start], :tab_width => @options[:coderay_tab_width],
-            :bold_every => @options[:coderay_bold_every], :css => @options[:coderay_css]}
-          lang = (lang || @options[:coderay_default_lang]).to_sym
-          result = CodeRay.scan(el.value, lang).html(opts).chomp << "\n"
-          "#{' '*indent}<div#{html_attributes(attr)}>#{result}#{' '*indent}</div>\n"
+        highlighted_code = highlight_code(el.value, lang, :block)
+
+        if highlighted_code
+          add_syntax_highlighter_to_class_attr(attr)
+          "#{' '*indent}<div#{html_attributes(attr)}>#{highlighted_code}#{' '*indent}</div>\n"
         else
           result = escape_html(el.value)
           result.chomp!
@@ -261,13 +249,16 @@ module Kramdown
       end
 
       def convert_codespan(el, indent)
-        lang = extract_code_language(el.attr)
-        result = if @coderay_enabled && lang
-                   CodeRay.scan(el.value, lang.to_sym).html(:wrap => :span, :css => @options[:coderay_css]).chomp
-                 else
-                   escape_html(el.value)
-                 end
-        format_as_span_html('code', el.attr, result)
+        attr = el.attr.dup
+        lang = extract_code_language(attr)
+        result = highlight_code(el.value, lang, :span)
+        if result
+          add_syntax_highlighter_to_class_attr(attr)
+        else
+          result = escape_html(el.value)
+        end
+
+        format_as_span_html('code', attr, result)
       end
 
       def convert_footnote(el, indent)
@@ -319,14 +310,12 @@ module Kramdown
       end
 
       def convert_math(el, indent)
-        block = (el.options[:category] == :block)
-        value = (el.value =~ /<|&/ ? "% <![CDATA[\n#{el.value} %]]>" : el.value)
-        value.gsub!(/<\/?script>?/, '')
-        type = {:type => "math/tex#{block ? '; mode=display' : ''}"}
-        if block
-          format_as_block_html('script', type, value, indent)
+        if (result = format_math(el, :indent => indent))
+          result
+        elsif el.options[:category] == :block
+          format_as_block_html('pre', el.attr, "$$\n#{el.value}\n$$", indent)
         else
-          format_as_span_html('script', type, value)
+          format_as_span_html('span', el.attr, "$#{el.value}$")
         end
       end
 
@@ -370,6 +359,11 @@ module Kramdown
         "#{' '*indent}<#{name}#{html_attributes(attr)}>\n#{body}#{' '*indent}</#{name}>\n"
       end
 
+      # Add the syntax highlighter name to the 'class' attribute of the given attribute hash.
+      def add_syntax_highlighter_to_class_attr(attr)
+        (attr['class'] = (attr['class'] || '') + " highlighter-#{@options[:syntax_highlighter]}").lstrip!
+      end
+
       # Generate and return an element tree for the table of contents.
       def generate_toc_tree(toc, type, attr)
         sections = Element.new(type, nil, attr)

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

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown::Converter::MathEngine
+
+  # Uses the Itex2MML library for converting math formulas to MathML.
+  module Itex2MML
+
+    begin
+      require 'itextomml'
+
+      # Itex2MML is available if this constant is +true+.
+      AVAILABLE = true
+    rescue LoadError
+      AVAILABLE = false  # :nodoc:
+    end
+
+    def self.call(converter, el, opts)
+      type = el.options[:category]
+      parser = ::Itex2MML::Parser.new
+      result = (type == :block ? parser.block_filter(el.value) : parser.inline_filter(el.value))
+
+      attr = el.attr.dup
+      attr.delete('xmlns')
+      attr.delete('display')
+      result.insert("<math".length, converter.html_attributes(attr))
+
+      (type == :block ? "#{' '*opts[:indent]}#{result}\n" : result)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2014 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)
+      type = el.options[:category]
+      text = (el.value =~ /<|&/ ? "% <![CDATA[\n#{el.value} %]]>" : el.value)
+      text.gsub!(/<\/?script>?/, '')
+
+      attr = {:type => "math/tex#{type == :block ? '; mode=display' : ''}"}
+      if type == :block
+        converter.format_as_block_html('script', attr, text, opts[:indent])
+      else
+        converter.format_as_span_html('script', attr, text)
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown::Converter::MathEngine
+
+  # Uses the Ritex library for converting math formulas to MathML.
+  module Ritex
+
+    begin
+      require 'ritex'
+
+      # Ritex is available if this constant is +true+.
+      AVAILABLE = true
+    rescue LoadError
+      AVAILABLE = false  # :nodoc:
+    end
+
+    def self.call(converter, el, opts)
+      type = el.options[:category]
+      result = ::Ritex::Parser.new.parse(el.value, :display => (type == :block))
+
+      attr = el.attr.dup
+      attr.delete('xmlns')
+      attr.delete('display')
+      result.insert("<math".length, converter.html_attributes(attr))
+
+      (type == :block ? "#{' '*opts[:indent]}#{result}\n" : result)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+module Kramdown::Converter::SyntaxHighlighter
+
+  # Uses Coderay to highlight code blocks and code spans.
+  module Coderay
+
+    begin
+      require 'coderay'
+
+      # Highlighting via coderay is available if this constant is +true+.
+      AVAILABLE = true
+    rescue LoadError
+      AVAILABLE = false  # :nodoc:
+    end
+
+    def self.call(converter, text, lang, type, _unused_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"
+      else
+        nil
+      end
+    end
+
+    def self.options(converter, type)
+      prepare_options(converter)
+      converter.data[:syntax_highlighter_coderay][type]
+    end
+
+    def self.prepare_options(converter)
+      return if converter.data.key?(:syntax_highlighter_coderay)
+
+      cache = converter.data[:syntax_highlighter_coderay] = {}
+
+      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[:default_lang] = converter.options[:coderay_default_lang] || opts.delete(:default_lang)
+      cache[:span] = {
+        :css => converter.options[:coderay_css]
+      }.update(opts).update(span_opts).update(:wrap => :span)
+      cache[:block] = {
+        :wrap => converter.options[:coderay_wrap],
+        :line_numbers => converter.options[:coderay_line_numbers],
+        :line_number_start => converter.options[:coderay_line_number_start],
+        :tab_width => converter.options[:coderay_tab_width],
+        :bold_every => converter.options[:coderay_bold_every],
+        :css => converter.options[:coderay_css]
+      }.update(opts).update(block_opts)
+
+      [:css, :wrap, :line_numbers].each do |key|
+        [:block, :span].each do |type|
+          cache[type][key] = cache[type][key].to_sym if cache[type][key].kind_of?(String)
+        end
+      end
+    end
+
+  end
+
+end