moredown 1.0.0

data/moredown.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{moredown}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Hoad", "Ryan Tomayko", "David Loren Parsons"]
+  s.date = %q{2009-10-23}
+  s.default_executable = %q{rdiscount}
+  s.description = %q{An extension to the RDiscount Markdown formatter}
+  s.email = %q{nathan@nathanhoad.net}
+  s.executables = ["rdiscount"]
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "COPYING",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "bin/rdiscount",
+     "ext/Csio.c",
+     "ext/amalloc.h",
+     "ext/config.h",
+     "ext/cstring.h",
+     "ext/docheader.c",
+     "ext/dumptree.c",
+     "ext/extconf.rb",
+     "ext/generate.c",
+     "ext/markdown.c",
+     "ext/markdown.h",
+     "ext/mkdio.c",
+     "ext/mkdio.h",
+     "ext/rdiscount.c",
+     "ext/resource.c",
+     "ext/toc.c",
+     "lib/markdown.rb",
+     "lib/moredown.rb",
+     "lib/rdiscount.rb",
+     "moredown.gemspec",
+     "test/benchmark.rb",
+     "test/benchmark.txt",
+     "test/markdown_test.rb",
+     "test/moredown_test.rb",
+     "test/rdiscount_test.rb"
+  ]
+  s.homepage = %q{http://nathanhoad.net/projects/moredown}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Markdown plus more!}
+  s.test_files = [
+    "test/benchmark.rb",
+     "test/markdown_test.rb",
+     "test/moredown_test.rb",
+     "test/rdiscount_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/benchmark.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+
+iterations = 100
+test_file = "#{File.dirname(__FILE__)}/benchmark.txt"
+implementations = %w[BlueCloth RDiscount Maruku PEGMarkdown]
+
+# Attempt to require each implementation and remove any that are not
+# installed.
+implementations.reject! do |class_name|
+  begin
+    module_path =
+      if class_name == 'PEGMarkdown'
+        'peg_markdown'
+      else
+        class_name.downcase
+      end
+    require module_path
+    false
+  rescue LoadError => boom
+    module_path.tr! '_', '-'
+    puts "#{class_name} excluded. Try: gem install #{module_path}"
+    true
+  end
+end
+
+# Grab actual class objects.
+implementations.map! { |class_name| Object.const_get(class_name) }
+
+# The actual benchmark.
+def benchmark(implementation, text, iterations)
+  start = Time.now
+  iterations.times do |i|
+    implementation.new(text).to_html
+  end
+  Time.now - start
+end
+
+# Read test file
+test_data = File.read(test_file)
+
+# Prime the pump
+puts "Spinning up ..."
+implementations.each { |impl| benchmark(impl, test_data, 1) }
+
+# Run benchmarks; gather results.
+puts "Running benchmarks ..."
+results =
+  implementations.inject([]) do |r,impl|
+    GC.start
+    r << [ impl, benchmark(impl, test_data, iterations) ]
+  end
+
+puts "Results for #{iterations} iterations:"
+results.each do |impl,time|
+  printf "  %10s %09.06fs total time, %09.06fs average\n", "#{impl}:", time, time / iterations
+end

data/test/benchmark.txt

@@ -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>

data/test/markdown_test.rb

@@ -0,0 +1,119 @@
+rootdir = File.dirname(File.dirname(__FILE__))
+$LOAD_PATH.unshift "#{rootdir}/lib"
+
+require 'test/unit'
+require 'markdown'
+
+MARKDOWN_TEST_DIR = "#{rootdir}/test/MarkdownTest_1.0.3"
+
+class MarkdownTest < Test::Unit::TestCase
+
+  def test_that_extension_methods_are_present_on_markdown_class
+      assert Markdown.instance_methods.map{|m| m.to_s }.include?('to_html'),
+        "Markdown class should respond to #to_html"
+  end
+
+  def test_that_simple_one_liner_goes_to_html
+    markdown = Markdown.new('Hello World.')
+    assert_respond_to markdown, :to_html
+    assert_equal "<p>Hello World.</p>", markdown.to_html.strip
+  end
+
+  def test_that_inline_markdown_goes_to_html
+    markdown = Markdown.new('_Hello World_!')
+    assert_equal "<p><em>Hello World</em>!</p>", markdown.to_html.strip
+  end
+
+  def test_that_inline_markdown_starts_and_ends_correctly
+    markdown = Markdown.new('_start _ foo_bar bar_baz _ end_ *italic* **bold** <a>_blah_</a>')
+    assert_respond_to markdown, :to_html
+    assert_equal "<p><em>start _ foo_bar bar_baz _ end</em> <em>italic</em> <strong>bold</strong> <a><em>blah</em></a></p>", markdown.to_html.strip
+
+    markdown = Markdown.new("Run 'rake radiant:extensions:rbac_base:migrate'")
+    assert_equal "<p>Run 'rake radiant:extensions:rbac_base:migrate'</p>", markdown.to_html.strip
+  end
+
+  def test_that_filter_html_works
+    markdown = Markdown.new('Through <em>NO</em> <script>DOUBLE NO</script>', :filter_html)
+    assert_equal "<p>Through &lt;em>NO&lt;/em> &lt;script>DOUBLE NO&lt;/script></p>", markdown.to_html.strip
+  end
+
+  def test_that_bluecloth_restrictions_are_supported
+    markdown = Markdown.new('Hello World.')
+    [:filter_html, :filter_styles].each do |restriction|
+      assert_respond_to markdown, restriction
+      assert_respond_to markdown, "#{restriction}="
+    end
+    assert_not_equal true, markdown.filter_html
+    assert_not_equal true, markdown.filter_styles
+
+    markdown = Markdown.new('Hello World.', :filter_html, :filter_styles)
+    assert_equal true, markdown.filter_html
+    assert_equal true, markdown.filter_styles
+  end
+
+  def test_that_redcloth_attributes_are_supported
+    markdown = Markdown.new('Hello World.')
+    assert_respond_to markdown, :fold_lines
+    assert_respond_to markdown, :fold_lines=
+    assert_not_equal true, markdown.fold_lines
+
+    markdown = Markdown.new('Hello World.', :fold_lines)
+    assert_equal true, markdown.fold_lines
+  end
+
+  def test_that_redcloth_to_html_with_single_arg_is_supported
+    markdown = Markdown.new('Hello World.')
+    assert_nothing_raised(ArgumentError) { markdown.to_html(true) }
+  end
+
+  def test_that_smart_converts_single_quotes_in_words_that_end_in_re
+    markdown = Markdown.new("They're not for sale.", :smart)
+    assert_equal "<p>They&rsquo;re not for sale.</p>\n", markdown.to_html
+  end
+
+  def test_that_smart_converts_single_quotes_in_words_that_end_in_ll
+    markdown = Markdown.new("Well that'll be the day", :smart)
+    assert_equal "<p>Well that&rsquo;ll be the day</p>\n", markdown.to_html
+  end
+
+  def test_that_urls_are_not_doubly_escaped
+    markdown = Markdown.new('[Page 2](/search?query=Markdown+Test&page=2)')
+    assert_equal "<p><a href=\"/search?query=Markdown+Test&amp;page=2\">Page 2</a></p>\n", markdown.to_html
+  end
+
+  def test_simple_inline_html
+    markdown = Markdown.new("before\n\n<div>\n  foo\n</div>\nafter")
+    assert_equal "<p>before</p>\n\n<div>\n  foo\n</div>\n\n\n<p>after</p>\n",
+      markdown.to_html
+  end
+
+  def test_that_html_blocks_do_not_require_their_own_end_tag_line
+    markdown = Markdown.new("Para 1\n\n<div><pre>HTML block\n</pre></div>\n\nPara 2 [Link](#anchor)")
+    assert_equal "<p>Para 1</p>\n\n<div><pre>HTML block\n</pre></div>\n\n\n<p>Para 2 <a href=\"#anchor\">Link</a></p>\n",
+      markdown.to_html
+  end
+
+  # Build tests for each file in the MarkdownTest test suite
+
+  Dir["#{MARKDOWN_TEST_DIR}/Tests/*.text"].each do |text_file|
+
+    basename = File.basename(text_file).sub(/\.text$/, '')
+    html_file = text_file.sub(/text$/, 'html')
+    method_name = basename.gsub(/[-,]/, '').gsub(/\s+/, '_').downcase
+
+    define_method "test_#{method_name}" do
+      markdown = Markdown.new(File.read(text_file))
+      actual_html = markdown.to_html
+      assert_not_nil actual_html
+    end
+
+    define_method "test_#{method_name}_with_smarty_enabled" do
+      markdown = Markdown.new(File.read(text_file), :smart)
+      actual_html = markdown.to_html
+      assert_not_nil actual_html
+    end
+
+  end
+
+end