devcenter-parser 1.4.9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: 9b2a9d71cb242667543a950f575062058af76f65
-  data.tar.gz: 74f7642f8925d9f74c5780fd140dc7ba07f7801a
+SHA1:
+  metadata.gz: 8201b0a7264aaf1d4c4aab88c4c77051b40adde1
+  data.tar.gz: e4b963e76da3ff3d57f915a69a620ad7d368a7e9
 SHA512:
-  metadata.gz: cbf842e52bfda01071bd7ca615d70cb203f3fb42a23f2ec7aeac71ff4404304177c9ab38445abfeb2cf65fb9545dff543ea91aef6ec41b58ac292d018dc50408
-  data.tar.gz: 64334aa1b572e2c334a6e3bee6c1074d6bc556590deae8b35d180864eab7ea34ed8e5aecd65baf1a4a4fa2bb872b65a1ea6d69a11c73a4e631fc260247480805
+  metadata.gz: 9223802189213472cc1a6129f447c43dc2303c66034fac510f2ed525237216f99e447726f7e708a1bd612fe02f3374195e270676e63621295026441a5fa35b30
+  data.tar.gz: 2b9ec108ef95d7ade76690b487512e84ff4725077c188dfe7a40261e07e8ed54b3a9848e85a52ad1b3dae5fa7cae8676e7e7a985ed53b726ee38dce3dbfe097b

data/README.md

@@ -8,16 +8,8 @@ Usage:
     require 'devcenter-parser'
 
     md = '[Dev Center](https://devcenter.heroku.com)'
-    flavour = :github # :github or :maruku
     DevcenterParser.to_html(md, flavour)
     # => "<p><a href=\"https://devcenter.heroku.com\">Dev Center</a></p>"
-
-    broken_md = '[foo](bar'
-    begin
-      DevcenterParser.to_html(broken_md, :maruku)
-    rescue DevcenterParser::InvalidMarkdownError => e
-      puts e.message # parser-dependent (sometimes cryptic) debugging info
-    end
 ```
 
 Test:

data/devcenter-parser.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = %w{ lib }
 
-  gem.add_runtime_dependency 'maruku', '0.7.0'
   gem.add_runtime_dependency 'nokogiri', '>= 1.4.4'
   gem.add_runtime_dependency 'redcarpet', '3.0.0'
   gem.add_runtime_dependency 'sanitize', '2.0.6'

data/lib/devcenter-parser.rb

@@ -1,4 +1,3 @@
-require 'maruku'
 require 'redcarpet'
 require 'nokogiri'
 require 'uri'
@@ -6,30 +5,21 @@ require 'sanitize'
 require 'ostruct'
 require_relative './devcenter-parser/header_id_generator'
 require_relative './devcenter-parser/github_parser'
-require_relative './devcenter-parser/maruku_parser'
 
 module DevcenterParser
-  AVAILABLE_FLAVOURS = [:github, :maruku]
-
   class InvalidMarkdownError < Exception; end
   class InvalidRawHTMLError < Exception; end
-  class UnknownFlavourError < Exception; end
 
-  def self.to_html(markdown, flavour)
-    html = to_unsanitized_html(markdown, flavour.to_sym)
-    sanitize(html)
+  def self.to_html(markdown)
+    sanitize to_unsanitized_html(markdown)
   end
 
-  def self.to_unsanitized_html(markdown, flavour)
-    raise(UnknownFlavourError, "Markdown flavour '#{flavour}' not supported") unless %w{ maruku github }.include?(flavour.to_s)
+  def self.to_unsanitized_html(markdown)
     markdown = normalize_markdown(markdown)
-    markdown_parser = flavour.to_s == 'maruku' ? MarukuParser : GitHubParser
-    doc = markdown_parser.parse(markdown)
+    doc = GitHubParser.parse(markdown)
     doc_to_html(doc)
   rescue InvalidRawHTMLError => e
     raise InvalidMarkdownError, e.message
-  rescue => e
-    raise InvalidMarkdownError, parse_maruku_error(e.message)
   end
 
   def self.sanitize(html)
@@ -95,7 +85,6 @@ module DevcenterParser
 
     # custom
     config[:elements] += %w{ toolbelt }
-    config[:attributes][:all] += %w{ data-next-message }
 
     @@sanitize_config = config.merge({remove_contents: true, allow_comments: true})
   end
@@ -116,14 +105,6 @@ module DevcenterParser
     html.to_s.include?('markdown-html-error')
   end
 
-  def self.parse_maruku_error(error_message)
-    lines = error_message.to_s.split("\n")
-    return lines unless lines.size > 1
-    msg = lines[4].gsub(/\A\|(\s)+|EOF\Z/,'').strip
-    code = lines[6].gsub(/\A\|(\s)+|EOF\Z/,'').strip
-    "#{msg} in \"#{code}\""
-  end
-
   def self.parse_raw_html_error(html)
     broken_html = html.match(/REXML could not parse this XML\/HTML\:(.+)<\/pre>/m)[1].strip rescue nil
     broken_html.nil? ? "Contains broken raw HTML." : "This raw HTML is invalid: #{CGI.unescapeHTML(broken_html)}"

data/lib/devcenter-parser/version.rb

@@ -1,3 +1,3 @@
 module DevcenterParser
-  VERSION = '1.4.9'
+  VERSION = '2.0.0'
 end

data/test/devcenter-parser_test.rb

@@ -7,26 +7,15 @@ describe 'DevcenterParser' do
   describe '.to_unsanitized_html' do
 
     it 'returns empty string for nil input' do
-      assert_parsing_unsanitized_result nil, :maruku, ''
-      assert_parsing_unsanitized_result nil, :maruku, ''
+      assert_parsing_unsanitized_result nil, ''
     end
 
     it 'maintains script tags' do
-      md = '<script>alert("hi")</script>'
-      assert_parsing_unsanitized_result md, :maruku, '<script><![CDATA[alert("hi")]]></script>'
-      assert_parsing_unsanitized_result md, :github, '<script>alert("hi")</script>'
+      assert_parsing_unsanitized_result '<script>alert("hi")</script>', '<script>alert("hi")</script>'
     end
 
     it 'maintains toolbelt custom element' do
-      md = '<toolbelt />'
-      assert_parsing_unsanitized_result md, :maruku, '<toolbelt></toolbelt>'
-      assert_parsing_unsanitized_result md, :github, '<p><toolbelt></toolbelt></p>'
-    end
-
-    it 'maintains custom attributes' do
-      md = '<p data-next-message="foo">hi</p>'
-      assert_parsing_unsanitized_result md, :maruku, '<p data-next-message="foo">hi</p>'
-      assert_parsing_unsanitized_result md, :github, '<p data-next-message="foo">hi</p>'
+      assert_parsing_unsanitized_result '<toolbelt />', '<p><toolbelt></toolbelt></p>'
     end
 
   end
@@ -34,36 +23,24 @@ describe 'DevcenterParser' do
   describe '.to_html' do
 
     it 'returns empty string for nil input' do
-      assert_maruku_result nil, ''
-      assert_github_result nil, ''
+      assert_parsing_result nil, ''
     end
 
     it 'does not create <em>s inside words' do
-      md = 'foo_bar_baz'
-      html = '<p>foo_bar_baz</p>'
-      assert_maruku_result md, html
-      assert_github_result md, html
-    end
-
-    it 'raises InvalidMarkdownError when parsing invalid markdown' do
-      md = '[foo](bar'
-      assert_raises DevcenterParser::InvalidMarkdownError do
-        DevcenterParser.to_html(md, :maruku)
-      end
+      assert_parsing_result 'foo_bar_baz', '<p>foo_bar_baz</p>'
     end
 
     it 'removes script tags and their content' do
       md = '<strong>clean<script>alert("hack!")</script></strong>'
       html = '<p><strong>clean</strong></p>'
-      assert_maruku_result md, html
-      assert_github_result md, html
+      assert_parsing_result md, html
     end
 
     it 'allows embedding vimeo videos' do
       src = <<-SRC
 <iframe src=\"https://player.vimeo.com/video/61044807?title=0&amp;byline=0&amp;portrait=0&amp;color=a086ee\" width=\"500\" height=\"281\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
 SRC
-      assert_github_result src, src
+      assert_parsing_result src, src
     end
 
     describe 'github markdown' do
@@ -118,14 +95,14 @@ MD
 <p>Three</p>
 HTML
 
-        assert_github_result md, html
+        assert_parsing_result md, html
       end
 
 
       it 'generates apostrophes from single quotes in plain text' do
         md = "That's it"
         html = "<p>That’s it</p>"
-        assert_github_result(md, html)
+        assert_parsing_result(md, html)
       end
 
       it 'generates apostrophes from single quotes in callout|warning|note blocks' do
@@ -138,39 +115,13 @@ MARKDOWN
 <p>That’s it</p>
 </div>
 HTML
-        assert_github_result(md, html)
+        assert_parsing_result(md, html)
       end
 
       it 'supports code blocks, respecting indentation and adding a custom class attribute' do
         md = <<-MARKDOWN
 Paragraph
 
-    :::term
-    $ command
-
-      indented
-    < tag1
-    > tag2
-
-Another paragraph
-MARKDOWN
-
-        html = <<-HTML
-<p>Paragraph</p>
-
-<pre><code class="term">$ command
-
-  indented
-&lt; tag1
-&gt; tag2</code></pre>
-
-<p>Another paragraph</p>
-HTML
-        assert_maruku_result md, html
-
-        md = <<-MARKDOWN
-Paragraph
-
 ```term
 $ command
 
@@ -194,10 +145,10 @@ MARKDOWN
 
 <p>Another paragraph</p>
 HTML
-        assert_github_result md, html
+        assert_parsing_result md, html
       end
 
-      it 'github markdown supports regular block quotes without callout|warning|note' do
+      it 'supports regular block quotes without callout|warning|note' do
         md = <<-MARKDOWN
 Testing
 
@@ -220,7 +171,7 @@ normal</p>
 <p>And that’s it.</p>
         HTML
 
-        assert_github_result(md, html)
+        assert_parsing_result(md, html)
 
         md = <<-MARKDOWN
 Testing
@@ -244,10 +195,10 @@ normal</p>
 <p>And that’s it.</p>
         HTML
 
-        assert_github_result(md, html)
+        assert_parsing_result(md, html)
       end
 
-      it 'github markdown supports "> callout" and ">callout" and parses inner markdown' do
+      it 'supports "> callout" and ">callout" and parses inner markdown' do
         mds = []
         mds << <<-MARKDOWN
 Testing
@@ -281,11 +232,11 @@ normal</p>
         HTML
 
         mds.each do |md|
-          assert_github_result(md, html)
+          assert_parsing_result(md, html)
         end
       end
 
-      it 'github markdown supports "> callout" and ">callout", parses inner markdown and allows paragraphs' do
+      it 'supports "> callout" and ">callout", parses inner markdown and allows paragraphs' do
         mds = []
         mds << <<-MARKDOWN
 Testing
@@ -329,12 +280,12 @@ more callout</p>
         HTML
 
         mds.each do |md|
-          assert_github_result(md, html)
+          assert_parsing_result(md, html)
         end
       end
     end
 
-    it 'github markdown generates separate special blocks from blockquotes separated by empty lines' do
+    it 'generates separate special blocks from blockquotes separated by empty lines' do
       md = <<-MARKDOWN
 > warning
 > foo
@@ -355,10 +306,10 @@ more callout</p>
 </div>
       HTML
 
-      assert_github_result md, html
+      assert_parsing_result md, html
     end
 
-    it 'github markdown supports tables' do
+    it 'supports tables' do
       md = <<-MARKDOWN
 |  A  |  B  |
 | --- | --- |
@@ -368,10 +319,12 @@ more callout</p>
 
       html = <<-HTML
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>A</th>
 <th>B</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>1</td>
@@ -385,50 +338,45 @@ more callout</p>
 </table>
       HTML
 
-      assert_github_result md, html
+      assert_parsing_result md, html
     end
 
-    it "does emdashes both in all flavours" do
+    it "does emdashes" do
       md = "foo -- bar"
       html = '<p>foo – bar</p>'
-      assert_all_flavours_result(md, html)
+      assert_parsing_result md, html
     end
 
     it 'converts relative links with missing initial slashes to article links' do
       ['foo', 'foo/bar', 'foo#bar', '123'].each do |href|
         md = "[link](#{href})"
         html = "<p><a href=\"/articles/#{href}\">link</a></p>"
-        assert_maruku_result md, html
-        assert_github_result md, html
+        assert_parsing_result md, html
       end
     end
 
     it 'converts "articles/foo relative links with missing initial slashes to article links' do
       md = '[link](articles/foo)'
       html = '<p><a href="/articles/foo">link</a></p>'
-      assert_maruku_result md, html
-      assert_github_result md, html
+      assert_parsing_result md, html
 
       md = '[link](articles/foo#bar)'
       html = '<p><a href="/articles/foo#bar">link</a></p>'
-      assert_maruku_result md, html
-      assert_github_result md, html
+      assert_parsing_result md, html
     end
 
     it 'does not alter relative links with initial slashes nor absolute links nor anchor links to the same doc' do
       ['http://foo.com', 'https://foo.com', '/foo', '/foo/bar', '/foo#bar', '#foo', '/123', 'mailto:foo@foobar.com'].each do |href|
         md = "[link](#{href})"
         html = "<p><a href=\"#{href}\">link</a></p>"
-        assert_maruku_result md, html
-        assert_github_result md, html
+        assert_parsing_result md, html
       end
     end
 
     it 'does not add href attribute to links where it does not exist' do
       md = '<a name="heh"></a>'
       html = '<p><a name="heh"></a></p>'
-      assert_maruku_result md, html
-      assert_github_result md, html
+      assert_parsing_result md, html
     end
 
 
@@ -439,19 +387,7 @@ more callout</p>
 > bar
       MARKDOWN
 
-      html_maruku = <<-HTML
-<blockquote>
-<p>foo</p>
-</blockquote>
-<p class="devcenter-parser-special-block-separator" style="display:none"> </p>
-<blockquote>
-<p>bar</p>
-</blockquote>
-      HTML
-
-      assert_maruku_result md, html_maruku
-
-      html_github = <<-HTML
+      html = <<-HTML
 <blockquote>
 <p>foo</p>
 </blockquote>
@@ -463,7 +399,7 @@ more callout</p>
 </blockquote>
       HTML
 
-      assert_github_result md, html_github
+      assert_parsing_result md, html
     end
 
   end
@@ -471,31 +407,18 @@ more callout</p>
 
   # helpers
 
-  def assert_all_flavours_result(md, expected)
-    [:github, :maruku].each { |flavour| assert_parsing_result(md, flavour, expected) }
-  end
-
-  def assert_maruku_result(md, expected)
-    assert_parsing_result md, :maruku, expected
-  end
-
-  def assert_github_result(md, expected)
-    assert_parsing_result md, :github, expected
-  end
-
-  def assert_parsing_result(md, flavour, expected)
-    result = DevcenterParser.to_html(md, flavour)
-    assert_equal expected.strip, result.strip, "Failed when parsing\n#{md}\nwith the #{flavour} flavour.\n\nExpected:\n#{expected}\n\nActual result:\n#{result}\n\n"
+  def assert_parsing_result(md, expected)
+    result = DevcenterParser.to_html(md)
+    assert_equal expected.strip, result.strip, "Failed when parsing\n#{md}\n.\n\nExpected:\n#{expected}\n\nActual result:\n#{result}\n\n"
   end
 
-  def assert_parsing_unsanitized_result(md, flavour, expected)
-    result = DevcenterParser.to_unsanitized_html(md, flavour)
-    assert_equal expected.strip, result.strip, "Failed when parsing on unsanitized mode\n#{md}\nwith the #{flavour} flavour.\n\nExpected:\n#{expected}\n\nActual result:\n#{result}\n\n"
+  def assert_parsing_unsanitized_result(md, expected)
+    result = DevcenterParser.to_unsanitized_html(md)
+    assert_equal expected.strip, result.strip, "Failed when parsing on unsanitized mode\n#{md}\n.\n\nExpected:\n#{expected}\n\nActual result:\n#{result}\n\n"
   end
 
   def assert_header_id(md, header, id)
-    assert DevcenterParser.to_html(md, :github).include?("<#{header} id=\"#{id}\">"), "GitHub does not generate a #{header} with id #{id}"
-    assert DevcenterParser.to_html(md, :maruku).include?("<#{header} id=\"#{id}\">"), "Maruku does not generate a #{header} with id #{id}"
+    assert DevcenterParser.to_html(md).include?("<#{header} id=\"#{id}\">"), "GitHub does not generate a #{header} with id #{id}"
   end
 
 end

metadata

@@ -1,41 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: devcenter-parser
 version: !ruby/object:Gem::Version
-  version: 1.4.9
+  version: 2.0.0
 platform: ruby
 authors:
 - Heroku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
 - !ruby/object:Gem::Dependency
@@ -70,28 +56,28 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Parser for Heroku Dev Center's content
@@ -109,7 +95,6 @@ files:
 - lib/devcenter-parser.rb
 - lib/devcenter-parser/github_parser.rb
 - lib/devcenter-parser/header_id_generator.rb
-- lib/devcenter-parser/maruku_parser.rb
 - lib/devcenter-parser/version.rb
 - test/devcenter-parser_test.rb
 - test/header_id_generator_test.rb
@@ -122,17 +107,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Parser for Heroku Dev Center's content

data/lib/devcenter-parser/maruku_parser.rb

@@ -1,28 +0,0 @@
-module MarukuParser
-  extend self
-
-  def self.parse(markdown)
-    html = Maruku.new(markdown, :on_error => :raise).to_html
-    doc = Nokogiri::HTML::DocumentFragment.parse(html)
-    code_blocks(doc)
-    doc
-  end
-
-  # This parser seem to deal correctly with tags inside HTML comments
-  def self.remove_tags_inside_html_comments(markdown)
-    markdown
-  end
-
-  private
-
-  def self.code_blocks(doc)
-    doc.css('pre>code').each do |node|
-      if match = node.content.match(/\A\s*:::\s*(\w+)/)
-        lang = match[1]
-        node.content = node.content.gsub(/\A\s*:::\s*\w+\n/, '')
-        node['class'] = lang
-      end
-    end
-    doc
-  end
-end