pandoc-ruby 2.0.1 → 2.1.10

data/lib/pandoc-ruby.rb

@@ -3,66 +3,133 @@ 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.
   READERS = {
-    'native'   => 'pandoc native',
-    'json'     => 'pandoc JSON',
-    'markdown' => 'markdown',
-    'rst'      => 'reStructuredText',
-    'textile'  => 'textile',
-    'html'     => 'HTML',
-    'latex'    => 'LaTeX'
+    'biblatex'          => 'BibLaTeX bibliography',
+    'bibtex'            => 'BibTeX bibliography',
+    'commonmark'        => 'CommonMark Markdown',
+    'commonmark_x'      => 'CommonMark Markdown with extensions',
+    'creole'            => 'Creole 1.0',
+    'csljson'           => 'CSL JSON bibliography',
+    'csv'               => 'CSV table',
+    'docbook'           => 'DocBook',
+    'docx'              => 'Word docx',
+    'dokuwiki'          => 'DokuWiki markup',
+    'endnotexml'        => 'EndNote XML bibliography',
+    'epub'              => 'EPUB',
+    'fb2'               => 'FictionBook2 e-book',
+    'gfm'               => 'GitHub-Flavored Markdown',
+    'haddock'           => 'Haddock markup',
+    'html'              => 'HTML',
+    'ipynb'             => 'Jupyter notebook',
+    'jats'              => 'JATS XML',
+    'jira'              => 'Jira wiki markup',
+    'json'              => 'JSON version of native AST',
+    'latex'             => 'LaTex',
+    'man'               => 'roff man',
+    'markdown'          => "Pandoc's Markdown",
+    'markdown_mmd'      => 'MultiMarkdown',
+    'markdown_phpextra' => 'PHP Markdown Extra',
+    'markdown_strict'   => 'original unextended Markdown',
+    'mediawiki'         => 'MediaWiki markup',
+    'muse'              => 'Muse',
+    'native'            => 'native Haskell',
+    'odt'               => 'ODT',
+    'opml'              => 'OPML',
+    'org'               => 'Emacs Org mode',
+    'ris'               => 'RIS bibliography',
+    'rst'               => 'reStructuredText',
+    'rtf'               => 'Rich Text Format',
+    't2t'               => 'txt2tags',
+    'textile'           => 'Textile',
+    'tikiwiki'          => 'TikiWiki markup',
+    'tsv'               => 'TSV table',
+    'twiki'             => 'TWiki markup',
+    'vimwiki'           => 'Vimwiki'
   }.freeze
 
   # The available string writers and their corresponding names. The keys are
   # used to generate methods and specify options to Pandoc.
   STRING_WRITERS = {
-    'native'        => 'pandoc native',
-    'json'          => 'pandoc JSON',
-    'html'          => 'HTML',
-    'html5'         => 'HTML5',
-    's5'            => 'S5 HTML slideshow',
-    'slidy'         => 'Slidy HTML slideshow',
-    'dzslides'      => 'Dzslides HTML slideshow',
-    'docbook'       => 'DocBook XML',
-    'opendocument'  => 'OpenDocument XML',
-    'latex'         => 'LaTeX',
-    'beamer'        => 'Beamer PDF slideshow',
-    'context'       => 'ConTeXt',
-    'texinfo'       => 'GNU Texinfo',
-    'man'           => 'groff man',
-    'markdown'      => 'markdown',
-    'plain'         => 'plain',
-    'rst'           => 'reStructuredText',
-    'mediawiki'     => 'MediaWiki markup',
-    'textile'       => 'textile',
-    'rtf'           => 'rich text format',
-    'org'           => 'emacs org mode',
-    'asciidoc'      => 'asciidoc'
+    'asciidoc'              => 'AsciiDoc',
+    'asciidoctor'           => 'AsciiDoctor',
+    'beamer'                => 'LaTeX beamer slide show',
+    'biblatex'              => 'BibLaTeX bibliography',
+    'bibtex'                => 'BibTeX bibliography',
+    'chunkedhtml'           => 'zip archive of multiple linked HTML files',
+    'commonmark'            => 'CommonMark Markdown',
+    'commonmark_x'          => 'CommonMark Markdown with extensions',
+    'context'               => 'ConTeXt',
+    'csljson'               => 'CSL JSON bibliography',
+    'docbook'               => 'DocBook 4',
+    'docbook4'              => 'DocBook 4',
+    'docbook5'              => 'DocBook 5',
+    'dokuwiki'              => 'DokuWiki markup',
+    'fb2'                   => 'FictionBook2 e-book',
+    'gfm'                   => 'GitHub-Flavored Markdown',
+    'haddock'               => 'Haddock markup',
+    'html'                  => 'HTML, i.e.  HTML5/XHTML polyglot markup',
+    'html5'                 => 'HTML, i.e.  HTML5/XHTML polyglot markup',
+    'html4'                 => 'XHTML 1.0 Transitional',
+    'icml'                  => 'InDesign ICML',
+    'ipynb'                 => 'Jupyter notebook',
+    'jats_archiving'        => 'JATS XML, Archiving and Interchange Tag Set',
+    'jats_articleauthoring' => 'JATS XML, Article Authoring Tag Set',
+    'jats_publishing'       => 'JATS XML, Journal Publishing Tag Set',
+    'jats'                  => 'alias for jats_archiving',
+    'jira'                  => 'Jira wiki markup',
+    'json'                  => 'JSON version of native AST',
+    'latex'                 => 'LaTex',
+    'man'                   => 'roff man',
+    'markdown'              => "Pandoc's Markdown",
+    'markdown_mmd'          => 'MultiMarkdown',
+    'markdown_phpextra'     => 'PHP Markdown Extra',
+    'markdown_strict'       => 'original unextended Markdown',
+    'markua'                => 'Markua',
+    'mediawiki'             => 'MediaWiki markup',
+    'ms'                    => 'roff ms',
+    'muse'                  => 'Muse',
+    'native'                => 'native Haskell',
+    'opml'                  => 'OPML',
+    'opendocument'          => 'OpenDocument',
+    'org'                   => 'Emacs Org mode',
+    'pdf'                   => 'PDF',
+    'plain'                 => 'plain text',
+    'pptx'                  => 'PowerPoint slide show',
+    'rst'                   => 'reStructuredText',
+    'rtf'                   => 'Rich Text Format',
+    'texinfo'               => 'GNU Texinfo',
+    'textile'               => 'Textile',
+    'slideous'              => 'Slideous HTML and JavaScript slide show',
+    'slidy'                 => 'Slidy HTML and JavaScript slide show',
+    'dzslides'              => 'DZSlides HTML5 + JavaScript slide show',
+    'revealjs'              => 'reveal.js HTML5 + JavaScript slide show',
+    's5'                    => 'S5 HTML and JavaScript slide show',
+    'tei'                   => 'TEI Simple',
+    'xwiki'                 => 'XWiki markup',
+    'zimwiki'               => 'ZimWiki markup'
   }.freeze
 
   # The available binary writers and their corresponding names. The keys are
   # used to generate methods and specify options to Pandoc.
   BINARY_WRITERS = {
-    'odt'   => 'OpenDocument',
+    'odt'   => 'OpenOffice text document',
     'docx'  => 'Word docx',
-    'epub'  => 'EPUB V2',
-    'epub3' => 'EPUB V3'
+    'epub'  => 'EPUB v3',
+    'epub2' => 'EPUB v2',
+    'epub3' => 'EPUB v3'
   }.freeze
 
   # 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
@@ -71,26 +138,33 @@ class PandocRuby
     new(*args).convert
   end
 
+  attr_writer :binary_output
+
+  def binary_output
+    @binary_output  ||= false
+  end
+
   attr_writer :options
+
   def options
-    @options ||= []
+    @options        ||= []
   end
 
   attr_writer :option_string
-  def option_string
-    @option_string ||= ''
-  end
 
-  attr_writer :binary_output
-  def binary_output
-    @binary_output ||= false
+  def option_string
+    @option_string  ||= ''
   end
 
   attr_writer :writer
+
   def writer
-    @writer ||= 'html'
+    @writer         ||= 'html'
   end
 
+  attr_accessor :input_files
+  attr_accessor :input_string
+
   # Create a new PandocRuby converter object. The first argument contains the
   # input either as string or as an array of filenames.
   #
@@ -101,14 +175,13 @@ class PandocRuby
   #   new(["/path/to/file.md"], :option1 => :value, :option2)
   #   new(["/to/file1.html", "/to/file2.html"], :option1 => :value)
   def initialize(*args)
-    @input_string = nil
-    @input_files = nil
-
-    if args[0].is_a?(String)
-      @input_string = args.shift
-    elsif args[0].is_a?(Array)
-      @input_files = args.shift.join(' ')
+    case args[0]
+    when String
+      self.input_string = args.shift
+    when Array
+      self.input_files  = args.shift.map { |f| "'#{f}'" }.join(' ')
     end
+
     self.options = args
   end
 
@@ -124,8 +197,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
@@ -146,6 +220,7 @@ class PandocRuby
     READERS.each_key do |r|
       define_method(r) do |*args|
         args += [{ :from => r }]
+
         new(*args)
       end
     end
@@ -163,6 +238,7 @@ class PandocRuby
   WRITERS.each_key do |w|
     define_method(:"to_#{w}") do |*args|
       args += [{ :to => w.to_sym }]
+
       convert(*args)
     end
   end
@@ -174,13 +250,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
@@ -192,36 +272,40 @@ class PandocRuby
 
     # Wrapper to run pandoc in a consistent, DRY way
     def execute_pandoc
-      if ! @input_files.nil?
-        execute("#{@@pandoc_path} #{@input_files}#{self.option_string}")
+      if !self.input_files.nil?
+        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
-            unless @input_string.nil?
-              stdin.puts @input_string
-              stdin.close
-            end
-            output = stdout.read
-            error = stderr.read
+            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}"
+
+          maybe_ex  = "\n#{ex}" if ex
+          error     = "Pandoc timed out after #{@timeout} seconds.#{maybe_ex}"
         end
       end
 
       raise error unless exit_status && exit_status.success?
+
       output
     end
 
@@ -229,14 +313,13 @@ class PandocRuby
     # opts passed in. Recursively calls itself in order to handle hash options.
     def prepare_options(opts = [])
       opts.inject('') do |string, (option, value)|
-        string += case
-                  when value
-                    create_option(option, value)
-                  when option.respond_to?(:each_pair)
-                    prepare_options(option)
-                  else
-                    create_option(option)
-                  end
+        string + if value
+                   create_option(option, value)
+                 elsif option.respond_to?(:each_pair)
+                   prepare_options(option)
+                 else
+                   create_option(option)
+                 end
       end
     end
 
@@ -245,13 +328,15 @@ class PandocRuby
     # command line options. If the option has an argument, it is also included.
     def create_option(flag, argument = nil)
       return '' unless flag
+
       flag = flag.to_s
       set_pandoc_ruby_options(flag, argument)
       return '' if flag == 'timeout' # pandoc doesn't accept timeouts yet
-      if !argument.nil?
-        "#{format_flag(flag)} #{argument}"
-      else
+
+      if argument.nil?
         format_flag(flag)
+      else
+        "#{format_flag(flag)} \"#{argument}\""
       end
     end
 
@@ -260,6 +345,8 @@ class PandocRuby
     def format_flag(flag)
       if flag.length == 1
         " -#{flag}"
+      elsif flag =~ /^-|\+/
+        " #{flag}"
       else
         " --#{flag.to_s.tr('_', '-')}"
       end
@@ -270,11 +357,10 @@ 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.keys.include?(self.writer)
+        self.writer         = argument.to_s
+        self.binary_output  = true if BINARY_WRITERS.key?(self.writer)
       when 'timeout'
         @timeout = argument
       end
     end
-
 end

data/pandoc-ruby.gemspec

@@ -5,18 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = 'pandoc-ruby'
-  s.version = '2.0.1'
-
-  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.version = '2.1.10'
   s.authors = ['William Melody']
-  s.date = '2016-05-04'
+  s.date = '2023-11-24'
   s.description = 'Ruby wrapper for Pandoc'
   s.email = 'hi@williammelody.com'
   s.extra_rdoc_files = [
     'LICENSE',
     'README.md'
   ]
-  s.files = %w(
+  s.files = %w[
     .document
     Gemfile
     Gemfile.lock
@@ -27,36 +25,15 @@ Gem::Specification.new do |s|
     pandoc-ruby.gemspec
     test/benchmark.rb
     test/files/benchmark.txt
-    test/files/test.md
+    test/files/Test\ File\ 1.md
+    test/files/Test\ File\ 2.md
     test/helper.rb
     test/test_conversions.rb
     test/test_pandoc_ruby.rb
-  )
-  s.homepage = 'http://github.com/alphabetum/pandoc-ruby'
+  ]
+  s.homepage = 'http://github.com/xwmx/pandoc-ruby'
   s.licenses = ['MIT']
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 1.9.3'
-  s.rubygems_version = '1.8.25'
+  s.required_ruby_version = '>= 2.2'
   s.summary = 'PandocRuby'
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      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('minitest', '~>5.8.3', '>= 5.8.3')
-    else
-      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('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

@@ -6,10 +6,10 @@
 iterations = 100
 test_file = File.join(File.dirname(__FILE__), 'files', 'benchmark.txt')
 impl_gems = {
-  'BlueCloth'   => 'bluecloth',
-  'RDiscount'   => 'rdiscount',
-  'Maruku'      => 'maruku',
-  'PandocRuby'  => 'pandoc-ruby'
+  'BlueCloth'  => 'bluecloth',
+  'RDiscount'  => 'rdiscount',
+  'Maruku'     => 'maruku',
+  'PandocRuby' => 'pandoc-ruby'
 }
 
 implementations = impl_gems.keys

data/test/files/Test File 2.md

@@ -0,0 +1 @@
+# A Second Title

data/test/helper.rb

@@ -3,13 +3,13 @@ require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'minitest/autorun'
 require 'minitest/pride'
-require 'mocha/setup'
+require 'mocha/minitest'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_conversions.rb

@@ -23,8 +23,59 @@ describe 'Conversions' do
           :from => from,
           :to   => to
         )
-        assert_equal(converted_content.strip, to_content.strip)
+
+        assert_equal(
+          to_content.strip,
+          converted_content.strip,
+          <<-HEREDOC
+---------
+EXPECTED:
+---------
+#{to_content.strip}
+---------
+-------
+ACTUAL:
+-------
+#{converted_content.strip}
+-------
+          HEREDOC
+        )
       end
     end
   end
+
+  describe '.docx' do
+    it "converts from docx to html" do
+      converted_content = PandocRuby.convert(
+        ['./test/files/reference.docx'],
+        :from => 'docx',
+        :to   => 'html'
+      )
+      assert_equal("<p>Hello World.</p>", converted_content.strip)
+    end
+
+    it "raises an error when attempting to convert doc with docx format" do
+      error = assert_raises(RuntimeError) do
+        PandocRuby.convert(
+          ['./test/files/reference.doc'],
+          :from => 'docx',
+          :to   => 'html'
+        )
+      end
+
+      assert_match(/couldn't unpack docx container/, error.message)
+    end
+
+    it "raises an error when attempting to convert doc with doc format" do
+      error = assert_raises(RuntimeError) do
+        PandocRuby.convert(
+          ['./test/files/reference.doc'],
+          :from => 'doc',
+          :to   => 'html'
+        )
+      end
+
+      assert_match(/Pandoc can convert from DOCX, but not from DOC./, error.message)
+    end
+  end
 end