pandocomatic 0.2.8 → 1.0.0

data/lib/pandocomatic/printer/help_printer.rb

@@ -1,28 +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 './printer.rb'
+  require_relative './printer'
 
   # Printer for pandocomatic's help
   class HelpPrinter < Printer
     # Create a new HelpPrinter
-    def initialize()
+    def initialize
       super 'help.txt'
     end
   end

data/lib/pandocomatic/printer/printer.rb

@@ -1,55 +1,55 @@
+# 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 'erb'
-
-    # Printer base class for printing information from pandocomatic
-    class Printer
-
-        # Create a new Printer
-        # 
-        # @param template_file [String = 'help.txt'] the template to use when
-        #   printing.
-        def initialize(template_file = 'help.txt')
-            set_template template_file
-        end
+  require 'erb'
 
-        # Set the template used by this Printer
-        #
-        # @param template_file [String] the template to use
-        def set_template(template_file)
-            dir = File.dirname(__FILE__)
-            @template = File.absolute_path(File.join(dir, 'views', template_file))
-        end
+  # Printer base class for printing information from pandocomatic
+  class Printer
+    # Create a new Printer
+    #
+    # @param template_file [String = 'help.txt'] the template to use when
+    #   printing.
+    def initialize(template_file = 'help.txt')
+      template template_file
+    end
 
-        # Create a string based on this printer's template
-        #
-        # @return [String]
-        def to_s()
-            erb = ERB.new(File.read(@template), trim_mode: '>')
-            erb.result(binding())
-        end
+    # Set the template used by this Printer
+    #
+    # @param template_file [String] the template to use
+    def template(template_file)
+      dir = File.dirname(__FILE__)
+      @template = File.absolute_path(File.join(dir, 'views', template_file))
+    end
 
-        # Print to STDOUT
-        def print()
-            puts to_s()
-        end
+    # Create a string based on this printer's template
+    #
+    # @return [String]
+    def to_s
+      erb = ERB.new(File.read(@template), trim_mode: '>')
+      erb.result(binding)
+    end
 
+    # Print to STDOUT
+    def print
+      puts to_s
     end
+  end
 end

data/lib/pandocomatic/printer/summary_printer.rb

@@ -1,53 +1,59 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
-# 
+# Copyright 2017, 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 './printer.rb'
-
-    # Printer for printing a summary of the conversion process in non-quiet mode
-    class SummaryPrinter < Printer
+  require_relative './printer'
 
-        # Create a new SummaryPrinter
-        # 
-        # @param command [Command] the command to summarize
-        # @param configuration [Configuration] the configuration of the
-        # pandocomatic invokation
-        def initialize(command, configuration)
-            super 'summary.txt'
-            @command = command
-            @input = configuration.input.to_s
-            @output = configuration.output
-        end
+  # Printer for printing a summary of the conversion process in non-quiet mode
+  class SummaryPrinter < Printer
+    # Create a new SummaryPrinter
+    #
+    # @param command [Command] the command to summarize
+    # @param configuration [Configuration] the configuration of the
+    # pandocomatic invokation
+    def initialize(command, configuration)
+      super 'summary.txt'
+      @command = command
+      @input = configuration.input.to_s
+      @output = if configuration.stdout?
+                  nil
+                else
+                  configuration.output
+                end
 
-        # A string representation of the commands being executed
-        #
-        # @return [String]
-        def commands()
-            "#{@command.count} command#{'s' if @command.count != 1}"
-        end
+      @config_files = configuration.config_files
+    end
 
-        # Is there an output file?
-        #
-        # @return [Boolean] True if there is an output defined in this
-        #   SummaryPrinter, false otherwise
-        def has_output?()
-            not @output.nil? and not @output.empty?
-        end
+    # A string representation of the commands being executed
+    #
+    # @return [String]
+    def commands
+      "#{@command.count} command#{'s' if @command.count != 1}"
+    end
 
+    # Is there an output file?
+    #
+    # @return [Boolean] True if there is an output defined in this
+    #   SummaryPrinter, false otherwise
+    def output?
+      !@output.nil? and !@output.empty?
     end
+  end
 end

data/lib/pandocomatic/printer/version_printer.rb

@@ -1,32 +1,32 @@
+# 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 to print pandocomatic's version
   class VersionPrinter < Printer
-
     # Create a new VersionPrinter
-    def initialize version
+    def initialize(version)
       super 'version.txt'
       @version = version
     end
-
   end
 end

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

@@ -12,6 +12,11 @@ See `pandocomatic --help` which options are allowed.
 <%= @error.data.join(" ") %>.
 <% when :problematic_invocation %>
 <%=@error.error.message%>.
+<% when :cannot_use_stdout_with_directory %>
+Using `--stdout/-s` with an input directory is not allowed.
+<% when :cannot_use_both_output_and_stdout %>
+Using both `--output/-o` and `--stdout/-s` is not allowed.
+Use eiter a specific output file or directory, or standard out, not both.
 <% else %>
 '<%= @error.data %>'.
 <% end %>

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

@@ -1 +1,2 @@
-<%=@error.message%>: '<%= @error.data %>'.
+<%=@error.message%>: '<%= @error.data %>'.<% if @error.error? %> <%=
+@error.error.to_s %><% end %>

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

@@ -1,4 +1,4 @@
-Pandocomatic has encountered an error:
+[ERROR] Pandocomatic encountered the following error(s):
 
     <%= @error.message %>
     <%= @error.data %>

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

@@ -1 +1 @@
-Pandocomatic needed <%=duration%> to convert '<%= @input %>'<%if has_output?%> to '<%= @output %>'<%end%>.
+Pandocomatic needed <%=duration%> to convert '<%= @input %>'<%if output?%> to '<%= @output %>'<%end%>.

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

@@ -11,17 +11,20 @@ DESCRIPTION
   tree. Configure the conversion process through configuration files.  Each
   input file that is converted by pandocomatic is processed as follows:
 
+    setup(0) ... setup(K)
     input_file -> 
       preprocessor(0) -> ... -> preprocessor(N) ->
         pandoc -> 
           postprocessor(0) -> ... -> postprocessor(M) -> 
             output_file
+    cleanup(0) ... cleanup(L)
 
-  The preprocessors and postprocessors used in the conversion process are
-  configured in pandocomatic templates. Besides processors, you can also
-  specify pandoc options to use to convert the input file. These templates are
-  specified in a configuration file. Templates can be used over and over, thus
-  automating the use of pandoc.
+  The setup and cleanup scripts are run before and after the conversion
+  process, respectively. The preprocessors and postprocessors used in the
+  conversion process are configured in pandocomatic templates. Besides
+  processors, you can also specify pandoc options to use to convert the input
+  file. These templates are specified in a configuration file. Templates can
+  be used over and over, thus automating the use of pandoc.
 
 OPTIONS
 
@@ -36,12 +39,18 @@ OPTIONS
                   are specified on the command-line. Pandocomatic treats 
                   the concatenated files as a single input file.
 
-  -o PATH, --output PATH
-                  Create converted files and directories in PATH.
-
 
   Optional:
 
+  -o PATH, --output PATH
+                  Create converted files and directories in PATH. Cannot be
+                  used together with the `--stdout` option.
+
+  -s, --stdout
+                  Write the converted files to STDOUT. Cannot be used when
+                  converting directories, nor in combination with the
+                  `--output` option.
+
   -d PATH, --data-dir PATH
                   Configure pandocomatic to use PATH as its data directory.
                   Default is PANDOC's data dir. (See `pandoc --version` to
@@ -95,14 +104,17 @@ OPTIONS
                   destination files will be converted, copied, or linked.
                   Default is FALSE.
 
-  -q, --quiet     Run pandocomatic quietly. Default is FALSE.
+  -V, --verbose   Run pandocomatic verbosely. Default is FALSE. Pandocomatic
+                  runs quietly unless the verbose, debug, or dry-run options
+                  are given.
 
   -b, --debug     Run pandocomatic in debug mode: show the pandoc invocations
-                  before each conversion. Default is FALSE. Only works
-                  when not quiet.
+                  before each conversion. Default is FALSE. In debug mode,
+                  pandocomatic runs verbosely.
 
   -y, --dry-run   Configure pandocomatic to run the conversion process, but do
-                  not actually run it. Default is FALSE.
+                  not actually run it. Default is FALSE. When using this
+                  dry-run option, pandocomatic runs verbosely.
   
 
   Experimental:
@@ -135,7 +147,7 @@ EXAMPLE:
 
 SEE ALSO
 
-  - Pandocomatic's documentation
+  - Pandocomatic's manual
     https://heerdebeer.org/Software/markdown/pandocomatic/
 
   - Pandoc's user guide
@@ -146,11 +158,11 @@ SEE ALSO
 
 AUTHOR
 
-  Huub de Beer <Huub@heerdebeer.org>
+  Huub de Beer <huub@heerdebeer.org>
 
 LICENSE
 
-  Copyright 2014—2020 Huub de Beer <huub@heerdebeer.org>
+  Copyright 2014—2021 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/summary.txt

@@ -1 +1,7 @@
-<% if @command.count <= 0 then%>Nothing to do<% else %><%= commands %> to execute to convert '<%= @input %>'<%if has_output?%> to '<%= @output %>'<%end%><% end %>.
+Using configuration hierarchy:
+<% @config_files.each do |file| %>
+- <%= file %>
+
+<% end %>
+
+<% if @command.count <= 0 then%>Nothing to do<% else %><%= commands %> to execute to convert '<%= @input %>'<%if output?%> to '<%= @output %>'<%end%><% end %>.

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

@@ -0,0 +1 @@
+<%=@error.message%>

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

@@ -1,8 +1,8 @@
 Pandocomatic version <%=@version.join('.')%>
 
-© 2014—2020 Huub de Beer <Huub@heerdebeer.org>
+© 2014—2021 Huub de Beer <huub@heerdebeer.org>
 
 Pandocomatic is free software; pandocomatic is released under the GPLv3.
 
-For more information about pandocomatic run 'pandocomatic --help' or read its
-documentation at https://heerdebeer.org/Software/markdown/pandocomatic/.
+For more information about pandocomatic run 'pandocomatic --help' or read
+pandocomatic's manual at https://heerdebeer.org/Software/markdown/pandocomatic/.

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

@@ -1 +1 @@
-Warning. <%=@warning.message.to_s%>: <%=@warning.src%>
+[WARNING] <%=@warning.message.to_s%>: <%=@warning.src%>

data/lib/pandocomatic/printer/warning_printer.rb

@@ -1,38 +1,40 @@
+# 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 warnings
-    class WarningPrinter < Printer
-        # Create a new WarningPrinter
-        #
-        # @param warning [Warning] the warning to print
-        def initialize(warning)
-            template = 'warning.txt'
-            super template
-            @warning = warning
-        end
+  # Printer for warnings
+  class WarningPrinter < Printer
+    # Create a new WarningPrinter
+    #
+    # @param warning [Warning] the warning to print
+    def initialize(warning)
+      template = 'warning.txt'
+      super template
+      @warning = warning
+    end
 
-        # Print warnings to STDERR rather than STDOUT
-        def print
-            warn to_s
-        end
+    # Print warnings to STDERR rather than STDOUT
+    def print
+      warn to_s
     end
+  end
 end

data/lib/pandocomatic/processor.rb

@@ -1,49 +1,49 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2014, 2015, 2016, 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 'open3'
-    require_relative 'error/processor_error.rb'
+  require 'open3'
+  require_relative 'error/processor_error'
 
-    # Generic class for processors used to preprocess, postproces, setup, and
-    # cleanup with external scripts or programs during the conversion process.
+  # Generic class for processors used to preprocess, postproces, setup, and
+  # cleanup with external scripts or programs during the conversion process.
+  #
+  # For preprocessors and postprocessors it is assumed that the input is the
+  # contents of the file to convert and the output the processed input. In
+  # the end, the output will be put through pandoc.
+  class Processor
+    # Run script on input and return captured output
     #
-    # For preprocessors and postprocessors it is assumed that the input is the
-    # contents of the file to convert and the output the processed input. In
-    # the end, the output will be put through pandoc.
-    class Processor
-
-        # Run script on input and return captured output
-        #
-        # @param script [String] path to script to run
-        # @param input [String] input to process in the script
-        # 
-        # @return [String] output of script.
-        def self.run script, input
-            output, error, status = Open3.capture3(script, :stdin_data => input)
-            warn error unless error.empty?
-
-            if status.exitstatus > 0
-                raise ProcessorError.new(:error_processing_script, StandardError.new(error), [script, input]) 
-            end
+    # @param script [String] path to script to run
+    # @param input [String] input to process in the script
+    #
+    # @return [String] output of script.
+    def self.run(script, input)
+      output, error, status = Open3.capture3(script, stdin_data: input)
+      warn error unless error.empty?
 
-            output
-        end
+      if status.exitstatus.positive?
+        raise ProcessorError.new(:error_processing_script, StandardError.new(error), [script, input])
+      end
 
+      output
     end
+  end
 end

data/lib/pandocomatic/processors/fileinfo_preprocessor.rb

@@ -1,50 +1,55 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2014, 2015, 2016, 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 '../processor'
 
-    require_relative '../processor.rb'
+  # FileInfoPreprocessor collects information about a file to be converted and
+  # mixes that information into that file's metadata. It is a default
+  # preprocessor.
+  #
+  class FileInfoPreprocessor < Processor
+    # rubocop:disable Metrics/AbcSize
 
-    # FileInfoPreprocessor collects information about a file to be converted and
-    # mixes that information into that file's metadata. It is a default
-    # preprocessor.
+    # Run this FileInfoPreprocessor
     #
-    class FileInfoPreprocessor < Processor
-        # Run this FileInfoPreprocessor
-        #
-        # @param input [String] the contents of the document being preprocessed
-        # @param path [String] the path to the input document
-        # @param options [Hash] pandoc options collected by pandocomatic to run on
-        #   this file
-        def self.run input, path, src_path, options
-            created_at = File.stat(path).ctime
-            modified_at = File.stat(path).mtime
-            output = input
-            output << "\n\n---\n"
-            output << "pandocomatic-fileinfo:\n"
-            output << "  from: #{options['from']}\n" if options.has_key? 'from'
-            output << "  to: #{options['to']}\n" if options.has_key? 'to'
-            output << "  template: #{options['template']}\n" if options.has_key? 'template'
-            output << "  path: '#{path}'\n"
-            output << "  src_path: '#{src_path}'\n"
-            output << "  created: #{created_at.strftime '%Y-%m-%d'}\n"
-            output << "  modified: #{modified_at.strftime '%Y-%m-%d'}\n"
-            output << "...\n\n"
-        end
+    # @param input [String] the contents of the document being preprocessed
+    # @param path [String] the path to the input document
+    # @param options [Hash] pandoc options collected by pandocomatic to run on
+    #   this file
+    def self.run(input, path, src_path, options)
+      created_at = File.stat(path).ctime
+      modified_at = File.stat(path).mtime
+      output = input
+      output << "\n\n---\n"
+      output << "pandocomatic-fileinfo:\n"
+      output << "  from: #{options['from']}\n" if options.key? 'from'
+      output << "  to: #{options['to']}\n" if options.key? 'to'
+      output << "  template: #{options['template']}\n" if options.key? 'template'
+      output << "  path: '#{path}'\n"
+      output << "  src_path: '#{src_path}'\n"
+      output << "  created: #{created_at.strftime '%Y-%m-%d'}\n"
+      output << "  modified: #{modified_at.strftime '%Y-%m-%d'}\n"
+      output << "...\n\n"
     end
+
+    # rubocop:enable Metrics/AbcSize
+  end
 end