wikiwah 0.0.1

data/lib/wikiwah.rb~

@@ -0,0 +1,99 @@
+require 'wikiwah/flow'
+require 'wikiwah/subst'
+require 'wikiwah/version'
+
+# A formatter for turning Wiki-esque text into HTML.
+#
+# = Block-level markup
+#
+# - A line prefixed by "=" is a heading.  The heading-level is implied by
+#   the number of "=" characters.
+#
+# - A line beginning with "*" or "-" is an unordered list item.
+#
+# - A line beginning with "1.", "(1)" or "#" is an ordered list item.
+#
+# - A paragraph prefixed by "|" is preformatted text (e.g. code)
+#
+# - A paragraph prefixed by ">" is a blockquote (ie. a citation)
+#
+# = Text markup
+#
+# - HTML tags are rendered verbatim.
+#
+# - Text may by marked *bold*, /italic/, _underlined_, +monospace+
+#
+# - Text may be quoted with '{{{' and '}}}'
+#
+# - URLs turn into links.
+#
+# - "{LOCATION}" creates a link to LOCATION.
+#
+# - "{LABEL}@LOCATION" creates a link to LOCATION, with the specified
+#   LABEL.
+#
+class WikiWah
+
+  attr_writer :link_translator
+
+  def initialize
+    @link_translator = proc do |link| link end
+    init_transformer
+  end
+
+  # Convert WikiWah text to HTML.
+  def to_html(text)
+    Flow.convert(text) do |paragraph|
+      @transformer.transform(paragraph)
+    end
+  end
+  
+  private
+
+  def translate_link(link)
+    @link_translator.call(link)
+  end
+  
+  def init_transformer
+    @transformer = WikiWah::Subst.new 
+    @transformer.add_transformation(/""(.+)""/) do |match|
+      # Double-double-quoted
+      CGI.escapeHTML(match[1])
+    end
+    @transformer.add_transformation(/\\(.)/) do |match|
+      # Backslash-quoted
+      match[1]
+    end
+    @transformer.add_transformation(/\<(.+?)\>/m) do |match| 
+      # In-line HTML
+      match[0] 
+    end
+    @transformer.add_transformation(/\{(.+?)\}(@(\S*[\w\/]))?/m) do |match|
+      # Distinuished link
+      label = @transformer.transform(match[1])
+      location = translate_link(match[3] || match[1])
+      if location
+        "<a href='#{location}'>#{label}</a>"
+      else
+        "{#{label}}"
+      end
+    end
+    @transformer.add_transformation(/\b[a-z]+:[\w\/]\S*[\w\/]/) do |match|
+      # URL
+      "<a href='#{match[0]}'>#{match[0]}</a>"
+    end
+    @transformer.add_transformation(%r[(^|\W)([*+_/])([*+_/]*\w.*?\w[*+_/]*)\2(?!\w)]) do |match|
+      # Bold/italic/etc.
+      tag = case match[2]
+            when '*'; 'strong'
+            when '+'; 'tt'
+            when '/'; 'em'
+            when '_'; 'u'
+            end
+      content = @transformer.transform(match[3])
+      (match[1] + '<' + tag + '>' + content + '</' + tag + '>')
+    end
+  end
+
+end
+

data/test/wikiwah/flow_tests.rb

@@ -0,0 +1,422 @@
+#!/usr/bin/env ruby
+ 
+require 'wikiwah/flow'
+require 'test/unit'
+
+# Tests follow.  The structure is
+#
+#   ====
+#   #{input}
+#   ----
+#   #{expected_output}
+#
+# This script will complain if the actual output doesn't match.
+
+TESTS = <<END_OF_TESTS
+
+==== # Paragraph
+Simple paragraph
+----
+<p>
+Simple paragraph
+</p>
+
+==== # Two paragraphs
+P1
+
+P2
+----
+<p>
+P1
+</p>
+<p>
+P2
+</p>
+
+==== # List: one item
+* List
+----
+<ul class="sparse">
+<li>
+List
+</li>
+</ul>
+
+==== # List: two items
+* item 1
+* item 2
+----
+<ul class="sparse">
+<li>
+item 1
+</li>
+<li>
+item 2
+</li>
+</ul>
+
+==== # Nested lists
+* item 1
+  - item 1.1
+* item 2
+----
+<ul class="sparse">
+<li>
+item 1
+</li>
+<ul>
+<li>
+item 1.1
+</li>
+</ul>
+<li>
+item 2
+</li>
+</ul>
+
+==== # Numbered list
+# item 1
+# item 2
+----
+<ol>
+<li>
+item 1
+</li>
+<li>
+item 2
+</li>
+</ol>
+
+==== # Numbered list followed by un-numbered list
+# item 1
+* item 2
+----
+<ol>
+<li>
+item 1
+</li>
+</ol>
+<ul class="sparse">
+<li>
+item 2
+</li>
+</ul>
+
+==== # Paragraph/list
+P1
+
+- item 1
+----
+<p>
+P1
+</p>
+<ul>
+<li>
+item 1
+</li>
+</ul>
+
+==== # Paragraph/nested-list
+P1
+
+  - item 1
+----
+<p>
+P1
+<ul>
+<li>
+item 1
+</li>
+</ul>
+</p>
+
+==== # List/paragraph
+- item 1
+
+P1
+----
+<ul>
+<li>
+item 1
+</li>
+</ul>
+<p>
+P1
+</p>
+
+==== # Paragraph/list/paragraph
+P1
+
+- item 1
+
+P2
+----
+<p>
+P1
+</p>
+<ul>
+<li>
+item 1
+</li>
+</ul>
+<p>
+P2
+</p>
+
+==== # Code
+| code
+| 
+| more code
+----
+<pre>
+code
+
+more code
+</pre>
+
+==== # Blockquote
+> block
+> quote
+----
+<blockquote>
+block
+quote
+</blockquote>
+
+==== # Blockquote with space
+> block
+>
+> quote
+----
+<blockquote>
+block
+
+quote
+</blockquote>
+
+====
+> q1
+
+  - item
+
+> q2
+----
+<blockquote>
+q1
+<ul>
+<li>
+item
+</li>
+</ul>
+q2
+</blockquote>
+
+====
+  - item
+
+  | code
+----
+<ul>
+<li>
+item
+</li>
+</ul>
+<pre>
+code
+</pre>
+
+====
+* item
+
+  | code
+----
+<ul class="sparse">
+<li>
+item
+</li>
+<pre>
+code
+</pre>
+</ul>
+
+====
+Text with <tags> in
+----
+<p>
+Text with <tags> in
+</p>
+
+====
+drink XXXX
+----
+<p>
+drink BEER
+</p>
+
+====
+= HEAD
+  - blah
+----
+<h1>
+HEAD
+</h1>
+<ul>
+<li>
+blah
+</li>
+</ul>
+
+====
+P1
+
+  quote
+
+P2
+----
+<p>
+P1
+<blockquote>
+quote
+</blockquote>
+</p>
+<p>
+P2
+</p>
+
+====
+P1
+
+  quote
+    - xxx
+----
+<p>
+P1
+<blockquote>
+quote
+<ul>
+<li>
+xxx
+</li>
+</ul>
+</blockquote>
+</p>
+
+====
+1. juan
+2. two
+----
+<ol>
+<li>
+juan
+</li>
+<li>
+two
+</li>
+</ol>
+
+====
+(1) juan
+(2) two
+----
+<ol>
+<li>
+juan
+</li>
+<li>
+two
+</li>
+</ol>
+
+====
+| x
+| |y|
+| z
+----
+<pre>
+x
+|y|
+z
+</pre>
+
+====
+- list item
+
+== header
+----
+<ul>
+<li>
+list item
+</li>
+</ul>
+<h2>
+header
+</h2>
+
+====
+% term1
+
+    definition1
+
+% term2
+
+    definition2
+----
+<dl>
+<dt>
+term1
+</dt>
+<dd>
+definition1
+</dd>
+<dt>
+term2
+</dt>
+<dd>
+definition2
+</dd>
+</dl>
+
+====
+b4
+
+% term1
+
+  def1
+
+after
+----
+<p>
+b4
+</p>
+<dl>
+<dt>
+term1
+</dt>
+<dd>
+def1
+</dd>
+</dl>
+<p>
+after
+</p>
+END_OF_TESTS
+
+class WikiWah
+  class FlowTests < Test::Unit::TestCase
+
+    TESTS.split(/\n====.*\n/).each_with_index do |test, i|
+      (input, expected) = test.split(/----\n/)
+      next unless expected
+      define_method("test_#{i}") do
+        actual = WikiWah::Flow.convert(input) do |s|
+          s.gsub(/XXXX/, "BEER")
+        end
+        expected[/\s*\z/] = ''
+        actual[/\s*\z/] = ''
+        assert_equal(expected, actual)
+      end
+    end
+
+  end 
+end
+