kramdown 0.4.0 → 0.5.0

data/ChangeLog

@@ -1,3 +1,279 @@
+commit 53449309c569f774d7d3cd68bcc71d48509a4c7e
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 15 10:16:18 2010 +0100
+
+    Updated benchmark data and graphs
+
+benchmark/historic-jruby-1.4.0.dat
+benchmark/historic-ruby-1.8.6.dat
+benchmark/historic-ruby-1.8.7.dat
+benchmark/historic-ruby-1.9.1p243.dat
+benchmark/historic-ruby-1.9.2dev.dat
+doc/img/graph-jruby-1.4.0.png
+doc/img/graph-ruby-1.8.6.png
+doc/img/graph-ruby-1.8.7.png
+doc/img/graph-ruby-1.9.1p243.png
+doc/img/graph-ruby-1.9.2dev.png
+
+commit 7422bb09e3df6c98b8d57335e50701bcde2c5f77
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 15 10:12:22 2010 +0100
+
+    Updated release notes
+
+doc/index.page
+doc/news/release_0_5_0.page
+
+commit 127f5205559a2beac7aae87b6b2ebf203830f68e
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 15 10:04:08 2010 +0100
+
+    Updated kramdown binary so that option descriptions are displayed better
+
+bin/kramdown
+
+commit d5cdc600c1e559deeac6c333fc8719aed748b1b4
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 15 10:03:31 2010 +0100
+
+    Fixed small problem with parsing of Symbol options
+
+lib/kramdown/options.rb
+
+commit 366dec49d98245e392a8c472ca62438763b4e36c
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 15 10:03:15 2010 +0100
+
+    Added better option descriptions
+
+lib/kramdown/options.rb
+
+commit 9dab841f7f75be1b126ff55eedd4b3a8d851b2f8
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Feb 13 09:18:19 2010 +0100
+
+    Added warning output to $stderr for kramdown binary
+
+bin/kramdown
+
+commit 3f576659ec18548c3ca24923565fbbcf285dadbc
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Feb 13 09:18:00 2010 +0100
+
+    Fixed last remaining issues with LaTeX converter
+    
+    * Local images are now included in the output
+    * Entities are correctly converted to their LaTeX equivalent
+    * Warnings have been added where approriate
+
+data/kramdown/document.latex
+lib/kramdown/converter/base.rb
+lib/kramdown/converter/latex.rb
+lib/kramdown/document.rb
+
+commit 5a14647e4f5da8595b61f03c2f80af0fc6d93d5c
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Feb 13 09:15:55 2010 +0100
+
+    Better internal support for HTML entities
+
+lib/kramdown/converter/html.rb
+lib/kramdown/parser/kramdown/html_entity.rb
+test/testcases/span/text_substitutions/entities.html
+
+commit b94ff3c15d67419f50ea3f4097a44c47f618c7f3
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Feb 12 14:05:19 2010 +0100
+
+    Implemented syntax parsing and conversion support for smart quotes
+    
+    This additional syntax support causes a small performance penalty
+    on Ruby 1.8 which is, however, acceptable.
+
+doc/syntax.page
+lib/kramdown/converter/html.rb
+lib/kramdown/converter/latex.rb
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/escaped_chars.rb
+lib/kramdown/parser/kramdown/smart_quotes.rb
+test/testcases/span/01_link/inline.html
+test/testcases/span/01_link/reference.html
+test/testcases/span/escaped_chars/normal.html
+test/testcases/span/escaped_chars/normal.text
+test/testcases/span/text_substitutions/typography.html
+test/testcases/span/text_substitutions/typography.text
+
+commit a7db5ce9d37771b2fcd8ec0ab5e3848e4d6410c4
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Feb 12 14:02:38 2010 +0100
+
+    Fixed bug in benchmark.rb: false date was shown
+
+benchmark/benchmark.rb
+
+commit 7e91476e1562495daea1d87c90e8195d6f58e59a
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Feb 12 12:20:47 2010 +0100
+
+    Performance optimization in span parser
+    
+    The span parser now uses a much smaller regexp for locating possible span
+    elements which leads to better performance.
+
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/attribute_list.rb
+lib/kramdown/parser/kramdown/autolink.rb
+lib/kramdown/parser/kramdown/codespan.rb
+lib/kramdown/parser/kramdown/emphasis.rb
+lib/kramdown/parser/kramdown/escaped_chars.rb
+lib/kramdown/parser/kramdown/footnote.rb
+lib/kramdown/parser/kramdown/html.rb
+lib/kramdown/parser/kramdown/html_entity.rb
+lib/kramdown/parser/kramdown/line_break.rb
+lib/kramdown/parser/kramdown/link.rb
+lib/kramdown/parser/kramdown/typographic_symbol.rb
+
+commit d8d372e894cdf2239d34a58517f918fc983952b3
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Feb 11 17:10:21 2010 +0100
+
+    Fixed Rakefile
+
+Rakefile
+
+commit f6e878cebd3590a253e1b177610e354e2ab37d28
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Feb 10 18:33:04 2010 +0100
+
+    Added basic support for converting a kramdown document to LaTeX
+
+bin/kramdown
+data/kramdown/document.latex
+lib/kramdown/converter.rb
+lib/kramdown/converter/latex.rb
+
+commit bb35de9db070ad5e227c0197d71fcda636b76821
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Feb 10 18:22:47 2010 +0100
+
+    Updated converter
+    
+    * Added a base class with common functionality
+    * Added support for wrapping the output of a converter in a given ERB template
+
+data/kramdown/document.html
+doc/news/release_0_5_0.page
+lib/kramdown/converter.rb
+lib/kramdown/converter/base.rb
+lib/kramdown/converter/html.rb
+lib/kramdown/document.rb
+lib/kramdown/options.rb
+
+commit 889bcc99ddae386a4cf6d81f79eb5a46be0e604d
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Feb 10 15:31:13 2010 +0100
+
+    Fixed syntax error
+
+doc/syntax.page
+
+commit e5ab07d5dbfedb71255c74495643bca5da7cc7d5
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Feb 10 15:30:50 2010 +0100
+
+    Fixed potential future problem with escape regexp in HTML converter
+
+lib/kramdown/converter/html.rb
+
+commit ab862baa4612736c64b153b9426720ce1c56205a
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 8 17:15:11 2010 +0100
+
+    Enhanced the kramdown binary
+
+bin/kramdown
+doc/news/release_0_5_0.page
+lib/kramdown/options.rb
+
+commit 38e6052580225bbb42c32499c4c699dac5e0762a
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 8 16:56:37 2010 +0100
+
+    Small API doc update
+
+lib/kramdown/converter/html.rb
+
+commit 6acf84b84a4eed2706888dd31364dbc5e0ed65be
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Feb 8 16:51:24 2010 +0100
+
+    Implemented better options mechanism
+    
+    Parser/converter options can now be defined easily
+
+lib/kramdown/converter/html.rb
+lib/kramdown/document.rb
+lib/kramdown/options.rb
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/extension.rb
+lib/kramdown/parser/kramdown/header.rb
+lib/kramdown/parser/kramdown/html.rb
+
+commit d2cb1882a9c4e0dd3d094a393c8c37a0631910ac
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Feb 5 18:41:09 2010 +0100
+
+    The quotation mark " is not converted to &quot; in normal text anymore
+
+doc/news/release_0_5_0.page
+lib/kramdown/converter/html.rb
+test/testcases/span/01_link/reference.html
+
+commit c2e7145bd8fa1723bb97803840f04937c092fd1f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Feb 4 10:03:16 2010 +0100
+
+    Bumped version number
+
+doc/news/release_0_5_0.page
+lib/kramdown/version.rb
+
+commit 400283889466d95724eed6169a306d411940bbc8
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Feb 4 09:56:54 2010 +0100
+
+    Code restructurations
+    
+    * Moved default options away from Document into parser and converter classes
+    * Moved definition of Extension class to where it belongs, the kramdown parser
+    * Moved HTML converter class into lib/kramdown/converter/html.rb
+
+lib/kramdown/converter.rb
+lib/kramdown/converter/html.rb
+lib/kramdown/document.rb
+lib/kramdown/extension.rb
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/extension.rb
+lib/kramdown/parser/kramdown/header.rb
+lib/kramdown/parser/kramdown/html.rb
+
+commit 0ea859157e8f30d488a8e1f78407466c369cc717
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Feb 4 09:10:32 2010 +0100
+
+    Fixed problems with multibyte encodings in Ruby 1.9
+    
+    The StringScanner class returns positions based on bytes and not based on
+    characters. Therefore a workaround was needed sothat multibyte encoded
+    documents are parsed correctly
+
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/emphasis.rb
+lib/kramdown/parser/kramdown/html.rb
+lib/kramdown/parser/kramdown/link.rb
+test/testcases/encoding.html
+test/testcases/encoding.text
+
 commit fa3d9d59c3e912a011a26f10a74ee0858cafe4dd
 Author: Thomas Leitner <t_leitner@gmx.at>
 Date:   Fri Jan 22 17:41:32 2010 +0100

data/Rakefile

@@ -216,7 +216,7 @@ EOF
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2010 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown.
 #
@@ -258,7 +258,7 @@ task :clobber => ['dev:clobber']
 
 module Kramdown
 
-  class Extension
+  class Parser::Kramdown::Extension
 
     def parse_kdexample(parser, opts, body)
       wrap = Element.new(:html_element, 'div', :attr => {'class' => 'kdexample'})

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/benchmark/benchmark.rb

@@ -18,7 +18,7 @@ RUNS=20
 
 FILES=['mdsyntax.text', 'mdbasics.text']
 
-puts "Running tests on #{Time.now.strftime("%Y-%M-%d")} under #{RUBY_DESCRIPTION}"
+puts "Running tests on #{Time.now.strftime("%Y-%m-%d")} under #{RUBY_DESCRIPTION}"
 
 FILES.each do |file|
   data = File.read(File.join(File.dirname(__FILE__), file))

data/benchmark/historic-jruby-1.4.0.dat

@@ -1,7 +1,7 @@
-#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0
-    1    0.21300    0.31800    0.20500    0.24800    0.16800    0.30400
-    2    0.20700    0.22600    0.27200    0.22900    0.26700    0.23400
-    4    0.22000    0.21700    0.21600    0.19600    0.20400    0.19300
-    8    0.36300    0.44500    0.39300    0.34300    0.30100    0.29500
-   16    0.45400    0.53400    1.01400    0.41100    0.46200    0.48900
-   32    1.02800    0.98100    1.70100    0.84600    0.84600    0.81900
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0 ||  kramdown 0.5.0
+    1    0.21300    0.31800    0.20500    0.24800    0.16800    0.30400    0.30800
+    2    0.20700    0.22600    0.27200    0.22900    0.26700    0.23400    0.26800
+    4    0.22000    0.21700    0.21600    0.19600    0.20400    0.19300    0.19400
+    8    0.36300    0.44500    0.39300    0.34300    0.30100    0.29500    0.32800
+   16    0.45400    0.53400    1.01400    0.41100    0.46200    0.48900    0.50200
+   32    1.02800    0.98100    1.70100    0.84600    0.84600    0.81900    0.72200

data/benchmark/historic-ruby-1.8.6.dat

@@ -1,7 +1,7 @@
-#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0
-    1    0.01211    0.01274    0.01406    0.01150    0.01385    0.01359
-    2    0.02449    0.02582    0.02545    0.02329    0.02924    0.02691
-    4    0.08228    0.08475    0.07402    0.07921    0.08600    0.09013
-    8    0.12842    0.13410    0.24217    0.12481    0.14426    0.13687
-   16    0.22743    0.27748    0.84538    0.21843    0.29497    0.28115
-   32    0.45690    0.51838    3.95635    0.51363    0.54252    0.51869
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0 ||  kramdown 0.5.0
+    1    0.01211    0.01274    0.01406    0.01150    0.01385    0.01359    0.01539
+    2    0.02449    0.02582    0.02545    0.02329    0.02924    0.02691    0.03194
+    4    0.08228    0.08475    0.07402    0.07921    0.08600    0.09013    0.05768
+    8    0.12842    0.13410    0.24217    0.12481    0.14426    0.13687    0.14952
+   16    0.22743    0.27748    0.84538    0.21843    0.29497    0.28115    0.26786
+   32    0.45690    0.51838    3.95635    0.51363    0.54252    0.51869    0.57976

data/benchmark/historic-ruby-1.8.7.dat

@@ -1,7 +1,7 @@
-#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0
-    1    0.01259    0.01329    0.01446    0.01219    0.01580    0.01397
-    2    0.02472    0.02672    0.02637    0.02406    0.02858    0.02849
-    4    0.09610    0.08355    0.07451    0.07719    0.05439    0.05232
-    8    0.13269    0.13811    0.24393    0.12766    0.10869    0.10471
-   16    0.27243    0.27540    0.93940    0.25091    0.28680    0.27240
-   32    0.52890    0.55667    4.93810    0.50113    0.54547    0.52283
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0 ||  kramdown 0.5.0
+    1    0.01259    0.01329    0.01446    0.01219    0.01580    0.01397    0.01554
+    2    0.02472    0.02672    0.02637    0.02406    0.02858    0.02849    0.03387
+    4    0.09610    0.08355    0.07451    0.07719    0.05439    0.05232    0.05801
+    8    0.13269    0.13811    0.24393    0.12766    0.10869    0.10471    0.15673
+   16    0.27243    0.27540    0.93940    0.25091    0.28680    0.27240    0.31712
+   32    0.52890    0.55667    4.93810    0.50113    0.54547    0.52283    0.60766

data/benchmark/historic-ruby-1.9.1p243.dat

@@ -1,7 +1,7 @@
-#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0
-    1    0.02062    0.02216    0.01349    0.02013    0.02152    0.02025
-    2    0.04097    0.04290    0.03316    0.03738    0.03939    0.03956
-    4    0.07696    0.08015    0.07079    0.07084    0.09122    0.07573
-    8    0.16986    0.16998    0.17800    0.14978    0.16856    0.16380
-   16    0.33684    0.34800    0.60818    0.30365    0.35242    0.33358
-   32    0.68273    0.70498    2.77191    0.61580    0.74138    0.66569
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0 ||  kramdown 0.5.0
+    1    0.02062    0.02216    0.01349    0.02013    0.02152    0.02025    0.01289
+    2    0.04097    0.04290    0.03316    0.03738    0.03939    0.03956    0.02890
+    4    0.07696    0.08015    0.07079    0.07084    0.09122    0.07573    0.06272
+    8    0.16986    0.16998    0.17800    0.14978    0.16856    0.16380    0.11127
+   16    0.33684    0.34800    0.60818    0.30365    0.35242    0.33358    0.23528
+   32    0.68273    0.70498    2.77191    0.61580    0.74138    0.66569    0.44669

data/benchmark/historic-ruby-1.9.2dev.dat

@@ -1,7 +1,7 @@
-#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0
-    1    0.01827    0.02000    0.01064    0.01981    0.01830    0.02061
-    2    0.03951    0.04158    0.03260    0.03712    0.04056    0.04378
-    4    0.08055    0.08419    0.05945    0.07256    0.08363    0.08286
-    8    0.14925    0.15101    0.15053    0.14051    0.15830    0.14567
-   16    0.31483    0.31485    0.46291    0.28562    0.31176    0.30726
-   32    0.62318    0.64162    2.17304    0.56619    0.61918    0.59270
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0 ||  kramdown 0.4.0 ||  kramdown 0.5.0
+    1    0.01827    0.02000    0.01064    0.01981    0.01830    0.02061    0.01632
+    2    0.03951    0.04158    0.03260    0.03712    0.04056    0.04378    0.03590
+    4    0.08055    0.08419    0.05945    0.07256    0.08363    0.08286    0.04809
+    8    0.14925    0.15101    0.15053    0.14051    0.15830    0.14567    0.10250
+   16    0.31483    0.31485    0.46291    0.28562    0.31176    0.30726    0.20651
+   32    0.62318    0.64162    2.17304    0.56619    0.61918    0.59270    0.42345

data/bin/kramdown

@@ -21,6 +21,51 @@
 #++
 #
 
+require 'optparse'
 require 'kramdown'
 
-puts Kramdown::Document.new(ARGF.read).to_html
+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("-f", "--format ARG", "Specify the output format: html (default) 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|
+    if definition.type == Kramdown::Options::Boolean
+      opts.on("--[no-]#{n}") {|v| options[n] = Kramdown::Options.parse(n, v)}
+    else
+      next if definition.type == Object
+      type = definition.type
+      type = String if type == Symbol
+      opts.on("--#{n} 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!
+
+doc = Kramdown::Document.new(ARGF.read, options)
+puts doc.send("to_#{format}")
+doc.warnings.each {|warn| $stderr.puts warn}

data/doc/index.page

@@ -79,11 +79,11 @@ and [mailing lists][ml] available if you have any questions!
 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 (January 2010), being about 4.5x
+It is probably the fastest pure-Ruby Markdown converter available (February 2010), being about 4.5x
 faster than [Maruku] and about 10x faster than [BlueFeather].
 
 <div class="a-center">
-The latest version of kramdown is <b>0.4.0</b> and it was released on <b>2010-01-22</b>.
+The latest version of kramdown is <b>0.5.0</b> and it was released on <b>2010-02-15</b>.
 </div>
 
 [PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/