devcenter-parser 1.2.1 → 1.3.1

data/lib/devcenter-parser.rb

@@ -6,7 +6,7 @@ require 'sanitize'
 
 module DevcenterParser
 
-  VERSION = '1.2.1'
+  VERSION = '1.3.1'
 
   AVAILABLE_FLAVOURS = [:github, :maruku]
 
@@ -90,20 +90,22 @@ module DevcenterParser
 
   def self.maruku_underscores_to_dashes_in_subheader_anchors(doc)
     doc.css("h2,h3,h4,h5,h6").each do |node|
-      if node.attributes['id'] && node.attributes['id'].value
-        node.attributes['id'].value = node.attributes['id'].value.gsub(/_+/,'-')
-      end
+      node['id'] = subheader_id(node.content)
     end
     doc
   end
 
   def self.github_underscores_to_dashes_in_subheader_anchors(doc)
     doc.css("h2,h3,h4,h5,h6").each do |node|
-      node['id'] = node.content.to_s.downcase.gsub(/\W/, '-')
+      node['id'] = subheader_id(node.content)
     end
     doc
   end
 
+  def self.subheader_id(content)
+    content.to_s.downcase.gsub(/\W+/, '-').gsub(/\A-+|-+\Z/, '')
+  end
+
   def self.github_parse_special_blocks(doc)
     doc.css('blockquote>p:first').each do |node|
       if match = node.inner_html.match(/\A\W*(callout|warning|note)\W/)
@@ -116,7 +118,7 @@ module DevcenterParser
 
   def self.convert_to_article_links_all_relative_links_with_missing_initial_slashes(doc)
     doc.css('a').each do |node|
-      unless node['href'] =~ /\Ahttp|\A\/|\Amailto\:|\A#/
+      unless node['href'].nil? || node['href'] =~ /\Ahttp|\A\/|\Amailto\:|\A#/
         node['href'] = "/articles/#{node['href']}"
       end
     end

data/test/devcenter-parser_test.rb

@@ -24,33 +24,40 @@ describe 'DevcenterParser' do
     it 'respects existing ids' do
       md = '<strong id="foo">clean</strong>'
       assert_maruku_result md, '<strong id="foo">clean</strong>'
+      assert_github_result md, '<p><strong id="foo">clean</strong></p>'
     end
 
     it 'removes script tags and their content' do
       md = '<strong>clean<script>alert("hack!")</script></strong>'
       assert_maruku_result md, '<strong>clean</strong>'
+      assert_github_result md, '<p><strong>clean</strong></p>'
     end
 
-    it 'github markdown includes ids in subheaders' do
+    it 'includes ids in subheaders' do
       md = <<-MARKDOWN
 ## Foo Bar Header 123
 
 Foo bar content
     MARKDOWN
       assert DevcenterParser.to_html(md, :github).include?('<h2 id="foo-bar-header-123">Foo Bar Header 123</h2>')
+      assert DevcenterParser.to_html(md, :maruku).include?('<h2 id="foo-bar-header-123">Foo Bar Header 123</h2>')
     end
 
-    it 'maruku markdown includes ids in subheaders' do
-      md = <<-MARKDOWN
-## Foo Bar Header 123
+    it 'generates ids replacing inner non-alphanum chars with dashes' do
+      ['Foo Bar', 'Foo-Bar', 'Foo#bar', 'Foo##Bar', 'Foo##Bar', '-$Foo##Bar$-'].each do |title|
+        md = <<-MARKDOWN
+## #{title}
 
 Foo bar content
-      MARKDOWN
-      assert DevcenterParser.to_html(md, :maruku).include?('<h2 id="foo-bar-header-123">Foo Bar Header 123</h2>')
+MARKDOWN
+      assert DevcenterParser.to_html(md, :github).include?("<h2 id=\"foo-bar\">#{title}</h2>"), "GitHub with title #{title}: " + DevcenterParser.to_html(md, :github)
+      assert DevcenterParser.to_html(md, :maruku).include?("<h2 id=\"foo-bar\">#{title}</h2>"), "Maruku: " + DevcenterParser.to_html(md, :maruku)
+      end
     end
 
-    it 'github markdown supports regular block quotes without callout|warning|note' do
-      md = <<-MARKDOWN
+    describe 'github markdown' do
+      it 'github markdown supports regular block quotes without callout|warning|note' do
+        md = <<-MARKDOWN
 Testing
 
 > not a callout
@@ -58,9 +65,9 @@ Testing
 > normal
 
 And that's it.
-      MARKDOWN
+        MARKDOWN
 
-      html = <<-HTML
+        html = <<-HTML
 <p>Testing</p>
 
 <blockquote>
@@ -70,11 +77,11 @@ normal</p>
 </blockquote>
 
 <p>And that's it.</p>
-      HTML
+        HTML
 
-      assert_github_result(md, html)
+        assert_github_result(md, html)
 
-      md = <<-MARKDOWN
+        md = <<-MARKDOWN
 Testing
 
 > calloutnonono
@@ -82,9 +89,9 @@ Testing
 > normal
 
 And that's it.
-      MARKDOWN
+        MARKDOWN
 
-      html = <<-HTML
+        html = <<-HTML
 <p>Testing</p>
 
 <blockquote>
@@ -94,14 +101,14 @@ normal</p>
 </blockquote>
 
 <p>And that's it.</p>
-      HTML
+        HTML
 
-      assert_github_result(md, html)
-    end
+        assert_github_result(md, html)
+      end
 
-    it 'github markdown supports "> callout" and ">callout" and parses inner markdown' do
-      mds = []
-      mds << <<-MARKDOWN
+      it 'github markdown supports "> callout" and ">callout" and parses inner markdown' do
+        mds = []
+        mds << <<-MARKDOWN
 Testing
 
 > callout
@@ -109,9 +116,9 @@ Testing
 > normal
 
 And that's it.
-      MARKDOWN
+        MARKDOWN
 
-      mds << <<-MARKDOWN
+        mds << <<-MARKDOWN
 Testing
 
 >callout
@@ -119,9 +126,9 @@ Testing
 >normal
 
 And that's it.
-      MARKDOWN
+        MARKDOWN
 
-      html = <<-HTML
+        html = <<-HTML
 <p>Testing</p>
 
 <div class="callout">
@@ -130,16 +137,16 @@ normal</p>
 </div>
 
 <p>And that's it.</p>
-      HTML
+        HTML
 
-      mds.each do |md|
-        assert_github_result(md, html)
+        mds.each do |md|
+          assert_github_result(md, html)
+        end
       end
-    end
 
-    it 'github markdown supports "> callout" and ">callout", parses inner markdown and allows paragraphs' do
-      mds = []
-      mds << <<-MARKDOWN
+      it 'github markdown supports "> callout" and ">callout", parses inner markdown and allows paragraphs' do
+        mds = []
+        mds << <<-MARKDOWN
 Testing
 
 > callout
@@ -148,9 +155,9 @@ Testing
 > normal
 
 And that's it.
-      MARKDOWN
+        MARKDOWN
 
-      mds << <<-MARKDOWN
+        mds << <<-MARKDOWN
 Testing
 
 >callout
@@ -159,9 +166,9 @@ Testing
 >normal
 
 And that's it.
-      MARKDOWN
+        MARKDOWN
 
-      html = <<-HTML
+        html = <<-HTML
 <p>Testing</p>
 
 <div class="callout">
@@ -171,10 +178,11 @@ And that's it.
 </div>
 
 <p>And that's it.</p>
-      HTML
+        HTML
 
-      mds.each do |md|
-        assert_github_result(md, html)
+        mds.each do |md|
+          assert_github_result(md, html)
+        end
       end
     end
 
@@ -202,6 +210,12 @@ And that's it.
       end
     end
 
+    it 'does not add href attribute to links where it does not exist' do
+      md = '<a name="heh"></a>'
+      assert_maruku_result md, md
+      assert_github_result md, "<p>#{md}</p>"
+    end
+
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devcenter-parser
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-03 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: maruku