pandocomatic 0.2.8 → 1.0.0

data/lib/pandocomatic/default_configuration.yaml

@@ -3,3 +3,7 @@ settings:
     follow-symlinks: false
     skip: ['.*', 'pandocomatic.yaml']
     match-files: 'first'
+templates:
+  empty:
+    metadata:
+      empty: true

data/lib/pandocomatic/error/cli_error.rb

@@ -1,52 +1,56 @@
+# frozen_string_literal: true
+
 #--
 # 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 './pandocomatic_error.rb'
+  require_relative './pandocomatic_error'
 
-  # A command line error.
+  # A command-line error.
   class CLIError < PandocomaticError
-
     # Get the template used to print this CLIError
-    def template()
+    def template
       'cli_error.txt'
     end
 
-      # :no_input_given,
-      # :input_does_not_exist,
-      # :input_is_not_readable,
-      # :multiple_input_files_only,
-      # :no_mixed_inputs
+    # :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,
+    # :output_is_not_a_file,
+    # :output_it_not_writable,
 
-      # :no_output_given,
-      # :output_is_not_a_directory,
-      # :output_is_not_a_file,
-      # :output_it_not_writable,
+    # :cannot_use_stdout_with_directory
+    # :cannot_use_both_output_and_stdout
 
-      # :unknown_option,
-      # :problematic_invocation,
+    # :unknown_option,
+    # :problematic_invocation,
 
-      # :data_dir_does_not_exist,
-      # :data_dir_is_not_a_directory,
-      # :data_dir_is_not_readable,
+    # :data_dir_does_not_exist,
+    # :data_dir_is_not_a_directory,
+    # :data_dir_is_not_readable,
 
-      # :config_file_does_not_exist,
-      # :config_file_is_not_a_file,
-      # :config_file_is_not_readable
+    # :config_file_does_not_exist,
+    # :config_file_is_not_a_file,
+    # :config_file_is_not_readable
   end
-end 
+end

data/lib/pandocomatic/error/configuration_error.rb

@@ -1,29 +1,30 @@
+# frozen_string_literal: true
+
 #--
 # 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 './pandocomatic_error.rb'
+  require_relative './pandocomatic_error'
 
   # A ConfigurationError
   class ConfigurationError < PandocomaticError
-    
     # The template to print this ConfigurationError
-    def template()
+    def template
       'configuration_error.txt'
     end
 
@@ -35,7 +36,7 @@ module Pandocomatic
     # :config_file_is_not_a_file,
     # :config_file_is_not_readable,
     # :unable_to_load_config_file
-    
+
     # :no_such_template
   end
-end 
+end

data/lib/pandocomatic/error/io_error.rb

@@ -1,40 +1,41 @@
+# frozen_string_literal: true
+
 #--
 # 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 './pandocomatic_error.rb'
+  require_relative './pandocomatic_error'
 
   # An IOError
   class IOError < PandocomaticError
-
     # The template to use when printing this IOError
-    def template()
+    def template
       'io_error.txt'
     end
-    
+
     # :file_does_not_exist file
     # :file_is_not_a_file file
     # :file_is_not_readable file
     # :file_is_not_writable file
-    
+
     # :error_opening_file file
     # :error_writing_file file
-    
+
     # :directory_does_not_exist dir
     # :directory_is_not_a_directory dir
     # :directory_is_not_readable dir
@@ -42,11 +43,10 @@ module Pandocomatic
 
     # :error_opening_directory dir
     # :error_creating_directory dir
-   
+
     # :file_or_directory_does_not_exist src
     # :unable_to_copy_file [src, dst]
     # :unable_to_create_symbolic_link [src, dst]
     # :unable_to_read_symbolic_link [src]
   end
-
-end 
+end

data/lib/pandocomatic/error/pandoc_error.rb

@@ -1,32 +1,33 @@
+# frozen_string_literal: true
+
 #--
 # 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 './pandocomatic_error.rb'
+  require_relative './pandocomatic_error'
 
-  # An error when running pandoc  
+  # An error when running pandoc
   class PandocError < PandocomaticError
-
     # The template to use to print this PandocError
-    def template()
+    def template
       'pandoc_error.txt'
     end
 
     # :error_running_pandoc
   end
-end 
+end

data/lib/pandocomatic/error/pandocomatic_error.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 #--
 # 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 '../printer/error_printer.rb'
+  require_relative '../printer/error_printer'
 
   # General pandocomatic error
   #
@@ -39,7 +41,7 @@ module Pandocomatic
     # @param data [Object = nil] extra information attached to this
     #   PandocomaticError, if any; optional
     def initialize(type = :unknown, error = nil, data = nil)
-      super type.to_s.gsub("_", " ").capitalize
+      super type.to_s.gsub('_', ' ').capitalize
       @type = type
       @error = error
       @data = data
@@ -48,28 +50,27 @@ module Pandocomatic
     # Has this PandocomaticError an underlying error?
     #
     # @return [Boolean]
-    def has_error?()
-      not @error.nil?
+    def error?
+      !@error.nil?
     end
 
     # Has this PandocomaticError extra information associated to it?
     #
     # @return [Boolean]
-    def has_data?()
-      not @data.nil?
+    def data?
+      !@data.nil?
     end
 
     # Print this error.
-    def print()
+    def print
       ErrorPrinter.new(self).print
     end
 
     # Show this error
     #
     # @return [String] a string representation of this PandocomaticError
-    def show()
+    def show
       ErrorPrinter.new(self).to_s
     end
-
   end
-end 
+end

data/lib/pandocomatic/error/processor_error.rb

@@ -1,29 +1,30 @@
+# frozen_string_literal: true
+
 #--
 # 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 './pandocomatic_error.rb'
+  require_relative './pandocomatic_error'
 
   # An error while running a processor
   class ProcessorError < PandocomaticError
-
     # The template to use when printing this ProcessorError
-    def template()
+    def template
       'processor_error.txt'
     end
 
@@ -31,5 +32,4 @@ module Pandocomatic
     # :script_is_not_executable script
     # :error_processing_script [script, src]
   end
-
-end 
+end

data/lib/pandocomatic/error/template_error.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#--
+# Copyright 2022, 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 './pandocomatic_error'
+
+  # A TemplateError
+  class TemplateError < PandocomaticError
+    # Create a new PandocomaticError
+    #
+    # @param type [Symbol = :unknown] the type of error, defaults to :unknown
+    # @param data [Object = nil] extra information attached to this
+    #   TemplateError, if any; optional
+    def initialize(type = :unknown, data = nil)
+      super(type, nil, data)
+    end
+
+    # Represent this template error as a string.
+    # @return [String]
+    def to_s
+      "Environment variable '#{@data[:key]}'"\
+        "#{" in '#{@data[:path]}'" unless @data[:path].nil?}"\
+        ' does not exist: No substitution possible.'
+    end
+
+    # The template to print this TemplateError
+    def template
+      'template_error.txt'
+    end
+
+    # :environment_variable_does_not_exist
+  end
+end

data/lib/pandocomatic/input.rb

@@ -1,79 +1,78 @@
+# frozen_string_literal: true
+
 #--
 # 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'
 
-    require_relative './configuration.rb'
-
-    # Generic class to handle input files and directories in a general manner.
-    class Input
-
-        attr_reader :errors
+  # Generic class to handle input files and directories in a general manner.
+  class Input
+    attr_reader :errors
 
-        # Create a new Input
-        #
-        # @param input [String[]] a list of input files
-        def initialize(input)
-            @input_files = input
-            @errors = []
-        end
+    # Create a new Input
+    #
+    # @param input [String[]] a list of input files
+    def initialize(input)
+      @input_files = input
+      @errors = []
+    end
 
-        # The absolute path to this Input
-        #
-        # @return String
-        def absolute_path()
-            File.absolute_path @input_files.first
-        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 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
+    # 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
-        
-        # Does this input have encountered any errors?
-        #
-        # @return Boolean
-        def has_errors?()
-            not @errors.empty?
-        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
+    # Does this input have encountered any errors?
+    #
+    # @return Boolean
+    def errors?
+      !@errors.empty?
+    end
 
+    # A string representation of this Input
+    #
+    # @return String
+    def to_s
+      name
     end
+  end
 end