pandocomatic 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4eb96b887676605773e3929aebac5709f2a70ff
-  data.tar.gz: 2815789aeb3065e128606f3dedb338277251134f
+  metadata.gz: 54aa9b0867deb75ba7418c9fd508e5081d3aadc3
+  data.tar.gz: 86f74230480873d24004306c5c446b7ff6a2648e
 SHA512:
-  metadata.gz: 439b66fabcd4f8c9af43c112f16495aa251a71a592ba22b8691fbdfb40ced84dd1abdb859a927be56ad2fd829aede581a4f811749bdb58bcc9e0839a41ce9623
-  data.tar.gz: 982c94db04f6e51e0bce760e3028aa8256bd9315d3b7ffab6bfe0609810479a215f7cc5ccb27df428fd0daffb4dd19d0cac76587741b0fcf6dda5a7fef99f78b
+  metadata.gz: 43f04725a6eb099b3d545cc9ac7da7435d9d2de923b2a91e46b842c6c5c710acd43cc37d98c957c0a25ab34f6ed36939438b36a94237b497a6a2310aeadafec4
+  data.tar.gz: d0c090612f6482cf293a29636f9bd8520504b063a6c01b03f0c08cb866a89e96d360ae09544a286c6df7f71d074b1862d06cb143c86bb8ef524df9fda742e09b

data/lib/pandocomatic/command/command.rb

@@ -96,6 +96,10 @@ module Pandocomatic
       false
     end
 
+    def multiple?()
+      false
+    end
+
     def skip?()
       false
     end

data/lib/pandocomatic/command/convert_dir_command.rb

@@ -23,12 +23,14 @@ module Pandocomatic
   require_relative 'command.rb'
   require_relative 'create_link_command.rb'
   require_relative 'convert_file_command.rb'
+  require_relative 'convert_list_command.rb'
+  require_relative 'convert_file_multiple_command.rb'
   require_relative 'copy_file_command.rb'
   require_relative 'skip_command.rb'
 
-  class ConvertDirCommand < Command
+  class ConvertDirCommand < ConvertListCommand
 
-    attr_reader :config, :src_dir, :dst_dir, :subcommands
+    attr_reader :config, :src_dir, :dst_dir
 
     def initialize(current_config, src_dir, dst_dir)
       super()
@@ -49,8 +51,6 @@ module Pandocomatic
         @errors.push IOError.new(:directory_is_not_a_directory, nil, @dst_dir) unless File.directory? @dst_dir
       end
 
-      @subcommands = []
-
       Dir.foreach @src_dir do |filename|
         src = File.join @src_dir, filename
 
@@ -70,10 +70,7 @@ module Pandocomatic
           end
         elsif File.file? src 
           if config.convert? src then
-            dst = config.set_extension dst
-            if not modified_only? or file_modified? src, dst then
-              subcommand = ConvertFileCommand.new(config, src, dst)
-            end
+              subcommand = ConvertFileMultipleCommand.new(config, src, dst)
           else
             if not modified_only? or file_modified? src, dst then
               subcommand = CopyFileCommand.new(src, dst)
@@ -83,7 +80,7 @@ module Pandocomatic
           subcommand = SkipCommand.new(src, :unclear_what_to_do)
         end
 
-        @subcommands.push subcommand unless subcommand.nil? or subcommand.skip?
+        push subcommand unless subcommand.nil? or subcommand.skip?
       end
 
       # Empty commands do not count to the total amount of commands to execute
@@ -94,18 +91,6 @@ module Pandocomatic
       @subcommands.empty?
     end
 
-    def count()
-      @subcommands.reduce(if skip? then 0 else 1 end) do |total, subcommand|
-        total += subcommand.count
-      end
-    end
-
-    def all_errors()
-      @subcommands.reduce(@errors) do |total, subcommand|
-        total += subcommand.all_errors
-      end
-    end
-
     def directory?()
       true
     end
@@ -122,17 +107,6 @@ module Pandocomatic
       end
     end
 
-    def execute()
-      if not @subcommands.empty?
-        CommandPrinter.new(self).print unless quiet?
-        run if not dry_run? and runnable?
-
-        @subcommands.each do |subcommand|
-          subcommand.execute
-        end
-      end
-    end
-
     private
 
     def create_directory?()

data/lib/pandocomatic/command/convert_file_command.rb

@@ -24,22 +24,32 @@ module Pandocomatic
   require_relative '../processor.rb'
   require_relative '../fileinfo_preprocessor'
 
+  require_relative '../configuration.rb'
+
   require_relative '../error/io_error.rb'
   require_relative '../error/configuration_error.rb'
   require_relative '../error/processor_error.rb'
 
   require_relative 'command.rb'
 
+  OUTPUT_FORMATS = ["docx", "odt", "pdf", "beamer"]
+
   class ConvertFileCommand < Command
 
     attr_reader :config, :src, :dst
 
-    def initialize(config, src, dst)
+    def initialize(config, src, dst, template_name = nil)
       super()
       @config = config
       @src = src
       @dst = dst
 
+      if template_name.nil? or template_name.empty?
+          @template_name = @config.determine_template @src
+      else
+          @template_name = template_name
+      end
+
       @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
       @errors.push IOError.new(:file_is_not_readable, nil, @src) unless File.readable? @src
@@ -60,16 +70,9 @@ module Pandocomatic
       pandoc_options = metadata.pandoc_options || {}
       template = {}
 
-      if metadata.has_template? then
-        template_name = metadata.template_name
-      else
-        template_name = @config.determine_template @src
-      end
-
-      if not template_name.nil? and not template_name.empty?
-        raise ConfigurationError.new(:no_such_template, nil, template_name) unless @config.has_template? template_name
-
-        template = @config.get_template template_name
+      if not @template_name.nil? and not @template_name.empty?
+        raise ConfigurationError.new(:no_such_template, nil, @template_name) unless @config.has_template? @template_name
+        template = @config.get_template @template_name
 
         pandoc_options = (template['pandoc'] || {}).merge(pandoc_options) do |key, oldval, newval| 
           # Options that can occur more than once, such as 'filter' or
@@ -94,11 +97,13 @@ module Pandocomatic
       end
 
       begin
-        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
-          file << output
-        end
+          unless OUTPUT_FORMATS.include? pandoc_options["to"] 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
+                  file << output
+              end
+          end
       rescue StandardError => e
         raise IOError.new(:error_writing_file, e, @dst)
       end
@@ -125,18 +130,28 @@ module Pandocomatic
     def pandoc(input, options, src_dir)
       converter = Paru::Pandoc.new
       options.each do |option, value|
+        # Pandoc multi-word options can have the multiple words separated by
+        # both underscore (_) and dash (-).
+        option= option.gsub "-", "_"
+
         if PANDOC_OPTIONS_WITH_PATH.include? option
           if value.is_a? Array
-            value = value.map {|v| @config.update_path v, src_dir}
+              value = value.map {|v| @config.update_path(v, src_dir, option == "filter")}
           else
-            value = @config.update_path value, src_dir
+              value = @config.update_path(value, src_dir, option == "filter")
           end
         end
 
+        # There is no "pdf" output format; change it to latex but keep the
+        # extension.
+        value = "latex" if option == "to" and value == "pdf"
+
         converter.send option, value unless option == 'output'
         # don't let pandoc write the output to enable postprocessing
       end
 
+      converter.send "output", @dst if OUTPUT_FORMATS.include? options["to"]
+
       begin
         converter << input
       rescue Paru::Error => e
@@ -160,8 +175,13 @@ module Pandocomatic
         output = input
         processors.each do |processor|
           script = @config.update_path(processor, File.dirname(@src))
-          
-          raise ProcessorError.new(:script_does_not_exist, nil, script) unless File.exist? script
+
+          if not File.exists? script
+            script = Configuration.which(script)
+
+            raise ProcessorError.new(:script_does_not_exist, nil, script) if script.nil?
+          end
+
           raise ProcessorError.new(:script_is_not_executable, nil, script) unless File.executable? script
 
           begin
@@ -175,6 +195,5 @@ module Pandocomatic
         input
       end
     end
-
   end
 end

data/lib/pandocomatic/command/convert_file_multiple_command.rb

@@ -0,0 +1,87 @@
+#--
+# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
+# 
+# This file is part of pandocomatic.
+# 
+# Pandocomatic is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+# 
+# Pandocomatic is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
+#++
+module Pandocomatic
+
+  require_relative '../error/io_error.rb'
+
+  require_relative 'command.rb'
+  require_relative 'create_link_command.rb'
+  require_relative 'convert_file_command.rb'
+  require_relative 'convert_list_command.rb'
+  require_relative 'copy_file_command.rb'
+  require_relative 'skip_command.rb'
+
+  class ConvertFileMultipleCommand < ConvertListCommand
+
+    attr_reader :subcommands
+
+    def initialize(config, src, dst)
+        super()
+        @config = config
+        @src = src
+        
+        metadata = PandocMetadata.load_file @src
+        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?
+            end
+        end
+    end
+
+    def push(command)
+        @subcommands.push command
+    end
+
+    def skip?()
+      @subcommands.empty?
+    end
+
+    def count()
+      @subcommands.reduce(if skip? then 0 else 1 end) do |total, subcommand|
+        total += subcommand.count
+      end
+    end
+
+    def all_errors()
+      @subcommands.reduce(@errors) do |total, subcommand|
+        total += subcommand.all_errors
+      end
+    end
+
+    def to_s()
+        "converting #{@src} #{@subcommands.size} time#{'s' if @subcommands.size != 1}:"
+    end
+
+    def execute()
+      if not @subcommands.empty?
+        CommandPrinter.new(self).print unless quiet? or @subcommands.size == 1
+        run if not dry_run? and runnable?
+
+        @subcommands.each do |subcommand|
+          subcommand.execute
+        end
+      end
+    end
+
+  end
+end

data/lib/pandocomatic/command/convert_list_command.rb

@@ -0,0 +1,78 @@
+#--
+# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
+# 
+# This file is part of pandocomatic.
+# 
+# Pandocomatic is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+# 
+# Pandocomatic is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
+#++
+module Pandocomatic
+
+  require_relative '../error/io_error.rb'
+
+  require_relative 'command.rb'
+  require_relative 'create_link_command.rb'
+  require_relative 'convert_file_command.rb'
+  require_relative 'copy_file_command.rb'
+  require_relative 'skip_command.rb'
+
+  class ConvertListCommand < Command
+
+    attr_reader :subcommands
+
+    def initialize()
+      super()
+      @subcommands = []
+    end
+
+    def push(command)
+        @subcommands.push command
+    end
+
+    def skip?()
+      @subcommands.empty?
+    end
+
+    def count()
+      @subcommands.reduce(if skip? then 0 else 1 end) do |total, subcommand|
+        total += subcommand.count
+      end
+    end
+
+    def all_errors()
+      @subcommands.reduce(@errors) do |total, subcommand|
+        total += subcommand.all_errors
+      end
+    end
+
+    def to_s()
+        "converting #{@subcommands.size} items:"
+    end
+
+    def multiple?
+        true
+    end
+
+    def execute()
+      if not @subcommands.empty?
+        CommandPrinter.new(self).print unless quiet?
+        run if not dry_run? and runnable?
+
+        @subcommands.each do |subcommand|
+          subcommand.execute
+        end
+      end
+    end
+
+  end
+end

data/lib/pandocomatic/configuration.rb

@@ -139,22 +139,38 @@ module Pandocomatic
       @settings['follow_links']
     end
 
-    def set_extension(dst)
+    def set_extension(dst, template_name, metadata)
       dir = File.dirname dst
       ext = File.extname dst
       basename = File.basename dst, ext
-      File.join dir, "#{basename}.#{find_extension dst}"
+      File.join dir, "#{basename}.#{find_extension(dst, template_name, metadata)}"
     end
 
-    def find_extension(dst)
-      template = determine_template dst
-      if template.nil? then
-        extension = 'html'
+    def find_extension(dst, template_name, metadata)
+      extension = "html"
+      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"]
+                end
+            end
+        end 
       else
         # TODO: what if there is no pandoc.to?
-        to = @templates[template]['pandoc']['to']
-        extension = FORMAT_TO_EXT[to] || to
+        if @templates[template_name].has_key? "pandoc"
+            pandoc = @templates[template_name]["pandoc"]
+            if pandoc.has_key? "to"
+                extension = pandoc["to"]
+            end
+        end
       end
+
+      extension = FORMAT_TO_EXT[extension] || extension
+      return extension
     end
 
     def has_template?(template_name)
@@ -171,16 +187,23 @@ module Pandocomatic
       end.keys.first
     end
 
-    def update_path(path, src_dir)
+    def update_path(path, src_dir, check_executable = false)
+      updated_path = path
       if path.start_with? './' 
         # refers to a local (to file) dir
-        File.join src_dir, path
-      elsif path.start_with? '/' then
-        path
+        updated_path = File.join src_dir, path
       else
-        # refers to data-dir
-        File.join @data_dir, path
+        if check_executable
+            updated_path = Configuration.which path
+        end
+
+        if not updated_path.start_with? '/' then
+            # refers to data-dir
+            updated_path = File.join @data_dir, updated_path
+        end
       end
+
+      updated_path
     end
 
     private 
@@ -234,6 +257,24 @@ module Pandocomatic
       end
     end
 
+    # Cross-platform way of finding an executable in the $PATH.
+    # 
+    # which('ruby') #=> /usr/bin/ruby
+    #
+    # Taken from:
+    # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby#5471032
+    def self.which(cmd)
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+            exts.each { |ext|
+                exe = File.join(path, "#{cmd}#{ext}")
+                return exe if File.executable?(exe) &&
+                    !File.directory?(exe)
+            }
+        end
+        return nil
+    end
+
   end
 
 end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -37,7 +37,7 @@ module Pandocomatic
 
     def self.pandoc2yaml(input)
       input
-        .scan(/^---\n(.+?)^(?:---|\.\.\.)\n/m)
+        .scan(/^---[ \t]*\n(.+?)^(?:---|\.\.\.)[ \t]*\n/m)
         .flatten
         .map{|yaml| yaml.strip}
         .join("\n")
@@ -63,6 +63,18 @@ module Pandocomatic
       has_pandocomatic? and pandocomatic.has_key? 'use-template' and not pandocomatic['use-template'].empty?
     end
 
+    def templates() 
+        if has_template?
+            if pandocomatic['use-template'].is_a? Array
+                pandocomatic['use-template']
+            else
+                [pandocomatic['use-template']]
+            end
+        else
+            [""]
+        end
+    end
+
     def template_name()
       if has_template? then
         pandocomatic['use-template']
@@ -87,7 +99,12 @@ module Pandocomatic
     end
 
     def has_pandocomatic?()
-      has_key? 'pandocomatic' or has_key? 'pandocomatic_'
+      config = nil
+      if has_key? 'pandocomatic' or has_key? 'pandocomatic_'
+        config = self['pandocomatic'] if has_key? 'pandocomatic'
+        config = self['pandocomatic_'] if has_key? 'pandocomatic_'
+      end
+      config.is_a? Hash
     end
 
     def pandocomatic()

data/lib/pandocomatic/pandocomatic.rb

@@ -37,7 +37,9 @@ module Pandocomatic
 
   require_relative './command/command.rb'
   require_relative './command/convert_dir_command.rb'
+  require_relative './command/convert_list_command.rb'
   require_relative './command/convert_file_command.rb'
+  require_relative './command/convert_file_multiple_command.rb'
 
   class Pandocomatic
     VERSION = [0, 1, 2]
@@ -79,8 +81,10 @@ module Pandocomatic
           if File.directory? input
             command = ConvertDirCommand.new(configuration, input, output)
           else
-            command = ConvertFileCommand.new(configuration, input, output)
-            command.make_quiet
+            destination = if output.nil? or output.empty? then File.basename input else output end
+
+            command = ConvertFileMultipleCommand.new(configuration, input, destination)
+            command.make_quiet unless command.subcommands.size > 1
           end
 
           # Notify the user about all configuration errors collected when

data/lib/pandocomatic/printer/views/command.txt

@@ -1 +1 @@
-(<%=@command.index_to_s%>) <%=if @command.directory? then "+ " else "  - " end%><%= @command.to_s%>
+(<%=@command.index_to_s%>) <%=if @command.multiple? then "+ " else "  - " end%><%= @command.to_s%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Huub de Beer
@@ -91,6 +91,8 @@ files:
 - lib/pandocomatic/command/command.rb
 - lib/pandocomatic/command/convert_dir_command.rb
 - lib/pandocomatic/command/convert_file_command.rb
+- lib/pandocomatic/command/convert_file_multiple_command.rb
+- lib/pandocomatic/command/convert_list_command.rb
 - lib/pandocomatic/command/copy_file_command.rb
 - lib/pandocomatic/command/create_link_command.rb
 - lib/pandocomatic/command/skip_command.rb
@@ -150,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - pandoc, a universal document converer <http://pandoc.org>
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Automating the use of pandoc