Merge master

Author: gjtorikian

.travis.yml

@@ -1,8 +1,11 @@
+language: ruby
 before_install: sudo pip install docutils
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.1
+  - jruby-19mode
+jdk:
+  - oraclejdk8
 notifications:
-  disabled: true
-bundler_args: --without development
+  email: false

Gemfile

@@ -1,10 +1,13 @@
 source "http://rubygems.org"
 gemspec
-gem "redcarpet"
+
+gem "posix-spawn", :platforms => :ruby
+gem "redcarpet", :platforms => :ruby
+gem "kramdown", :platforms => :jruby
 gem "RedCloth"
 gem "rdoc", "~>3.6"
 gem "org-ruby", "= 0.9.9"
 gem "creole", "~>0.3.6"
-gem "wikicloth", "=0.8.1"
+gem "wikicloth", "=0.8.1", :platforms => :ruby
 gem "asciidoctor", "= 0.1.4"
-gem "rake"
+gem "rake"

HISTORY.md

@@ -1,3 +1,9 @@
+## 1.3.1 (2014-11-13)
+
+* Fix name error when trying to use newer versions of RedCarpet [#387](https://github.com/github/markup/pull/387)
+
+[Full changelog](https://github.com/github/markup/compare/v1.3.0...v1.3.1)
+
 ## 1.3.0 (2014-09-11)
 
 * Extend the field limit for tables to 50 characters for RST [#306](https://github.com/github/markup/pull/306)

README.md

@@ -19,7 +19,7 @@ you wish to run the library. You can also run `script/bootstrap` to fetch them a
 * [.rst](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils`
 * [.asciidoc, .adoc, .asc](http://asciidoc.org/) -- `gem install asciidoctor` (http://asciidoctor.org)
 * [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML`
-  comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
+  comes with Perl >= 5.10. Lower versions should install [Pod::Simple](http://search.cpan.org/~dwheeler/Pod-Simple-3.28/lib/Pod/Simple.pod) from CPAN.
 
 Installation
 -----------

github-markup.gemspec

@@ -16,5 +16,9 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = %w[lib]
 
-  s.add_dependency "posix-spawn", "~> 0.3.8"
+  s.add_development_dependency 'minitest', '~> 5.4.3'
+  s.add_development_dependency 'html-pipeline', '~> 1.0'
+  s.add_development_dependency 'sanitize', '~> 2.1.0'
+  s.add_development_dependency 'nokogiri', '~> 1.6.1'
+  s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
 end

lib/github-markup.rb

@@ -1,6 +1,6 @@
 module GitHub
   module Markup
-    VERSION = '1.3.0'
+    VERSION = '1.3.1'
     Version = VERSION
   end
 end

lib/github/commands/rest2html

@@ -89,6 +89,14 @@ class GitHubHTMLTranslator(HTMLTranslator):
         else:
             self.body.append(self.starttag(node, 'pre'))
 
+    # always wrap two-backtick rst inline literals in <code>, not <tt>
+    # this also avoids the generation of superfluous <span> tags
+    def visit_literal(self, node):
+        self.body.append(self.starttag(node, 'code', suffix=''))
+
+    def depart_literal(self, node):
+        self.body.append('</code>')
+
     def visit_table(self, node):
         classes = ' '.join(['docutils', self.settings.table_style]).strip()
         self.body.append(

lib/github/markup.rb

@@ -31,7 +31,7 @@ def markup(file, pattern, opts = {}, &block)
     end
 
     def command(command, regexp, &block)
-      if File.exists?(file = File.dirname(__FILE__) + "/commands/#{command}")
+      if File.exist?(file = File.dirname(__FILE__) + "/commands/#{command}")
         command = file
       end
 

lib/github/markup/command_implementation.rb

@@ -1,4 +1,9 @@
-require "posix-spawn"
+begin
+  require "posix-spawn"
+rescue LoadError
+  require "open3"
+end
+
 require "github/markup/implementation"
 
 module GitHub
@@ -31,15 +36,35 @@ def call_block(rendered, content)
           rendered
         end
       end
-
-      def execute(command, target)
-        spawn = POSIX::Spawn::Child.new(*command, :input => target)
-        if spawn.status.success?
-          spawn.out.gsub("\r", '').force_encoding(target.encoding)
-        else
-          raise CommandError.new(spawn.err.strip)
+      
+      if defined?(Posix::Spawn)
+        def execute(command, target)
+          spawn = POSIX::Spawn::Child.new(*command, :input => target)
+          if spawn.status.success?
+            sanitize(spawn.out, target.encoding)
+          else
+            raise CommandError.new(spawn.err.strip)
+          end
+        end
+      else
+        def execute(command, target)
+          output = Open3.popen3(*command) do |stdin, stdout, stderr, wait_thr|
+            stdin.puts target
+            stdin.close
+            if wait_thr.value.success?
+              stdout.readlines
+            else
+              raise CommandError.new(stderr.readlines.join('').strip)
+            end
+          end
+          sanitize(output.join(''), target.encoding)
         end
       end
+      
+      def sanitize(input, encoding)
+        input.gsub("\r", '').force_encoding(encoding)
+      end
+      
     end
   end
 end

test/fixtures/fail.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "failure message">&2 && false

test/markup_test.rb

@@ -3,19 +3,61 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
 
 require 'github/markup'
-require 'test/unit'
+require 'minitest/autorun'
+require 'html/pipeline'
+require 'nokogiri'
+require 'nokogiri/diff'
+
+def normalize_html(text)
+  text.strip!
+  text.gsub!(/\s\s+/,' ')
+  text.gsub!(/\p{Pi}|\p{Pf}|"/u,'"')
+  text.gsub!("\u2026",'...')
+  text
+end
+
+def assert_html_equal(expected, actual, msg = nil)
+    assertion = Proc.new do
+      expected_doc = Nokogiri::HTML(expected) {|config| config.noblanks}
+      actual_doc   = Nokogiri::HTML(actual) {|config| config.noblanks}
+
+      expected_doc.search('//text()').each {|node| node.content = normalize_html node.content}
+      actual_doc.search('//text()').each {|node| node.content = normalize_html node.content}
+
+      ignore_changes = {"+" => Regexp.union(/^\s*id=".*"\s*$/), "-" => nil}
+      expected_doc.diff(actual_doc) do |change, node|
+        if change != ' ' && !node.blank? then
+          break unless node.to_html =~ ignore_changes[change]
+        end
+      end
+    end
+    assert(assertion.call, msg)
+end
+
+class MarkupTest < Minitest::Test
+  class MarkupFilter < HTML::Pipeline::Filter
+    def call
+      filename = context[:filename]
+      GitHub::Markup.render(filename, File.read(filename)).strip.force_encoding("utf-8")
+    end
+  end
+
+  Pipeline = HTML::Pipeline.new [
+    MarkupFilter,
+    HTML::Pipeline::SanitizationFilter
+  ]
 
-class MarkupTest < Test::Unit::TestCase
   Dir['test/markups/README.*'].each do |readme|
     next if readme =~ /html$/
     markup = readme.split('/').last.gsub(/^README\./, '')
 
     define_method "test_#{markup}" do
-      source = File.read(readme)
+      skip "Skipping MediaWiki test because wikicloth is currently not compatible with JRuby." if markup == "mediawiki" && RUBY_PLATFORM == "java"
 
+      source = File.read(readme)
       expected_file = "#{readme}.html"
       expected = File.read(expected_file).rstrip
-      actual = GitHub::Markup.render(readme, File.read(readme)).rstrip.force_encoding("utf-8")
+      actual = Pipeline.to_html(nil, :filename => readme)
 
       if source != expected
         assert(source != actual, "#{markup} did not render anything")
@@ -27,8 +69,8 @@ class MarkupTest < Test::Unit::TestCase
         f.read
       end
 
-      assert expected == actual, <<message
-#{File.basename expected_file}'s contents don't match command output:
+      assert_html_equal expected, actual, <<message
+#{File.basename expected_file}'s contents are not html equal to output:
 #{diff}
 message
     end
@@ -44,7 +86,7 @@ def test_knows_what_it_can_and_cannot_render
   end
 
   def test_raises_error_if_command_exits_non_zero
-    GitHub::Markup.command('echo "failure message">&2 && false', /fail/)
+    GitHub::Markup.command('test/fixtures/fail.sh', /fail/)
     assert GitHub::Markup.can_render?('README.fail')
     begin
       GitHub::Markup.render('README.fail', "stop swallowing errors")

test/markups/README.asciidoc.html

@@ -1,8 +1,8 @@
 <h1>Document Title</h1>
-<div class="sect1">
-<h2 id="first-section">First Section</h2>
-<div class="sectionbody">
-<div class="ulist">
+<div>
+<h2>First Section</h2>
+<div>
+<div>
 <ul>
 <li>
 <p>One</p>
@@ -14,26 +14,25 @@ <h2 id="first-section">First Section</h2>
 </div>
 </div>
 </div>
-<div class="sect1">
-<h2 id="second-section">Second Section</h2>
-<div class="sectionbody">
-<div class="admonitionblock note">
+<div>
+<h2>Second Section</h2>
+<div>
+<div>
 <table>
 <tr>
-<td class="icon">
-<div class="title">Note</div>
+<td>
+<div>Note</div>
 </td>
-<td class="content">
+<td>
 Here is some source code.
 </td>
 </tr>
 </table>
 </div>
-<div class="listingblock">
-<div class="content">
+<div>
+<div>
 <pre lang="ruby"><code>puts "Hello, World!"</code></pre>
 </div>
 </div>
 </div>
-</div>
-
+</div>

test/markups/README.creole.html

@@ -1,4 +1,8 @@
-<h1>H1</h1><h2>H2</h2><p>paragraph of text that will be turned into a paragraph element. It can go over several lines with line breaks, it will be turned into a contiguous paragraph element.</p><p>You can force a linebreak in your paragraph text<br/>thusly.</p><ul><li>a list element<ul><li>sub list element</li></ul></li><li>2nd list element</li></ul><pre>pre formatted text
+<h1>H1</h1><h2>H2</h2><p>paragraph of text that will be turned into a paragraph element. It can go over several lines with line breaks, it will be turned into a contiguous paragraph element.</p><p>You can force a linebreak in your paragraph text<br>thusly.</p><ul>
+<li>a list element<ul><li>sub list element</li></ul>
+</li>
+<li>2nd list element</li>
+</ul><pre>pre formatted text
 
 $ ls -la
 total 56

test/markups/README.litcoffee.html

@@ -6,13 +6,13 @@ <h2>Literate CoffeeScript Test</h2>
 
 <p>comment comment</p>
 
-<pre><code>test &quot;basic literate CoffeeScript parsing&quot;, -&gt;
+<pre><code>test "basic literate CoffeeScript parsing", -&gt;
   ok yes
 </code></pre>
 
 <p>now with a...</p>
 
-<pre><code>test &quot;broken up indentation&quot;, -&gt;
+<pre><code>test "broken up indentation", -&gt;
 </code></pre>
 
 <p>... broken up ...</p>
@@ -27,7 +27,7 @@ <h2>Literate CoffeeScript Test</h2>
 
 <p>Code must be separated from text by a blank line.</p>
 
-<pre><code>test &quot;code blocks must be preceded by a blank line&quot;, -&gt;
+<pre><code>test "code blocks must be preceded by a blank line", -&gt;
 </code></pre>
 
 <p>The next line is part of the text and will not be executed.
@@ -38,7 +38,7 @@ <h2>Literate CoffeeScript Test</h2>
 
 <p>Code in <code>backticks is not parsed</code> and...</p>
 
-<pre><code>test &quot;comments in indented blocks work&quot;, -&gt;
+<pre><code>test "comments in indented blocks work", -&gt;
   do -&gt;
     do -&gt;
       # Regular comment.
@@ -62,5 +62,5 @@ <h2>Literate CoffeeScript Test</h2>
 
 <p>Tabs work too:</p>
 
-<p>test &quot;tabbed code&quot;, -&gt;
-    ok yes</p>
+<p>test "tabbed code", -&gt;
+    ok yes</p>

test/markups/README.markdown.html

@@ -1,4 +1,4 @@
 <ul>
 <li>One</li>
 <li>Two</li>
-</ul>
+</ul>