paru 0.2.5.2 → 0.2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 123f1097edc329ac82a90778e260cc336e6b5bd3
-  data.tar.gz: 0427bccc5044f30c371671be6ad347179a2f2428
+  metadata.gz: 2f4e0a6ab8839d2b19d005de0d8caacbd5c87244
+  data.tar.gz: 8d358a982f09cb62b309d3cced5183bf6ff16c89
 SHA512:
-  metadata.gz: 9b46f6684ac0f14248396a58a473309259837718c92ee97a52ac61e8870aa78e7f04033e6e50e699938f6e07c0fb10d26fc57da69e116d60a9634fc8ae764519
-  data.tar.gz: 408f1a79436fe4431e2c94cdb567718a27b77a37a17b96539bafb7a2646cb14cf271c2c9aff138ee08cd86fa7ed1eff78e229f8db38dfe652a451e75bcb1450e
+  metadata.gz: a86c52201e8e4451ee4b7175bb5fece4c23b451302db3f56e9b887498427b08a19465631eb7da68edf236e6d8a2368bd8fec8417a70d6b98f77e8fb26855d26c
+  data.tar.gz: 05a2a5b0c2d426d73b69c6d33203a64681096070f48e586c9f5f02bde453199a5426ef08a52597bfdab17ca0fb75e97da042086e668ad08fc4fcc7b099f35975

data/lib/paru.rb

@@ -18,5 +18,5 @@
 #++
 module Paru
     # Paru's current version
-    VERSION = [0, 2, 5, 2]
+    VERSION = [0, 2, 5, 3]
 end

data/lib/paru/pandoc.rb

@@ -137,7 +137,9 @@ module Paru
         # configured in this Pandoc instance.
         #
         # @param input [String] the input string to convert
-        # @return [String] the converted output string
+        # @return [String] the converted output as a string. Note. For some
+        # formats, output to STDOUT is not supported (see pandoc's manual) and
+        # the result string will be empty.
         #
         # The following two examples are the same:
         #
@@ -161,6 +163,31 @@ module Paru
         end
         alias << convert
 
+        # Converts an input file to output string using the pandoc invocation
+        # configured in this Pandoc instance. The path to the input file is
+        # appended to that invocation.
+        #
+        # @param input_file [String] the path to the input file to convert
+        # @return [String] the converted output as a string. Note. For some
+        # formats, output to STDOUT is not supported (see pandoc's manual) and
+        # the result string will be empty.
+        #
+        # @example Using convert_file
+        #   output = converter.convert_file 'files/document.md'
+        def convert_file(input_file)
+            command = "#{to_command} #{input_file}"
+            begin
+                output = ''
+                IO.popen(command, 'r+') do |p|
+                    p.close_write
+                    output << p.read
+                end
+                output
+            rescue StandardError => err
+                throw Error.new "Error while running '#{command}' on input:\n\n#{input}\n\nPandoc responds: '#{err.message}'"
+            end
+        end
+
         # Create a string representation of this converter's pandoc command
         # line invocation. This is useful for debugging purposes.
         #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paru
 version: !ruby/object:Gem::Version
-  version: 0.2.5.2
+  version: 0.2.5.3
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Use Pandoc (http://www.pandoc.org) with ruby
 email: Huub@heerdebeer.org