markitdown 0.1.2 → 0.2.0

data/README.md

@@ -11,6 +11,10 @@ Markitdown is a Ruby library that converts HTML to Markdown. It's powered by Nok
  * Code (inline and blocks)
  * Definition lists
  * Tables
+ * Underlines
+ * Strikethroughs (strike tag)
+ * Highlights (mark tag)
+ * Superscripts (sup tag)
 
 As well as other tags.
 

data/lib/markitdown.rb

@@ -72,17 +72,29 @@ module Markitdown
     when "br"
       results << self.newline(pre, nil,  2)
     when "em"
-      results << " _"
-      after = "END_TAG(_) "
+      results << " *"
+      after = "END_TAG(*) "
     when "i"
-      results << " _"
-      after = "END_TAG(_) "
+      results << " *"
+      after = "END_TAG(*) "
     when "strong"
-      results << " **"
-      after = "END_TAG(**) "
+      results << " __"
+      after = "END_TAG(__) "
     when "b"
-      results << " **"
-      after = "END_TAG(**) "
+      results << " __"
+      after = "END_TAG(__) "
+    when "u"
+      results << " _"
+      after = "END_TAG(_) "
+    when "strike"
+      results << " ~~"
+      after = "END_TAG(~~) "
+    when "mark"
+      results << " =="
+      after = "END_TAG(==) "
+    when "sup"
+      results << "^("
+      after = "END_TAG(\)) "
     when "blockquote"
       results << "\n\n"
       results << pre

data/lib/markitdown/version.rb

@@ -1,3 +1,3 @@
 module Markitdown
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/asmartbear.markdown

@@ -2,7 +2,7 @@
 
  > 
  > 
- >  Try to avoid using vague words like "one" or "it" to describe an issue. For example: _"When I opened the document, the content was askew. When I tried to print the document, the printer jammed up. **It** cannot blow up like that!"_  In the last sentence of this example, are you complaining about the document or the printer? It's not really clear. So I would repeat myself even at the risk of sounding redundant. It's better to be redundant and clear than to leave the other person wondering. 
+ >  Try to avoid using vague words like "one" or "it" to describe an issue. For example: *"When I opened the document, the content was askew. When I tried to print the document, the printer jammed up. __It__ cannot blow up like that!"*  In the last sentence of this example, are you complaining about the document or the printer? It's not really clear. So I would repeat myself even at the risk of sounding redundant. It's better to be redundant and clear than to leave the other person wondering. 
  > 
  >  
  > 

data/spec/doc.markdown

@@ -2,7 +2,7 @@
 
 # Main Header
 
-This _is_ a **test**. It includes a [link](http://www.google.com) as well as an image ![Google Logo](https://www.google.com/images/srpr/logo3w.png) 
+This *is* a __test__. It includes a [link](http://www.google.com) as well as an image ![Google Logo](https://www.google.com/images/srpr/logo3w.png) 
 
  * bullet 1
  * bullet 2
@@ -38,5 +38,5 @@ simple
  : This is a simple term and a simple definition
 complicated term
  : This is a complicated term with a multi-line definition
- : The **second definition** has a some **bold** terms
+ : The __second definition__ has a some __bold__ terms
 

data/spec/table.markdown

@@ -12,8 +12,8 @@ This [announcement](http://www.google.com) would be followed by instructions.
 |---|---|---|---|
 |This|is|a|
 |This|is|a|[announcement](http://www.google.com)|
-|This|is|a|_table_|
-|This|is|a|**table**|
+|This|is|a|*table*|
+|This|is|a|__table__|
 |This|is|a|table|
 |This|is|a|table|
 

data/spec/table2.markdown

@@ -12,8 +12,8 @@ This [announcement](http://www.google.com) would be followed by instructions.
 |---|---|---|---|
 |This|is|a|
 |This|is|a|[announcement](http://www.google.com)|
-|This|is|a|_table_|
-|This|is|a|**table**|
+|This|is|a|*table*|
+|This|is|a|__table__|
 |This|is|a|table|
 |This|is|a|table|
 

data/spec/tag_spec.rb

@@ -77,7 +77,7 @@ describe Markitdown do
     let(:html) { "<em>emphasis added</em>" }
 
     it "should return valid markdown" do
-      Markitdown.from_html(html).should == " _emphasis added_ "
+      Markitdown.from_html(html).should == " *emphasis added* "
     end
   end
 
@@ -85,7 +85,7 @@ describe Markitdown do
     let(:html) { "<i>italics added</i>" }
 
     it "should return valid markdown" do
-      Markitdown.from_html(html).should == " _italics added_ "
+      Markitdown.from_html(html).should == " *italics added* "
     end
   end
 
@@ -93,7 +93,7 @@ describe Markitdown do
     let(:html) { "<strong>strong added</strong>" }
 
     it "should return valid markdown" do
-      Markitdown.from_html(html).should == " **strong added** "
+      Markitdown.from_html(html).should == " __strong added__ "
     end
   end
 
@@ -101,7 +101,7 @@ describe Markitdown do
     let(:html) { "<b>bold added</b>" }
 
     it "should return valid markdown" do
-      Markitdown.from_html(html).should == " **bold added** "
+      Markitdown.from_html(html).should == " __bold added__ "
     end
   end
 
@@ -109,7 +109,7 @@ describe Markitdown do
     let(:html) { "<html><b>bold added</b>.</html>" }
 
     it "should return valid markdown without a space" do
-      Markitdown.from_html(html).should == " **bold added**."
+      Markitdown.from_html(html).should == " __bold added__."
     end
   end
 
@@ -117,7 +117,48 @@ describe Markitdown do
     let(:html) { "<html><em>emphasis added</em>?</html>" }
 
     it "should return valid markdown without a space" do
-      Markitdown.from_html(html).should == " _emphasis added_?"
+      Markitdown.from_html(html).should == " *emphasis added*?"
+    end
+  end
+
+  context "When parsing an underlined element that's followed by a punctuation" do
+    let(:html) { "<html><u>underline added</u>.</html>" }
+
+    it "should return valid markdown without a space" do
+      Markitdown.from_html(html).should == " _underline added_."
+    end
+  end
+
+  context "When parsing an strikethrough element that's followed by a punctuation" do
+    let(:html) { "<html><strike>strikethrough added</strike>.</html>" }
+
+    it "should return valid markdown without a space" do
+      Markitdown.from_html(html).should == " ~~strikethrough added~~."
+    end
+  end
+
+  context "When parsing an highlight element that's followed by a punctuation" do
+    let(:html) { "<html><mark>highlight added</mark>.</html>" }
+
+    it "should return valid markdown without a space" do
+      Markitdown.from_html(html).should == " ==highlight added==."
+    end
+  end
+
+  context "When parsing a superscript element with no spaces" do
+    let(:html) { "<html>2<sup>nd</sup>.</html>" }
+
+    it "should return valid markdown without spaces" do
+      Markitdown.from_html(html).should == "2^(nd)."
+    end
+  end
+
+  context "When parsing a superscript element with spaces" do
+    let(:html) { "<html>This <sup>is a</sup> test</html>" }
+
+    it "should return valid markdown with spaces" do
+      pending "Still need to figure out leading spaces for <sup> elements"
+      Markitdown.from_html(html).should == "This ^(is a) test"
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markitdown
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-27 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3593533597031584594
+      hash: 4208653128680196527
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3593533597031584594
+      hash: 4208653128680196527
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23