pandoc-ruby 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 650e0986f59f42561631dfdce08087dceb3de5e5b29e1f14172238aa035ea364
-  data.tar.gz: e8b2c8d850877561d3c7336fdc9aa1ae2f3282be0f3e8f7de12211f7d64c0bc1
+  metadata.gz: 7ec374a42893d6b60b7b22ab158a0c1aaa5eaad560523ff4f9fb57272587f20d
+  data.tar.gz: f6c841353fa08a7182276fff06eb5bcef5e36d95a3560ca3ae7114048ac48156
 SHA512:
-  metadata.gz: 8bf133e569fcdcd1bff4367d532cf076677e6535e803fe737034871897a6b4ec25994a3a9c56f3913510d32c7d7560142881ab852b6d989bd7f491a4d0fac579
-  data.tar.gz: fa7eb59f4b16126a3b838dfd91932080a0ff2eb7a9613f7c7a6041c1dfa74831fc56d3af87d60fbc4916449aa620d3e99cdf613cf119b32421e154d63d134d9f
+  metadata.gz: a81a3373767b06a74a75bc0c15edb546071d7ccbbd588f5ca5a5f075065b7ad02acbe71c90fb111e1cebf5d666798ca11b426f5222faef4bf5c33523bee14127
+  data.tar.gz: 65b26a50284f935ded2d61b895fc492d8fa04a1fd51bd45d13aa7da2aba657a8c96b4f4e7cd2595cde6ecaaa49bbf94a6c76c3c6b42c559ebd477604f20e5ce9

data/README.md

@@ -4,29 +4,31 @@ PandocRuby is a wrapper for [Pandoc](http://johnmacfarlane.net/pandoc/), a
 Haskell library with command line tools for converting one markup format to
 another.
 
-Pandoc can convert documents in markdown, reStructuredText, textile, HTML,
-DocBook, LaTeX, or MediaWiki markup to a variety of formats, including
-markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML,
-OpenDocument XML, ODT, GNU Texinfo, MediaWiki markup, groff man pages,
-HTML slide shows, EPUB, and Microsoft Word docx.
+Pandoc can convert documents from a variety of formats including markdown,
+reStructuredText, textile, HTML, DocBook, LaTeX, and MediaWiki markup to a
+variety of other formats, including markdown, reStructuredText, HTML, LaTeX,
+ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, MediaWiki
+markup, groff man pages, HTML slide shows, EPUB, Microsoft Word docx, and more.
 
 ## Installation
 
-First, make sure to
-[install Pandoc](http://johnmacfarlane.net/pandoc/installing.html).
+First, [install Pandoc](http://johnmacfarlane.net/pandoc/installing.html).
 
-Next, add PandocRuby to your Gemfile
+PandocRuby is available on [RubyGems](http://rubygems.org/gems/pandoc-ruby):
 
-```ruby
-gem 'pandoc-ruby'
+```bash
+gem install pandoc-ruby
 ```
 
-or install PandocRuby from [RubyGems](http://rubygems.org/gems/pandoc-ruby).
+To install with [Bundler](https://bundler.io/), add the following to your
+Gemfile:
 
-```bash
-gem install pandoc-ruby
+```ruby
+gem 'pandoc-ruby'
 ```
 
+Then run `bundle install`
+
 ## Usage
 
 ```ruby
@@ -35,7 +37,7 @@ require 'pandoc-ruby'
 puts @converter.convert
 ```
 
-This takes the Markdown formatted file and converts it to reStructuredText.
+This takes the Markdown formatted string and converts it to reStructuredText.
 
 You can also use the `#convert` class method:
 
@@ -44,8 +46,7 @@ puts PandocRuby.convert('# Markdown Title', from: :markdown, to: :html)
 ```
 
 Other arguments are simply converted into command line options, accepting
-symbols or strings for options without arguments and hashes of strings or
-symbols for options with arguments.
+symbols and strings for options and hashes for options with arguments.
 
 ```ruby
 PandocRuby.convert('# Markdown Title', :s, {f: :markdown, to: :rst}, '--wrap=none', :table_of_contents)
@@ -76,7 +77,14 @@ PandocRuby.html("<h1>hello</h1>").to_latex
 # => "\\section{hello}"
 ```
 
-PandocRuby assumes the `pandoc` executable is via your environment's `$PATH`
+Available readers and writers are can be found in the following
+variables:
+- [`PandocRuby::READERS`](lib/pandoc-ruby.rb#L10)
+- [`PandocRuby::STRING_WRITERS`](lib/pandoc-ruby.rb#L48)
+- [`PandocRuby::BINARY_WRITERS`](lib/pandoc-ruby.rb#L104)
+- [`PandocRuby::WRITERS`](lib/pandoc-ruby.rb#L113)
+
+PandocRuby assumes the `pandoc` executable is in your environment's `$PATH`
 variable.  If you'd like to set an explicit path to the `pandoc` executable,
 you can do so with  `PandocRuby.pandoc_path = '/path/to/pandoc'`
 
@@ -108,20 +116,17 @@ used to modify the behavior of readers and writers. To use an extension,
 add the extension with a `+` or `-` after the reader or writer name:
 
 ```ruby
-# Without extension
+# Without extension:
 PandocRuby.new("Line 1\n# Heading", from: 'markdown_strict').to_html
 # => "<p>Line 1</p>\n<h1>Heading</h1>\n"
 
-# With extension:
->> PandocRuby.new("Line 1\n# Heading", from: 'markdown_strict+blank_before_header').to_html
+# With `+blank_before_header` extension:
+PandocRuby.new("Line 1\n# Heading", from: 'markdown_strict+blank_before_header').to_html
 # => "<p>Line 1 # Heading</p>\n
 ```
 
 ### More Information
 
-Available format readers and writers are available in the `PandocRuby::READERS`
-and `PandocRuby::WRITERS` constants.
-
 For more information on Pandoc, see the
 [Pandoc documentation](http://johnmacfarlane.net/pandoc/)
 or run `man pandoc`

data/lib/pandoc-ruby.rb

@@ -305,8 +305,8 @@ class PandocRuby
 
       if argument.nil?
         format_flag(flag)
-      elsif argument =~ /\s/
-        "#{format_flag(flag)} '#{argument}'"
+      elsif argument.to_s =~ /\s/
+        "#{format_flag(flag)} \"#{argument}\""
       else
         "#{format_flag(flag)} #{argument}"
       end

data/pandoc-ruby.gemspec

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

data/test/test_pandoc_ruby.rb

@@ -154,7 +154,23 @@ describe PandocRuby do
     end
   end
 
-  it 'supports output filenames without spaces' do
+  it 'quotes output filenames with spaces' do
+    Tempfile.create('example with spaces') do |file|
+      converter = PandocRuby.new(
+        '# Example',
+        :from   => 'markdown',
+        :to     => 'html',
+        :output => file.path
+      )
+      converter \
+        .expects(:execute) \
+        .with("pandoc --from markdown --to html --output \"#{file.path}\"") \
+        .returns(true)
+      assert converter.convert
+    end
+  end
+
+  it 'outputs to filenames with spaces' do
     Tempfile.create('example with spaces') do |file|
       PandocRuby.convert(
         '# Example',
@@ -162,6 +178,36 @@ describe PandocRuby do
         :to     => 'html',
         :output => file.path
       )
+
+      file.rewind
+      assert_equal("<h1 id=\"example\">Example</h1>\n", file.read)
+    end
+  end
+
+  it 'quotes output filenames as Pathname objects' do
+    Tempfile.create('example with spaces') do |file|
+      converter = PandocRuby.new(
+        '# Example',
+        :from   => 'markdown',
+        :to     => 'html',
+        :output => Pathname.new(file.path)
+      )
+      converter \
+        .expects(:execute) \
+        .with("pandoc --from markdown --to html --output \"#{file.path}\"") \
+        .returns(true)
+      assert converter.convert
+    end
+  end
+
+  it 'outputs to filenames as Pathname objects' do
+    Tempfile.create('example with spaces') do |file|
+      PandocRuby.convert(
+        '# Example',
+        :from   => 'markdown',
+        :to     => 'html',
+        :output => Pathname.new(file.path)
+      )
       file.rewind
       assert_equal("<h1 id=\"example\">Example</h1>\n", file.read)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandoc-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.4
 platform: ruby
 authors:
 - William Melody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies: []
 description: Ruby wrapper for Pandoc
 email: hi@williammelody.com