mcbean 0.2.0 → 0.3.0

data.tar.gz.sig

@@ -1,2 +1,3 @@
-"5��Ri�Os+�?�'�/�Z�~�5'%���
ٗ]
��ce62����P�~��פ�Dґ<Xᚯ}c��-���·�A�n&HTX}������ޝ�k/ж�!uD}�S�m�p�?�������P���>��Pi��{k����7�d���N=���6�])�Z�"Q�qH�&�֤q�	��A��7v''��]�\Qu�M��>
-�љ���]ֺ�y,a�Ѿ) G,=�aJ\��Z����ki��@�+
+W�BB�����90���\֫5�#�$Kߵ�2�f�F�ko��%�s��c���
+n���%�I0?-���aI�j@�hkjo��k��ҷA�j��±�I�?b6Ïw�{�VK9P�:��u�-��~�C��n
�g�yeΪ��Z�Lr�.���	���>E��ښ�Ҝ��k�CZ�F�!/���=N
���k܁��+�t��x�먊<e�w)
+�j���%

data/CHANGELOG.rdoc

@@ -2,10 +2,33 @@
 
 == HEAD
 
+Features:
+
+* Support for Textile.
+* McBean#to_html now does the right thing when the instance is created via McBean.markdown or McBean.textile.
+* McBean#to_html now entity-escapes unsafe and invalid HTML tags (thanks to Loofah).
+
+Deprecations:
+
+* McBean.new and .allocate are now private. You shouldn't have been using them, anyway.
+* McBean#html and #markdown accessors have been dropped.
+
+== 0.2.0 (2010-03-24)
+
+* Converts Markdown to HTML (thanks to RDiscount). GH #2.
 * <br> elements are converted into newlines (markdown). GH #5
 * <a> elements without an 'href' attribute are not rendered as hyperlinks (markdown). GH #4
 
+== 0.1.2 (2010-03-10)
+
+* Command line utility "mcbean"
+* Demo site on Heroku
+
+== 0.1.1 (2010-03-09)
+
+* Better hyperlink handling
+
 == 0.1.0 (2010-03-09)
 
 * Happy Birthday!
-* Converts HTML documents into Markdown.
+* Converts HTML documents to Markdown.

data/Manifest.txt

@@ -1,12 +1,13 @@
 .autotest
 CHANGELOG.rdoc
-History.txt
 Manifest.txt
 README.rdoc
 Rakefile
 bin/mcbean
 lib/mcbean.rb
 lib/mcbean/markdown.rb
+lib/mcbean/textile.rb
 test/helper.rb
 test/test_markdown.rb
 test/test_mcbean.rb
+test/test_textile.rb

data/README.rdoc

@@ -1,46 +1,51 @@
 = McBean
 
 * http://github.com/flavorjones/mcbean
-* http://mcbean.heroku.com/
+* http://mcbean.heroku.com (live demo)
 
 == Description
 
-McBean converts HTML into Markdown, and Markdown into HTML (with the
-help of Loofah, Nokogiri and RDiscount).
+McBean can convert documents from one format to another. McBean currently supports:
 
-Its goal is to eventually be able to transform documents from HTML to
-Markdown to Textile, and anything in between. It will be the Sylvester
-McMonkey McBean of markup, placing stars onto the bellies of all kinds
-of Sneetchy document formats.
+* HTML
+* Markdown (a subset)
+* Textile (a subset)
 
-"You can't teach a Sneetch."
+with the help of Loofah, Nokogiri, RDiscount and RedCloth.
 
-== Features / Problems
+"You can't teach a Sneetch." -- Sylvester McMonkey McBean
 
-* Transforms HTML into Markdown, and Markdown into HTML.
-* Doesn't do anything else yet.
+== Features
 
-== Synopsis
+* Transforms HTML into Markdown, and Markdown into HTML (thanks to RDiscount).
+* Transforms HTML into Textile, and Textile into HTML (thanks to RedCloth).
+* Transforms Textile into Markdown, and Markdown into Textile.
+* Emitted HTML is sanitized (thanks to Loofah).
+* Fancy-pants command line utility, "mcbean".
 
-If you have an HTML fragment, you can convert it into Markdown:
+== Problems
 
-  McBean.fragment(your_html).to_markdown
+* Only supports a limited subset of Markdown and Textile. Patches welcome.
 
-Or if you have an HTML document, you can convert it into Markdown:
+== Synopsis
 
-  McBean.document(your_html).to_markdown
+Wrap your document (which can be either a String or an IO object):
 
-You can also convert Markdown into HTML (via RDiscount):
+  mcbean = McBean.fragment(your_html_fragment)
+  mcbean = McBean.document(your_html_document)
+  mcbean = McBean.markdown(your_markdown)
+  mcbean = McBean.textile(your_textile)
 
-  McBean.markdown(your_markdown).to_html
+And then generate the desired markup format:
 
-Note that the parameter passed to +fragment+, +document+ and
-+markdown+ can be either a String or an IO.
+  mcbean.to_html
+  mcbean.to_markdown
+  mcbean.to_textile
 
 Also, +mcbean+ provides a command-line utility installed into your gem path:
 
-  $ mcbean /usr/lib/openoffice/licenses/LICENSE_en-GB.html
-  $ mcbean http://daringfireball.net/projects/markdown/syntax
+  $ mcbean --html="http://en.wikipedia.org/wiki/The_Sneetches_and_Other_Stories" --to-markdown
+  $ mcbean --markdown="treetop-1.4.2/doc/grammar_composition.markdown" --to-textile
 
 You can try out McBean at the live demo site: http://mcbean.heroku.com
 
@@ -52,8 +57,9 @@ have a single root node, you have a *fragment*.
 
 == Requirements
 
-* Loofah 0.4.7 (and thusly Nokogiri)
-* RDiscount 1.3.4
+* Loofah >= 0.4.7 (and thusly Nokogiri)
+* RDiscount >= 1.3.4
+* RedCloth >= 4.0.0
 
 == Install
 
@@ -63,6 +69,8 @@ have a single root node, you have a *fragment*.
 
 Thanks to David Loren Parsons and Ryan Tomayko for RDiscount.
 
+Thanks to Jason Garber for RedCloth.
+
 == License
 
 (The MIT License)

data/Rakefile

@@ -13,10 +13,12 @@ Hoe.spec 'mcbean' do
   self.history_file     = "CHANGELOG.rdoc"
   self.readme_file      = "README.rdoc"
 
-  extra_deps << ["loofah", ">= 0.4.7"]
-  extra_deps << ["rdiscount", ">= 1.3.4"]
-  extra_dev_deps << ["shoulda", ">= 2.10"]
-  extra_dev_deps << ["rr", ">= 0.10.4"]
+  self.extra_deps << ["loofah", ">= 0.4.7"]
+  self.extra_deps << ["rdiscount", ">= 1.3.4"]
+  self.extra_deps << ["RedCloth", ">= 4.0.0"]
+  self.extra_dev_deps << ["minitest", ">= 1.6.0"]
+
+  self.testlib = :minitest
 end
 
 task :redocs => :fix_css
@@ -35,11 +37,6 @@ task :fix_css do
       margin-top                : .5em ;
     }
 
-    #main ul, div#documentation ul {
-      list-style-type           : disc ! IMPORTANT ;
-      list-style-position       : inside ! IMPORTANT ;
-    }
-
     h2 + ul {
       margin-top                : 1em;
     }

data/bin/mcbean

@@ -3,12 +3,65 @@
 require 'open-uri'
 require 'rubygems'
 require 'mcbean'
+require 'getoptlong'
 
-unless ARGV[0]
-  puts "USAGE: #{File.basename(__FILE__)} <file-or-url>"
+SCRIPT = File.basename(__FILE__)
+@input_format  = "html"
+@output_format = "markdown"
+@input_file    = nil
+
+OPTS = []
+McBean.formats.each do |format|
+  OPTS << [ "--#{format}", "-#{format[0,1]}", GetoptLong::REQUIRED_ARGUMENT ]
+  OPTS << [ "--to-#{format}", "-#{format[0,1].upcase}", GetoptLong::NO_ARGUMENT ]
+end
+
+def _usage
+  puts "USAGE: #{SCRIPT} [--<FROM_FORMAT>=]<FILE-OR-URL> [--to-<TO_FORMAT>]"
+  puts
+  puts "     McBean transforms a file from one format to another, for your reading pleasure."
+  puts
+  puts "     e.g.:"
+  puts "       #{SCRIPT} --html=\"http://en.wikipedia.org/wiki/The_Sneetches_and_Other_Stories\" --to-markdown"
+  puts "       #{SCRIPT} --markdown=\"sneetches.md\" --to-textile"
+  puts
+  puts "     If FROM_FORMAT option is not specified, --#{@input_format} is assumed"
+  puts "     If TO_FORMAT option is not specified, --to-#{@output_format} is assumed"
   puts
-  puts "McBean transforms HTML into Markdown for your reading pleasure."
+  puts "     Shortcuts / Supported Formats:"
+  OPTS.each do |long, short, _|
+    puts "       #{short} for #{long}"
+  end
   exit 1
 end
 
-puts McBean.document(open(ARGV[0])).to_markdown
+begin
+  GetoptLong.new(*OPTS).each do |opt, arg|
+    McBean.formats.each do |format|
+      if opt == "--#{format}"
+        @input_format = format
+        @input_file   = arg
+      elsif opt == "--to-#{format}"
+        @output_format = format
+      end
+    end
+  end
+rescue
+  _usage
+end
+
+if @input_file.nil?
+  _usage if ARGV.length != 1
+  @input_file = ARGV[0]
+end
+
+mcbean = case @input_format
+         when "html"
+           McBean.document(open(@input_file))
+         else
+           McBean.send(@input_format, open(@input_file))
+         end
+
+puts mcbean.send("to_#{@output_format}")
+
+exit 0

data/lib/mcbean.rb

@@ -1,36 +1,82 @@
 require "loofah"
 
+#
+#  McBean can convert documents from one format to another.
+#
+#  See the README.rdoc for more details and examples.
+#
 class McBean
-  VERSION = "0.2.0"
+  # Current version of McBean
+  VERSION = "0.3.0"
+
+  # Minimum required version of Loofah
   REQUIRED_LOOFAH_VERSION = "0.4.7"
 
-  attr_accessor :html
+  attr_writer :__html__ # :nodoc:
+
+  private_class_method :new, :allocate
 
+  @@__formats__ = ["html"]
+
+  ##
+  #  Create a McBean from an HTML fragment string (or IO object)
+  #
+  #  Please see README.rdoc for more information on HTML fragments and documents.
+  #
   def McBean.fragment(string_or_io)
-    mcbean = allocate
-    mcbean.html = Loofah.fragment(string_or_io)
+    mcbean = new
+    mcbean.__html__ = Loofah.fragment(string_or_io)
     mcbean
   end
 
+  ##
+  #  Create a McBean from an HTML document string (or IO object)
+  #
+  #  Please see README.rdoc for more information on HTML fragments and documents.
+  #
   def McBean.document(string_or_io)
-    mcbean = allocate
-    mcbean.html = Loofah.document(string_or_io)
+    mcbean = new
+    mcbean.__html__ = Loofah.document(string_or_io)
     mcbean
   end
 
-  def McBean.markdown(string_or_io)
-    if string_or_io.respond_to?(:read)
-      McBean::Markdownify::Antidote.new(string_or_io.read)
-    else
-      McBean::Markdownify::Antidote.new(string_or_io)
+  ##
+  #  Returns an array of formats that McBean supports.
+  #
+  def McBean.formats
+    @@__formats__
+  end
+
+  ##
+  #  Generate an HTML string representation of the McBeaned document.
+  #
+  #  So you can convert documents in other formats to HTML as follows:
+  #
+  #    McBean.markdown(File.read(path_to_markdown_file)).to_html
+  #
+  def to_html
+    __html__.dup.scrub!(:escape).to_html
+  end
+
+  def __html__ # :nodoc:
+    @__html__ ||= nil
+    unless @__html__
+      (McBean.formats - ["html"]).each do |format|
+        obj = send("__#{format}__", false)
+        if obj
+          @__html__ = Loofah.document(obj.to_html)
+          break
+        end
+      end
     end
+    @__html__
   end
 end
 Mcbean = McBean
 
 require "mcbean/markdown"
+require "mcbean/textile"
 
 if Loofah::VERSION < McBean::REQUIRED_LOOFAH_VERSION
   raise RuntimeError, "McBean requires Loofah #{McBean::REQUIRED_LOOFAH_VERSION} or later (currently #{Loofah::VERSION})"
 end
-

data/lib/mcbean/markdown.rb

@@ -1,6 +1,42 @@
 require 'rdiscount'
 
 class McBean
+  attr_writer :__markdown__ # :nodoc:
+
+  @@__formats__ << "markdown"
+
+  ##
+  #  Create a McBean from a Markdown document string (or IO object)
+  #
+  def McBean.markdown(string_or_io)
+    mcbean = new
+    mcbean.__markdown__ = McBean::Markdownify::Antidote.new(string_or_io.respond_to?(:read) ? string_or_io.read : string_or_io)
+    mcbean
+  end
+
+  ##
+  #  Generate a Markdown string representation of the McBeaned document.
+  #
+  #  So you can convert documents in other formats to Markdown as follows:
+  #
+  #    McBean.fragment(File.read(path_to_html_file)).to_markdown
+  #
+  def to_markdown
+    __markdown__.text
+  end
+
+  def __markdown__ generate_from_html_if_necessary=true # :nodoc:
+    @__markdown__ ||= nil
+    if @__markdown__.nil? && generate_from_html_if_necessary
+      @__markdown__ = McBean::Markdownify::Antidote.new(
+                        Loofah::Helpers.remove_extraneous_whitespace(
+                          __html__.dup.scrub!(:escape).scrub!(Markdownify.new).text(:encode_special_chars => false)
+                      ))
+    end
+    @__markdown__
+  end
+
+  # :stopdoc:
   class Markdownify < Loofah::Scrubber
     Antidote = ::RDiscount # could conceivably be BlueCloth
 
@@ -88,10 +124,5 @@ class McBean
       (node.document.serialize_root || node.ancestors.last).children.last
     end
   end
-
-  def to_markdown
-    Loofah::Helpers.remove_extraneous_whitespace \
-      html.dup.scrub!(:prune).scrub!(Markdownify.new).text(:encode_special_chars => false)
-  end
+  # :startdoc:
 end
-

data/lib/mcbean/textile.rb

@@ -0,0 +1,110 @@
+require 'redcloth'
+
+class McBean
+  attr_writer :__textile__ # :nodoc:
+
+  @@__formats__ << "textile"
+
+  ##
+  #  Create a McBean from a Textile document string (or IO object)
+  #
+  def McBean.textile string_or_io
+    mcbean = new
+    mcbean.__textile__ = McBean::Textilify::Antidote.new(string_or_io.respond_to?(:read) ? string_or_io.read : string_or_io)
+    mcbean
+  end
+
+  ##
+  #  Generate a Textile string representation of the McBeaned document.
+  #
+  #  So you can convert documents in other formats to Textile as follows:
+  #
+  #    McBean.fragment(File.read(path_to_html_file)).to_textile
+  #
+  def to_textile
+    __textile__.to_s
+  end
+
+  def __textile__ generate_from_html_if_necessary=true # :nodoc:
+    @__textile__ ||= nil
+    if @__textile__.nil? && generate_from_html_if_necessary
+      @__textile__ = McBean::Textilify::Antidote.new(
+                       Loofah::Helpers.remove_extraneous_whitespace(
+                         __html__.dup.scrub!(:escape).scrub!(Textilify.new).text(:encode_special_chars => false)
+                     ))
+    end
+    @__textile__
+  end
+
+  # :stopdoc:
+  class Textilify < Loofah::Scrubber
+    Antidote = ::RedCloth::TextileDoc
+
+    def initialize
+      @direction = :bottom_up
+      @link_references = nil
+      @link_reference_count = 0
+    end
+
+    def scrub(node)
+      return CONTINUE if node.text?
+      replacement_killer = \
+        case node.name
+        when "h1"
+          new_text node, "\nh1. #{node.content}\n"
+        when "h2"
+          new_text node, "\nh2. #{node.content}\n"
+        when "h3"
+          new_text node, "\nh3. #{node.content}\n"
+        when "h4"
+          new_text node, "\nh4. #{node.content}\n"
+        when "blockquote"
+          new_text node, "\nbq. #{node.content.gsub(/\n\n/, "\n").sub(/^\n/,'')}"
+        when "li"
+          nil # handled by parent list tag
+        when "ul"
+          fragment = []
+          node.xpath("./li").each do |li|
+            fragment << "* #{li.text}" if li.text =~ /\S/
+          end
+          new_text node, "\n#{fragment.join("\n")}\n"
+        when "ol"
+          fragment = []
+          node.xpath("./li").each do |li|
+            fragment << "# #{li.text}" if li.text =~ /\S/
+          end
+          new_text node, "\n#{fragment.join("\n")}\n"
+        when "code"
+          if node.parent.name == "pre"
+            new_text node, node.content.sub(/^/,"bc. ")
+          else
+            nil
+          end
+        when "br"
+          new_text node, "\n"
+        when "a"
+          if node['href'].nil?
+            new_text node, node.content
+          elsif node['title']
+            new_text node, %Q{["#{node.text} (#{node['title']})":#{node['href']}]}
+          else
+            new_text node, %Q{["#{node.text}":#{node['href']}]}
+          end
+        else
+          if Loofah::HashedElements::BLOCK_LEVEL[node.name]
+            new_text node, "\n#{node.content}\n"
+          else
+            nil
+          end
+        end
+      node.replace(replacement_killer) if replacement_killer
+    end
+
+    private
+
+    def new_text(node, text)
+      Nokogiri::XML::Text.new(text, node.document)
+    end
+  end
+  # :startdoc:
+end

data/test/helper.rb

@@ -1,8 +1,2 @@
-require "test/unit"
+require "minitest/autorun"
 require "mcbean"
-require "shoulda"
-require "rr"
-
-class Test::Unit::TestCase
-  include RR::Adapters::TestUnit
-end

data/test/test_markdown.rb

@@ -1,132 +1,149 @@
 require File.dirname(__FILE__) + "/helper"
 
-class TestMcBeanMarkdown < Test::Unit::TestCase
-  context McBean::Markdownify do
-    context "#to_markdown" do
-      should "add whitespace around block elements" do
-        assert_markdown "before<div>inner</div>after", "before\ninner\nafter", false
+describe McBean::Markdownify do
+  describe ".markdown" do
+    describe "passed a string" do
+      it "sets #__markdown__ to be a Markdownify::Antidote" do
+        McBean.markdown("hello\n=====\n").__markdown__.must_be_instance_of McBean::Markdownify::Antidote
       end
+    end
 
-      should "convert h1 tag" do
-        assert_markdown "<h1>Foo</h1>", "\nFoo\n==========\n"
+    describe "passed an IO" do
+      it "sets #__markdown__ to be a Markdownify::Antidote" do
+        io = StringIO.new "hello\n=====\n"
+        McBean.markdown(io).__markdown__.must_be_instance_of McBean::Markdownify::Antidote
       end
+    end
+  end
 
-      should "convert h2 tag" do
-        assert_markdown "<h2>Foo</h2>", "\nFoo\n----------\n"
-      end
+  describe "#to_html" do
+    attr_accessor :mcbean
 
-      should "convert h3 tag" do
-        assert_markdown "<h3>Foo</h3>", "\n### Foo ###\n"
+    describe "on an instance created by .markdown" do
+      before do
+        @mcbean = McBean.markdown "ohai!\n=====\n"
       end
 
-      should "convert h4 tag" do
-        assert_markdown "<h4>Foo</h4>", "\n#### Foo ####\n"
+      it "returns an html string" do
+        html = mcbean.to_html
+        html.must_be_instance_of String
+        html.must_match %r{<h1>ohai!</h1>}
       end
+    end
+  end
 
-      should "convert blockquote tag" do
-        assert_markdown "<blockquote><p>Hello\nGoodbye</p></blockquote>",
-        "> Hello\n> Goodbye\n"
-      end
+  describe "#to_markdown" do
+    it "add whitespace around block elements" do
+      assert_markdown "before<div>inner</div>after", "before\ninner\nafter", false
+    end
 
-      #     should "convert nested blockquote tag" do
-      #       assert_markdown(
-      #         "<blockquote><p>Hello</p>\n\n<blockquote><p>Nested</p></blockquote>\n\n<p>Goodbye</p></blockquote>",
-      # <<-EOM
-      # > Hello
-      # >
-      # > > Nested
-      # >
-      # > Goodbye
-      # EOM
-      #         )
-      #     end
-
-      should "convert unordered list" do
-        assert_markdown "<ul>\n<li>one</li>\n<li>two</li>\n<li>three</li>\n</ul>\n",
-        "\n* one\n* two\n* three\n"
-      end
+    it "convert h1 tag" do
+      assert_markdown "<h1>Foo</h1>", "\nFoo\n==========\n"
+    end
 
-      should "convert ordered list" do
-        assert_markdown "<ol>\n<li>one</li>\n<li>two</li>\n<li>three</li>\n</ol>\n",
-        "\n1. one\n2. two\n3. three\n"
-      end
+    it "convert h2 tag" do
+      assert_markdown "<h2>Foo</h2>", "\nFoo\n----------\n"
+    end
 
-      should "ignore empty unordered list items" do
-        assert_markdown "<ul>\n<li>one</li>\n<li></li>\n<li>three</li>\n</ul>\n",
-        "\n* one\n* three\n",
-        false
-      end
+    it "convert h3 tag" do
+      assert_markdown "<h3>Foo</h3>", "\n### Foo ###\n"
+    end
 
-      should "ignore empty ordered list items" do
-        assert_markdown "<ol>\n<li>one</li>\n<li></li>\n<li>three</li>\n</ol>\n",
-        "\n1. one\n3. three\n",
-        false
-      end
+    it "convert h4 tag" do
+      assert_markdown "<h4>Foo</h4>", "\n#### Foo ####\n"
+    end
 
-      should "convert code blocks" do
-        assert_markdown "<pre><code>This is a code block\ncontinued\n</code></pre>",
-        "\n    This is a code block\n    continued\n\n"
-      end
+    it "convert blockquote tag" do
+      assert_markdown "<blockquote><p>Hello\nGoodbye</p></blockquote>",
+      "> Hello\n> Goodbye\n"
+    end
+
+    #     it "convert nested blockquote tag" do
+    #       assert_markdown(
+    #         "<blockquote><p>Hello</p>\n\n<blockquote><p>Nested</p></blockquote>\n\n<p>Goodbye</p></blockquote>",
+    # <<-EOM
+    # > Hello
+    # >
+    # > > Nested
+    # >
+    # > Goodbye
+    # EOM
+    #         )
+    #     end
+
+    it "convert unordered list" do
+      assert_markdown "<ul>\n<li>one</li>\n<li>two</li>\n<li>three</li>\n</ul>\n",
+      "\n* one\n* two\n* three\n"
+    end
+
+    it "convert ordered list" do
+      assert_markdown "<ol>\n<li>one</li>\n<li>two</li>\n<li>three</li>\n</ol>\n",
+      "\n1. one\n2. two\n3. three\n"
+    end
+
+    it "ignore empty unordered list items" do
+      assert_markdown "<ul>\n<li>one</li>\n<li></li>\n<li>three</li>\n</ul>\n",
+      "\n* one\n* three\n",
+      false
+    end
 
-      should "convert <br> tags to newlines" do
-        assert_markdown "<div>hello<br>there</div>",
-        "\nhello\nthere\n",
-        false
-        assert_markdown "<div>hello<br />there</div>",
-        "\nhello\nthere\n",
-        false
+    it "ignore empty ordered list items" do
+      assert_markdown "<ol>\n<li>one</li>\n<li></li>\n<li>three</li>\n</ol>\n",
+      "\n1. one\n3. three\n",
+      false
+    end
+
+    it "convert code blocks" do
+      assert_markdown "<pre><code>This is a code block\ncontinued\n</code></pre>",
+      "\n    This is a code block\n    continued\n\n"
+    end
+
+    it "convert <br> tags to newlines" do
+      assert_markdown "<div>hello<br>there</div>",
+      "\nhello\nthere\n",
+      false
+      assert_markdown "<div>hello<br />there</div>",
+      "\nhello\nthere\n",
+      false
+    end
+
+    describe "anchors" do
+      it "convert <a> tags" do
+        assert_markdown "<p>Yes, magic helmet. And <a href=\"http://sample.com/\">I'll give you a sample</a>.</p>",
+        "\nYes, magic helmet. And [I'll give you a sample](http://sample.com/).\n"
       end
 
-      context "anchors" do
-        should "convert <a> tags" do
-          assert_markdown "<p>Yes, magic helmet. And <a href=\"http://sample.com/\">I'll give you a sample</a>.</p>",
-          "\nYes, magic helmet. And [I'll give you a sample](http://sample.com/).\n"
-        end
+      describe "<a> tags without hrefs" do
+        it "be ignored" do
+          assert_markdown "<div><a name='link-target'>target title</a></div>",
+          "\ntarget title\n",
+          false
 
-        context "<a> tags without hrefs" do
-          should "be ignored" do
-            assert_markdown "<div><a name='link-target'>target title</a></div>",
-            "\ntarget title\n",
-            false
+          assert_markdown "<div><a id='link-target'>target title</a></div>",
+          "\ntarget title\n",
+          false
+        end
+      end
 
-            assert_markdown "<div><a id='link-target'>target title</a></div>",
-            "\ntarget title\n",
-            false
-          end
+      describe "<a> tags with titles" do
+        it "convert fq urls to reference-style" do
+          assert_markdown2 "<p>Yes, magic helmet. And <a href=\"http://sample.com/\" title=\"Fudd\">I'll give you a sample</a>.</p>",
+          "\nYes, magic helmet. And [I'll give you a sample][1].\n\n[1]: http://sample.com/ \"Fudd\"\n"
         end
 
-        context "<a> tags with titles" do
-          should "convert fq urls to reference-style" do
-            assert_markdown2 "<p>Yes, magic helmet. And <a href=\"http://sample.com/\" title=\"Fudd\">I'll give you a sample</a>.</p>",
-            "\nYes, magic helmet. And [I'll give you a sample][1].\n\n[1]: http://sample.com/ \"Fudd\"\n"
-          end
-
-          should "convert relative urls to reference-style" do
-            assert_markdown2 "<p>Yes, magic helmet. And <a href=\"/home\" title=\"Fudd\">I'll give you a sample</a>.</p>",
-            "\nYes, magic helmet. And [I'll give you a sample][1].\n\n[1]: /home \"Fudd\"\n"
-          end
-
-          should "convert multiple to appear in order at the end of the document" do
-            assert_markdown2 "<p>See <a href=\"/prefs\" title=\"Prefs\">Prefs</a> and <a href=\"/home\" title=\"Home\">Home</a>.</p>",
-            "\nSee [Prefs][1] and [Home][2].\n\n[1]: /prefs \"Prefs\"\n[2]: /home \"Home\"\n"
-          end
+        it "convert relative urls to reference-style" do
+          assert_markdown2 "<p>Yes, magic helmet. And <a href=\"/home\" title=\"Fudd\">I'll give you a sample</a>.</p>",
+          "\nYes, magic helmet. And [I'll give you a sample][1].\n\n[1]: /home \"Fudd\"\n"
         end
-      end
-    end
-  end
 
-  context McBean::Markdownify::Antidote do
-    context "given that RDiscount is already pretty well tested" do
-      context "let's limit ourselves to a token test case" do
-        should "convert markdown into html" do
-          assert_equal "<h1>hello</h1>\n", McBean.markdown("hello\n=====\n").to_html
+        it "convert multiple to appear in order at the end of the document" do
+          assert_markdown2 "<p>See <a href=\"/prefs\" title=\"Prefs\">Prefs</a> and <a href=\"/home\" title=\"Home\">Home</a>.</p>",
+          "\nSee [Prefs][1] and [Home][2].\n\n[1]: /prefs \"Prefs\"\n[2]: /home \"Home\"\n"
         end
       end
     end
   end
 
-  private
-
   def assert_markdown html, markdown, roundtrip=true
     assert_equal(html, McBean::Markdownify::Antidote.new(markdown).to_html.chomp, "markdown roundtrip failed") if roundtrip
     assert_equal(markdown, McBean.fragment(html).to_markdown, "fragment transformation failed")
@@ -142,3 +159,25 @@ class TestMcBeanMarkdown < Test::Unit::TestCase
       McBean.document("<div>#{html}</div>").to_markdown, "document transformation failed")
   end
 end
+
+describe McBean::Markdownify::Antidote do
+  describe "given that RDiscount is already pretty well tested, let's limit ourselves to a token test case" do
+    it "convert markdown into html" do
+      McBean.markdown("hello\n=====\n").to_html.must_match %r{<body><h1>hello</h1></body>}
+    end
+  end
+
+  describe "given markdown with an unsafe tag" do
+    it "escapes the tag" do
+      markdown = "hello\n=====\n\n<script>alert('ohai!');</script>\n\nLOL\n"
+      McBean.markdown(markdown).to_html.must_include "<body>\n<h1>hello</h1>\n\n&lt;script&gt;alert('ohai!');&lt;/script&gt;<p>LOL</p>\n</body>"
+    end
+  end
+
+  describe "given markdown with an invalid tag" do
+    it "escapes the tag" do
+      markdown = "hello\n=====\n\n<xyzzy>Adventure!</xyzzy>\n\nLOL\n"
+      McBean.markdown(markdown).to_html.must_match %r{<body>\n<h1>hello</h1>\n\n<p>&lt;xyzzy&gt;Adventure!&lt;/xyzzy&gt;</p>\n\n<p>LOL</p>\n</body>}
+    end
+  end
+end

data/test/test_mcbean.rb

@@ -1,52 +1,66 @@
 require File.dirname(__FILE__) + "/helper"
 
-class TestMcBean < Test::Unit::TestCase
-  context "class name" do
-    should "set McBean and Mcbean to be the same thing" do
+describe McBean do
+  describe "class name" do
+    it "sets McBean and Mcbean to be the same thing" do
       assert McBean == Mcbean
     end
   end
 
-  context "cleanup" do
-    should "prune unsafe tags" do
-      result = McBean.fragment("<div>OK</div><script>BAD</script>").to_markdown
-      assert_match(    /OK/,  result)
-      assert_no_match( /BAD/, result)
+  describe ".new" do
+    it "cannot be called" do
+      proc { McBean.new }.must_raise NoMethodError
     end
   end
 
-  context "parsing" do
-    context "McBean.fragment" do
-      should "call Loofah.fragment" do
-        html = "<h1>hello</h1>\n"
-        mock.proxy(Loofah).fragment(html).once
-        McBean.fragment html
-      end
+  describe ".allocate" do
+    it "cannot be called" do
+      proc { McBean.allocate }.must_raise NoMethodError
+    end
+  end
+
+  describe ".fragment" do
+    it "sets #__html__ to be a Loofah fragment" do
+      McBean.fragment("<h1>hello</h1>\n").__html__.must_be_instance_of Loofah::HTML::DocumentFragment
+    end
+  end
+
+  describe ".document" do
+    it "sets #__html__ to be a Loofah document" do
+      McBean.document("<h1>hello</h1>\n").__html__.must_be_instance_of Loofah::HTML::Document
     end
+  end
+
+  describe "#to_html" do
+    attr_accessor :mcbean
+
+    it "escapes unsafe tags" do
+      result = McBean.fragment("<div>OK</div><script>BAD</script>").to_html
+      result.must_include "<div>OK</div>"
+      result.must_include "&lt;script&gt;BAD&lt;/script&gt;"
+    end
+
+    describe "on an instance created by .fragment" do
+      before do
+        @mcbean = McBean.fragment "<div>ohai!</div>"
+      end
 
-    context "McBean.document" do
-      should "call Loofah.document" do
-        html = "<h1>hello</h1>\n"
-        mock.proxy(Loofah).document(html).once
-        McBean.document html
+      it "returns an html string" do
+        html = mcbean.to_html
+        html.must_be_instance_of String
+        html.must_match %r{<div>ohai!</div>}
       end
     end
 
-    context "McBean.markdown" do
-      context "passed a string" do
-        should "create a Markdownify::Antidote" do
-          mock.proxy(McBean::Markdownify::Antidote).new(anything).once
-          assert_equal "<h1>hello</h1>\n", McBean.markdown("hello\n=====\n").to_html
-        end
+    describe "on an instance created by .fragment" do
+      before do
+        @mcbean = McBean.document "<div>ohai!</div>"
       end
 
-      context "passed an IO" do
-        should "create a Markdownify::Antidote" do
-          io = StringIO.new "hello\n=====\n"
-          mock.proxy(McBean::Markdownify::Antidote).new(anything).once
-          mock.proxy(io).read.once
-          assert_equal "<h1>hello</h1>\n", McBean.markdown(io).to_html
-        end
+      it "returns an html string" do
+        html = mcbean.to_html
+        html.must_be_instance_of String
+        html.must_match %r{<div>ohai!</div>}
       end
     end
   end

data/test/test_textile.rb

@@ -0,0 +1,151 @@
+# -*- coding: utf-8 -*-
+require File.dirname(__FILE__) + "/helper"
+
+describe McBean::Textilify do
+  describe ".textile" do
+    describe "passed a string" do
+      it "sets #__textile__ to be a Textilify::Antidote" do
+        McBean.textile("h1. hello").__textile__.must_be_instance_of McBean::Textilify::Antidote
+      end
+    end
+
+    describe "passed an IO" do
+      it "sets #__textile__ to be a Textilify::Antidote" do
+        io = StringIO.new "h1. hello"
+        McBean.textile(io).__textile__.must_be_instance_of McBean::Textilify::Antidote
+      end
+    end
+  end
+
+  describe "#to_html" do
+    attr_accessor :mcbean
+
+    describe "on an instance created by .textile" do
+      before do
+        @mcbean = McBean.textile "h1. ohai!"
+      end
+
+      it "returns an html string" do
+        html = mcbean.to_html
+        html.must_be_instance_of String
+        html.must_match %r{<h1>ohai!</h1>}
+      end
+    end
+  end
+
+  describe "#to_textile" do
+    it "adds whitespace around block elements" do
+      assert_textile "before<div>inner</div>after", "before\ninner\nafter", false
+    end
+
+    it "converts h1 tag" do
+      assert_textile "<h1>Foo</h1>", "\nh1. Foo\n"
+    end
+
+    it "converts h2 tag" do
+      assert_textile "<h2>Foo</h2>", "\nh2. Foo\n"
+    end
+
+    it "converts h3 tag" do
+      assert_textile "<h3>Foo</h3>", "\nh3. Foo\n"
+    end
+
+    it "converts h4 tag" do
+      assert_textile "<h4>Foo</h4>", "\nh4. Foo\n"
+    end
+
+    it "converts blockquote tag" do
+      assert_textile "<blockquote>\n<p>foo fazz<br />\nbizz buzz<br />\nwang wong</p>\n</blockquote>", "\nbq. foo fazz\nbizz buzz\nwang wong\n"
+    end
+
+    it "converts ul lists" do
+      html = "<ul>\n\t<li>foo</li>\n\t<li>wuxx</li>\n</ul>"
+      textile = "\n* foo\n* wuxx\n"
+      assert_textile html, textile
+    end
+
+    it "converts ol lists" do
+      html = "<ol>\n\t<li>foo</li>\n\t<li>wuxx</li>\n</ol>"
+      textile = "\n# foo\n# wuxx\n"
+      assert_textile html, textile
+    end
+
+    it "ignores empty unordered list items" do
+      assert_textile "<ul>\n<li>one</li>\n<li></li>\n<li>three</li>\n</ul>\n",
+        "\n* one\n* three\n",
+        false
+    end
+
+    it "ignores empty ordered list items" do
+      assert_textile "<ol>\n<li>one</li>\n<li></li>\n<li>three</li>\n</ol>\n",
+        "\n# one\n# three\n",
+        false
+    end
+
+    it "converts code blocks" do
+      assert_textile "<pre><code>This is a code block\ncontinued</code></pre>",
+        "\nbc. This is a code block\ncontinued\n"
+    end
+
+    it "converts <br> tags to newlines" do
+      assert_textile "<p>hello<br>there</p>", "\nhello\nthere\n", false
+      assert_textile "<p>hello<br />there</p>", "\nhello\nthere\n", false
+    end
+
+    describe "anchors" do
+      it "converts <a> tags" do
+        assert_textile "<p>Yes, magic helmet. And <a href=\"http://sample.com/\">I will give you a sample</a>.</p>",
+          %Q{\nYes, magic helmet. And ["I will give you a sample":http://sample.com/].\n}
+      end
+
+      describe "<a> tags without hrefs" do
+        it "ignores them" do
+          assert_textile "<div><a name='link-target'>target title</a></div>",
+            "\ntarget title\n",
+            false
+
+          assert_textile "<div><a id='link-target'>target title</a></div>",
+            "\ntarget title\n",
+            false
+        end
+      end
+
+      describe "<a> tags with titles" do
+        it "include the title" do
+          assert_textile %Q{<p>Yes, magic helmet. And <a href="http://sample.com/" title="Fudd">I will give you a sample</a>.</p>},
+            %Q{\nYes, magic helmet. And ["I will give you a sample (Fudd)":http://sample.com/].\n}, false
+        end
+      end
+    end
+  end
+
+  def assert_textile html, textile, roundtrip=true
+    assert_equal(html, McBean::Textilify::Antidote.new(textile).to_html, "textile roundtrip failed") if roundtrip
+    assert_equal(textile, McBean.fragment(html).to_textile, "fragment transformation failed")
+    assert_equal(Loofah::Helpers.remove_extraneous_whitespace("\n#{textile}\n"),
+      McBean.document("<div>#{html}</div>").to_textile, "document transformation failed")
+  end
+
+end
+
+describe McBean::Textilify::Antidote do
+  describe "given that RedCloth is already pretty well tested, let's limit ourselves to a token test case" do
+    it "convert textile into html" do
+      McBean.textile("h1. hello").to_html.must_match %r{<body><h1>hello</h1></body>}
+    end
+  end
+
+  describe "given textile with an unsafe tag" do
+    it "escapes the tag" do
+      textile = "h1. hello\n\n<script>alert('ohai!');</script>\n\nlol\n"
+      McBean.textile(textile).to_html.must_include "<body>\n<h1>hello</h1>\n&lt;script&gt;alert('ohai!');&lt;/script&gt;<p>lol</p>\n</body>"
+    end
+  end
+
+  describe "given textile with an invalid tag" do
+    it "escapes the tag" do
+      textile = "h1. hello\n\n<xyzzy>Adventure!</xyzzy>\n\nlol\n"
+      McBean.textile(textile).to_html.must_match %r{<body>\n<h1>hello</h1>\n&lt;xyzzy&gt;Adventure!&lt;/xyzzy&gt;<p>lol</p>\n</body>}
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mike Dalessio
@@ -35,7 +35,7 @@ cert_chain:
   FlqnTjy13J3nD30uxy9a1g==
   -----END CERTIFICATE-----
 
-date: 2010-03-24 00:00:00 -04:00
+date: 2010-04-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,84 +67,71 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: RedCloth
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 2
+        - 4
         - 0
-        - 3
-        version: 2.0.3
-  type: :development
+        - 0
+        version: 4.0.0
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: gemcutter
+  name: rubyforge
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
         - 0
         - 3
-        - 0
-        version: 0.3.0
+        version: 2.0.3
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: minitest
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 2
-        - 10
-        version: "2.10"
-  type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rr
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
+        - 1
+        - 6
         - 0
-        - 10
-        - 4
-        version: 0.10.4
+        version: 1.6.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 5
+        - 6
         - 0
-        version: 2.5.0
+        version: 2.6.0
   type: :development
-  version_requirements: *id007
+  version_requirements: *id006
 description: |-
-  McBean converts HTML into Markdown, and Markdown into HTML (with the
-  help of Loofah, Nokogiri and RDiscount).
+  McBean can convert documents from one format to another. McBean currently supports:
+  
+  * HTML
+  * Markdown (a subset)
+  * Textile (a subset)
   
-  Its goal is to eventually be able to transform documents from HTML to
-  Markdown to Textile, and anything in between. It will be the Sylvester
-  McMonkey McBean of markup, placing stars onto the bellies of all kinds
-  of Sneetchy document formats.
+  with the help of Loofah, Nokogiri, RDiscount and RedCloth.
   
-  "You can't teach a Sneetch."
+  "You can't teach a Sneetch." -- Sylvester McMonkey McBean
 email: 
 - mike.dalessio@gmail.com
 executables: 
@@ -152,23 +139,23 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
 - Manifest.txt
 - CHANGELOG.rdoc
 - README.rdoc
 files: 
 - .autotest
 - CHANGELOG.rdoc
-- History.txt
 - Manifest.txt
 - README.rdoc
 - Rakefile
 - bin/mcbean
 - lib/mcbean.rb
 - lib/mcbean/markdown.rb
+- lib/mcbean/textile.rb
 - test/helper.rb
 - test/test_markdown.rb
 - test/test_mcbean.rb
+- test/test_textile.rb
 has_rdoc: true
 homepage: http://github.com/flavorjones/mcbean
 licenses: []
@@ -199,7 +186,8 @@ rubyforge_project: mcbean
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: McBean converts HTML into Markdown, and Markdown into HTML (with the help of Loofah, Nokogiri and RDiscount)
+summary: McBean can convert documents from one format to another
 test_files: 
 - test/test_mcbean.rb
 - test/test_markdown.rb
+- test/test_textile.rb

data/History.txt

@@ -1,6 +0,0 @@
-=== 1.0.0 / 2010-03-08
-
-* 1 major enhancement
-
-  * Birthday!
-