pandoc-ruby 1.0.0 → 2.0.0

data/pandoc-ruby.gemspec

@@ -4,24 +4,24 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "pandoc-ruby"
-  s.version = "1.0.0"
+  s.name = 'pandoc-ruby'
+  s.version = '2.0.0'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["William Melody"]
-  s.date = "2015-02-09"
-  s.description = "Ruby wrapper for Pandoc"
-  s.email = "hi@williammelody.com"
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.authors = ['William Melody']
+  s.date = '2016-03-28'
+  s.description = 'Ruby wrapper for Pandoc'
+  s.email = 'hi@williammelody.com'
   s.extra_rdoc_files = [
-    "LICENSE",
-    "README.markdown"
+    'LICENSE',
+    'README.md'
   ]
-  s.files = %w[
+  s.files = %w(
     .document
     Gemfile
     Gemfile.lock
     LICENSE
-    README.markdown
+    README.md
     Rakefile
     lib/pandoc-ruby.rb
     pandoc-ruby.gemspec
@@ -30,14 +30,14 @@ Gem::Specification.new do |s|
     test/files/test.md
     test/helper.rb
     test/test_conversions.rb
-    test/test_pandoc-ruby.rb
-  ]
-  s.homepage = "http://github.com/alphabetum/pandoc-ruby"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
+    test/test_pandoc_ruby.rb
+  )
+  s.homepage = 'http://github.com/alphabetum/pandoc-ruby'
+  s.licenses = ['MIT']
+  s.require_paths = ['lib']
   s.required_ruby_version = '>= 1.9.3'
-  s.rubygems_version = "1.8.25"
-  s.summary = "PandocRuby"
+  s.rubygems_version = '1.8.25'
+  s.summary = 'PandocRuby'
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
@@ -46,20 +46,17 @@ Gem::Specification.new do |s|
       s.add_development_dependency('mocha', '~> 1.1', '>= 1.1.0')
       s.add_development_dependency('rake', '~> 10.4', '>= 10.4.2')
       s.add_development_dependency('rdoc', '~> 4.2', '>= 4.2.0')
-      s.add_development_dependency('shoulda', '~> 3.5', '>= 3.5.0')
-      s.add_development_dependency('test-unit', '~> 3.0', '>= 3.0.9')
+      s.add_development_dependency('minitest', '~>5.8.3', '>= 5.8.3')
     else
-      s.add_dependency(%q<mocha>, ["~> 1.1.0"])
-      s.add_dependency(%q<rake>, ["~> 10.4.2"])
-      s.add_dependency(%q<rdoc>, ["~> 4.2.0"])
-      s.add_dependency(%q<shoulda>, ["~> 3.5.0"])
-      s.add_dependency(%q<test-unit>, ["~> 3.0.9"])
+      s.add_dependency('mocha', ['~> 1.1.0'])
+      s.add_dependency('rake', ['~> 10.4.2'])
+      s.add_dependency('rdoc', ['~> 4.2.0'])
+      s.add_dependency('minitest', ['~>5.8.3'])
     end
   else
-    s.add_dependency(%q<mocha>, ["~> 1.1.0"])
-    s.add_dependency(%q<rake>, ["~> 10.4.2"])
-    s.add_dependency(%q<rdoc>, ["~> 4.2.0"])
-    s.add_dependency(%q<shoulda>, ["~> 3.5.0"])
-    s.add_dependency(%q<test-unit>, ["~> 3.0.9"])
+    s.add_dependency('mocha', ['~> 1.1.0'])
+    s.add_dependency('rake', ['~> 10.4.2'])
+    s.add_dependency('rdoc', ['~> 4.2.0'])
+    s.add_dependency('minitest', ['~>5.8.3'])
   end
 end

data/test/benchmark.rb

@@ -31,7 +31,7 @@ implementations.map! { |class_name| Object.const_get(class_name) }
 
 def benchmark(implementation, text, iterations)
   start = Time.now
-  iterations.times do |i|
+  iterations.times do |_i|
     implementation.new(text).to_html
   end
   Time.now - start
@@ -39,18 +39,20 @@ end
 
 test_data = File.read(test_file)
 
-puts "Spinning up ..."
+puts 'Spinning up ...'
 implementations.each { |impl| benchmark(impl, test_data, 1) }
 
-puts "Running benchmarks ..."
+puts 'Running benchmarks ...'
 results =
-  implementations.inject([]) do |r,impl|
+  implementations.inject([]) do |r, impl|
     GC.start
-    r << [ impl, benchmark(impl, test_data, iterations) ]
+    r << [impl, benchmark(impl, test_data, iterations)]
   end
 
 puts "Results for #{iterations} iterations:"
-results.each do |impl,time|
+results.each do |impl, time|
   printf "  %10s %09.06fs total time, %09.06fs average\n",
-    "#{impl}:", time, time / iterations
-end
+         "#{impl}:",
+         time,
+         time / iterations
+end

data/test/files/test.md

@@ -1,3 +1,4 @@
 # This is a Title
 
-Some *emphasized text* and [a link](http://daringfireball.net/projects/markdown/)
+Some *emphasized text* and
+[a link](http://daringfireball.net/projects/markdown/)

data/test/helper.rb

@@ -4,16 +4,13 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
-require 'test/unit'
-require 'shoulda'
+require 'minitest/autorun'
+require 'minitest/pride'
 require 'mocha/setup'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'pandoc-ruby'
-
-class Test::Unit::TestCase
-end

data/test/test_conversions.rb

@@ -1,67 +1,30 @@
 require 'helper'
 
-class TestConversions < Test::Unit::TestCase
-
-  def self.formatted_strings
-    h = Hash.new
-    h[:native] =
-      %Q|[Header 1 (\"this-is-a-title\",[],[]) [Str \"This\",Space,Str \"is\",Space,Str \"a\",Space,Str \"Title\"]\n,Para [Str \"Some\",Space,Emph [Str \"emphasized\",Space,Str \"text\"],Space,Str \"and\",Space,Link [Str \"a\",Space,Str \"link\"] (\"http://daringfireball.net/projects/markdown/\",\"\")]]|
-    h[:json] =
-      %Q|[{"unMeta":{}},[{"t":"Header","c":[1,["this-is-a-title",[],[]],[{"t":"Str","c":"This"},{"t":"Space","c":[]},{"t":"Str","c":"is"},{"t":"Space","c":[]},{"t":"Str","c":"a"},{"t":"Space","c":[]},{"t":"Str","c":"Title"}]]},{"t":"Para","c":[{"t":"Str","c":"Some"},{"t":"Space","c":[]},{"t":"Emph","c":[{"t":"Str","c":"emphasized"},{"t":"Space","c":[]},{"t":"Str","c":"text"}]},{"t":"Space","c":[]},{"t":"Str","c":"and"},{"t":"Space","c":[]},{"t":"Link","c":[[{"t":"Str","c":"a"},{"t":"Space","c":[]},{"t":"Str","c":"link"}],["http://daringfireball.net/projects/markdown/",""]]}]}]]|
-    h[:html] =
-      %Q|<h1 id=\"this-is-a-title\">This is a Title</h1>\n<p>Some <em>emphasized text</em> and <a href=\"http://daringfireball.net/projects/markdown/\">a link</a></p>|
-    h[:html5] =
-      %Q|<h1 id=\"this-is-a-title\">This is a Title</h1>\n<p>Some <em>emphasized text</em> and <a href=\"http://daringfireball.net/projects/markdown/\">a link</a></p>|
-    h[:s5] =
-      %Q|<div id=\"this-is-a-title\" class=\"slide section level1\">\n<h1>This is a Title</h1>\n<p>Some <em>emphasized text</em> and <a href=\"http://daringfireball.net/projects/markdown/\">a link</a></p>\n</div>|
-    h[:slidy] =
-      %Q|<div id=\"this-is-a-title\" class=\"slide section level1\">\n<h1>This is a Title</h1>\n<p>Some <em>emphasized text</em> and <a href=\"http://daringfireball.net/projects/markdown/\">a link</a></p>\n</div>|
-    h[:dzslides] =
-      %Q|<section id=\"this-is-a-title\" class=\"slide level1\">\n<h1>This is a Title</h1>\n<p>Some <em>emphasized text</em> and <a href=\"http://daringfireball.net/projects/markdown/\">a link</a></p>\n</section>|
-    h[:docbook] =
-      %Q|<sect1 id=\"this-is-a-title\">\n  <title>This is a Title</title>\n  <para>\n    Some <emphasis>emphasized text</emphasis> and\n    <ulink url=\"http://daringfireball.net/projects/markdown/\">a\n    link</ulink>\n  </para>\n</sect1>|
-    h[:opendocument] =
-      %Q|<text:h text:style-name=\"Heading_20_1\" text:outline-level=\"1\">This is a\nTitle</text:h>\n<text:p text:style-name=\"First_20_paragraph\">Some\n<text:span text:style-name=\"T1\">emphasized</text:span><text:span text:style-name=\"T2\">\n</text:span><text:span text:style-name=\"T3\">text</text:span> and\n<text:a xlink:type=\"simple\" xlink:href=\"http://daringfireball.net/projects/markdown/\" office:name=\"\"><text:span text:style-name=\"Definition\">a\nlink</text:span></text:a></text:p>|
-    h[:latex] =
-      %Q|\\section{This is a Title}\\label{this-is-a-title}\n\nSome \\emph{emphasized text} and\n\\href{http://daringfireball.net/projects/markdown/}{a link}|
-    h[:beamer] =
-      %Q|\\begin{frame}{This is a Title}\n\nSome \\emph{emphasized text} and\n\\href{http://daringfireball.net/projects/markdown/}{a link}\n\n\\end{frame}|
-    h[:context] =
-      %Q|\\section[this-is-a-title]{This is a Title}\n\nSome {\\em emphasized text} and\n\\useURL[url1][http://daringfireball.net/projects/markdown/][][a\nlink]\\from[url1]|
-    h[:texinfo] =
-      %Q|@node Top\n@top Top\n\n@menu\n* This is a Title::\n@end menu\n\n@node This is a Title\n@chapter This is a Title\n@anchor{#this-is-a-title}\nSome @emph{emphasized text} and @uref{http://daringfireball.net/projects/markdown/,a link}|
-    h[:man] =
-      %Q|.SH This is a Title\n.PP\nSome \\f[I]emphasized text\\f[] and a\nlink (http://daringfireball.net/projects/markdown/)|
-    h[:markdown] =
-      %Q|This is a Title\n===============\n\nSome *emphasized text* and [a\nlink](http://daringfireball.net/projects/markdown/)|
-    h[:plain] =
-      %Q|THIS IS A TITLE\n\n\nSome _emphasized text_ and a link|
-    h[:rst] =
-      %Q|This is a Title\n===============\n\nSome *emphasized text* and `a\nlink <http://daringfireball.net/projects/markdown/>`__|
-    h[:mediawiki] =
-      %Q|= This is a Title =\n\nSome ''emphasized text'' and [http://daringfireball.net/projects/markdown/ a link]|
-    h[:textile] =
-      %Q|h1(#this-is-a-title). This is a Title\n\nSome _emphasized text_ and \"a link\":http://daringfireball.net/projects/markdown/|
-    h[:rtf] =
-      %Q|{\\pard \\ql \\f0 \\sa180 \\li0 \\fi0 \\b \\fs36 This is a Title\\par}\n{\\pard \\ql \\f0 \\sa180 \\li0 \\fi0 Some {\\i emphasized text} and {\\field{\\*\\fldinst{HYPERLINK \"http://daringfireball.net/projects/markdown/\"}}{\\fldrslt{\\ul\na link\n}}}\n\\par}|
-    h[:org] =
-      %Q|* This is a Title\n\nSome /emphasized text/ and\n[[http://daringfireball.net/projects/markdown/][a link]]|
-    h[:asciidoc] =
-      %Q|[[this-is-a-title]]\nThis is a Title\n---------------\n\nSome _emphasized text_ and\nhttp://daringfireball.net/projects/markdown/[a link]|
-    return h
+# Generate tests for converting to and from various formats. Use two nested
+# loops to iterate over each source and destination format, using files with
+# names of the following structure: "format.#{format_name}"
+describe 'Conversions' do
+  @extensions = []
+  Dir.glob(File.join(File.dirname(__FILE__), 'files', 'format*')) do |f|
+    @extensions << f.match(/format\.(\w+)\Z/)[1]
   end
 
   [:markdown, :html, :rst, :latex].each do |from|
-    formatted_strings.each_key do |format|
-      unless from == format
-        should "convert #{from} to #{format}" do
-          assert_equal(
-            PandocRuby.convert(TestConversions.formatted_strings[from], :from => from, :to => format).strip,
-            TestConversions.formatted_strings[format]
-          )
-        end
+    @extensions.each do |to|
+      next if from == to
+
+      it "converts #{from} to #{to}" do
+        files_dir     = File.join(File.dirname(__FILE__), 'files')
+        from_content  = File.read(File.join(files_dir, "format.#{from}"))
+        to_content    = File.read(File.join(files_dir, "format.#{to}"))
+
+        converted_content = PandocRuby.convert(
+          from_content,
+          :from => from,
+          :to   => to
+        )
+        assert_equal(converted_content.strip, to_content.strip)
       end
     end
   end
-
 end

data/test/test_pandoc_ruby.rb

@@ -0,0 +1,205 @@
+require 'helper'
+
+describe PandocRuby do
+  before do
+    @file = File.join(File.dirname(__FILE__), 'files', 'test.md')
+    @file2 = File.join(File.dirname(__FILE__), 'files', 'test2.md')
+    @string = '# Test String'
+    @converter = PandocRuby.new(@string, :t => :rst)
+  end
+
+  after do
+    PandocRuby.pandoc_path = 'pandoc'
+  end
+
+  it 'calls bare pandoc when passed no options' do
+    converter = PandocRuby.new(@string)
+    converter.expects(:execute).with('pandoc').returns(true)
+    assert converter.convert
+  end
+
+  it 'converts with altered pandoc_path' do
+    path = '/usr/bin/env pandoc'
+    PandocRuby.pandoc_path = path
+    converter = PandocRuby.new(@string)
+    converter.expects(:execute).with(path).returns(true)
+    assert converter.convert
+  end
+
+  it 'converts input passed as a string' do
+    assert_equal "<h1 id=\"test-string\">Test String</h1>\n",
+                 PandocRuby.new(@string).to_html
+  end
+
+  it 'converts single element array input as array of file paths' do
+    assert PandocRuby.new([@file]).to_html.match(/This is a Title/)
+  end
+
+  it 'converts multiple element array input as array of file paths' do
+    assert PandocRuby.new([@file, @file2]).to_html.match(/This is a Title/)
+    assert PandocRuby.new([@file, @file2]).to_html.match(/A Second Title/)
+  end
+
+  it 'accepts short options' do
+    @converter.expects(:execute).with('pandoc -t rst').returns(true)
+    assert @converter.convert
+  end
+
+  it 'accepts long options' do
+    converter = PandocRuby.new(@string, :to => :rst)
+    converter.expects(:execute).with('pandoc --to rst').returns(true)
+    assert converter.convert
+  end
+
+  it 'accepts a variety of options in initializer' do
+    converter = PandocRuby.new(@string, :s, {
+      :f => :markdown, :to => :rst
+    }, 'no-wrap')
+    converter \
+      .expects(:execute) \
+      .with('pandoc -s -f markdown --to rst --no-wrap') \
+      .returns(true)
+    assert converter.convert
+  end
+
+  it 'accepts a variety of options in convert' do
+    converter = PandocRuby.new(@string)
+    converter \
+      .expects(:execute) \
+      .with('pandoc -s -f markdown --to rst --no-wrap') \
+      .returns(true)
+    assert converter.convert(:s, { :f => :markdown, :to => :rst }, 'no-wrap')
+  end
+
+  it 'converts underscore symbol ares to hyphenated long options' do
+    converter = PandocRuby.new(@string, {
+      :email_obfuscation => :javascript
+    }, :table_of_contents)
+    converter \
+      .expects(:execute) \
+      .with('pandoc --email-obfuscation javascript --table-of-contents') \
+      .returns(true)
+    assert converter.convert
+  end
+
+  it 'uses second arg as option' do
+    converter = PandocRuby.new(@string, 'toc')
+    converter.expects(:execute).with('pandoc --toc').returns(true)
+    assert converter.convert
+  end
+
+  it 'raises RuntimeError from pandoc executable error' do
+    assert_raises(RuntimeError) do
+      PandocRuby.new('# hello', 'badopt').to_html5
+    end
+  end
+
+  PandocRuby::READERS.each_key do |r|
+    it "converts from #{r} with PandocRuby.#{r}" do
+      converter = PandocRuby.send(r, @string)
+      converter.expects(:execute).with("pandoc --from #{r}").returns(true)
+      assert converter.convert
+    end
+  end
+
+  PandocRuby::STRING_WRITERS.each_key do |w|
+    it "converts to #{w} with to_#{w}" do
+      converter = PandocRuby.new(@string)
+      converter \
+        .expects(:execute) \
+        .with("pandoc --no-wrap --to #{w}") \
+        .returns(true)
+      assert converter.send("to_#{w}", :no_wrap)
+    end
+  end
+
+  PandocRuby::BINARY_WRITERS.each_key do |w|
+    it "converts to #{w} with to_#{w}" do
+      converter = PandocRuby.new(@string)
+      converter \
+        .expects(:execute) \
+        .with(regexp_matches(/^pandoc --no-wrap --to #{w} --output /)) \
+        .returns(true)
+      assert converter.send("to_#{w}", :no_wrap)
+    end
+  end
+
+  it 'works with strings' do
+    converter = PandocRuby.new('## this is a title')
+    assert_match(/h2/, converter.convert)
+  end
+
+  it 'aliases to_s' do
+    assert_equal @converter.convert, @converter.to_s
+  end
+
+  it 'has convert class method' do
+    assert_equal @converter.convert, PandocRuby.convert(@string, :t => :rst)
+  end
+
+  it 'runs more than 400 times without error' do
+    begin
+      400.times do
+        PandocRuby.convert(@string)
+      end
+      assert true
+    rescue Errno::EMFILE, Errno::EAGAIN => e
+      flunk e
+    end
+  end
+
+  it 'gracefully times out when pandoc hangs due to malformed input' do
+    file = File.join(File.dirname(__FILE__), 'files', 'bomb.tex')
+    contents = File.read(file)
+
+    assert_raises(RuntimeError) do
+      PandocRuby.convert(
+        contents, :from => :latex, :to => :html, :timeout => 1
+      )
+    end
+  end
+
+  it 'has reader and writer constants' do
+    assert_equal PandocRuby::READERS,
+                 'html'      =>  'HTML',
+                 'latex'     =>  'LaTeX',
+                 'textile'   =>  'textile',
+                 'native'    =>  'pandoc native',
+                 'markdown'  =>  'markdown',
+                 'json'      =>  'pandoc JSON',
+                 'rst'       =>  'reStructuredText'
+
+    assert_equal PandocRuby::STRING_WRITERS,
+                 'mediawiki'     =>  'MediaWiki markup',
+                 'html'          =>  'HTML',
+                 'plain'         =>  'plain',
+                 'latex'         =>  'LaTeX',
+                 's5'            =>  'S5 HTML slideshow',
+                 'textile'       =>  'textile',
+                 'texinfo'       =>  'GNU Texinfo',
+                 'docbook'       =>  'DocBook XML',
+                 'html5'         =>  'HTML5',
+                 'native'        =>  'pandoc native',
+                 'org'           =>  'emacs org mode',
+                 'rtf'           =>  'rich text format',
+                 'markdown'      =>  'markdown',
+                 'man'           =>  'groff man',
+                 'dzslides'      =>  'Dzslides HTML slideshow',
+                 'beamer'        =>  'Beamer PDF slideshow',
+                 'json'          =>  'pandoc JSON',
+                 'opendocument'  =>  'OpenDocument XML',
+                 'slidy'         =>  'Slidy HTML slideshow',
+                 'rst'           =>  'reStructuredText',
+                 'context'       =>  'ConTeXt',
+                 'asciidoc'      =>  'asciidoc'
+
+    assert_equal PandocRuby::BINARY_WRITERS,
+                 'odt'   => 'OpenDocument',
+                 'docx'  => 'Word docx',
+                 'epub'  => 'EPUB V2',
+                 'epub3' => 'EPUB V3'
+
+    assert_equal PandocRuby::WRITERS,
+                 PandocRuby::STRING_WRITERS.merge(PandocRuby::BINARY_WRITERS)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandoc-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - William Melody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -71,58 +71,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 5.8.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 5.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 5.8.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.9
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: 5.8.3
 description: Ruby wrapper for Pandoc
 email: hi@williammelody.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.markdown
+- README.md
 files:
 - ".document"
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - lib/pandoc-ruby.rb
 - pandoc-ruby.gemspec
@@ -131,7 +111,7 @@ files:
 - test/files/test.md
 - test/helper.rb
 - test/test_conversions.rb
-- test/test_pandoc-ruby.rb
+- test/test_pandoc_ruby.rb
 homepage: http://github.com/alphabetum/pandoc-ruby
 licenses:
 - MIT
@@ -152,8 +132,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 3
 summary: PandocRuby
 test_files: []
+has_rdoc: