mcbean 0.1.2 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 = Changelog
 
+== HEAD
+
+* <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.0 (2010-03-09)
 
 * Happy Birthday!

data/README.rdoc

@@ -3,53 +3,67 @@
 * http://github.com/flavorjones/mcbean
 * http://mcbean.heroku.com/
 
-== DESCRIPTION:
+== Description
 
-McBean transforms HTML into Markdown with the help of Loofah and Nokogiri.
+McBean converts HTML into Markdown, and Markdown into HTML (with the
+help of Loofah, Nokogiri and RDiscount).
 
-Its goal is to eventually be able to transform (with the help of other
-relevant gems) 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 document
-formats.
+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.
 
 "You can't teach a Sneetch."
 
-== FEATURES/PROBLEMS:
+== Features / Problems
 
-* Transforms HTML into Markdown.
+* Transforms HTML into Markdown, and Markdown into HTML.
 * Doesn't do anything else yet.
 
-== SYNOPSIS:
+== Synopsis
 
-If you have an HTML fragment:
+If you have an HTML fragment, you can convert it into Markdown:
 
-  McBean.fragment(your_html_string).to_markdown
+  McBean.fragment(your_html).to_markdown
 
-Or if you have an HTML document:
+Or if you have an HTML document, you can convert it into Markdown:
 
-  McBean.document(your_html_string).to_markdown
+  McBean.document(your_html).to_markdown
+
+You can also convert Markdown into HTML (via RDiscount):
+
+  McBean.markdown(your_markdown).to_html
+
+Note that the parameter passed to +fragment+, +document+ and
++markdown+ can be either a String or an IO.
 
 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
 
+You can try out McBean at the live demo site: http://mcbean.heroku.com
+
 === Side Note: Fragments vs Documents
 
 Generally speaking, if you expect to have a DOCTYPE and a single root
 \<html\> node, you have a *document*. If you don't expect to
 have a single root node, you have a *fragment*.
 
-== REQUIREMENTS:
+== Requirements
 
 * Loofah 0.4.7 (and thusly Nokogiri)
+* RDiscount 1.3.4
 
-== INSTALL:
+== Install
 
 * sudo gem install mcbean
 
-== LICENSE:
+== Shout Outs
+
+Thanks to David Loren Parsons and Ryan Tomayko for RDiscount.
+
+== License
 
 (The MIT License)
 

data/Rakefile

@@ -14,7 +14,9 @@ Hoe.spec 'mcbean' do
   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"]
 end
 
 task :redocs => :fix_css

data/lib/mcbean.rb

@@ -1,7 +1,7 @@
 require "loofah"
 
 class McBean
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
   REQUIRED_LOOFAH_VERSION = "0.4.7"
 
   attr_accessor :html
@@ -17,6 +17,14 @@ class McBean
     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)
+    end
+  end
 end
 Mcbean = McBean
 

data/lib/mcbean/markdown.rb

@@ -1,6 +1,9 @@
-class McBean
+require 'rdiscount'
 
+class McBean
   class Markdownify < Loofah::Scrubber
+    Antidote = ::RDiscount # could conceivably be BlueCloth
+
     def initialize
       @direction = :bottom_up
       @link_references = nil
@@ -43,8 +46,12 @@ class McBean
           else
             nil
           end
+        when "br"
+          new_text node, "\n"
         when "a"
-          if node['title']
+          if node['href'].nil?
+            new_text node, node.content
+          elsif node['title']
             unless @link_references
               @link_references = node.document.fragment("<div>\n</div>").children.first
               end_of_doc(node).add_next_sibling @link_references

data/test/helper.rb

@@ -1,6 +1,8 @@
 require "test/unit"
 require "mcbean"
 require "shoulda"
+require "rr"
 
-gem "bluecloth", ">= 2.0"
-require "bluecloth"
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end

data/test/test_markdown.rb

@@ -1,92 +1,125 @@
 require File.dirname(__FILE__) + "/helper"
 
 class TestMcBeanMarkdown < Test::Unit::TestCase
-  context "markdown" do
-    should "add whitespace around block elements" do
-      assert_markdown "before<div>inner</div>after", "before\ninner\nafter", false
-    end
+  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
+      end
 
-    should "convert h1 tag" do
-      assert_markdown "<h1>Foo</h1>", "\nFoo\n==========\n"
-    end
+      should "convert h1 tag" do
+        assert_markdown "<h1>Foo</h1>", "\nFoo\n==========\n"
+      end
 
-    should "convert h2 tag" do
-      assert_markdown "<h2>Foo</h2>", "\nFoo\n----------\n"
-    end
+      should "convert h2 tag" do
+        assert_markdown "<h2>Foo</h2>", "\nFoo\n----------\n"
+      end
 
-    should "convert h3 tag" do
-      assert_markdown "<h3>Foo</h3>", "\n### Foo ###\n"
-    end
+      should "convert h3 tag" do
+        assert_markdown "<h3>Foo</h3>", "\n### Foo ###\n"
+      end
 
-    should "convert h4 tag" do
-      assert_markdown "<h4>Foo</h4>", "\n#### Foo ####\n"
-    end
+      should "convert h4 tag" do
+        assert_markdown "<h4>Foo</h4>", "\n#### Foo ####\n"
+      end
 
-    should "convert blockquote tag" do
-      assert_markdown "<blockquote><p>Hello\nGoodbye</p></blockquote>",
-                      "> Hello\n> Goodbye\n"
-    end
+      should "convert blockquote tag" do
+        assert_markdown "<blockquote><p>Hello\nGoodbye</p></blockquote>",
+        "> Hello\n> Goodbye\n"
+      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
+      #     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
 
-    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
+      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
 
-    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
+      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
 
-    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
+      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
 
-    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
+      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
 
-    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"
+      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
       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"
+      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
+
+        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
 
-        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"
+        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
         end
+      end
+    end
+  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"
+  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
         end
       end
     end
@@ -95,7 +128,7 @@ class TestMcBeanMarkdown < Test::Unit::TestCase
   private
 
   def assert_markdown html, markdown, roundtrip=true
-    assert_equal(html, BlueCloth.new(markdown).to_html, "markdown roundtrip failed") if roundtrip
+    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")
     assert_equal(Loofah::Helpers.remove_extraneous_whitespace("\n#{markdown}\n"),
       McBean.document("<div>#{html}</div>").to_markdown, "document transformation failed")
@@ -103,7 +136,7 @@ class TestMcBeanMarkdown < Test::Unit::TestCase
 
   def assert_markdown2 html, markdown, roundtrip=true
     # note peskily absent newline at end of document. sigh.
-    assert_equal(html, BlueCloth.new(markdown).to_html, "markdown roundtrip failed") if roundtrip
+    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")
     assert_equal(Loofah::Helpers.remove_extraneous_whitespace("\n#{markdown}"),
       McBean.document("<div>#{html}</div>").to_markdown, "document transformation failed")

data/test/test_mcbean.rb

@@ -10,8 +10,44 @@ class TestMcBean < Test::Unit::TestCase
   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
+      assert_match(    /OK/,  result)
+      assert_no_match( /BAD/, result)
+    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
+    end
+
+    context "McBean.document" do
+      should "call Loofah.document" do
+        html = "<h1>hello</h1>\n"
+        mock.proxy(Loofah).document(html).once
+        McBean.document html
+      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
+      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
+      end
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Mike Dalessio
@@ -35,7 +35,7 @@ cert_chain:
   FlqnTjy13J3nD30uxy9a1g==
   -----END CERTIFICATE-----
 
-date: 2010-03-10 00:00:00 -05:00
+date: 2010-03-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,9 +53,23 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: rdiscount
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 4
+        version: 1.3.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -65,11 +79,11 @@ dependencies:
         - 3
         version: 2.0.3
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: gemcutter
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -79,11 +93,11 @@ dependencies:
         - 0
         version: 0.3.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -92,11 +106,25 @@ dependencies:
         - 10
         version: "2.10"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 4
+        version: 0.10.4
+  type: :development
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -106,15 +134,15 @@ dependencies:
         - 0
         version: 2.5.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id007
 description: |-
-  McBean transforms HTML into Markdown with the help of Loofah and Nokogiri.
+  McBean converts HTML into Markdown, and Markdown into HTML (with the
+  help of Loofah, Nokogiri and RDiscount).
   
-  Its goal is to eventually be able to transform (with the help of other
-  relevant gems) 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 document
-  formats.
+  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.
   
   "You can't teach a Sneetch."
 email: 
@@ -171,7 +199,7 @@ rubyforge_project: mcbean
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: McBean transforms HTML into Markdown with the help of Loofah and Nokogiri
+summary: McBean converts HTML into Markdown, and Markdown into HTML (with the help of Loofah, Nokogiri and RDiscount)
 test_files: 
 - test/test_mcbean.rb
 - test/test_markdown.rb

metadata.gz.sig

@@ -1,2 +1,3 @@
-�}�[���3\��,��b�Cy����$�W�P�M�I�:���b�S�Ż����b�rR̗��p���p����^X�|X�������.m~�1w�Ypf[��\�l�Y%�w�9���T�P�
-S
+�Ԕ�
+�m�Z�QH��t��Jkq��$�ڇ
+�B��U�Ӡ�CR�"�x�Q�t�yP� �n~5y9�p`Fg�*��>��/�9�s7d)�������8�|��^Ť�A	�^���	��K��nZ�C���5f��E%	�ӄ?}Wa��%���t׉�3X����U