kramdown 1.5.0 → 1.6.0

data/lib/kramdown/converter/latex.rb

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

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -20,11 +20,26 @@ module Kramdown::Converter::MathEngine
       text = (el.value =~ /<|&/ ? "% <![CDATA[\n#{el.value} %]]>" : el.value)
       text.gsub!(/<\/?script>?/, '')
 
+      preview = preview_string(converter, el, opts)
+
       attr = {:type => "math/tex#{type == :block ? '; mode=display' : ''}"}
       if type == :block
-        converter.format_as_block_html('script', attr, text, opts[:indent])
+        preview << converter.format_as_block_html('script', attr, text, opts[:indent])
+      else
+        preview << 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)
+
+      if el.options[:category] == :block
+        converter.format_as_block_html('div', {'class' => 'MathJax_Preview'}, preview, opts[:indent])
       else
-        converter.format_as_span_html('script', attr, text)
+        converter.format_as_span_html('span', {'class' => 'MathJax_Preview'}, preview)
       end
     end
 

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/converter/pdf.rb

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

data/lib/kramdown/converter/remove_html_tags.rb

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

data/lib/kramdown/converter/syntax_highlighter.rb

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2015 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 a 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!
+    module SyntaxHighlighter
+    end
+
+  end
+end

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

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

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -28,7 +28,7 @@ module Kramdown::Converter::SyntaxHighlighter
 
       opts[:wrap] = false if type == :span
 
-      formatter = ::Rouge::Formatters::HTML.new(opts)
+      formatter = (opts.delete(:formatter) || ::Rouge::Formatters::HTML).new(opts)
       formatter.format(lexer.lex(text))
     end
 

data/lib/kramdown/converter/toc.rb

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

data/lib/kramdown/document.rb

@@ -1,29 +1,29 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # 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.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'
 #

data/lib/kramdown/element.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -37,6 +37,9 @@ module Kramdown
   # :abbrev_defs:: This key may be used to store the mapping of abbreviation to abbreviation
   #                definition.
   #
+  # :abbrev_attr:: This key may be used to store the mapping of abbreviation to abbreviation
+  #                attributes.
+  #
   # :options:: This key may be used to store options that were set during parsing of the document.
   #
   #

data/lib/kramdown/error.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/options.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -418,7 +418,8 @@ specified levels are used for the table of contents.
 Default: 1..6
 Used by: HTML/Latex converter
 EOF
-      if String === val
+      case val
+      when String
         if val =~ /^(\d)\.\.(\d)$/
           val = Range.new($1.to_i, $2.to_i).to_a
         elsif val =~ /^\d(?:,\d)*$/
@@ -426,7 +427,7 @@ EOF
         else
           raise Kramdown::Error, "Invalid syntax for option toc_levels"
         end
-      elsif Array === val
+      when Array, Range
         val = val.map {|s| s.to_i}.uniq
       else
         raise Kramdown::Error, "Invalid type #{val.class} for option toc_levels"

data/lib/kramdown/parser.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/parser/base.rb

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-require 'kramdown/utils/string_scanner'
+require 'kramdown/utils'
+require 'kramdown/parser'
 
 module Kramdown
 
@@ -51,7 +52,8 @@ module Kramdown
       def initialize(source, options)
         @source = source
         @options = Kramdown::Options.merge(options)
-        @root = Element.new(:root, nil, nil, :encoding => (source.encoding rescue nil), :location => 1)
+        @root = Element.new(:root, nil, nil, :encoding => (source.encoding rescue nil), :location => 1,
+                            :options => {}, :abbrev_defs => {}, :abbrev_attr => {})
         @warnings = []
         @text_type = :text
       end
@@ -88,7 +90,9 @@ module Kramdown
       # +\n+ and makes sure +source+ ends with a new line character).
       def adapt_source(source)
         if source.respond_to?(:encode)
-          raise "The encoding of the source text is not valid!" if !source.valid_encoding?
+          if !source.valid_encoding?
+            raise "The source text contains invalid characters for the used encoding #{source.encoding}"
+          end
           source = source.encode('UTF-8')
         end
         source.gsub(/\r\n?/, "\n").chomp + "\n"

data/lib/kramdown/parser/gfm.rb

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

data/lib/kramdown/parser/html.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -10,6 +10,7 @@
 require 'rexml/parsers/baseparser'
 require 'strscan'
 require 'kramdown/utils'
+require 'kramdown/parser'
 
 module Kramdown
 
@@ -78,8 +79,7 @@ module Kramdown
         def handle_html_start_tag(line = nil) # :yields: el, closed, handle_body
           name = @src[1].downcase
           closed = !@src[4].nil?
-          attrs = Utils::OrderedHash.new
-          @src[2].scan(HTML_ATTRIBUTE_RE).each {|attr,sep,val| attrs[attr.downcase] = val || ""}
+          attrs = parse_html_attributes(@src[2], line)
 
           el = Element.new(:html_element, name, attrs, :category => :block)
           el.options[:location] = line if line
@@ -97,6 +97,21 @@ module Kramdown
           end
         end
 
+        # Parses the given string for HTML attributes and returns the resulting hash.
+        #
+        # If the optional +line+ parameter is supplied, it is used in warning messages.
+        def parse_html_attributes(str, line = nil)
+          attrs = Utils::OrderedHash.new
+          str.scan(HTML_ATTRIBUTE_RE).each do |attr, sep, val|
+            attr.downcase!
+            if attrs.has_key?(attr)
+              warning("Duplicate HTML attribute '#{attr}' on line #{line || '?'} - overwriting previous one")
+            end
+            attrs[attr] = val || ""
+          end
+          attrs
+        end
+
         # Handle the raw HTML tag at the current position.
         def handle_raw_html_tag(name)
           curpos = @src.pos

data/lib/kramdown/parser/kramdown.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -9,6 +9,7 @@
 
 require 'strscan'
 require 'stringio'
+require 'kramdown/parser'
 
 #TODO: use [[:alpha:]] in all regexp to allow parsing of international values in 1.9.1
 #NOTE: use @src.pre_match only before other check/match?/... operations, otherwise the content is changed
@@ -66,7 +67,6 @@ module Kramdown
 
         reset_env
 
-        @root.options[:abbrev_defs] = {}
         @alds = {}
         @footnotes = {}
         @link_defs = {}
@@ -88,6 +88,7 @@ module Kramdown
         configure_parser
         parse_blocks(@root, adapt_source(source))
         update_tree(@root)
+        correct_abbreviations_attributes
         replace_abbreviations(@root)
         @footnotes.each {|name,data| update_tree(data[:content])}
       end
@@ -134,7 +135,6 @@ module Kramdown
 
         status = catch(:stop_block_parsing) do
           while !@src.eos?
-            block_ial_set = @block_ial
             @block_parsers.any? do |name|
               if @src.check(@parsers[name].start_re)
                 send(@parsers[name].method)
@@ -145,7 +145,6 @@ module Kramdown
               warning('Warning: this should not occur - no block parser handled the line')
               add_text(@src.scan(/.*\n/))
             end
-            @block_ial = nil if block_ial_set
           end
         end
 
@@ -165,6 +164,7 @@ module Kramdown
             parse_spans(child)
             child.children
           elsif child.type == :eob
+            update_attr_with_ial(child.attr, child.options[:ial]) if child.options[:ial]
             []
           elsif child.type == :blank
             if last_blank
@@ -290,7 +290,10 @@ module Kramdown
       # exists. This method should always be used for creating a block-level element!
       def new_block_el(*args)
         el = Element.new(*args)
-        el.options[:ial] = @block_ial if @block_ial && el.type != :blank && el.type != :eob
+        if @block_ial
+          el.options[:ial] = @block_ial
+          @block_ial = nil
+        end
         el
       end