bean-kramdown 0.13.5

data/README

@@ -0,0 +1,43 @@
+= kramdown
+
+kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
+supporting several common extensions. The syntax definition for the kramdown syntax can be found in
+doc/syntax.page and a quick reference is available in doc/quickref.page.
+
+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)
+
+All the documentation on the available input and output formats is available in the doc/ directory
+and online at http://kramdown.rubyforge.org.
+
+
+== Usage
+
+kramdown has a basic *Cloth API, so using kramdown is as easy as
+
+    require 'kramdown'
+
+    Kramdown::Document.new(text).to_html
+
+For detailed information have a look at the API documentation of the Kramdown::Document class.
+
+The full API documentation is available at http://kramdown.rubyforge.org/rdoc/, other sites with an
+API documentation for kramdown probably don't provide the complete documentation!
+
+
+== Development
+
+Just clone the git repository as described in doc/installation.page and you are good to go. You
+probably want to install `rake` so that you can use the provided rake tasks. Aside from that:
+
+* The +tidy+ binary needs to be installed for the automatically derived tests to work.
+* The +latex+ binary needs to be installed for the latex-compilation tests to work.
+
+
+== License
+
+GPLv3 - see the COPYING file.

data/VERSION

@@ -0,0 +1 @@
+0.13.7

data/bin/kramdown

@@ -0,0 +1,78 @@
+#! /Users/vincent/.rvm/rubies/ruby-1.9.3-p125/bin/ruby
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2012 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/>.
+#++
+#
+
+require 'optparse'
+require 'kramdown'
+
+options = {}
+format = 'html'
+OptionParser.new do |opts|
+  opts.banner = "Usage: kramdown [options] [FILE FILE ...]"
+  opts.summary_indent = ' '*4
+
+  opts.separator ""
+  opts.separator "Command line options:"
+  opts.separator ""
+
+  opts.on("-i", "--input ARG", "Specify the input format: kramdown (default) or html") {|v| options[:input] = v}
+  opts.on("-o", "--output ARG", "Specify the output format: html (default), kramdown or latex") {|v| format = v}
+
+  opts.on("-v", "--version", "Show the version of kramdown") do
+    puts Kramdown::VERSION
+    exit
+  end
+  opts.on("-h", "--help", "Show the help") do
+    puts opts.summarize('', 5, 72)
+    exit
+  end
+
+  opts.separator ""
+  opts.separator "kramdown options:"
+  opts.separator ""
+
+  Kramdown::Options.definitions.each do |n, definition|
+    no = n.to_s.tr('_', '-')
+    if definition.type == Kramdown::Options::Boolean
+      opts.on("--[no-]#{no}") {|v| options[n] = Kramdown::Options.parse(n, v)}
+    else
+      type = definition.type
+      type = String if type == Symbol || type == Object
+      opts.on("--#{no} ARG", type) {|v| options[n] = Kramdown::Options.parse(n, v)}
+    end
+
+    definition.desc.split(/\n/).each do |line|
+      opts.separator opts.summary_indent + ' '*6 + line
+    end
+    opts.separator ''
+  end
+
+end.parse!
+
+begin
+  doc = Kramdown::Document.new(ARGF.read, options)
+  puts doc.send("to_#{format}")
+  doc.warnings.each {|warn| $stderr.puts "Warning: #{warn}"}
+rescue Kramdown::Error => e
+  $stderr.puts "Error: #{e.message}"
+  exit(1)
+end

data/lib/kramdown.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2012 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/>.
+#++
+#
+
+require 'kramdown/document'

data/lib/kramdown/compatibility.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2012 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/>.
+#++
+#
+# All the code in this file is backported from Ruby 1.8.7 sothat kramdown works under 1.8.5
+#
+# :stopdoc:
+
+if RUBY_VERSION <= '1.8.6'
+  require 'rexml/parsers/baseparser'
+  module REXML
+    module Parsers
+      class BaseParser
+        UNAME_STR= "(?:#{NCNAME_STR}:)?#{NCNAME_STR}" unless const_defined?(:UNAME_STR)
+      end
+    end
+  end
+
+  if !String.instance_methods.include?("start_with?")
+
+    class String
+      def start_with?(str)
+        self[0, str.length] == str
+      end
+      def end_with?(str)
+        self[-str.length, str.length] == str
+      end
+    end
+
+  end
+
+end

data/lib/kramdown/converter.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2012 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/>.
+#++
+#
+
+module Kramdown
+
+  # This module contains all available converters, i.e. classes that take a root Element and convert
+  # it to a specific output format. The result is normally a string. For example, the
+  # Converter::Html module converts an element tree into valid HTML.
+  #
+  # Converters use the Base class for common functionality (like applying a template to the output)
+  # \- see its API documentation for how to create a custom converter class.
+  module Converter
+
+    autoload :Base, 'kramdown/converter/base'
+    autoload :Html, 'kramdown/converter/html'
+    autoload :Latex, 'kramdown/converter/latex'
+    autoload :Kramdown, 'kramdown/converter/kramdown'
+    autoload :Toc, 'kramdown/converter/toc'
+
+  end
+
+end

data/lib/kramdown/converter/base.rb

@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2012 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/>.
+#++
+#
+
+require 'erb'
+
+module Kramdown
+
+  module Converter
+
+    # == \Base class for converters
+    #
+    # This class serves as base class for all converters. It provides methods that can/should be
+    # used by all converters (like #generate_id) as well as common functionality that is
+    # automatically applied to the result (for example, embedding the output into a template).
+    #
+    # A converter object is used as a throw-away object, i.e. it is only used for storing the needed
+    # state information during conversion. Therefore one can't instantiate a converter object
+    # directly but only use the Base::convert method.
+    #
+    # == Implementing a converter
+    #
+    # Implementing a new converter is rather easy: just derive a new class from this class and put
+    # it in the Kramdown::Converter module (the latter is only needed if auto-detection should work
+    # properly). Then you need to implement the #convert method which has to contain the conversion
+    # code for converting an element and has to return the conversion result.
+    #
+    # The actual transformation of the document tree can be done in any way. However, writing one
+    # method per element type is a straight forward way to do it - this is how the Html and Latex
+    # converters do the transformation.
+    #
+    # Have a look at the Base::convert method for additional information!
+    class Base
+
+      # Can be used by a converter for storing arbitrary information during the conversion process.
+      attr_reader :data
+
+      # The hash with the conversion options.
+      attr_reader :options
+
+      # The root element that is converted.
+      attr_reader :root
+
+      # The warnings array.
+      attr_reader :warnings
+
+      # Initialize the converter with the given +root+ element and +options+ hash.
+      def initialize(root, options)
+        @options = options
+        @root = root
+        @data = {}
+        @warnings = []
+      end
+      private_class_method(:new, :allocate)
+
+      # Convert the element tree +tree+ and return the resulting conversion object (normally a
+      # string) and an array with warning messages. The parameter +options+ specifies the conversion
+      # options that should be used.
+      #
+      # Initializes a new instance of the calling class and then calls the #convert method with
+      # +tree+ as parameter. If the +template+ option is specified and non-empty, the result is
+      # rendered into the specified template. The template resolution is done in the following way:
+      #
+      # 1. Look in the current working directory for the template.
+      #
+      # 2. Append +.convertername+ (e.g. +.html+) to the template name and look for the resulting
+      #    file in the current working directory.
+      #
+      # 3. Append +.convertername+ to the template name and look for it in the kramdown data
+      #    directory.
+      def self.convert(tree, options = {})
+        converter = new(tree, ::Kramdown::Options.merge(options.merge(tree.options[:options] || {})))
+        result = converter.convert(tree)
+        result = apply_template(converter, result) if !converter.options[:template].empty?
+        [result, converter.warnings]
+      end
+
+      # Convert the element +el+ and return the resulting object.
+      #
+      # This is the only method that has to be implemented by sub-classes!
+      def convert(el)
+        raise NotImplementedError
+      end
+
+      # Apply the +template+ using +body+ as the body string.
+      def self.apply_template(converter, body) # :nodoc:
+        erb = ERB.new(get_template(converter.options[:template]))
+        obj = Object.new
+        obj.instance_variable_set(:@converter, converter)
+        obj.instance_variable_set(:@body, body)
+        erb.result(obj.instance_eval{binding})
+      end
+
+      # Return the template specified by +template+.
+      def self.get_template(template) # :nodoc:
+        format_ext = '.' + self.name.split(/::/).last.downcase
+        shipped = File.join(::Kramdown.data_dir, template + format_ext)
+        if File.exist?(template)
+          File.read(template)
+        elsif File.exist?(template + format_ext)
+          File.read(template + format_ext)
+        elsif File.exist?(shipped)
+          File.read(shipped)
+        else
+          raise "The specified template file #{template} does not exist"
+        end
+      end
+
+      # Add the given warning +text+ to the warning array.
+      def warning(text)
+        @warnings << text
+      end
+
+      # Return +true+ if the header element +el+ should be used for the table of contents (as
+      # specified by the +toc_levels+ option).
+      def in_toc?(el)
+        @options[:toc_levels].include?(el.options[:level])
+      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
+      # ID.
+      def generate_id(str)
+        gen_id = str.gsub(/^[^a-zA-Z]+/, '')
+        gen_id.tr!('^a-zA-Z0-9 -', '')
+        gen_id.tr!(' ', '-')
+        gen_id.downcase!
+        gen_id = 'section' if gen_id.length == 0
+        @used_ids ||= {}
+        if @used_ids.has_key?(gen_id)
+          gen_id += '-' << (@used_ids[gen_id] += 1).to_s
+        else
+          @used_ids[gen_id] = 0
+        end
+        @options[:auto_id_prefix] + gen_id
+      end
+
+      SMART_QUOTE_INDICES = {:lsquo => 0, :rsquo => 1, :ldquo => 2, :rdquo => 3} # :nodoc:
+
+      # Return the entity that represents the given smart_quote element.
+      def smart_quote_entity(el)
+        res = @options[:smart_quotes][SMART_QUOTE_INDICES[el.value]]
+        ::Kramdown::Utils::Entities.entity(res)
+      end
+
+    end
+
+  end
+
+end

data/lib/kramdown/converter/bean_html.rb

@@ -0,0 +1,71 @@
+require 'rexml/parsers/baseparser'
+
+module Kramdown
+
+  module Converter
+
+    # Converts a Kramdown::Document to HTML.
+    #
+    # You can customize the HTML converter by sub-classing it and overriding the +convert_NAME+
+    # methods. Each such method takes the following parameters:
+    #
+    # [+el+] The element of type +NAME+ to be converted.
+    #
+    # [+indent+] A number representing the current amount of spaces for indent (only used for
+    #            block-level elements).
+    #
+    # The return value of such a method has to be a string containing the element +el+ formatted as
+    # HTML element.
+    class Html < Base
+      
+      def convert_info_box(el, indent)
+        if el.attr['class']
+          el.attr['class'] = el.attr['class'].include?('test') ?
+              el.attr['class'] :
+              el.attr['class'].split.unshift('test').reject(&:empty?).join(' ')
+        else
+          el.attr['class'] = 'infoBox'
+        end
+
+        "#{' '*indent}<div#{html_attributes(el.attr)}>\n#{inner(el, indent)}#{' '*indent}</div>\n"
+      end
+      
+      def convert_oembed(el, indent)
+        provider = el.attr['provider_name']
+        el.attr['provider_name'] = nil
+        el_id = ""
+        if el.attr['html']
+          oembed_html = el.attr['html']
+          el.attr['html'] = nil
+        end
+        if el.attr['id']
+          el_id = " aria-labelledby=\"#{el.attr['id']}\""
+          el.attr['id'] = nil
+        end
+        if el.attr['role'] === "img"
+          "#{' '*indent}<figure%s#{html_attributes(el.attr)}>#{inner(el, indent)}</figure>\n" % el_id
+        else
+          if provider.casecmp "twitter"
+             "#{' '*indent}<figure#{html_attributes(el.attr)}>#{oembed_html}#{inner(el, indent)}</figure>\n"
+          else
+            "#{' '*indent}<figure%s#{html_attributes(el.attr)}>#{oembed_html}#{inner(el, indent)}</figure>\n" % el_id
+          end
+        end
+      end
+      
+      def convert_figure(el, indent)
+        "#{' '*indent}<figure#{html_attributes(el.attr)}>#{inner(el, indent)}</figure>\n"
+      end
+      
+      def convert_figCaption(el, indent)
+        id = ""
+        if el.attr['id']
+          id = " id=\"#{el.attr['id']}\""
+          el.attr['id'] = nil
+        end
+         "#{' '*indent}<figCaption%s#{html_attributes(el.attr)}>#{escape_html(el.value)}</figCaption>\n" % id
+      end
+      
+    end
+  end
+end