pandocomatic 0.2.4.2 → 0.2.5.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5805486820ab39b17105f8734d5a8bb06cd4974b504a433bfb2a8fd7257f1292
-  data.tar.gz: fac1b7cdaf0b6bde56c14b27cf69a8314a9cb8d61570ee0b9bae8fa24bc119a5
+  metadata.gz: e0830abb917ca87c8d072ee5a4f88fee1f2f2d8da6359f14e74f9160614b23f9
+  data.tar.gz: 68f2dbf9325b3ccaeeeae4c2c99b3de4486ff00a2e6c1951a6b14f3f4260232a
 SHA512:
-  metadata.gz: c6af721ff587c11366cdec4bf08dea7d022d9e82b902f6ca4690864ebacdc463e8eed745158f8e1d716a98d755943cd8c0300b17d17b1145bc4940361648a4f0
-  data.tar.gz: 400a4e734a7bb904dac926a6fee4a35ca1f0622ff37cb202f7b9b61e33b94e8704aae94e601975228eeab2a7f06c1e0f81cc44e24b429a3a5026c8a55b29b5fd
+  metadata.gz: e8c034acc735d84f56c95765a070a129bb522bfe2b6536d407dc067c86f954fad64c7679cb561551689f837d1c54186a9e6c69e7f9fa192eaf548dc948395a0b
+  data.tar.gz: a625b92f99fdccfc5786cb8e2e234b572f4157f4efc894bdc6ed2be39eaad54cb4d33895014e410abfc37e3e983fa9bb6b9de805fa693fa5e1bab54a1f0cebf0

data/lib/pandocomatic/cli.rb

@@ -20,9 +20,11 @@ module Pandocomatic
   require 'optimist'
 
   require_relative './error/cli_error.rb'
+  require_relative './configuration.rb'
+
 
   ##
-  # Command line options parser for pandocomatic using trollop.
+  # Command line options parser for pandocomatic using optimist.
   #
   class CLI
 
@@ -32,15 +34,13 @@ module Pandocomatic
     #
     # @param args [String, Array] A command line invocation string or a list of strings like ARGV
     #
-    # @return [Hash] The options to pandocomatic
-    # the subcommand's options
-    #
+    # @return [Configuration] The configuration for running pandocomatic given
+    # the command-line options.
     def self.parse(args)
       args = args.split if args.is_a? String
 
       begin
-        options = parse_options args || {:help => true, :help_given => true}
-        options
+        parse_options args || Configuration.new({:help => true, :help_given => true})
       rescue Optimist::CommandlineError => e
         raise CLIError.new(:problematic_invocation, e, args)
       end
@@ -49,6 +49,8 @@ module Pandocomatic
     private 
 
     # Parse pandocomatic's global options.
+    #
+    # @return [Configuration]
     def self.parse_options(args)
       parser = Optimist::Parser.new do
         # General options 
@@ -63,7 +65,7 @@ module Pandocomatic
 
         # What to convert and where to put it
         opt :output, 'Output', :short => '-o', :type => String
-        opt :input, 'Input', :short => '-i', :type => String
+        opt :input, 'Input', :short => '-i', :type => String, :multi => true
 
         # Version and help
         opt :show_version, 'Version', :short => '-v', :long => 'version'
@@ -79,29 +81,38 @@ module Pandocomatic
       
       options = use_custom_version options
       options = use_custom_help options
-     
+
       if options_need_to_be_validated? options
-        # if no input option is specified, it should follow as the last item
+        # if no input option is specified, all items following the last option
+        # are treated as input files.
         if not options[:input_given]
-          options[:input] = args.shift
+          options[:input] = args
           options[:input_given] = true
+        elsif not args.empty?
+          raise CLIError.new(:no_mixed_inputs)
         end
 
-        # There should be no other options left.
-        raise CLIError.new(:too_many_options, nil, args) if not args.empty?
-
         # There should be an input specified
         raise CLIError.new(:no_input_given) if options[:input].nil? or options[:input].empty?
 
-        # The input file or directory should exist
-        input = File.absolute_path options[:input]
-        raise CLIError.new(:input_does_not_exist, nil, options[:input]) unless File.exist? input
-        raise CLIError.new(:input_is_not_readable, nil, input) unless File.readable? input
+        # Support multiple input files for conversion
+        multiple_inputs = 1 < options[:input].size
+
+        # The input files or directories should exist
+        input = options[:input].map do |input_file|
+          raise CLIError.new(:input_does_not_exist, nil, input_file) unless File.exist? input_file
+          raise CLIError.new(:input_is_not_readable, nil, input_file) unless File.readable? input_file
+        
+          # If there are multiple input files, these files cannot be directories
+          raise CLIError.new(:multiple_input_files_only, nil, input_file) if multiple_inputs and File.directory? input_file
+          
+          File.absolute_path input_file
+        end
 
         if options[:output_given]
           output = File.absolute_path options[:output]
           # Input and output should be both files or directories
-          match_file_types input, output
+          match_file_types input.first, output
 
           # The output, if it already exist, should be writable
           raise CLIError.new(:output_is_not_writable, nil, output) unless not File.exist? output or File.writable? output
@@ -109,7 +120,7 @@ module Pandocomatic
           # If the input is a directory, an output directory should be
           # specified as well. If the input is a file, the output could be
           # specified in the input file, or STDOUT could be used.
-          raise CLIError.new(:no_output_given) if File.directory? input
+          raise CLIError.new(:no_output_given) if not multiple_inputs and File.directory? input.first
         end
 
         # Data dir, if specified, should be an existing and readable directory
@@ -130,9 +141,9 @@ module Pandocomatic
           raise CLIError.new(:config_file_is_not_a_file, nil, config) unless File.file? config
         end
 
-      end
-      
-      options
+      end 
+
+      Configuration.new options, input
     end
 
     def self.options_need_to_be_validated? options
@@ -140,7 +151,7 @@ module Pandocomatic
     end
 
     #--
-    #Optimist has special behavior for the version and help options. To
+    # Optimist has special behavior for the version and help options. To
     # overcome, "show_version" and "show_help" options are introduced. When
     # set, these are put in the options as "version" and "help"
     # respectively.

data/lib/pandocomatic/command/command.rb

@@ -50,18 +50,13 @@ module Pandocomatic
 
     # Reset all Commands
     #
-    # @param src_root [String = "."] the root directory to convert
-    # @param dry_run [Boolean = false] should Commands actually run or not?
-    # @param quiet [Boolean = false] should Commands run silently?
-    # @param debug [Boolean = false] should Commands be run in debug mode?
-    # @param modified_only [Boolean = false] should only modified files be
-    #   converted?
-    def self.reset(src_root = ".", dry_run = false, quiet = false, debug = false, modified_only = false)
-      @@src_root = src_root
-      @@dry_run = dry_run
-      @@quiet = quiet
-      @@debug = debug
-      @@modified_only = modified_only
+    # @param configuration [Configuration] the configuration used to convert
+    def self.reset(configuration)
+      @@src_root = configuration.src_root
+      @@dry_run = configuration.dry_run?
+      @@quiet = configuration.quiet?
+      @@debug = configuration.debug?
+      @@modified_only = configuration.modified_only?
       @@total = 0
     end
 

data/lib/pandocomatic/command/convert_dir_command.rb

@@ -142,7 +142,7 @@ module Pandocomatic
     # If the source directory contains a configuration file, use it to
     # reconfigure the converter. Otherwise, use the current configuration
     def reconfigure(current_config, src_dir)
-      config_file = File.join src_dir, Pandocomatic::CONFIG_FILE
+      config_file = File.join src_dir, Configuration::CONFIG_FILE
       if File.exist? config_file then
         config = current_config.reconfigure config_file
       else

data/lib/pandocomatic/configuration.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2014, 2015, 2016, 2017, Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2014—2019 Huub de Beer <Huub@heerdebeer.org>
 # 
 # This file is part of pandocomatic.
 # 
@@ -20,6 +20,11 @@ module Pandocomatic
 
     require 'yaml'
     require 'paru/pandoc'
+    
+    require_relative './error/configuration_error.rb'
+    require_relative './command/command.rb'
+    require_relative './input.rb'
+    require_relative './multiple_files_input.rb'
 
     # The default configuration for pandocomatic is read from
     # default_configuration.yaml.
@@ -56,12 +61,38 @@ module Pandocomatic
     # A Configuration object models a pandocomatic configuration.
     class Configuration
 
-        # Create a new Configuration instance based on the command-line
-        # options, a data_dir, and a configuration file.
-        def initialize options, data_dir, configuration_file
-            @data_dir = data_dir
+        # Pandocomatic's default configuration file
+        CONFIG_FILE = 'pandocomatic.yaml'
 
-            load configuration_file
+        # Create a new Configuration instance based on the command-line options
+        def initialize options, input
+            @options = options
+            @data_dir = determine_data_dir options
+            config_file = determine_config_file(options, @data_dir)
+
+            load config_file unless config_file.nil? or config_file.empty?
+            
+            @input = if input.nil? or input.empty? then
+                         nil
+                     elsif 1 < input.size then
+                         MultipleFilesInput.new(input)
+                     else
+                         Input.new(input)
+                     end
+
+            @output = if output? then 
+                          options[:output] 
+                      elsif @input.is_a? Input then 
+                          @input.base 
+                      else 
+                          nil 
+                      end
+
+            # Extend the command classes by setting the source tree root
+            # directory, and the options quiet and dry-run, which are used when
+            # executing a command: if dry-run the command is not actually
+            # executed and if quiet the command is not printed to STDOUT
+            Command.reset(self)
         end
 
         # Read a configuration file and create a pandocomatic configuration object
@@ -149,6 +180,116 @@ module Pandocomatic
             marshal_dump
         end
 
+        # Is the dry run CLI option given?
+        #
+        # @return [Boolean]
+        def dry_run?() 
+            @options[:dry_run_given] and @options[:dry_run]
+        end
+
+        # Is the quiet CLI option given?
+        #
+        # @return [Boolean]
+        def quiet?()
+            @options[:quiet_given] and @options[:quiet]
+        end
+
+        # Is the debug CLI option given?
+        #
+        # @return [Boolean]
+        def debug?()
+            @options[:debug_given] and @options[:debug]
+        end
+
+        # Is the modified only CLI option given?
+        #
+        # @return [Boolean]
+        def modified_only?()
+            @options[:modified_only_given] and @options[:modified_only]
+        end
+
+        # Is the version CLI option given?
+        #
+        # @return [Boolean]
+        def show_version?()
+            @options[:version_given]
+        end
+
+        # Is the help CLI option given?
+        #
+        # @return [Boolean]
+        def show_help?()
+            @options[:help_given]
+        end
+
+        # Is the data dir CLI option given?
+        #
+        # @return [Boolean]
+        def data_dir?()
+            @options[:data_dir_given]
+        end
+
+        # Is the config CLI option given?
+        #
+        # @return [Boolean]
+        def config?()
+            @options[:config_given]
+        end
+
+        # Is the output CLI option given and can that output be used?
+        #
+        # @return [Boolean]
+        def output?()
+            @options[:output_given] and @options[:output]
+        end
+
+        # Get the output file name
+        #
+        # @return [String]
+        def output()
+            @output
+        end
+
+        # Get the source root directory
+        #
+        # @return [String]
+        def src_root()  
+            if @input.nil? then nil else @input.absolute_path end
+        end
+
+        # Have input CLI options be given?
+        def input?()
+            @options[:input_given]
+        end
+
+        # Get the input file name
+        #
+        # @return [String]
+        def input()
+            if @input.nil? then
+                nil
+            else
+                @input.name
+            end
+        end
+
+        # Is this Configuration for converting directories?
+        #
+        # @return [Boolean]
+        def directory?()
+            not @input.nil? and @input.directory?
+        end
+
+        # Clean up this configuration. This will remove temporary files
+        # created for the conversion process guided by this Configuration.
+        def clean_up!()
+            # If a temporary file has been created while concatenating
+            # multiple input files, ensure it is removed.
+            if @input.is_a? MultipleFilesInput then
+                @input.destroy!
+            end
+        end
+
         # Should the source file be skipped given this Configuration?
         #
         # @param src [String] path to a source file
@@ -245,13 +386,22 @@ module Pandocomatic
                 end
             end
 
-            # Output options in pandoc property have precedence
-            destination = determine_output_in_pandoc.call metadata.pandoc_options
-            rename_script = metadata.pandoc_options["rename"]
+            destination = nil
+            rename_script = nil
+
+            # Output option in pandoc property has precedence
+            if metadata.has_pandocomatic?
+                pandocomatic = metadata.pandocomatic
+                if pandocomatic.has_key? "pandoc"
+                    pandoc = pandocomatic["pandoc"]
+                    destination = determine_output_in_pandoc.call pandoc
+                    rename_script = pandoc["rename"]
+                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" and not @templates[template_name]["pandoc"].nil?
+                if @templates[template_name].has_key? "pandoc"
                     pandoc = @templates[template_name]["pandoc"]
                     destination = determine_output_in_pandoc.call pandoc
                     rename_script ||= pandoc["rename"]
@@ -295,14 +445,21 @@ module Pandocomatic
             end
 
             if template_name.nil? or template_name.empty? then
-                ext = use_extension.call metadata.pandoc_options
-                if not ext.nil?
-                    extension = ext
-                elsif metadata.pandoc_options.has_key? "to"
-                    extension = strip_extensions.call(metadata.pandoc_options["to"])
-                end
+                if metadata.has_pandocomatic? 
+                    pandocomatic = metadata.pandocomatic
+                    if pandocomatic.has_key? "pandoc"
+                        pandoc = pandocomatic["pandoc"]
+                        
+                        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 
             else
-                if @templates[template_name].has_key? "pandoc" and not @templates[template_name]["pandoc"].nil?
+                if @templates[template_name].has_key? "pandoc"
                     pandoc = @templates[template_name]["pandoc"]
                     ext = use_extension.call pandoc
 
@@ -669,5 +826,65 @@ module Pandocomatic
                 path.start_with? "/"
             end
         end
+
+        def determine_config_file(options, data_dir = Dir.pwd)
+            config_file = ''
+
+            if options[:config_given]
+                config_file = options[:config]
+            elsif Dir.entries(data_dir).include? CONFIG_FILE
+                config_file = File.join(data_dir, CONFIG_FILE)
+            elsif Dir.entries(Dir.pwd()).include? CONFIG_FILE
+                config_file = File.join(Dir.pwd(), CONFIG_FILE)
+            else
+                # Fall back to default configuration file distributed with
+                # pandocomatic
+                config_file = File.join(__dir__, 'default_configuration.yaml')
+            end
+
+            path = File.absolute_path config_file
+
+            raise ConfigurationError.new(:config_file_does_not_exist, nil, path) unless File.exist? path
+            raise ConfigurationError.new(:config_file_is_not_a_file, nil, path) unless File.file? path
+            raise ConfigurationError.new(:config_file_is_not_readable, nil, path) unless File.readable? path
+
+            path
+        end
+
+        def determine_data_dir(options)
+            data_dir = ''
+
+            if options[:data_dir_given]
+                data_dir = options[:data_dir]
+            else
+                # No data-dir option given: try to find the default one from pandoc
+                begin
+                    data_dir = Paru::Pandoc.info()[:data_dir]
+
+                    # If pandoc's data dir does not exist, however, fall back
+                    # to the current directory
+                    unless File.exist? File.absolute_path(data_dir)
+                        data_dir = Dir.pwd
+                    end
+                rescue Paru::Error => e
+                    # If pandoc cannot be run, continuing probably does not work out
+                    # anyway, so raise pandoc error
+                    raise PandocError.new(:error_running_pandoc, e, data_dir)
+                rescue StandardError => e
+                    # Ignore error and use the current working directory as default working directory
+                    data_dir = Dir.pwd
+                end
+            end
+
+            # check if data directory does exist and is readable
+            path = File.absolute_path data_dir
+
+            raise ConfigurationError.new(:data_dir_does_not_exist, nil, path) unless File.exist? path
+            raise ConfigurationError.new(:data_dir_is_not_a_directory, nil, path) unless File.directory? path
+            raise ConfigurationError.new(:data_dir_is_not_readable, nil, path) unless File.readable? path
+
+            path
+        end
+
     end
 end

data/lib/pandocomatic/error/cli_error.rb

@@ -30,6 +30,8 @@ module Pandocomatic
       # :no_input_given,
       # :input_does_not_exist,
       # :input_is_not_readable,
+      # :multiple_input_files_only,
+      # :no_mixed_inputs
 
       # :no_output_given,
       # :output_is_not_a_directory,
@@ -37,7 +39,6 @@ module Pandocomatic
       # :output_it_not_writable,
 
       # :unknown_option,
-      # :too_many_options,
       # :problematic_invocation,
 
       # :data_dir_does_not_exist,

data/lib/pandocomatic/input.rb

@@ -0,0 +1,69 @@
+#--
+# Copyright 2019 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 './configuration.rb'
+
+    # Generic class to handle input files and directories in a general manner.
+    class Input
+
+        # Create a new Input
+        #
+        # @param input [String[]] a list of input files
+        def initialize(input)
+            @input_files = input
+        end
+
+        # The absolute path to this Input
+        #
+        # @return String
+        def absolute_path()
+            File.absolute_path @input_files.first
+        end
+
+        # The base name of this Input
+        #
+        # @return String
+        def base()
+            File.basename @input_files.first
+        end
+
+        # The name of this input
+        #
+        # @return String
+        def name()
+            @input_files.first
+        end
+
+        # Is this input a directory?
+        #
+        # @return Boolean
+        def directory?()
+            File.directory? @input_files.first
+        end
+
+        # A string representation of this Input
+        #
+        # @return String
+        def to_s()
+            self.name
+        end
+
+    end
+end

data/lib/pandocomatic/multiple_files_input.rb

@@ -0,0 +1,82 @@
+#--
+# Copyright 2019 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 'tempfile'
+    require_relative './input.rb'
+
+    # A specific Input class to handle multiple input files
+    class MultipleFilesInput < Input
+
+        # Create a new MultipleFilesInput. As a side-effect a temporary file
+        # is created as well containing the content of all the files in input.
+        #
+        # @param input [String[]] a list with input files
+        def initialize(input)
+            super(input)
+            create_temp_file
+        end
+
+        # The name of this input
+        #
+        # @return String
+        def name()
+            @tmp_file
+        end
+
+        # Is this input a directory? A MultipleFilesInput cannot be a
+        # directory
+        #
+        # @return Boolean
+        def directory?()
+            false
+        end
+
+        # Destroy the temporary file created for this MultipleFilesInput
+        def destroy!()
+            if not @tmp_file.nil?
+                @tmp_file.close
+                @tmp_file.unlink
+            end
+        end
+
+        # A string representation of this Input
+        #
+        # @return String
+        def to_s()
+            @input_files.join(" + ")
+        end
+
+        private 
+
+        def create_temp_file()
+            # Concatenate all input files into one (temporary) input file
+            # created in the same directory as the first input file
+            @tmp_file = Tempfile.new(@input_files.first, File.dirname(self.absolute_path))
+            
+            @input_files.each_with_index do |filename, index|
+                input = File.read File.absolute_path(filename)
+                input = if 0 === index then input else PandocMetadata.remove_metadata(input) end
+                @tmp_file.write input
+            end
+
+            @tmp_file.rewind
+        end
+    end
+end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -24,6 +24,9 @@ module Pandocomatic
 
     require_relative './error/pandoc_error.rb'
     require_relative './error/io_error.rb'
+            
+    # Regular expression to find metadata blocks in a string.
+    METADATA_BLOCK = /^---[ \t]*(\r\n|\r|\n)(.+?)^(?:---|\.\.\.)[ \t]*(\r\n|\r|\n)/m
 
     # PandocMetadata represents the metadata with pandoc options set in
     # templates and input files.
@@ -41,12 +44,20 @@ module Pandocomatic
             end
         end
 
+        # Remove all metadata from an input string
+        #
+        # @param input [String] the input to remove all metadata from
+        # @return [String] the input with all metadata blocks removed
+        def self.remove_metadata(input)
+            input.gsub(METADATA_BLOCK, "\n");
+        end
+
         # Extract the YAML metadata from an input string
         #
         # @param input [String] the input string
         # @return [String] the YAML data embedded in the input string
         def self.pandoc2yaml(input)
-            mined_metadata = input.scan(/^---[ \t]*(\r\n|\r|\n)(.+?)^(?:---|\.\.\.)[ \t]*(\r\n|\r|\n)/m)
+            mined_metadata = input.scan(METADATA_BLOCK)
             
             mined_metadata
                 .flatten
@@ -159,7 +170,7 @@ module Pandocomatic
         # @return [Boolean] True if there is a pandoc options property in this
         #   PandocMetadata object. False otherwise.
         def has_pandoc_options?()
-            has_pandocomatic? and pandocomatic.has_key? 'pandoc' and not pandocomatic['pandoc'].nil?
+            has_pandocomatic? and pandocomatic.has_key? 'pandoc'
         end
 
     end

data/lib/pandocomatic/pandocomatic.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2014, 2015, 2016, 2017, Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2014—2019, Huub de Beer <Huub@heerdebeer.org>
 # 
 # This file is part of pandocomatic.
 # 
@@ -21,15 +21,13 @@ module Pandocomatic
     Encoding.default_internal = Encoding::UTF_8
 
     require 'paru'
+    require 'tempfile'
 
     require_relative './error/pandocomatic_error.rb'
     require_relative './error/pandoc_error.rb'
-    require_relative './error/configuration_error.rb'
 
     require_relative './cli.rb'
 
-    require_relative './configuration.rb'
-
     require_relative './printer/help_printer.rb'
     require_relative './printer/version_printer.rb'
     require_relative './printer/error_printer.rb'
@@ -37,7 +35,6 @@ module Pandocomatic
     require_relative './printer/finish_printer.rb'
     require_relative './printer/summary_printer.rb'
 
-    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'
@@ -50,54 +47,34 @@ 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, 4, 2]
-
-        # Pandocomatic's default configuration file
-        CONFIG_FILE = 'pandocomatic.yaml'
-
+        VERSION = [0, 2, 5, 0, "α"]
+        
         # Run pandocomatic given options
         #
         # @param args [String[]] list of options to configure pandocomatic
         def self.run(args)
             begin
                 start_time = Time.now
-                options = CLI.parse args
+                configuration = CLI.parse args
 
-                if options[:version_given]
+                if configuration.show_version?
                     # The version option has precedence over all other options; if
                     # given, the version is printed
                     VersionPrinter.new(VERSION).print
-                elsif options[:help_given]
+                elsif configuration.show_help?
                     # The help option has precedence over all other options except the
                     # version option. If given, the help is printed.
                     HelpPrinter.new().print
                 else
                     # Run the pandocomatic converter configured according to the options
                     # given.
-                    input = options[:input]
-                    output = options[:output]
-                    configuration = configure options
-
-                    # Extend the command classes by setting the source tree root
-                    # directory, and the options quiet and dry-run, which are used when
-                    # executing a command: if dry-run the command is not actually
-                    # executed and if quiet the command is not printed to STDOUT
-                    src_root = File.absolute_path input
-                    dry_run = if options[:dry_run_given] then options[:dry_run] else false end
-                    quiet = if options[:quiet_given] then options[:quiet] else false end
-                    debug = if options[:debug_given] and not quiet then options[:debug] else false end
-                    modified_only = if options[:modified_only_given] then options[:modified_only_given] else false end
-
-                    Command.reset(src_root, dry_run, quiet, debug, modified_only)
-
+                    #
                     # Pandocomatic has two modes: converting a directory tree or
                     # converting a single file. The mode is selected by the input.
-                    if File.directory? input
-                        command = ConvertDirCommand.new(configuration, input, output)
+                    if configuration.directory?
+                        command = ConvertDirCommand.new(configuration, configuration.input, configuration.output)
                     else
-                        destination = if output.nil? or output.empty? then File.basename input else output end
-
-                        command = ConvertFileMultipleCommand.new(configuration, input, destination)
+                        command = ConvertFileMultipleCommand.new(configuration, configuration.input, configuration.output)
                         command.make_quiet unless command.subcommands.size > 1
                     end
 
@@ -112,14 +89,14 @@ module Pandocomatic
                     # Pandocomatic is successfully configured: running the
                     # actual conversion now. But first a short summary of the
                     # process to execute is printed.
-                    SummaryPrinter.new(command, input, output).print unless quiet or not command.directory?
+                    SummaryPrinter.new(command, configuration).print unless configuration.quiet? or not command.directory?
 
                     # Depending on the options dry-run and quiet, the command.execute
                     # method will actually performing the commands (dry-run = false) and
                     # print the command to STDOUT (quiet = false)
                     command.execute()
 
-                    FinishPrinter.new(command, input, output, start_time).print unless quiet
+                    FinishPrinter.new(command, configuration, start_time).print unless configuration.quiet?
                 end
             rescue PandocomaticError => e
                 # Report the error and break off the conversion process.
@@ -130,75 +107,9 @@ module Pandocomatic
                 # for now. This is likely a bug: ask the user to report it.
                 warn "An unexpected error has occurred. You can report this bug via https://github.com/htdebeer/pandocomatic/issues/new."
                 raise e
+            ensure
+                configuration.clean_up!
             end
         end
-
-        private
-
-        def self.determine_config_file(options, data_dir = Dir.pwd)
-            config_file = ''
-
-            if options[:config_given]
-                config_file = options[:config]
-            elsif Dir.entries(data_dir).include? CONFIG_FILE
-                config_file = File.join(data_dir, CONFIG_FILE)
-            elsif Dir.entries(Dir.pwd()).include? CONFIG_FILE
-                config_file = File.join(Dir.pwd(), CONFIG_FILE)
-            else
-                # Fall back to default configuration file distributed with
-                # pandocomatic
-                config_file = File.join(__dir__, 'default_configuration.yaml')
-            end
-
-            path = File.absolute_path config_file
-
-            raise ConfigurationError.new(:config_file_does_not_exist, nil, path) unless File.exist? path
-            raise ConfigurationError.new(:config_file_is_not_a_file, nil, path) unless File.file? path
-            raise ConfigurationError.new(:config_file_is_not_readable, nil, path) unless File.readable? path
-
-            path
-        end
-
-        def self.determine_data_dir(options)
-            data_dir = ''
-
-            if options[:data_dir_given]
-                data_dir = options[:data_dir]
-            else
-                # No data-dir option given: try to find the default one from pandoc
-                begin
-                    data_dir = Paru::Pandoc.info()[:data_dir]
-
-                    # If pandoc's data dir does not exist, however, fall back
-                    # to the current directory
-                    unless File.exist? File.absolute_path(data_dir)
-                        data_dir = Dir.pwd
-                    end
-                rescue Paru::Error => e
-                    # If pandoc cannot be run, continuing probably does not work out
-                    # anyway, so raise pandoc error
-                    raise PandocError.new(:error_running_pandoc, e, data_dir)
-                rescue StandardError => e
-                    # Ignore error and use the current working directory as default working directory
-                    data_dir = Dir.pwd
-                end
-            end
-
-            # check if data directory does exist and is readable
-            path = File.absolute_path data_dir
-
-            raise ConfigurationError.new(:data_dir_does_not_exist, nil, path) unless File.exist? path
-            raise ConfigurationError.new(:data_dir_is_not_a_directory, nil, path) unless File.directory? path
-            raise ConfigurationError.new(:data_dir_is_not_readable, nil, path) unless File.readable? path
-
-            path
-        end
-
-        def self.configure(options)
-            data_dir = determine_data_dir options
-            config_file = determine_config_file options, data_dir
-            Configuration.new options, data_dir, config_file
-        end
-
     end
 end

data/lib/pandocomatic/printer/finish_printer.rb

@@ -25,8 +25,13 @@ module Pandocomatic
     MINUTE = 60
 
     # Create a new FinishPrinter
-    def initialize(command, input, output, start_time)
-      super command, input, output
+    # 
+    # @param command [Command] the command to finish
+    # @param configuration [Configuration] the configuration of the
+    # pandocomatic invokation
+    # @param start_time [Time] the time the command was started
+    def initialize(command, configuration, start_time)
+      super command, configuration
       set_template 'finish.txt'
 
       @start_time = start_time
@@ -34,6 +39,8 @@ module Pandocomatic
     end
 
     # Calculate the duration of the whole conversion process
+    #
+    # @erturn [Number]
     def duration()
       seconds = @end_time - @start_time
       if seconds > MINUTE

data/lib/pandocomatic/printer/summary_printer.rb

@@ -25,13 +25,13 @@ module Pandocomatic
         # Create a new SummaryPrinter
         # 
         # @param command [Command] the command to summarize
-        # @param input [String] the filename of the input file
-        # @param output [String] the filename of the output file
-        def initialize(command, input, output)
+        # @param configuration [Configuration] the configuration of the
+        # pandocomatic invokation
+        def initialize(command, configuration)
             super 'summary.txt'
             @command = command
-            @input = input
-            @output = output
+            @input = configuration.input.to_s
+            @output = configuration.output
         end
 
         # A string representation of the commands being executed

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

@@ -1,6 +1,11 @@
 <%=@error.message%>: <% case @error.type 
 when :no_input_given%>
 Specify the input file or directory with the option `--input PATH`.
+<% when :no_mixed_inputs%>
+Using both the `--input/-i` options and extra input parameters is not allowed.
+Use either only `--input/-i` options or only input parameters.
+<% when :multiple_input_files_only %>
+When specifying multiple inputs, only files are allowed. '<%= @error.data %>' is a directory.
 <% when :unknown_option %>
 See `pandocomatic --help` which options are allowed.
 <% when :too_many_options %>

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

@@ -59,8 +59,15 @@ OPTIONS
                       TRUE
 
                   - templates:
+                    - cleanup: [SCRIPTS] paths to scripts to run after a
+                      conversion is finished, i.e. after the last
+                      postprocessor is run.
                     - glob: [GLOB PATTERNS] files to convert using this
                       template.
+                    - setup: [SCRIPTS] paths to scripts to run before a
+                      conversion is started, i.e. before any preprocessor is
+                      run.
+                    - metadata: [YAML properties] metadata properties
                     - preprocessors: [SCRIPTS] paths to scripts to run before
                       converting with pandoc.
                     - postprocessors: [SCRIPTS] paths to scripts to run after
@@ -111,11 +118,11 @@ SEE ALSO
   - Pandocomatic's documentation
     https://heerdebeer.org/Software/markdown/pandocomatic/
 
-  - Pandoc's manual
-    http://pandoc.org/MANUAL.html
+  - Pandoc's user guide
+    https://pandoc.org/MANUAL.html
 
   - YAML website
-    http://yaml.org/
+    https://yaml.org/
 
 AUTHOR
 
@@ -123,7 +130,7 @@ AUTHOR
 
 LICENSE
 
-  Copyright 2014, 2015, 2016, 2017, Huub de Beer <Huub@heerdebeer.org>
+  Copyright 2014—2019 Huub de Beer <Huub@heerdebeer.org>
 
   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

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

@@ -1,5 +1,6 @@
 Pandocomatic version <%=@version.join('.')%>
-© 2014, 2015, 2016, 2017, 2018 Huub de Beer <Huub@heerdebeer.org>
+
+© 2014—2019 Huub de Beer <Huub@heerdebeer.org>
 
 Pandocomatic is free software; pandocomatic is released under the GPLv3.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.2.4.2
+  version: 0.2.5.0.alpha
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
@@ -105,6 +105,8 @@ files:
 - lib/pandocomatic/error/pandoc_error.rb
 - lib/pandocomatic/error/pandocomatic_error.rb
 - lib/pandocomatic/error/processor_error.rb
+- lib/pandocomatic/input.rb
+- lib/pandocomatic/multiple_files_input.rb
 - lib/pandocomatic/pandoc_metadata.rb
 - lib/pandocomatic/pandocomatic.rb
 - lib/pandocomatic/printer/command_printer.rb
@@ -148,9 +150,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - pandoc, a universal document converer <http://pandoc.org>
 rubyforge_project: