pandoc-ruby 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ec374a42893d6b60b7b22ab158a0c1aaa5eaad560523ff4f9fb57272587f20d
-  data.tar.gz: f6c841353fa08a7182276fff06eb5bcef5e36d95a3560ca3ae7114048ac48156
+  metadata.gz: cae685a045d8dbe0031568787e914fc4a3a6ac2228abf9cb5447ee41cebddfe4
+  data.tar.gz: e603e4caa7038e4b299457c8ad9e48464d6283ecaa02ac5dc383d27e7f768b2f
 SHA512:
-  metadata.gz: a81a3373767b06a74a75bc0c15edb546071d7ccbbd588f5ca5a5f075065b7ad02acbe71c90fb111e1cebf5d666798ca11b426f5222faef4bf5c33523bee14127
-  data.tar.gz: 65b26a50284f935ded2d61b895fc492d8fa04a1fd51bd45d13aa7da2aba657a8c96b4f4e7cd2595cde6ecaaa49bbf94a6c76c3c6b42c559ebd477604f20e5ce9
+  metadata.gz: b066e046f9f55034567f483b037481c933b4c754cfe776133c002f15968999f27a924ebb2ce6d726637741e734893439b6f4ec3ae1157647641be274e11273c3
+  data.tar.gz: ded6cbe85511048fc67b07aba3b6ed83610bfce88ac391e820c80ad341c3fe886e4109695dab660b6fe58dad6aaeb2460d6b882a324169d582d64c3c9ade7352

data/Gemfile.lock

@@ -1,10 +1,10 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    minitest (5.14.0)
-    mocha (1.11.2)
-    rake (13.0.1)
-    rdoc (6.2.1)
+    minitest (5.14.4)
+    mocha (1.13.0)
+    rake (13.0.6)
+    rdoc (6.3.3)
 
 PLATFORMS
   ruby
@@ -16,4 +16,4 @@ DEPENDENCIES
   rdoc
 
 BUNDLED WITH
-   2.1.4
+   2.2.28

data/README.md

@@ -1,5 +1,9 @@
 # PandocRuby
 
+[![Build Status](https://travis-ci.org/xwmx/pandoc-ruby.svg?branch=master)](https://travis-ci.org/xwmx/pandoc-ruby)
+[![Gem Version](https://img.shields.io/gem/v/pandoc-ruby)](http://rubygems.org/gems/pandoc-ruby)
+[![Gem Downloads](https://img.shields.io/gem/dt/pandoc-ruby)](http://rubygems.org/gems/pandoc-ruby)
+
 PandocRuby is a wrapper for [Pandoc](http://johnmacfarlane.net/pandoc/), a
 Haskell library with command line tools for converting one markup format to
 another.
@@ -62,11 +66,12 @@ Also provided are `#to_[writer]` instance methods for each of the writers,
 and these can also accept options:
 
 ```ruby
-PandocRuby.new("# Some title").to_html(:no_wrap)
-# => "<div id=\"some-title\"><h1>Some title</h1></div>"
+PandocRuby.new('# Example').to_html(:ascii)
+# => "<h1 id="example">Example</h1>"
 # or
-PandocRuby.new("# Some title").to_rst
-# => "Some title\n=========="
+PandocRuby.new("# Example").to_rst
+# => "Example
+#     ======="
 ```
 
 Similarly, there are class methods for each of the readers, so readers

data/lib/pandoc-ruby.rb

@@ -3,7 +3,11 @@ require 'tempfile'
 require 'timeout'
 
 class PandocRuby
-  @@pandoc_path = 'pandoc'
+  # Use the pandoc command with a custom executable path.
+  @pandoc_path = 'pandoc'
+  class << self
+    attr_accessor :pandoc_path
+  end
 
   # The available readers and their corresponding names. The keys are used to
   # generate methods and specify options to Pandoc.
@@ -112,12 +116,6 @@ class PandocRuby
   # All of the available Writers.
   WRITERS = STRING_WRITERS.merge(BINARY_WRITERS)
 
-  # To use run the pandoc command with a custom executable path, the path
-  # to the pandoc executable can be set here.
-  def self.pandoc_path=(path)
-    @@pandoc_path = path
-  end
-
   # A shortcut method that creates a new PandocRuby object and immediately
   # calls `#convert`. Options passed to this method are passed directly to
   # `#new` and treated the same as if they were passed directly to the
@@ -127,23 +125,27 @@ class PandocRuby
   end
 
   attr_writer :binary_output
+
   def binary_output
-    @binary_output ||= false
+    @binary_output  ||= false
   end
 
   attr_writer :options
+
   def options
-    @options ||= []
+    @options        ||= []
   end
 
   attr_writer :option_string
+
   def option_string
-    @option_string ||= ''
+    @option_string  ||= ''
   end
 
   attr_writer :writer
+
   def writer
-    @writer ||= 'html'
+    @writer         ||= 'html'
   end
 
   attr_accessor :input_files
@@ -159,11 +161,13 @@ class PandocRuby
   #   new(["/path/to/file.md"], :option1 => :value, :option2)
   #   new(["/to/file1.html", "/to/file2.html"], :option1 => :value)
   def initialize(*args)
-    if args[0].is_a?(String)
+    case args[0]
+    when String
       self.input_string = args.shift
-    elsif args[0].is_a?(Array)
-      self.input_files = args.shift.join(' ')
+    when Array
+      self.input_files  = args.shift.join(' ')
     end
+
     self.options = args
   end
 
@@ -179,8 +183,9 @@ class PandocRuby
   #   PandocRuby.new("# text").convert
   #   # => "<h1 id=\"text\">text</h1>\n"
   def convert(*args)
-    self.options += args if args
-    self.option_string = prepare_options(self.options)
+    self.options        +=  args if args
+    self.option_string  =   prepare_options(self.options)
+
     if self.binary_output
       convert_binary
     else
@@ -201,6 +206,7 @@ class PandocRuby
     READERS.each_key do |r|
       define_method(r) do |*args|
         args += [{ :from => r }]
+
         new(*args)
       end
     end
@@ -218,6 +224,7 @@ class PandocRuby
   WRITERS.each_key do |w|
     define_method(:"to_#{w}") do |*args|
       args += [{ :to => w.to_sym }]
+
       convert(*args)
     end
   end
@@ -229,13 +236,17 @@ class PandocRuby
     # temp file is closed and unlinked.
     def convert_binary
       tmp_file = Tempfile.new('pandoc-conversion')
+
       begin
-        self.options += [{ :output => tmp_file.path }]
-        self.option_string = "#{self.option_string} --output #{tmp_file.path}"
+        self.options        +=  [{ :output => tmp_file.path }]
+        self.option_string  =   "#{self.option_string} --output \"#{tmp_file.path}\""
+
         execute_pandoc
+
         return IO.binread(tmp_file)
       ensure
         tmp_file.close
+
         tmp_file.unlink
       end
     end
@@ -248,30 +259,33 @@ class PandocRuby
     # Wrapper to run pandoc in a consistent, DRY way
     def execute_pandoc
       if !self.input_files.nil?
-        execute("#{@@pandoc_path} #{self.input_files}#{self.option_string}")
+        execute("#{PandocRuby.pandoc_path} #{self.input_files}#{self.option_string}")
       else
-        execute("#{@@pandoc_path}#{self.option_string}")
+        execute("#{PandocRuby.pandoc_path}#{self.option_string}")
       end
     end
 
     # Run the command and returns the output.
     def execute(command)
       output = error = exit_status = nil
-      @timeout ||= 31_557_600 # A year should be enough?
+
+      @timeout ||= 31_557_600
+
       Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
-        begin
-          Timeout.timeout(@timeout) do
-            stdin.puts self.input_string
-            stdin.close
-            output = stdout.read
-            error = stderr.read
-            exit_status = wait_thr.value
-          end
-        rescue Timeout::Error => ex
-          Process.kill 9, wait_thr.pid
-          maybe_ex = "\n#{ex}" if ex
-          error = "Pandoc timed out after #{@timeout} seconds.#{maybe_ex}"
+        Timeout.timeout(@timeout) do
+          stdin.puts self.input_string
+
+          stdin.close
+
+          output      = stdout.read
+          error       = stderr.read
+          exit_status = wait_thr.value
         end
+      rescue Timeout::Error => ex
+        Process.kill 9, wait_thr.pid
+
+        maybe_ex  = "\n#{ex}" if ex
+        error     = "Pandoc timed out after #{@timeout} seconds.#{maybe_ex}"
       end
 
       raise error unless exit_status && exit_status.success?
@@ -305,10 +319,8 @@ class PandocRuby
 
       if argument.nil?
         format_flag(flag)
-      elsif argument.to_s =~ /\s/
-        "#{format_flag(flag)} \"#{argument}\""
       else
-        "#{format_flag(flag)} #{argument}"
+        "#{format_flag(flag)} \"#{argument}\""
       end
     end
 
@@ -329,8 +341,8 @@ class PandocRuby
     def set_pandoc_ruby_options(flag, argument = nil)
       case flag
       when 't', 'to'
-        self.writer = argument.to_s
-        self.binary_output = true if BINARY_WRITERS.key?(self.writer)
+        self.writer         = argument.to_s
+        self.binary_output  = true if BINARY_WRITERS.key?(self.writer)
       when 'timeout'
         @timeout = argument
       end

data/pandoc-ruby.gemspec

@@ -5,9 +5,9 @@
 
 Gem::Specification.new do |s|
   s.name = 'pandoc-ruby'
-  s.version = '2.1.4'
+  s.version = '2.1.5'
   s.authors = ['William Melody']
-  s.date = '2020-03-25'
+  s.date = '2021-11-13'
   s.description = 'Ruby wrapper for Pandoc'
   s.email = 'hi@williammelody.com'
   s.extra_rdoc_files = [

data/test/test_conversions.rb

@@ -23,7 +23,8 @@ describe 'Conversions' do
           :from => from,
           :to   => to
         )
-        assert_equal(converted_content.strip, to_content.strip)
+
+        assert_equal(to_content.strip, converted_content.strip)
       end
     end
   end
@@ -47,7 +48,7 @@ describe 'Conversions' do
         )
       end
 
-      assert_match(/couldn't parse docx file/, error.message)
+      assert_match(/couldn't unpack docx container/, error.message)
     end
 
     it "raises an error when attempting to convert doc with doc format" do

data/test/test_pandoc_ruby.rb

@@ -2,10 +2,10 @@ 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)
+    @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
@@ -14,15 +14,20 @@ describe PandocRuby do
 
   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
 
@@ -45,50 +50,66 @@ describe PandocRuby do
   end
 
   it 'accepts short options' do
-    @converter.expects(:execute).with('pandoc -t rst').returns(true)
+    @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)
+
+    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') \
+    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') \
+
+    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 args 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') \
+    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
 
@@ -97,9 +118,11 @@ describe PandocRuby do
       @string,
       '+RTS', '-M512M', '-RTS', '--to=markdown', '--no-wrap'
     )
+
     converter.expects(:execute).with(
       'pandoc +RTS -M512M -RTS --to=markdown --no-wrap'
     ).returns(true)
+
     assert converter.convert
   end
 
@@ -112,6 +135,7 @@ describe PandocRuby do
       ),
       "<p>Line 1</p>\n<h1>Heading</h1>\n"
     )
+
     assert_equal(
       PandocRuby.convert(
         "Line 1\n# Heading",
@@ -131,6 +155,7 @@ describe PandocRuby do
       ),
       "~example~\n"
     )
+
     assert_equal(
       PandocRuby.convert(
         "<sub>example</sub>\n",
@@ -149,7 +174,9 @@ describe PandocRuby do
         :to     => 'html',
         :output => file.path
       )
+
       file.rewind
+
       assert_equal("<h1 id=\"example\">Example</h1>\n", file.read)
     end
   end
@@ -162,10 +189,13 @@ describe PandocRuby do
         :to     => 'html',
         :output => file.path
       )
-      converter \
-        .expects(:execute) \
-        .with("pandoc --from markdown --to html --output \"#{file.path}\"") \
-        .returns(true)
+
+      converter             \
+        .expects(:execute)  \
+        .with(
+          "pandoc --from \"markdown\" --to \"html\" --output \"#{file.path}\""
+        ).returns(true)
+
       assert converter.convert
     end
   end
@@ -180,6 +210,7 @@ describe PandocRuby do
       )
 
       file.rewind
+
       assert_equal("<h1 id=\"example\">Example</h1>\n", file.read)
     end
   end
@@ -192,10 +223,13 @@ describe PandocRuby do
         :to     => 'html',
         :output => Pathname.new(file.path)
       )
-      converter \
-        .expects(:execute) \
-        .with("pandoc --from markdown --to html --output \"#{file.path}\"") \
-        .returns(true)
+
+      converter             \
+        .expects(:execute)  \
+        .with(
+          "pandoc --from \"markdown\" --to \"html\" --output \"#{file.path}\""
+        ).returns(true)
+
       assert converter.convert
     end
   end
@@ -208,7 +242,9 @@ describe PandocRuby do
         :to     => 'html',
         :output => Pathname.new(file.path)
       )
+
       file.rewind
+
       assert_equal("<h1 id=\"example\">Example</h1>\n", file.read)
     end
   end
@@ -222,7 +258,9 @@ describe PandocRuby do
   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)
+
+      converter.expects(:execute).with("pandoc --from \"#{r}\"").returns(true)
+
       assert converter.convert
     end
   end
@@ -230,10 +268,12 @@ describe PandocRuby do
   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}") \
+
+      converter                                 \
+        .expects(:execute)                      \
+        .with("pandoc --no-wrap --to \"#{w}\"") \
         .returns(true)
+
       assert converter.send("to_#{w}", :no_wrap)
     end
   end
@@ -241,26 +281,31 @@ describe PandocRuby do
   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 /)) \
+
+      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 'accepts blank strings' do
     converter = PandocRuby.new('')
+
     assert_match("\n", converter.convert)
   end
 
   it 'accepts nil and treats like a blank string' do
     converter = PandocRuby.new(nil)
+
     assert_match("\n", converter.convert)
   end
 
@@ -273,21 +318,20 @@ describe PandocRuby do
   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
+    400.times do
+      PandocRuby.convert(@string)
     end
+
+    assert true
+  rescue Errno::EMFILE, Errno::EAGAIN => e
+    flunk e
   end
 
   it 'gracefully times out when pandoc hangs due to malformed input' do
-    skip(%(
-Pandoc no longer times out with test file. Determine how to test.
-    ))
+    skip('Pandoc no longer times out with test file. Determine how to test.')
+
     file = File.join(File.dirname(__FILE__), 'files', 'bomb.tex')
+
     contents = File.read(file)
 
     assert_raises(RuntimeError) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandoc-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - William Melody
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2021-11-13 00:00:00.000000000 Z
 dependencies: []
 description: Ruby wrapper for Pandoc
 email: hi@williammelody.com
@@ -36,7 +36,7 @@ homepage: http://github.com/xwmx/pandoc-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: PandocRuby
 test_files: []