pandocomatic 0.2.0.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afacaad785c7eb45360aa50f87d46ceb667f9cda
-  data.tar.gz: 2f9084e8580106a270eb95c48f2820f6770cf346
+  metadata.gz: 8300ffdd25e759cb2192d95cf3d152b65618507b
+  data.tar.gz: 72e11c0aeb38ccc9d0e88f93e24132a70f500a3a
 SHA512:
-  metadata.gz: 5f25fbb7ff1e67a1f2468892cbdd75ef18e63b303379577c4bc90e8be7dc0f50c513dc7b990096a6c803f3f45d884ac030b47e672cda28463f850901336d53fe
-  data.tar.gz: 509fc4307ed88c20a95a23d737838706175626c48bebdcc85cd3aeb279498966fe590d34540f0446b407d575161a554a5e4b17aea8c0656ca32428f8a416891c
+  metadata.gz: d72562edd9458bf74660ac5c9446dfa861a79a66c79bf940a95deeada6034837fa4f9b28a5dd81f7a05d5fb82d9f47dcd68cf9a5edd2e59fb3d15e7aa8dd84e0
+  data.tar.gz: c6b9a79dced50944bd7003c2490c9d6cca3d07377f47b9acffea82f6fa3f15b60b4ed9333a5e40c4a7b37580f38086a004ad38b2cbbc9b3913f0e44fbb62162c

data/lib/pandocomatic/command/convert_file_command.rb

@@ -36,7 +36,7 @@ module Pandocomatic
     require_relative 'command.rb'
 
     # Output formats used in pandocomatic
-    OUTPUT_FORMATS = ["docx", "odt", "pdf", "beamer"]
+    OUTPUT_FORMATS = ["docx", "odt", "pdf", "epub", "epub3", "epub2"]
 
     # Command to convert a file
     #
@@ -74,7 +74,7 @@ module Pandocomatic
             end
             
             @metadata = PandocMetadata.load_file @src
-            @dst = @config.set_extension @dst, @template_name, @metadata
+            @dst = @config.set_destination @dst, @template_name, @metadata
 
             @errors.push IOError.new(:file_does_not_exist, nil, @src) unless File.exist? @src
             @errors.push IOError.new(:file_is_not_a_file, nil, @src) unless File.file? @src
@@ -134,7 +134,7 @@ module Pandocomatic
             end
 
             begin
-                unless OUTPUT_FORMATS.include? pandoc_options["to"] then
+                unless use_output_option @dst then
                     File.open(@dst, 'w') do |file| 
                         raise IOError.new(:file_is_not_a_file, nil, @dst) unless File.file? @dst
                         raise IOError.new(:file_is_not_writable, nil, @dst) unless File.writable? @dst
@@ -199,14 +199,14 @@ module Pandocomatic
                         # Pandoc multi-word options can have the multiple words separated by
                         # both underscore (_) and dash (-).
                         option = option.gsub "-", "_"
-                        converter.send option, value unless option == 'output'
+                        converter.send option, value unless option == 'output' or option == 'use-extension'
                         # don't let pandoc write the output to enable postprocessing
                     rescue
                         warn "The pandoc option '#{option}' (with value '#{value}') is not recognized by paru. This option is skipped." if debug?
                     end
                 end
 
-                converter.send "output", absolute_dst if OUTPUT_FORMATS.include? options["to"]
+                converter.send "output", absolute_dst if use_output_option absolute_dst
 
                 begin
                     puts converter.to_command if debug?
@@ -267,6 +267,10 @@ module Pandocomatic
 
         private
 
+        def use_output_option(dst) 
+            OUTPUT_FORMATS.include?(File.extname(dst).slice(1..-1))
+        end
+
         # Pandoc version 2 supports multiple pdf engines. Determine which
         # to use given the options.
         #

data/lib/pandocomatic/command/convert_file_multiple_command.rb

@@ -51,8 +51,7 @@ module Pandocomatic
 
         metadata.templates.each do |template_name|
             raise ConfigurationError.new(:no_such_template, nil, template_name) unless template_name.empty? or config.has_template? template_name
-
-            dst = config.set_extension dst, template_name, metadata
+    
             if not modified_only? or file_modified? @src, dst then
                 subcommand = ConvertFileCommand.new(@config, @src, dst, template_name)
                 push subcommand unless subcommand.nil? or subcommand.skip?

data/lib/pandocomatic/configuration.rb

@@ -25,17 +25,32 @@ module Pandocomatic
     # default_configuration.yaml.
     DEFAULT_CONFIG = YAML.load_file File.join(__dir__, 'default_configuration.yaml')
 
-    # Maps pandoc output formats to an extension.
-    FORMAT_TO_EXT = {
+    # Maps pandoc output formats to their conventional default extension.
+    DEFAULT_EXTENSION = {
         'native' => 'hs',
+        'plain' => 'txt',
         'markdown' => 'md',
         'markdown_strict' => 'md',
         'markdown_phpextra' => 'md',
-        'markdown_github' => 'md',
+        'markdown_mmd' => 'md',
+        'gfm' => 'md',
+        'commonmark' => 'md',
+        'html4' => 'html',
         'html5' => 'html',
-        'docx' => 'docx',
         'latex' => 'tex',
-        'context' => 'tex'
+        'beamer' => 'tex',
+        'context' => 'tex',
+        'docbook4' => 'docbook',
+        'docbook5' => 'docbook',
+        'opendocument' => 'odt',
+        'epub2' => 'epub',
+        'epub3' => 'epub',
+        'asciidoc' => 'adoc',
+        'slidy' => 'html',
+        'slideous' => 'html',
+        'dzslides' => 'html',
+        'revealjs' => 'html',
+        's5' => 'html'
     }
 
     # A Configuration object models a pandocomatic configuration.
@@ -184,6 +199,57 @@ module Pandocomatic
             File.join dir, "#{basename}.#{find_extension(dst, template_name, metadata)}"
         end
 
+        # Set the destination file given this Confguration,
+        # template, and metadata
+        #
+        # @param dst [String] path to a destination file
+        # @param template_name [String] the name of the template used to
+        #   convert to destination
+        # @param metadata [PandocMetadata] the metadata in the source file
+        def set_destination(dst, template_name, metadata)
+            dir = File.dirname dst
+
+            determine_output_in_pandoc = lambda do |pandoc|
+                if pandoc.has_key? "output"
+                    output = pandoc["output"]
+                    if output.start_with? "/"
+                        # Treat as an absolute path. Note. this probably
+                        # does not work on windows?
+                        return output
+                    else
+                        # Put it relative to the current directory
+                        return File.join dir, output
+                    end
+                end
+                return nil
+            end
+
+            destination = nil
+
+            # Output option in pandoc property has precedence
+            if metadata.has_pandocomatic?
+                pandocomatic = metadata.pandocomatic
+                if pandocomatic.has_key? "pandoc"
+                    destination = determine_output_in_pandoc.call pandocomatic["pandoc"]
+                end
+            end
+
+            # Output option in template's pandoc property is next
+            if destination.nil? and not template_name.nil? and not template_name.empty? then
+                if @templates[template_name].has_key? "pandoc"
+                    destination = determine_output_in_pandoc.call @templates[template_name]["pandoc"]
+                end
+            end
+
+            # Else fall back to taking the input file as output file with the
+            # extension updated to the output format
+            if destination.nil?
+                destination = set_extension dst, template_name, metadata
+            end
+            
+            destination
+        end
+
         # Find the extension of the destination file given this Confguration,
         # template, and metadata
         #
@@ -195,14 +261,29 @@ module Pandocomatic
         # @return [String] the extension to use for the destination file
         def find_extension(dst, template_name, metadata)
             extension = "html"
+
+            # Pandoc supports enabling / disabling extensions
+            # using +EXTENSION and -EXTENSION
+            strip_extensions = lambda{|format| format.split(/[+-]/).first}
+            use_extension = lambda do |pandoc|
+                if pandoc.has_key? "use-extension"
+                    pandoc["use-extension"]
+                else
+                    nil
+                end
+            end
+
             if template_name.nil? or template_name.empty? then
                 if metadata.has_pandocomatic? 
                     pandocomatic = metadata.pandocomatic
                     if pandocomatic.has_key? "pandoc"
                         pandoc = pandocomatic["pandoc"]
-
-                        if pandoc.has_key? "to"
-                            extension = pandoc["to"]
+                        
+                        ext = use_extension.call pandoc
+                        if not ext.nil?
+                            extension = ext
+                        elsif pandoc.has_key? "to"
+                            extension = strip_extensions.call(pandoc["to"])
                         end
                     end
                 end 
@@ -210,14 +291,17 @@ module Pandocomatic
                 # TODO: what if there is no pandoc.to?
                 if @templates[template_name].has_key? "pandoc"
                     pandoc = @templates[template_name]["pandoc"]
-                    if pandoc.has_key? "to"
-                        extension = pandoc["to"]
+                    ext = use_extension.call pandoc
+                    if not ext.nil?
+                        extension = nil
+                    elsif pandoc.has_key? "to"
+                        extension = strip_extensions.call(pandoc["to"])
                     end
                 end
             end
 
-            extension = FORMAT_TO_EXT[extension] || extension
-            return extension
+            extension = DEFAULT_EXTENSION[extension] || extension
+            extension
         end
 
         # Is there a template with template_name in this Configuration?

data/lib/pandocomatic/pandocomatic.rb

@@ -50,7 +50,7 @@ module Pandocomatic
         ERROR_STATUS = 1266 # This is the sum of the ascii values of the characters in 'pandocomatic'
 
         # Pandocomatic's current version
-        VERSION = [0, 2, 0, 4]
+        VERSION = [0, 2, 1]
 
         # Pandocomatic's default configuration file
         CONFIG_FILE = 'pandocomatic.yaml'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.2.0.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru