gitdown 0.0.1

data/benchmark/benchmark.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+source ~/.bashrc
+
+RUBY_VERSIONS=`rvm list strings | sort`
+KD_VERSIONS="`git tag | sort -V` master"
+OTHERS=false
+AVERAGE=1
+MASTER_AS=master
+
+while getopts "r:k:o:m:a:" optname; do
+    case "$optname" in
+        "r")
+            RUBY_VERSIONS="$OPTARG"
+            ;;
+        "k")
+            KD_VERSIONS="$OPTARG"
+            ;;
+        "o")
+            OTHERS=true
+	    ;;
+	"m")
+	    MASTER_AS="$OPTARG"
+            ;;
+	"a")
+	    AVERAGE="$OPTARG"
+	    ;;
+        "?")
+            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
+        if [ -z $MASTER_AS -o $KD_VERSION != master ]; then
+            VNUM=${KD_VERSION}
+        else
+            VNUM=$MASTER_AS
+        fi
+        ruby -I${TMPDIR}/kramdown/lib ../generate_data.rb -k ${VNUM} -a ${AVERAGE} >/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

@@ -0,0 +1,119 @@
+require 'benchmark'
+require 'optparse'
+require 'fileutils'
+
+require 'kramdown'
+
+options = {:others => false, :average => 1}
+OptionParser.new do |opts|
+  opts.on("-a AVG", "--average AVG", Integer, "Average times over the specified number of runs") {|v| options[:average] = 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("-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}") + '-' + RUBY_PATCHLEVEL.to_s
+
+Dir.chdir(File.dirname(__FILE__))
+BMDATA = File.read('mdbasics.text')
+MULTIPLIER = (0..5).map {|i| 2**i}
+
+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)
+        labels << "RDiscount #{RDiscount::VERSION}"
+        x.report { RDiscount.new(mddata).to_html }
+      end
+    end
+  end
+  File.open("static-#{THISRUBY}.dat", 'w+') do |f|
+    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[: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| "%3d" % m}]
+         end
+  data.first << "#{options[:kramdown]}".rjust(10)
+
+  times = []
+  options[:average].times do
+    MULTIPLIER.each_with_index do |m, i|
+      $stderr.puts "Generating benchmark data for kramdown version #{options[:kramdown]}, multiplier #{m}"
+      mddata = BMDATA*m
+      begin
+        (times[i] ||= []) << Benchmark::bmbm {|x| x.report { Kramdown::Document.new(mddata).to_html } }.first.real
+      rescue
+        $stderr.puts $!.message
+        (times[i] ||= []) << 0
+      end
+    end
+  end
+  times.each_with_index {|t,i| data[i+1] << "%14.5f" % (t.inject(0) {|sum,v| sum+v}/3.0)}
+  File.open(kramdown, 'w+') do |f|
+    data.each {|l| f.puts l}
+  end
+end
+
+if options[:graph]
+  Dir['kramdown-*.dat'].each do |kramdown_name|
+    theruby = kramdown_name.sub(/^kramdown-/, '').sub(/\.dat$/, '')
+    graph_name = "graph-#{theruby}.png"
+    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}"
+set xlabel "File Multiplier (i.e. n times mdbasic.text)"
+set ylabel "Execution Time in secondes"
+set key left top
+set grid "on"
+set terminal png
+set output "#{graph_name}"
+EOF
+      f.print "plot "
+      i, j = 1, 1
+      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`
+    FileUtils.rm("gnuplot.dat")
+  end
+end

data/benchmark/mdbasics.text

@@ -0,0 +1,306 @@
+Markdown: Basics
+================
+
+<ul id="ProjectSubmenu">
+    <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>
+    <li><a class="selected" title="Markdown Basics">Basics</a></li>
+    <li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li>
+    <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>
+    <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>
+</ul>
+
+
+Getting the Gist of Markdown's Formatting Syntax
+------------------------------------------------
+
+This page offers a brief overview of what it's like to use Markdown.
+The [syntax page] [s] provides complete, detailed documentation for
+every feature, but Markdown should be very easy to pick up simply by
+looking at a few examples of it in action. The examples on this page
+are written in a before/after style, showing example syntax and the
+HTML output produced by Markdown.
+
+It's also helpful to simply try Markdown out; the [Dingus] [d] is a
+web application that allows you type your own Markdown-formatted text
+and translate it to XHTML.
+
+**Note:** This document is itself written using Markdown; you
+can [see the source for it by adding '.text' to the URL] [src].
+
+  [s]: /projects/markdown/syntax  "Markdown Syntax"
+  [d]: /projects/markdown/dingus  "Markdown Dingus"
+  [src]: /projects/markdown/basics.text
+
+
+## Paragraphs, Headers, Blockquotes ##
+
+A paragraph is simply one or more consecutive lines of text, separated
+by one or more blank lines. (A blank line is any line that looks like a
+blank line -- a line containing nothing spaces or tabs is considered
+blank.) Normal paragraphs should not be intended with spaces or tabs.
+
+Markdown offers two styles of headers: *Setext* and *atx*.
+Setext-style headers for `<h1>` and `<h2>` are created by
+"underlining" with equal signs (`=`) and hyphens (`-`), respectively.
+To create an atx-style header, you put 1-6 hash marks (`#`) at the
+beginning of the line -- the number of hashes equals the resulting
+HTML header level.
+
+Blockquotes are indicated using email-style '`>`' angle brackets.
+
+Markdown:
+
+    A First Level Header
+    ====================
+    
+    A Second Level Header
+    ---------------------
+
+    Now is the time for all good men to come to
+    the aid of their country. This is just a
+    regular paragraph.
+
+    The quick brown fox jumped over the lazy
+    dog's back.
+    
+    ### Header 3
+
+    > This is a blockquote.
+    > 
+    > This is the second paragraph in the blockquote.
+    >
+    > ## This is an H2 in a blockquote
+
+
+Output:
+
+    <h1>A First Level Header</h1>
+    
+    <h2>A Second Level Header</h2>
+    
+    <p>Now is the time for all good men to come to
+    the aid of their country. This is just a
+    regular paragraph.</p>
+    
+    <p>The quick brown fox jumped over the lazy
+    dog's back.</p>
+    
+    <h3>Header 3</h3>
+    
+    <blockquote>
+        <p>This is a blockquote.</p>
+        
+        <p>This is the second paragraph in the blockquote.</p>
+        
+        <h2>This is an H2 in a blockquote</h2>
+    </blockquote>
+
+
+
+### Phrase Emphasis ###
+
+Markdown uses asterisks and underscores to indicate spans of emphasis.
+
+Markdown:
+
+    Some of these words *are emphasized*.
+    Some of these words _are emphasized also_.
+    
+    Use two asterisks for **strong emphasis**.
+    Or, if you prefer, __use two underscores instead__.
+
+Output:
+
+    <p>Some of these words <em>are emphasized</em>.
+    Some of these words <em>are emphasized also</em>.</p>
+    
+    <p>Use two asterisks for <strong>strong emphasis</strong>.
+    Or, if you prefer, <strong>use two underscores instead</strong>.</p>
+   
+
+
+## Lists ##
+
+Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,
+`+`, and `-`) as list markers. These three markers are
+interchangable; this:
+
+    *   Candy.
+    *   Gum.
+    *   Booze.
+
+this:
+
+    +   Candy.
+    +   Gum.
+    +   Booze.
+
+and this:
+
+    -   Candy.
+    -   Gum.
+    -   Booze.
+
+all produce the same output:
+
+    <ul>
+    <li>Candy.</li>
+    <li>Gum.</li>
+    <li>Booze.</li>
+    </ul>
+
+Ordered (numbered) lists use regular numbers, followed by periods, as
+list markers:
+
+    1.  Red
+    2.  Green
+    3.  Blue
+
+Output:
+
+    <ol>
+    <li>Red</li>
+    <li>Green</li>
+    <li>Blue</li>
+    </ol>
+
+If you put blank lines between items, you'll get `<p>` tags for the
+list item text. You can create multi-paragraph list items by indenting
+the paragraphs by 4 spaces or 1 tab:
+
+    *   A list item.
+    
+        With multiple paragraphs.
+
+    *   Another item in the list.
+
+Output:
+
+    <ul>
+    <li><p>A list item.</p>
+    <p>With multiple paragraphs.</p></li>
+    <li><p>Another item in the list.</p></li>
+    </ul>
+    
+
+
+### Links ###
+
+Markdown supports two styles for creating links: *inline* and
+*reference*. With both styles, you use square brackets to delimit the
+text you want to turn into a link.
+
+Inline-style links use parentheses immediately after the link text.
+For example:
+
+    This is an [example link](http://example.com/).
+
+Output:
+
+    <p>This is an <a href="http://example.com/">
+    example link</a>.</p>
+
+Optionally, you may include a title attribute in the parentheses:
+
+    This is an [example link](http://example.com/ "With a Title").
+
+Output:
+
+    <p>This is an <a href="http://example.com/" title="With a Title">
+    example link</a>.</p>
+
+Reference-style links allow you to refer to your links by names, which
+you define elsewhere in your document:
+
+    I get 10 times more traffic from [Google][1] than from
+    [Yahoo][2] or [MSN][3].
+
+    [1]: http://google.com/        "Google"
+    [2]: http://search.yahoo.com/  "Yahoo Search"
+    [3]: http://search.msn.com/    "MSN Search"
+
+Output:
+
+    <p>I get 10 times more traffic from <a href="http://google.com/"
+    title="Google">Google</a> than from <a href="http://search.yahoo.com/"
+    title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
+    title="MSN Search">MSN</a>.</p>
+
+The title attribute is optional. Link names may contain letters,
+numbers and spaces, but are *not* case sensitive:
+
+    I start my morning with a cup of coffee and
+    [The New York Times][NY Times].
+
+    [ny times]: http://www.nytimes.com/
+
+Output:
+
+    <p>I start my morning with a cup of coffee and
+    <a href="http://www.nytimes.com/">The New York Times</a>.</p>
+
+
+### Images ###
+
+Image syntax is very much like link syntax.
+
+Inline (titles are optional):
+
+    ![alt text](/path/to/img.jpg "Title")
+
+Reference-style:
+
+    ![alt text][id]
+
+    [id]: /path/to/img.jpg "Title"
+
+Both of the above examples produce the same output:
+
+    <img src="/path/to/img.jpg" alt="alt text" title="Title" />
+
+
+
+### Code ###
+
+In a regular paragraph, you can create code span by wrapping text in
+backtick quotes. Any ampersands (`&`) and angle brackets (`<` or
+`>`) will automatically be translated into HTML entities. This makes
+it easy to use Markdown to write about HTML example code:
+
+    I strongly recommend against using any `<blink>` tags.
+
+    I wish SmartyPants used named entities like `&mdash;`
+    instead of decimal-encoded entites like `&#8212;`.
+
+Output:
+
+    <p>I strongly recommend against using any
+    <code>&lt;blink&gt;</code> tags.</p>
+    
+    <p>I wish SmartyPants used named entities like
+    <code>&amp;mdash;</code> instead of decimal-encoded
+    entites like <code>&amp;#8212;</code>.</p>
+
+
+To specify an entire block of pre-formatted code, indent every line of
+the block by 4 spaces or 1 tab. Just like with code spans, `&`, `<`,
+and `>` characters will be escaped automatically.
+
+Markdown:
+
+    If you want your page to validate under XHTML 1.0 Strict,
+    you've got to put paragraph tags in your blockquotes:
+
+        <blockquote>
+            <p>For example.</p>
+        </blockquote>
+
+Output:
+
+    <p>If you want your page to validate under XHTML 1.0 Strict,
+    you've got to put paragraph tags in your blockquotes:</p>
+    
+    <pre><code>&lt;blockquote&gt;
+        &lt;p&gt;For example.&lt;/p&gt;
+    &lt;/blockquote&gt;
+    </code></pre>