kramdown 0.2.0 → 0.3.0

data/ChangeLog

@@ -1,3 +1,270 @@
+commit fff933c46a6345aca7ee2333b6c71d9466b0e297
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 20 16:20:10 2009 +0100
+
+    Small doc update before release
+
+doc/index.page
+doc/installation.page
+
+commit e1e97bcfeea51c1e3fe5afa787132e24d59fd968
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 20 16:18:54 2009 +0100
+
+    Small display fix
+
+benchmark/generate_data.rb
+
+commit d80c3782881777c246e971db4f86c7ff16241c7f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 20 16:18:47 2009 +0100
+
+    Added kramdown 0.3.0 data to benchmark 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 064f97f9bace384a54373f4dca168911dbccf19f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 20 15:59:11 2009 +0100
+
+    Updated release notes
+
+doc/news/release_0_3_0.page
+
+commit 9041790eb12fedc914d6a9511640e41deeadfcd4
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 15 08:02:55 2009 +0100
+
+    Updated release notes
+
+doc/news/release_0_3_0.page
+
+commit e737974d5cdd9efcf381f3cd1d47809f6a5fbeb2
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 15 07:59:44 2009 +0100
+
+    Span HTML parser now uses the same semantics for invalid end tags and unclosed tags as block HTML parser
+
+doc/syntax.page
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/html.rb
+test/testcases/span/05_html/normal.html
+test/testcases/span/05_html/normal.text
+
+commit cf9330e6f27f21e9a93251d78da61cb8be549671
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 15 07:35:41 2009 +0100
+
+    Updated release notes
+
+doc/news/release_0_3_0.page
+
+commit cd36641782835ddb7f32a0d83131db6193404f5e
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 15 07:31:11 2009 +0100
+
+    Fixed bug in emphasis parser
+    
+    Emphasis started with an underscore at the beginning of a new line inside
+    a paragraph was not recognized.
+
+lib/kramdown/parser/kramdown/emphasis.rb
+test/testcases/span/02_emphasis/normal.html
+test/testcases/span/02_emphasis/normal.text
+
+commit 59d9be0976970cb33248c81c81d0500c2cfbb4ce
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 15 07:22:39 2009 +0100
+
+    Small update to the HTML syntax documentation
+
+doc/syntax.page
+
+commit ba0d7e1dc9deb8837c95e2f1f9e0f59cdfa93d33
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Dec 14 10:56:57 2009 +0100
+
+    Fixed some flaws in the HTML parser
+    
+    * raw HTML parsing did not work as specified in the syntax documentation
+    * XML comments/PIs now have their own element type
+    * fixed a small problem with autolinks in raw HTML blocks
+    * adjusted parsing of unclosed raw HTML blocks to adhere to syntax documentation
+
+lib/kramdown/converter.rb
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/footnote.rb
+lib/kramdown/parser/kramdown/html.rb
+test/testcases/block/09_html/not_parsed.html
+test/testcases/block/09_html/not_parsed.text
+test/testcases/block/09_html/parse_as_raw.html
+test/testcases/block/09_html/parse_as_raw.text
+test/testcases/span/05_html/markdown_attr.html
+test/testcases/span/05_html/markdown_attr.text
+
+commit b85972868dd907fd102b665421d51c9bb86c3d86
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 13 19:42:45 2009 +0100
+
+    Fixed Maruku version number display
+
+benchmark/benchmark.rb
+
+commit 94e89b51cf33bae5cee929fa8ce97703f2fee6fc
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 13 19:42:28 2009 +0100
+
+    Fixed warning on Ruby 1.9
+
+lib/kramdown/parser/kramdown/list.rb
+
+commit d3df238aeb533302bafbcc3fe8246dedd74b42f7
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 13 19:42:04 2009 +0100
+
+    Implemented a new HTML block parser
+    
+    The new parser is a little bit more restrictive but the surprise factor
+    for most HTML input should be less than before.
+
+doc/syntax.page
+lib/kramdown/converter.rb
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/html.rb
+test/testcases/block/09_html/comment.html
+test/testcases/block/09_html/comment.text
+test/testcases/block/09_html/content_model/tables.text
+test/testcases/block/09_html/not_parsed.html
+test/testcases/block/09_html/not_parsed.text
+test/testcases/block/09_html/parse_as_raw.html
+test/testcases/block/09_html/parse_block_html.html
+test/testcases/block/09_html/parse_block_html.text
+test/testcases/block/09_html/processing_instruction.html
+test/testcases/block/09_html/processing_instruction.text
+test/testcases/block/09_html/simple.html
+test/testcases/block/09_html/simple.text
+
+commit cb8333118e7d70719bd25a6ef44c38e98af1d44f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Dec 9 14:51:24 2009 +0100
+
+    Added benchmark data and graphs from this data to the tests page
+
+benchmark/generate_data.rb
+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
+benchmark/static-jruby-1.4.0.dat
+benchmark/static-ruby-1.8.6.dat
+benchmark/static-ruby-1.8.7.dat
+benchmark/static-ruby-1.9.1p243.dat
+benchmark/static-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
+doc/tests.page
+
+commit 78d9311ef919d9467502f053f416238937fb2746
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 8 09:45:56 2009 +0100
+
+    Source code restructuration
+    
+    * email obfuscation is part of conversion now since it makes more sense there
+    * block parsers can now be enabled/disabled by the parser methods
+    * parsers methods put into various files
+
+lib/kramdown/converter.rb
+lib/kramdown/parser.rb
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/attribute_list.rb
+lib/kramdown/parser/kramdown/autolink.rb
+lib/kramdown/parser/kramdown/blank_line.rb
+lib/kramdown/parser/kramdown/blockquote.rb
+lib/kramdown/parser/kramdown/codeblock.rb
+lib/kramdown/parser/kramdown/codespan.rb
+lib/kramdown/parser/kramdown/emphasis.rb
+lib/kramdown/parser/kramdown/eob.rb
+lib/kramdown/parser/kramdown/escaped_chars.rb
+lib/kramdown/parser/kramdown/extension.rb
+lib/kramdown/parser/kramdown/footnote.rb
+lib/kramdown/parser/kramdown/header.rb
+lib/kramdown/parser/kramdown/horizontal_rule.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/list.rb
+lib/kramdown/parser/kramdown/paragraph.rb
+lib/kramdown/parser/kramdown/typographic_symbol.rb
+lib/kramdown/parser/registry.rb
+
+commit 13c1b5037d5ada5f661dc09ef3f1f18b437ed0f1
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 8 08:35:32 2009 +0100
+
+    Added note about spelling of kramdown
+
+doc/index.page
+
+commit f8f9e65ea3e980286086b7bc25ce6126ea5a2332
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 4 23:03:15 2009 +0100
+
+    Updated tested platforms and ruby versions
+
+doc/installation.page
+
+commit 06d1ff82de3a02c612b912e6384b89feb00a6e0a
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 4 21:02:03 2009 +0100
+
+    Removed deprecated methods
+
+lib/kramdown/deprecated.rb
+lib/kramdown/document.rb
+
+commit 1591c98a983398b8867c9aaf5151dc3021e2eedf
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 4 21:00:29 2009 +0100
+
+    Bumped version number and added release notes file
+
+doc/news/release_0_3_0.page
+lib/kramdown/version.rb
+
+commit b93f953c14e8c6c23951e5f78541f5ab69dc2b93
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 4 20:56:29 2009 +0100
+
+    Added a compatibility fix so that kramdown works under Ruby 1.8.5
+
+benchmark/testing.sh
+lib/kramdown/compatibility.rb
+lib/kramdown/document.rb
+
+commit 84bbbdd91686ada39b99af5b5cdd61d212065c9a
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 4 08:13:15 2009 +0100
+
+    Fixed typos in the documentation
+
+doc/quickref.page
+doc/syntax.page
+
 commit 034525fb53f178da9498e0f653c382a17549ca3a
 Author: Thomas Leitner <t_leitner@gmx.at>
 Date:   Thu Dec 3 20:25:17 2009 +0100

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/benchmark/benchmark.rb

@@ -4,6 +4,7 @@ require 'stringio'
 require 'kramdown'
 require 'bluecloth'
 require 'maruku'
+require 'maruku/version'
 require 'rdiscount'
 require 'bluefeather'
 
@@ -25,7 +26,7 @@ FILES.each do |file|
   puts "Test using file #{file} and #{RUNS} runs"
   Benchmark.bmbm do |b|
     b.report("kramdown #{Kramdown::VERSION}") { RUNS.times { Kramdown::Document.new(data).to_html } }
-    b.report("Maruku #{Maruku::VERSION}") { RUNS.times { Maruku.new(data, :on_error => :ignore).to_html } }
+    b.report("Maruku #{MaRuKu::Version}") { RUNS.times { Maruku.new(data, :on_error => :ignore).to_html } }
     b.report("BlueFeather #{BlueFeather::VERSION}") { RUNS.times { BlueFeather.parse(data) } }
     b.report("BlueCloth #{BlueCloth::VERSION}") { RUNS.times { BlueCloth.new(data).to_html } }
     b.report("RDiscount #{RDiscount::VERSION}") { RUNS.times { RDiscount.new(data).to_html } }

data/benchmark/generate_data.rb

@@ -0,0 +1,110 @@
+require 'benchmark'
+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}
+OptionParser.new do |opts|
+  opts.on("-s", "--[no-]static", "Generate static data") {|v| options[:static] = 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}
+end.parse!
+
+
+THISRUBY = (self.class.const_defined?(:RUBY_DESCRIPTION) ? RUBY_DESCRIPTION.scan(/^.*?(?=\s*\()/).first.sub(/\s/, '-') : "ruby-#{RUBY_VERSION}")
+
+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]
+      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]
+      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}]
+    end
+  end
+end
+
+if options[:historic]
+  historic = "historic-#{THISRUBY}.dat"
+  data = if File.exist?(historic)
+           lines = File.readlines(historic).map {|l| l.chomp}
+           lines.first << " || "
+           lines
+         else
+           ["# ", *MULTIPLIER.map {|m| "%5d" % m}]
+         end
+  data.first << " #{options[:historic]}"
+  MULTIPLIER.each_with_index do |m, i|
+    $stderr.puts "Generating historic benchmark data, 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
+  end
+  File.open(historic, '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$/, '')
+    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*/) : [])
+    File.open("gnuplot.dat", "w+") do |f|
+      f.puts <<EOF
+set title "Execution Time Performance for #{theruby}"
+set xlabel "File Multiplier (i.e. n times mdbasic.text)"
+set ylabel "Execution Time in secondes"
+set grid "on"
+set terminal png
+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).join(", "))
+    end
+    `gnuplot gnuplot.dat`
+    FileUtils.rm("gnuplot.dat")
+  end
+end

data/benchmark/historic-jruby-1.4.0.dat

@@ -0,0 +1,7 @@
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0
+    1    0.21300    0.31800    0.20500    0.24800    0.16800
+    2    0.20700    0.22600    0.27200    0.22900    0.26700
+    4    0.22000    0.21700    0.21600    0.19600    0.20400
+    8    0.36300    0.44500    0.39300    0.34300    0.30100
+   16    0.45400    0.53400    1.01400    0.41100    0.46200
+   32    1.02800    0.98100    1.70100    0.84600    0.84600

data/benchmark/historic-ruby-1.8.6.dat

@@ -0,0 +1,7 @@
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0
+    1    0.01211    0.01274    0.01406    0.01150    0.01385
+    2    0.02449    0.02582    0.02545    0.02329    0.02924
+    4    0.08228    0.08475    0.07402    0.07921    0.08600
+    8    0.12842    0.13410    0.24217    0.12481    0.14426
+   16    0.22743    0.27748    0.84538    0.21843    0.29497
+   32    0.45690    0.51838    3.95635    0.51363    0.54252

data/benchmark/historic-ruby-1.8.7.dat

@@ -0,0 +1,7 @@
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0
+    1    0.01259    0.01329    0.01446    0.01219    0.01580
+    2    0.02472    0.02672    0.02637    0.02406    0.02858
+    4    0.09610    0.08355    0.07451    0.07719    0.05439
+    8    0.13269    0.13811    0.24393    0.12766    0.10869
+   16    0.27243    0.27540    0.93940    0.25091    0.28680
+   32    0.52890    0.55667    4.93810    0.50113    0.54547

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

@@ -0,0 +1,7 @@
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0
+    1    0.02062    0.02216    0.01349    0.02013    0.02152
+    2    0.04097    0.04290    0.03316    0.03738    0.03939
+    4    0.07696    0.08015    0.07079    0.07084    0.09122
+    8    0.16986    0.16998    0.17800    0.14978    0.16856
+   16    0.33684    0.34800    0.60818    0.30365    0.35242
+   32    0.68273    0.70498    2.77191    0.61580    0.74138

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

@@ -0,0 +1,7 @@
+#  kramdown 0.1.0 ||  kramdown 0.2.0 ||  kramdown 2009-03-10 ||  kramdown 2009-11-05 ||  kramdown 0.3.0
+    1    0.01827    0.02000    0.01064    0.01981    0.01830
+    2    0.03951    0.04158    0.03260    0.03712    0.04056
+    4    0.08055    0.08419    0.05945    0.07256    0.08363
+    8    0.14925    0.15101    0.15053    0.14051    0.15830
+   16    0.31483    0.31485    0.46291    0.28562    0.31176
+   32    0.62318    0.64162    2.17304    0.56619    0.61918

data/benchmark/static-jruby-1.4.0.dat

@@ -0,0 +1,7 @@
+# Maruku 0.6.0 || BlueFeather 0.33 || BlueCloth Not Available. || RDiscount Not Available.
+    1    0.07500    0.08500    0.00000    0.00000
+    2    0.14400    0.22800    0.00000    0.00000
+    4    0.28300    0.61100    0.00000    0.00000
+    8    0.62300    1.94700    0.00000    0.00000
+   16    1.30400    7.11800    0.00000    0.00000
+   32    2.56900   28.30800    0.00000    0.00000