pandocomatic 0.2.8 → 1.0.0

data/lib/pandocomatic/pandocomatic.rb

@@ -1,123 +1,127 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2014—2019, Huub de Beer <Huub@heerdebeer.org>
-# 
+# Copyright 2014—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
-    Encoding.default_external = Encoding::UTF_8 #ensure unicode encoding
-    Encoding.default_internal = Encoding::UTF_8
+  Encoding.default_external = Encoding::UTF_8 # ensure unicode encoding
+  Encoding.default_internal = Encoding::UTF_8
+
+  require 'paru'
+  require 'tempfile'
+
+  require_relative './error/pandocomatic_error'
+  require_relative './error/pandoc_error'
 
-    require 'paru'
-    require 'tempfile'
+  require_relative './cli'
 
-    require_relative './error/pandocomatic_error.rb'
-    require_relative './error/pandoc_error.rb'
+  require_relative './printer/help_printer'
+  require_relative './printer/version_printer'
+  require_relative './printer/error_printer'
+  require_relative './printer/configuration_errors_printer'
+  require_relative './printer/finish_printer'
+  require_relative './printer/summary_printer'
 
-    require_relative './cli.rb'
+  require_relative './command/convert_dir_command'
+  require_relative './command/convert_list_command'
+  require_relative './command/convert_file_command'
+  require_relative './command/convert_file_multiple_command'
 
-    require_relative './printer/help_printer.rb'
-    require_relative './printer/version_printer.rb'
-    require_relative './printer/error_printer.rb'
-    require_relative './printer/configuration_errors_printer.rb'
-    require_relative './printer/finish_printer.rb'
-    require_relative './printer/summary_printer.rb'
+  # The Pandocomatic class controlls the pandocomatic conversion process
+  class Pandocomatic
+    # Pandocomatic error status codes start from ERROR_STATUS
+    ERROR_STATUS = 1266 # This is the sum of the ASCII values of the characters in 'pandocomatic'
 
-    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'
+    # Pandocomatic's current version
+    VERSION = [1, 0, 0].freeze
 
-    # The Pandocomatic class controlls the pandocomatic conversion process
-    class Pandocomatic
-        
-        # Pandocomatic error status codes start from ERROR_STATUS
-        ERROR_STATUS = 1266 # This is the sum of the ascii values of the characters in 'pandocomatic'
+    # rubocop:disable Metrics
 
-        # Pandocomatic's current version
-        VERSION = [0, 2, 8]
+    # Run pandocomatic given options
+    #
+    # @param args [String[]] list of options to configure pandocomatic
+    def self.run(args)
+      start_time = Time.now
+      configuration = CLI.parse args
 
-        # Run pandocomatic given options
+      if configuration.show_version?
+        # The version option has precedence over all other options; if
+        # given, the version is printed
+        VersionPrinter.new(VERSION).print
+      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
+        # When using multiple input files, errors reading these
+        # files are already encountered at this point. If there
+        # are any errors, there is no reason to continue.
+        if configuration.input.errors?
+          ConfigurationErrorsPrinter.new(configuration.input.all_errors).print
+          exit ERROR_STATUS
+        end
+
+        # Run the pandocomatic converter configured according to the options
+        # given.
         #
-        # @param args [String[]] list of options to configure pandocomatic
-        def self.run(args)
-            begin
-                start_time = Time.now
-                configuration = CLI.parse args
-
-                if configuration.show_version?
-                    # The version option has precedence over all other options; if
-                    # given, the version is printed
-                    VersionPrinter.new(VERSION).print
-                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
-                    # When using multiple input files, errors reading these
-                    # files are already encountered at this point. If there
-                    # are any errors, there is no reason to continue.
-                    if configuration.input.has_errors?
-                        ConfigurationErrorsPrinter.new(configuration.input.all_errors).print
-                        exit ERROR_STATUS
-                    end
-
-                    # Run the pandocomatic converter configured according to the options
-                    # given.
-                    #
-                    # Pandocomatic has two modes: converting a directory tree or
-                    # converting a single file. The mode is selected by the input.
-                    if configuration.directory?
-                        command = ConvertDirCommand.new(configuration, configuration.input_file, configuration.output)
-                    else
-                        command = ConvertFileMultipleCommand.new(configuration, configuration.input_file, configuration.output)
-                        command.make_quiet unless command.subcommands.size > 1
-                    end
-
-                    # Notify the user about all configuration errors collected when
-                    # determining the commands to run to perform this pandocomatic
-                    # conversion.
-                    if command.all_errors.size > 0
-                        ConfigurationErrorsPrinter.new(command.all_errors).print
-                        exit ERROR_STATUS
-                    end
-
-                    # Pandocomatic is successfully configured: running the
-                    # actual conversion now. But first a short summary of the
-                    # process to execute is printed.
-                    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, configuration, start_time).print unless configuration.quiet?
-                end
-            rescue PandocomaticError => e
-                # Report the error and break off the conversion process.
-                ErrorPrinter.new(e).print
-                exit ERROR_STATUS + 1
-            rescue StandardError => e
-                # An unexpected error has occurred; break off the program drastically
-                # 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! unless configuration.nil?
-            end
+        # Pandocomatic has two modes: converting a directory tree or
+        # converting a single file. The mode is selected by the input.
+        if configuration.directory?
+          command = ConvertDirCommand.new(configuration, configuration.input_file, configuration.output)
+        else
+          command = ConvertFileMultipleCommand.new(configuration, configuration.input_file,
+                                                   configuration.output)
+          command.make_quiet unless command.subcommands.size > 1
         end
+
+        # Notify the user about all configuration errors collected when
+        # determining the commands to run to perform this pandocomatic
+        # conversion.
+        if command.all_errors.size.positive?
+          ConfigurationErrorsPrinter.new(command.all_errors).print
+          exit ERROR_STATUS
+        end
+
+        # Pandocomatic is successfully configured: running the
+        # actual conversion now. But first a short summary of the
+        # process to execute is printed.
+        SummaryPrinter.new(command, configuration).print if !configuration.quiet? || 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, configuration, start_time).print unless configuration.quiet?
+      end
+    rescue PandocomaticError => e
+      # Report the error and break off the conversion process.
+      ErrorPrinter.new(e).print
+      exit ERROR_STATUS + 1
+    rescue StandardError => e
+      # An unexpected error has occurred; break off the program drastically
+      # for now. This is likely a bug: ask the user to report it.
+      warn '[UNEXPECTED ERROR] 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
+
+  # rubocop:enable Metrics
 end

data/lib/pandocomatic/pandocomatic_yaml.rb

@@ -0,0 +1,69 @@
+# 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 'yaml'
+
+  require_relative './error/template_error'
+
+  # PandocomaticYAML is a wrapper around ruby's YAML library that replaces
+  # occurrences of "$(X)$" in the YAML by the value of the evironment variable
+  # X. If variable X cannot be found, an exception is thrown.
+  module PandocomaticYAML
+    # List of classes that are permitted in YAML
+    PERMITTED_YAML_CLASSES = [Date].freeze
+
+    # Regular expression representing environment variables in templates
+    VAR_PATTERN = /\$\((?<var>[a-zA-Z_][a-zA-Z0-9_]*)\)\$/
+
+    # Load a string, substitute any variables, and parse as YAML.
+    #
+    # @param str [String] String to parse as YAML
+    # @param path [Path|Nil] Path of the source of the string, if any
+    # @return [Hash]
+    # @raise [TemplateError] when environment variable does not exist.
+    def self.load(str, path = nil)
+      YAML.safe_load substitute_variables(str, path), permitted_classes: PERMITTED_YAML_CLASSES
+    end
+
+    # Load a text file, substitute any variables, and parse as YAML.
+    #
+    # @param path [String] Path to text file to parse as YAML
+    # @return [Hash]
+    # @raise [TemplateError] when environment variable does not exist.
+    def self.load_file(path)
+      self.load File.read(path), path
+    end
+
+    # Substitute all environment variables in the str with the values of the
+    # corresponding environment variables.
+    #
+    # @raise [TemplateError] when environment variable does not exist.
+    private_class_method def self.substitute_variables(str, path = nil)
+      str.gsub(VAR_PATTERN) do |_match|
+        key = Regexp.last_match(1)
+
+        raise TemplateError.new :environment_variable_does_not_exist, { key:, path: } unless ENV.key? key
+
+        ENV[key]
+      end
+    end
+  end
+end

data/lib/pandocomatic/path.rb

@@ -0,0 +1,171 @@
+# 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 'yaml'
+
+  # Pandocomatic related path functions. Paths in pandocomatic templates have
+  # various forms and behaviors. This behavior is defined by methods in this
+  # module.
+  module Path
+    # Indicator for paths that should be treated as "relative to the root
+    # path". These paths start with this ROOT_PATH_INDICATOR.
+    ROOT_PATH_INDICATOR = '$ROOT$'
+
+    # Update the path to an executable processor or executor given this
+    # Configuration
+    #
+    # @param config [Configuration] the configuration under which to update
+    #   the path.
+    # @param path [String] path to the executable
+    # @param dst [String] the destination path
+    # @param check_executable [Boolean = false] Should the executable be
+    #   verified to be executable? Defaults to false.
+    #
+    # @return [String] the updated path.
+    def self.update_path(config, path, dst = '', check_executable: false)
+      updated_path = path
+
+      if local_path? path
+        # refers to a local dir; strip the './' before appending it to
+        # the source directory as to prevent /some/path/./to/path
+        updated_path = path[2..]
+      elsif absolute_path? path
+        updated_path = path
+      elsif root_relative_path? path
+        updated_path = make_path_root_relative path, dst, config.root_path
+      else
+        updated_path = which path if check_executable
+
+        if updated_path.nil? || !check_executable
+          # refers to data-dir
+          updated_path = File.join config.data_dir, path
+        end
+      end
+
+      updated_path
+    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 do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) &&
+                        !File.directory?(exe)
+        end
+      end
+      nil
+    end
+
+    # Is this path a local path in pandocomatic?
+    #
+    # @param path [String]
+    # @return [Boolean]
+    def self.local_path?(path)
+      if Gem.win_platform?
+        path.match("^\\.\\\\\.*$")
+      else
+        path.start_with? './'
+      end
+    end
+
+    # Is this path an absolute path in pandocomatic?
+    #
+    # @param path [String]
+    # @return [Boolean]
+    def self.absolute_path?(path)
+      if Gem.win_platform?
+        path.match("^[a-zA-Z]:\\\\\.*$")
+      else
+        path.start_with? '/'
+      end
+    end
+
+    # Is this path a root relative path in pandocomatic?
+    #
+    # @param path [String]
+    # @return [Boolean]
+    def self.root_relative_path?(path)
+      path.start_with? ROOT_PATH_INDICATOR
+    end
+
+    # Determine the root path given a set of command-line options
+    #
+    # @param options [Hash]
+    # @return [String]
+    def self.determine_root_path(options)
+      if options[:root_path_given]
+        options[:root_path]
+      elsif options[:output_given]
+        File.absolute_path(File.dirname(options[:output]))
+      else
+        File.absolute_path '.'
+      end
+    end
+
+    # rubocop:disable Metrics
+
+    # Make a path root relative given the destination path and the root path
+    #
+    # @param path [String]
+    # @param dst [String]
+    # @param root [String]
+    # @return [String] The root relative path
+    def self.make_path_root_relative(path, dst, root)
+      # Find how to get to the root directopry from dst directory.
+      # Assumption is that dst is a subdirectory of root.
+      dst_dir = File.dirname(File.absolute_path(dst))
+
+      path.delete_prefix! ROOT_PATH_INDICATOR if root_relative_path? path
+
+      if File.exist?(root) && File.realpath(dst_dir.to_s).start_with?(File.realpath(root))
+        rel_start = ''
+
+        until File.identical?(File.realpath("#{dst_dir}/#{rel_start}"), File.realpath(root))
+          # invariant dst_dir/rel_start <= root
+          rel_start += '../'
+        end
+
+        if rel_start.end_with?('/') && path.start_with?('/')
+          "#{rel_start}#{path.delete_prefix('/')}"
+        else
+          "#{rel_start}#{path}"
+        end
+      else
+        # Because the destination is not in a subdirectory of root, a
+        # relative path to that root cannot be created. Instead,
+        # the path is assumed to be absolute relative to root
+        root = root.delete_suffix '/' if root.end_with? '/'
+        path = path.delete_prefix '/' if path.start_with? '/'
+
+        "#{root}/#{path}"
+      end
+    end
+
+    # rubocop:enable Metrics
+  end
+end

data/lib/pandocomatic/printer/command_printer.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.rb'
+  require_relative './printer'
 
   # Printer for Commands in non-quiet mode
   class CommandPrinter < Printer

data/lib/pandocomatic/printer/configuration_errors_printer.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.rb'
+  require_relative './printer'
 
   # Printer for ConfigurationErrors in non-quiet mode
   class ConfigurationErrorsPrinter < Printer
@@ -26,6 +28,5 @@ module Pandocomatic
       super 'configuration_errors.txt'
       @errors = errors
     end
-
   end
 end

data/lib/pandocomatic/printer/error_printer.rb

@@ -1,29 +1,35 @@
+# 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.rb'
+  require_relative './printer'
 
   # Printer for Errors in non-quiet mode
   class ErrorPrinter < Printer
     # Create a new ErrorPrinter
     def initialize(error)
-      template = if error.respond_to? :template then error.template else 'error.txt' end
+      template = if error.respond_to? :template
+                   error.template
+                 else
+                   'error.txt'
+                 end
       super template
       @error = error
     end
@@ -32,6 +38,5 @@ module Pandocomatic
     def print
       warn to_s
     end
-
   end
 end

data/lib/pandocomatic/printer/finish_printer.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 './summary_printer.rb'
+  require_relative './summary_printer'
 
   # Printer for the end of the conversion process in non-quiet mode
   class FinishPrinter < SummaryPrinter
@@ -25,14 +27,14 @@ module Pandocomatic
     MINUTE = 60
 
     # Create a new FinishPrinter
-    # 
+    #
     # @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'
+      template 'finish.txt'
 
       @start_time = start_time
       @end_time = Time.now
@@ -41,16 +43,15 @@ module Pandocomatic
     # Calculate the duration of the whole conversion process
     #
     # @return [Number]
-    def duration()
+    def duration
       seconds = @end_time - @start_time
       if seconds > MINUTE
         minutes = (seconds / MINUTE).floor
-        seconds = seconds - (minutes * MINUTE)
+        seconds -= (minutes * MINUTE)
         "#{minutes} minute#{'s' if minutes != 1} and #{seconds.round(1)} second#{'s' if seconds != 1}"
       else
         "#{seconds.round(1)} second#{'s' if seconds != 1}"
       end
     end
-
   end
 end