kramdown 0.1.0

data/README

@@ -0,0 +1,20 @@
+# kramdown
+
+kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
+supporting several common extensions.
+
+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.
+
+# Usage
+
+kramdown has a basic *Cloth API, so using kramdown is as easy as
+
+    require 'kramdown'
+
+    Kramdown::Document.new(text).to_html
+
+
+# License
+
+See the COPYING file.

data/Rakefile

@@ -0,0 +1,300 @@
+# -*- ruby -*-
+
+# load all optional developer libraries
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue LoadError
+end
+
+begin
+  require 'webgen/webgentask'
+  require 'webgen/page'
+rescue LoadError
+end
+
+require 'rdoc/task'
+require 'rdoc/rdoc'
+
+
+begin
+  require 'rubyforge'
+rescue LoadError
+end
+
+begin
+  require 'rcov/rcovtask'
+rescue LoadError
+end
+
+require 'fileutils'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+
+$:.unshift('lib')
+require 'kramdown'
+
+# End user tasks ################################################################
+
+task :default => :test
+
+desc "Install using setup.rb"
+task :install do
+  ruby "setup.rb config"
+  ruby "setup.rb setup"
+  ruby "setup.rb install"
+end
+
+task :clobber do
+  ruby "setup.rb clean"
+end
+
+
+if defined? Webgen
+  desc "Generate the HTML documentation"
+  Webgen::WebgenTask.new('htmldoc') do |site|
+    site.clobber_outdir = true
+    site.config_block = lambda do |config|
+      config['sources'] = [['/', "Webgen::Source::FileSystem", 'doc']]
+      config['output'] = ['Webgen::Output::FileSystem', 'htmldoc']
+      config.default_processing_pipeline('Page' => 'erb,tags,kramdown,blocks,fragments')
+      config['contentprocessor.map']['kramdown'] = 'Kramdown::KDConverter'
+    end
+  end
+
+  task :doc => :htmldoc
+end
+
+rd = Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'htmldoc/rdoc'
+  rdoc.title = 'kramdown'
+  rdoc.main = 'Kramdown'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Build the whole user documentation"
+task :doc => :rdoc
+
+tt = Rake::TestTask.new do |test|
+  test.warning = true
+  test.libs << 'test'
+end
+
+# Release tasks and development tasks ############################################
+
+namespace :dev do
+
+  SUMMARY = 'kramdown is a fast, pure-Ruby converter for Markdown-like markup.'
+  DESCRIPTION = <<EOF
+kramdown is yet-another-markdown-parser but fast, pure Ruby,
+using a strict syntax definition and supporting several common extensions.
+EOF
+
+  begin
+    REL_PAGE = Webgen::Page.from_data(File.read('doc/news/release_' + Kramdown::VERSION.split('.').join('_') + '.page'))
+  rescue
+    puts 'NO RELEASE NOTES/CHANGES FILE'
+  end
+
+  PKG_FILES = FileList.new([
+                            'Rakefile',
+                            'setup.rb',
+                            'COPYING', 'GPL', 'README', 'AUTHORS',
+                            'VERSION', 'ChangeLog',
+                            'bin/*',
+                            'benchmark/*',
+                            'lib/**/*.rb',
+                            'doc/**',
+                            'test/**/*'
+                           ])
+
+  CLOBBER << "VERSION"
+  file 'VERSION' do
+    puts "Generating VERSION file"
+    File.open('VERSION', 'w+') {|file| file.write(Kramdown::VERSION + "\n")}
+  end
+
+  CLOBBER << 'ChangeLog'
+  file 'ChangeLog' do
+    puts "Generating ChangeLog file"
+    `git log --name-only > ChangeLog`
+  end
+
+  Rake::PackageTask.new('kramdown', Kramdown::VERSION) do |pkg|
+    pkg.need_tar = true
+    pkg.need_zip = true
+    pkg.package_files = PKG_FILES
+  end
+
+  if defined? Gem
+    spec = Gem::Specification.new do |s|
+
+      #### Basic information
+      s.name = 'kramdown'
+      s.version = Kramdown::VERSION
+      s.summary = SUMMARY
+      s.description = DESCRIPTION
+
+      #### Dependencies, requirements and files
+      s.files = PKG_FILES.to_a
+
+      s.require_path = 'lib'
+      s.executables = ['kramdown']
+      s.default_executable = 'kramdown'
+
+      #### Documentation
+
+      s.has_rdoc = true
+      s.rdoc_options = ['--line-numbers', '--main', 'Kramdown']
+
+      #### Author and project details
+
+      s.author = 'Thomas Leitner'
+      s.email = 't_leitner@gmx.at'
+      s.homepage = "http://kramdown.rubyforge.org"
+      s.rubyforge_project = 'kramdown'
+    end
+
+    Rake::GemPackageTask.new(spec) do |pkg|
+      pkg.need_zip = true
+      pkg.need_tar = true
+    end
+
+  end
+
+  desc 'Release Kramdown version ' + Kramdown::VERSION
+  task :release => [:clobber, :package, :publish_files, :publish_doc, :post_news]
+
+  if defined? RubyForge
+    desc "Upload the release to Rubyforge"
+    task :publish_files => [:package] do
+      print 'Uploading files to Rubyforge...'
+      $stdout.flush
+
+      rf = RubyForge.new
+      rf.configure
+      rf.login
+
+      rf.userconfig["release_notes"] = REL_PAGE.blocks['content'].content
+      rf.userconfig["preformatted"] = false
+
+      files = %w[.gem .tgz .zip].collect {|ext| "pkg/kramdown-#{Kramdown::VERSION}" + ext}
+
+      rf.add_release('kramdown', 'kramdown', Kramdown::VERSION, *files)
+      puts 'done'
+    end
+
+    desc 'Post announcement to rubyforge.'
+    task :post_news do
+      print 'Posting announcement to Rubyforge ...'
+      $stdout.flush
+      rf = RubyForge.new
+      rf.configure
+      rf.login
+
+      content = REL_PAGE.blocks['content'].content
+      content += "\n\n\nAbout kramdown\n\n#{SUMMARY}\n\n#{DESCRIPTION}"
+      rf.post_news('kramdown', "kramdown #{Kramdown::VERSION} released", content)
+      puts "done"
+    end
+  end
+
+  desc "Upload the website to Rubyforge"
+  task :publish_website => ['rdoc', :website] do
+    sh "rsync -avc --delete --exclude 'wiki' --exclude 'robots.txt'  htmldoc/ gettalong@rubyforge.org:/var/www/gforge-projects/kramdown/"
+  end
+
+
+  if defined? Rcov
+    Rcov::RcovTask.new do |rcov|
+      rcov.libs << 'test'
+    end
+  end
+
+  COPYRIGHT=<<EOF
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009 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/>.
+#++
+#
+EOF
+
+  desc "Insert copyright notice"
+  task :insert_copyright do
+    inserted = false
+    Dir["lib/**/*.rb"].each do |file|
+      if !File.read(file).start_with?(COPYRIGHT)
+        inserted = true
+        puts "Updating file #{file}"
+        data = COPYRIGHT + "\n" + File.read(file)
+        File.open(file, 'w+') {|f| f.puts(data)}
+      end
+    end
+    puts "Look through the above mentioned files and correct all problems" if inserted
+  end
+
+end
+
+task :clobber => ['dev:clobber']
+
+# Helper methods and misc  ###################################################################
+
+module Kramdown
+
+  # Processes content in kramdown format using the +maruku+ library.
+  class KDConverter
+
+    # Convert the content in +context+ to HTML.
+    def call(context)
+      extend Webgen::Loggable
+      doc = ::Kramdown::Document.new(context.content, :auto_ids => true)
+      context.content = doc.to_html
+      doc.warnings.each do |warn|
+        log(:warn) { "Warning while parsing #{context.ref_node} with kramdown: #{warn}" }
+      end
+      context
+    end
+
+  end
+
+  class Extension
+
+    def parse_kdexample(parser, opts, body)
+      wrap = Element.new(:html_element, 'div', :attr => {'class' => 'kdexample'})
+      wrap.children << Element.new(:codeblock, body, :attr => {'class' => 'kdexample-before'})
+      doc = ::Kramdown::Document.new(body)
+      wrap.children << Element.new(:codeblock, doc.to_html,  :attr => {'class' => 'kdexample-after-source'})
+      wrap.children << Element.new(:html_element, 'div', :attr => {'class' => 'kdexample-after-live'})
+      wrap.children.last.children << Element.new(:raw, doc.to_html)
+      parser.tree.children << wrap
+      parser.tree.children << Element.new(:html_element, 'div', :attr => {'class' => 'clear'})
+    end
+
+    def parse_kdlink(parser, opts, body)
+      wrap = Element.new(:html_element, 'div', :attr => {'class' => 'kdsyntaxlink'})
+      wrap.children << Element.new(:a, nil, :attr => {'href' => "syntax.html##{opts['id']}"})
+      wrap.children.last.children << Element.new(:text, "&rarr; Syntax for #{opts['part']}")
+      parser.tree.children << wrap
+    end
+
+  end
+
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/benchmark/benchmark.rb

@@ -0,0 +1,33 @@
+require 'benchmark'
+require 'stringio'
+
+require 'kramdown'
+require 'bluecloth'
+require 'maruku'
+require 'rdiscount'
+require 'bluefeather'
+
+module MaRuKu::Errors
+  def tell_user(s)
+  end
+end
+
+
+RUNS=20
+
+FILES=['mdsyntax.text', 'mdbasics.text']
+
+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))
+  puts
+  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("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 } }
+  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>