mislav-remark 0.2.0 → 0.2.1

data/Rakefile

@@ -8,7 +8,7 @@ task :gemspec do
     gem.authors = ["Mislav Marohnić"]
     gem.has_rdoc = false
     
-    gem.version = '0.2.0'
+    gem.version = '0.2.1'
     gem.files = FileList['Rakefile', '{bin,lib,rails,spec}/**/*', 'README*', 'LICENSE*'] & `git ls-files`.split("\n")
     gem.executables = Dir['bin/*'].map { |f| File.basename(f) }
   end

data/lib/remark.rb

@@ -6,7 +6,7 @@ class Remark
   end
   
   def to_markdown
-    remark_children(scope).join("\n\n")
+    remark_block(scope)
   end
   
   def scope
@@ -23,6 +23,7 @@ class Remark
   end
   
   IGNORE = %w(script head style)
+  BLOCK = %w(p blockquote h1 h2 h3 h4 h5 h6 pre)
   
   private
   
@@ -37,6 +38,12 @@ class Remark
     end
   end
   
+  def remark_block(elem)
+    remark_children(elem).
+      reject { |item| item.blank? }.
+      join("\n\n")
+  end
+  
   def remark_children(node)
     remarked = []
     node.children.each do |item|
@@ -48,7 +55,7 @@ class Remark
   
   def remark_item(item)
     if item.text?
-      item.to_s.gsub(/\n+/, ' ') unless item.to_s =~ /\A\s*\Z/
+      item.to_s.gsub(/\n+/, ' ') unless item.blank?
     elsif item.elem?
       if IGNORE.include?(item.name)
         nil
@@ -69,23 +76,25 @@ class Remark
     when 'ul', 'ol'
       remark_list(elem)
     when 'li'
-      remark_inline(elem)
+      elem.children.any? { |e| e.elem? and BLOCK.include?(e.name) } ?
+        remark_block(elem).indent : remark_inline(elem)
     when 'pre'
-      elem.inner_text.gsub(/^/, ' '*4)
+      elem.inner_text.indent
     when 'em'
       "_#{elem.inner_text}_"
     when 'strong'
       "**#{elem.inner_text}**"
     when 'code'
-      "`#{elem.inner_text}`"
+      code = elem.inner_text
+      code.index('`') ? "`` #{code} ``" : "`#{code}`"
     when 'a'
       remark_link(elem.inner_html, elem.attributes['href'], elem.attributes['title'])
     when 'img'
       '!' + remark_link(elem.attributes['alt'], elem.attributes['src'], elem.attributes['title'])
     when 'blockquote'
-      remark_children(elem).join("\n\n").gsub(/^/, '> ')
+      remark_children(elem).join("\n\n").indent('> ')
     when 'br'
-      ' ' + elem.inner_html
+      "  \n" + elem.inner_html
     else
       elem
     end
@@ -97,18 +106,51 @@ class Remark
   end
   
   def remark_inline(elem)
-    remark_children(elem).join('').gsub(/\s{2,}/, ' ')
+    remark_children(elem).join('').strip.gsub(/ {2,}(?!\n)/, ' ').gsub(/(\n) +/, '\1')
   end
   
   def remark_list(list)
     unordered = list.name == 'ul'
     marker = unordered ? '*' : 0
-    remark_children(list).map do |item|
-      if unordered
-        marker + ' ' + item
+    nested = false
+    
+    items = remark_children(list).map do |item|
+      current = unordered ? marker : "#{marker += 1}."
+      if item =~ /\A\s/
+        nested = true
+        item[0, current.length] = current
+        item
       else
-        (marker += 1).to_s + '. ' + item
+        current + ' ' + item
       end
-    end.join("\n")
+    end
+    
+    items.join("\n" * (nested ? 2 : 1))
+  end
+end
+
+Object.class_eval do
+  def blank?() false end
+end
+
+NilClass.class_eval do
+  def blank?() true end
+end
+
+String.class_eval do
+  def blank?
+    self.empty? or !!(self =~ /\A\s+\Z/)
+  end
+  
+  def squish
+    self.strip.gsub!(/\s+/, ' ')
   end
+  
+  def indent(with = ' ' * 4)
+    self.gsub(/^/, with)
+  end
+end
+
+Hpricot::Text.class_eval do
+  def blank?() to_s.blank? end
 end

data/spec/remark_spec.rb

@@ -48,6 +48,25 @@ describe Remark do
     HTML
   end
   
+  it "should strip excess whitespace" do
+    remark(<<-HTML).should == "Foo bar"
+      <p>
+        Foo
+        bar
+      </p>
+    HTML
+  end
+  
+  it "should strip whitespace in text nodes between main content" do
+    pending
+    remark(<<-HTML).should == "Foo\n\nbar\n\nBaz"
+      <p>Foo</p>
+        
+           bar
+      <p>Baz</p>
+    HTML
+  end
+  
   it "should support lists" do
     remark(<<-HTML).should == "* foo\n* bar"
       <ul>
@@ -64,6 +83,15 @@ describe Remark do
     HTML
   end
   
+  it "should support lists with nested content" do
+    remark(<<-HTML).should == "*   foo\n    \n    bar\n\n*   baz"
+      <ul>
+        <li><p>foo</p><p>bar</p></li>
+        <li><p>baz</p></li>
+      </ul>
+    HTML
+  end
+  
   it "should support preformatted blocks" do
     remark("<pre>def foo\n  bar\nend</pre>").should == "    def foo\n      bar\n    end"
     remark("<pre><code>def foo\n  &lt;bar&gt;\nend</code></pre>").should == "    def foo\n      <bar>\n    end"
@@ -72,11 +100,16 @@ describe Remark do
   it "should remark inline elements" do
     remark("<p>I'm so <strong>strong</strong></p>").should == "I'm so **strong**"
     remark("<p>I'm so <em>emo</em></p>").should == "I'm so _emo_"
-    remark("<p>Write more <code>code</code></p>").should == "Write more `code`"
     remark("<ul><li><em>Inline</em> stuff in <strong>lists</strong></li></ul>").should == "* _Inline_ stuff in **lists**"
     remark("<h1>Headings <em>too</em></h1>").should == '# Headings _too_'
   end
   
+  it "should remark inline code" do
+    remark("<p>Write more <code>code</code></p>").should == "Write more `code`"
+    remark("<p>Even with <code>`backticks`</code></p>").should == "Even with `` `backticks` ``"
+    remark("<p>Or HTML <code>&lt;tags&gt;</code></p>").should == "Or HTML `<tags>`"
+  end
+  
   it "should support hyperlinks" do
     remark("<p>Click <a href='http://mislav.uniqpath.com'>here</a></p>").should ==
       "Click [here](http://mislav.uniqpath.com)"
@@ -94,8 +127,9 @@ describe Remark do
   end
   
   it "should not have BR ruin all the fun" do
-    remark("<p>Foo<br>bar</p>").should == 'Foo bar'
-    remark("<p>Foo<br>\nbar <code>baz</code></p>").should == 'Foo bar `baz`'
+    remark("<p>Foo<br>bar</p>").should == "Foo  \nbar"
+    remark("<p>Foo<br>\nbar <code>baz</code></p>").should == "Foo  \nbar `baz`"
+    remark("<p>Foo</p><br><p>Bar</p>").should == "Foo\n\nBar"
   end
   
   it "should scope to the most likely element that holds content" do

data/spec/sample.html

@@ -26,6 +26,19 @@ Markdown doesn't have a syntax for them.</p>
   <li>ordered or unordered.</li>
 </ul>
 
+<ol>
+  <li><p>Paragraphs in list items</p></li>
+  <li><p>Make them have one blank line between them in Markdown</p></li>
+  <li>
+    <p>Some list items even have multiple paragraphs</p>
+    <p>That shouldn't be too hard to do … right?</p>
+    <pre>code blocks too</pre>
+  </li>
+</ol>
+
+<p>Remark supports BR elements in paragraphs,<br>
+although people tend to abuse them.</p>
+
 <pre><code>And who would forget
 Preformatted code blocks :)</code></pre>
 
@@ -33,16 +46,8 @@ Preformatted code blocks :)</code></pre>
 
 <blockquote>
   <p>I think</p>
-  
   <p>therefore I am</p>
+  <blockquote>
+    <p>Nested blockquotes</p>
+  </blockquote>
 </blockquote>
-
-<h2>TODO</h2>
-
-<p>Remark should probably support BR elements in paragraphs,<br>
-although people tend to abuse them.</p>
-
-<div class="content">
-  <p>What to do with pieces of content inside wrapper elements,
-  like DIV, is still undecided.</p>
-</div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mislav-remark
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Mislav Marohni\xC4\x87"