kramdown 0.11.0 → 0.12.0

data/README

@@ -1,13 +1,21 @@
-# kramdown
+= kramdown
 
 kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
-supporting several common extensions.
+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 syntax definition can be found in doc/syntax.page, a quick reference in doc/quickref.page. All
-the documentation is available online at http://kramdown.rubyforge.org.
+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)
 
-# Usage
+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
 
@@ -15,16 +23,18 @@ kramdown has a basic *Cloth API, so using kramdown is as easy as
 
     Kramdown::Document.new(text).to_html
 
+For detailed information have a look at the API documentation of the Kramdown::Document class.
+
 
-# Development
+== Development
 
-Just clone the git repository as described in doc/installation.page you are good to go. You probably
-want to install `rake` so that you can use the provided rake tasks. Aside from that:
+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.
+* 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
+== License
 
-See the COPYING file.
+GPLv3 - see the COPYING file.

data/Rakefile

@@ -15,6 +15,7 @@ rescue LoadError
 end
 
 begin
+  gem 'rdoc' if RUBY_VERSION >= '1.9'
   require 'rdoc/task'
   require 'rdoc/rdoc'
 rescue LoadError
@@ -73,17 +74,16 @@ if defined? Webgen
   end
 end
 
-if defined? Rake::RDocTask
-  rd = Rake::RDocTask.new do |rdoc|
+if defined? RDoc::Task
+  rd = RDoc::Task.new do |rdoc|
     rdoc.rdoc_dir = 'htmldoc/rdoc'
     rdoc.title = 'kramdown'
-    rdoc.main = 'Kramdown'
-    rdoc.options << '--line-numbers'
-    rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.main = 'README'
+    rdoc.rdoc_files.include('lib', 'README')
   end
 end
 
-if defined?(Webgen) && defined?(Rake::RDocTask)
+if defined?(Webgen) && defined?(RDoc::Task)
   desc "Build the whole user documentation"
   task :doc => [:rdoc, 'htmldoc']
 end
@@ -176,7 +176,8 @@ EOF
       #### Documentation
 
       s.has_rdoc = true
-      s.rdoc_options = ['--line-numbers', '--main', 'Kramdown']
+      s.rdoc_options = ['--main', 'README']
+      s.extra_rdoc_files = 'README'
 
       #### Author and project details
 
@@ -236,7 +237,7 @@ EOF
 
   desc "Upload the website to Rubyforge"
   task :publish_website => ['doc'] do
-    sh "rsync -avc --delete --exclude 'wiki' --exclude 'js/jsMath' --exclude 'robots.txt'  htmldoc/ gettalong@rubyforge.org:/var/www/gforge-projects/kramdown/"
+    sh "rsync -avc --delete --exclude 'MathJax' --exclude 'robots.txt'  htmldoc/ gettalong@rubyforge.org:/var/www/gforge-projects/kramdown/"
   end
 
 

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.12.0

data/benchmark/benchmark.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+source ~/.bashrc
+
+RUBY_VERSIONS=`rvm list strings | sort`
+KD_VERSIONS="`git tag | sort -V` master"
+OTHERS=false
+
+while getopts "r:k:o" optname; do
+    case "$optname" in
+        "r")
+            RUBY_VERSIONS="$OPTARG"
+            ;;
+        "k")
+            KD_VERSIONS="$OPTARG"
+            ;;
+        "o")
+            OTHERS=true
+            ;;
+        "?")
+            echo "Unknown option $OPTARG"
+            exit 1
+            ;;
+        ":")
+            echo "No argument value for option $OPTARG"
+            exit 1
+            ;;
+        *)
+            echo "Unknown error while processing options"
+            exit 1
+            ;;
+    esac
+done
+
+TMPDIR=/tmp/kramdown-benchmark
+
+rm -rf $TMPDIR
+mkdir -p $TMPDIR
+cp benchmark/md* $TMPDIR
+cp benchmark/generate_data.rb $TMPDIR
+git clone .git ${TMPDIR}/kramdown
+cd ${TMPDIR}/kramdown
+
+for RUBY_VERSION in $RUBY_VERSIONS; do
+	rvm $RUBY_VERSION
+	echo "Creating benchmark data for $(ruby -v)"
+
+    for KD_VERSION in $KD_VERSIONS; do
+        echo "Using kramdown version $KD_VERSION"
+        git co $KD_VERSION 2>/dev/null
+        ruby -I${TMPDIR}/kramdown/lib ../generate_data.rb -k ${KD_VERSION} >/dev/null
+    done
+
+    if [ $OTHERS = "true" ]; then
+        ruby -rubygems -I${TMPDIR}/kramdown/lib ../generate_data.rb -o >/dev/null
+    fi
+done
+
+cd ${TMPDIR}
+rvm default
+ruby generate_data.rb -g

data/benchmark/generate_data.rb

@@ -3,93 +3,95 @@ require 'optparse'
 require 'fileutils'
 
 require 'kramdown'
-require 'maruku'
-require 'maruku/version'
-begin
-  require 'rdiscount'
-  require 'bluecloth'
-rescue LoadError
-end
-require 'bluefeather'
 
-module MaRuKu::Errors
-  def tell_user(s)
-  end
-end
-
-options = {:static => false}
+options = {:others => false}
 OptionParser.new do |opts|
-  opts.on("-s", "--[no-]static", "Generate static data") {|v| options[:static] = v}
+  opts.on("-o", "--[no-]others", "Generate data for other parsers") {|v| options[:others] = v}
   opts.on("-g", "--[no-]graph", "Generate graph") {|v| options[:graph] = v}
-  opts.on("-h NAME", "--historic NAME", String, "Add historic benchmark data") {|v| options[:historic] = v}
+  opts.on("-k VERSION", "--kramdown VERSION", String, "Add benchmark data for kramdown version VERSION") {|v| options[:kramdown] = v}
 end.parse!
 
 
-THISRUBY = (self.class.const_defined?(:RUBY_DESCRIPTION) ? RUBY_DESCRIPTION.scan(/^.*?(?=\s*\()/).first.sub(/\s/, '-') : "ruby-#{RUBY_VERSION}")
+THISRUBY = (self.class.const_defined?(:RUBY_DESCRIPTION) ? RUBY_DESCRIPTION.scan(/^.*?(?=\s*\()/).first.sub(/\s/, '-') : "ruby-#{RUBY_VERSION}") + '-' + RUBY_PATCHLEVEL.to_s
 
 Dir.chdir(File.dirname(__FILE__))
-$:.unshift "../lib"
 BMDATA = File.read('mdbasics.text')
 MULTIPLIER = (0..5).map {|i| 2**i}
 
-if options[:static]
-  static = {}
-  2.times do
-    MULTIPLIER.each do |i|
-      $stderr.puts "Generating static benchmark data, multiplier #{i}"
-      mddata = BMDATA*i
-      static[i] = []
-      static[i] << ["Maruku #{MaRuKu::Version}", Benchmark::measure { Maruku.new(mddata, :on_error => :ignore).to_html }.real]
-      static[i] << ["BlueFeather #{BlueFeather::VERSION}", Benchmark::measure { BlueFeather.parse(mddata) }.real]
-      if self.class.const_defined?(:BlueCloth)
-        static[i] << ["BlueCloth #{BlueCloth::VERSION}", Benchmark::measure { BlueCloth.new(mddata).to_html }.real]
-      else
-        static[i] << ["BlueCloth Not Available.", 0]
+if options[:others]
+  require 'maruku'
+  require 'maruku/version'
+  begin
+    require 'rdiscount'
+  rescue LoadError
+  end
+  #require 'bluefeather'
+
+  module MaRuKu::Errors
+    def tell_user(s)
+    end
+  end
+
+  bmdata = {}
+  labels = []
+  MULTIPLIER.each do |i|
+    $stderr.puts "Generating benchmark data for other parsers, multiplier #{i}"
+    mddata = BMDATA*i
+    labels = []
+    bmdata[i] = Benchmark::bmbm do |x|
+      labels << "Maruku #{MaRuKu::Version}"
+      x.report { Maruku.new(mddata, :on_error => :ignore).to_html }
+      if self.class.const_defined?(:BlueFeather)
+        labels << "BlueFeather #{BlueFeather::VERSION}"
+        x.report { BlueFeather.parse(mddata) }
       end
       if self.class.const_defined?(:RDiscount)
-        static[i] << ["RDiscount #{RDiscount::VERSION}", Benchmark::measure { RDiscount.new(mddata).to_html }.real]
-      else
-        static[i] << ["RDiscount Not Available.", 0]
+        labels << "RDiscount #{RDiscount::VERSION}"
+        x.report { RDiscount.new(mddata).to_html }
       end
     end
   end
   File.open("static-#{THISRUBY}.dat", 'w+') do |f|
-    f.puts "# " + static[MULTIPLIER.first].map {|name, val| name }.join(" || ")
-    format_str = "%5d" + " %10.5f"*static[MULTIPLIER.first].size
-    static.sort.each do |m,v|
-      f.puts format_str % [m, *v.map {|name,val| val}]
+    f.puts "# " + labels.join(" || ")
+    format_str = "%5d" + " %10.5f"*bmdata[MULTIPLIER.first].size
+    bmdata.sort.each do |m,v|
+      f.puts format_str % [m, *v.map {|tms| tms.real}]
     end
   end
 end
 
-if options[:historic]
-  historic = "historic-#{THISRUBY}.dat"
-  data = if File.exist?(historic)
-           lines = File.readlines(historic).map {|l| l.chomp}
+if options[:kramdown]
+  kramdown = "kramdown-#{THISRUBY}.dat"
+  data = if File.exist?(kramdown)
+           lines = File.readlines(kramdown).map {|l| l.chomp}
            lines.first << " || "
            lines
          else
-           ["# ", *MULTIPLIER.map {|m| "%5d" % m}]
+           ["#      ", *MULTIPLIER.map {|m| "%3d" % m}]
          end
-  data.first << " #{options[:historic]}"
+  data.first << "#{options[:kramdown]}".rjust(10)
   MULTIPLIER.each_with_index do |m, i|
-    $stderr.puts "Generating historic benchmark data, multiplier #{m}"
+    $stderr.puts "Generating benchmark data for kramdown version #{options[:kramdown]}, multiplier #{m}"
     mddata = BMDATA*m
-    Benchmark::measure { Kramdown::Document.new(mddata).to_html }
-    data[i+1] << " %10.5f" % Benchmark::measure { Kramdown::Document.new(mddata).to_html }.real
+    begin
+      data[i+1] << "%14.5f" % Benchmark::bmbm {|x| x.report { Kramdown::Document.new(mddata).to_html } }.first.real
+    rescue
+      $stderr.puts $!.message
+      data[i+1] << "%14.5f" % 0
+    end
   end
-  File.open(historic, 'w+') do |f|
+  File.open(kramdown, 'w+') do |f|
     data.each {|l| f.puts l}
   end
 end
 
 if options[:graph]
-  Dir['historic-*.dat'].each do |historic_name|
-    theruby = historic_name.sub(/^historic-/, '').sub(/\.dat$/, '')
+  Dir['kramdown-*.dat'].each do |kramdown_name|
+    theruby = kramdown_name.sub(/^kramdown-/, '').sub(/\.dat$/, '')
     graph_name = "graph-#{theruby}.png"
-    #static_name = "static-#{theruby}.dat"
-    historic_names = File.readlines(historic_name).first.chomp[1..-1].split(/\s*\|\|\s*/)
-    #static_names = (File.exist?(static_name) ? File.readlines(static_name).first.chomp[1..-1].split(/\s*\|\|\s*/) : [])
+    static_name = "static-#{theruby}.dat"
+    kramdown_names = File.readlines(kramdown_name).first.chomp[1..-1].split(/\s*\|\|\s*/)
+    static_names = (File.exist?(static_name) ? File.readlines(static_name).first.chomp[1..-1].split(/\s*\|\|\s*/) : [])
     File.open("gnuplot.dat", "w+") do |f|
       f.puts <<EOF
 set title "Execution Time Performance for #{theruby}"
@@ -102,8 +104,8 @@ set output "#{graph_name}"
 EOF
       f.print "plot "
       i, j = 1, 1
-      f.puts((historic_names.map {|n| i += 1; "\"#{historic_name}\" using 1:#{i} with lp title \"#{n}\""}
-              #static_names.map {|n| j += 1; n =~ /bluefeather/i ? nil : "\"#{static_name}\" using 1:#{j} with lp title \"#{n}\""}.compact
+      f.puts((kramdown_names.map {|n| i += 1; "\"#{kramdown_name}\" using 1:#{i} with lp title \"#{n}\""} +
+              static_names.map {|n| j += 1; n =~ /bluefeather/i ? nil : "\"#{static_name}\" using 1:#{j} with lp title \"#{n}\""}.compact
              ).join(", "))
     end
     `gnuplot gnuplot.dat`

data/benchmark/testing.sh

@@ -2,7 +2,7 @@
 
 source ~/.bashrc
 
-for VERSION in `rvm list strings`; do
+for VERSION in `rvm list strings | sort`; do
 	rvm $VERSION
 	echo $(ruby -v)
 	RUBYOPT=-rubygems rake test

data/benchmark/timing.sh

@@ -2,9 +2,9 @@
 
 source ~/.bashrc
 
-for VERSION in 1.8.6 1.8.7 1.9.1 1.9.2; do
+for VERSION in `rvm list strings | sort`; do
 	rvm $VERSION
 	echo $(ruby -v)
-	ruby -Ilib bin/kramdown < benchmark/mdsyntax.text 2>&1 > /dev/null
-	time ruby -Ilib bin/kramdown < benchmark/mdsyntax.text > /dev/null
+	ruby -Ilib bin/kramdown < benchmark/mdsyntax.text 2>/dev/null >/dev/null
+	time ruby -Ilib bin/kramdown < benchmark/mdsyntax.text 2>/dev/null >/dev/null
 done

data/bin/kramdown

@@ -55,9 +55,8 @@ OptionParser.new do |opts|
     if definition.type == Kramdown::Options::Boolean
       opts.on("--[no-]#{no}") {|v| options[n] = Kramdown::Options.parse(n, v)}
     else
-      next if definition.type == Object
       type = definition.type
-      type = String if type == Symbol
+      type = String if type == Symbol || type == Object
       opts.on("--#{no} ARG", type) {|v| options[n] = Kramdown::Options.parse(n, v)}
     end
 

data/data/kramdown/document.html

@@ -1,9 +1,9 @@
 <html>
   <head>
 <%
-extend ::Kramdown::Utils::HTML
+extend ::Kramdown::Utils::Html
 title = ''
-h = @doc.tree.children.find {|c| c.type == :header}
+h = @converter.root.children.find {|c| c.type == :header}
 if h
   collector = lambda {|c| c.children.collect {|cc| cc.type == :text ? escape_html(cc.value, :text) : collector.call(cc)}.join('')}
   title = collector.call(h)

data/data/kramdown/document.latex

@@ -29,10 +29,10 @@ encmap = {
 \usepackage[T1]{fontenc}
 \usepackage{listings}
 \usepackage{hyperref}
-<% @doc.conversion_infos[:packages].each {|pkg| %>\usepackage{<%= pkg %>}
+<% @converter.data[:packages].each {|pkg| %>\usepackage{<%= pkg %>}
 <% } %>
 
-<% if @doc.conversion_infos[:packages].include?('fancyvrb') %>
+<% if @converter.data[:packages].include?('fancyvrb') %>
 \VerbatimFootnotes
 <% end %>
 

data/doc/default.scss.css

@@ -231,7 +231,7 @@ body, table, code {
         }
 
         p, ul, ol, dl, table, pre, blockquote {
-            margin: 20px 0px 0px
+            margin: 20px 0px 0px;
         }
 
         ul, ol {
@@ -252,6 +252,11 @@ body, table, code {
         dd {
             margin: 5px 0px 10px 20px;
             padding: 2px;
+
+            p, ul, ol, dl, table, pre, blockquote {
+                margin-top: 0px;
+            }
+
         }
 
         *:target::after {

data/doc/default.template

@@ -8,7 +8,7 @@
     <meta name="keywords" content="ruby, kramdown, markdown, text markup" />
     <link href="{relocatable: default.css}" type="text/css" rel="stylesheet" media="screen,projection" />
     <link href="{relocatable: news.atom}" type="application/atom+xml" rel="alternate" />
-    <script src="http://kramdown.rubyforge.org/js/jsMath/easy/load.js" type="text/javascript"></script>
+    <script src="http://kramdown.rubyforge.org/MathJax/MathJax.js" type="text/javascript"></script>
     <title>{title:} | kramdown</title>
   </head>
   <body>

data/doc/documentation.page

@@ -9,7 +9,7 @@ kramdown is first and foremost a library for converting text written in a supers
 HTML. However, due to its modular architecture it is able to support additional input and output
 formats. The following input and output formats are currently supported:
 
-* Input: [kramdown](parser/kramdown.html) (a superset of Markdown), [html](parser/html.html)
+* Input: [kramdown](parser/kramdown.html) (a superset of Markdown), [Markdown](parser/markdown.html), [html](parser/html.html)
 * Output: [HTML](converter/html.html), [LaTeX](converter/latex.html), [kramdown](converter/kramdown.html)
 
 

data/doc/index.page

@@ -23,20 +23,22 @@ opts: |
   level 2 concept/.append style={font=\Large},
 }
 \node[concept, font=\Large] (lib) {kramdown's internal representation}
-  child[concept color=orange, grow=150, ->] {node[concept] (i-kramdown) {kramdown}}
-  child[concept color=orange, grow=210] {node[concept] (i-html) {HTML}}
+  child[concept color=orange, grow=140, ->] {node[concept] (i-kramdown) {kramdown}}
+  child[concept color=orange, grow=180] {node[concept] (i-html) {HTML}}
+  child[concept color=orange, grow=220] {node[concept] (i-markdown) {Markdown}}
   child[concept color=green!50!black, grow=40] {node[concept] (o-html) {HTML}}
   child[concept color=green!50!black, grow=0] {node[concept] (o-kramdown) {kramdown}}
-  child[concept color=green!50!black, grow=-45] {
+  child[concept color=green!50!black, grow=-40] {
     node[concept] (o-latex) {\LaTeX}
     child[grow=0] {
       node[concept] (o-latex-pdf) {PDF}
     }
   }
-  child[concept color=green!50!black, grow=-45] {node[concept] {\LaTeX}}
+  child[concept color=green!50!black, grow=-40] {node[concept] {\LaTeX}}
 ;
 \draw [dash pattern=on 0pt off 2pt,line width=5pt,arrows=-angle 60,shorten >=15pt,shorten <=10pt,color=orange]
    (i-kramdown) edge(lib)
+   (i-markdown) edge(lib)
    (i-html) edge (lib);
 \draw [dash pattern=on 0pt off 2pt,line width=5pt,arrows=-angle 60,shorten >=10pt,shorten <=15pt,color=green!50!black]
    (lib) edge(o-html)
@@ -84,11 +86,11 @@ Markdown implementations because kramdown borrowed many ideas from existing pack
 completely written in Ruby, supports standard Markdown (with some minor modifications) and various
 extensions that have been made popular by the [PHP Markdown Extra] package and [Maruku].
 
-It is probably the fastest pure-Ruby Markdown converter available (June 2010), being about 4x faster
-than [Maruku] and about 9x faster than [BlueFeather].
+It is probably the fastest pure-Ruby Markdown converter available (November 2010), being about 4x
+faster than [Maruku] and about 5x faster than [BlueFeather].
 
 <p class="a-center">
-The latest version of kramdown is <b>0.11.0</b> and it was released on <b>2010-10-01</b>.
+The latest version of kramdown is <b>0.12.0</b> and it was released on <b>2010-11-01</b>.
 </p>
 
 [PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/