pandocomatic 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a6d28368a126d0db126154df753827ee3d79bc678dd570164da442cde462eb
-  data.tar.gz: 556a96419582f0f3a8d5a2ffb1679181bcb2d36ac917278b02cd50385eed3f9a
+  metadata.gz: 8f44c7b8261cd7c59a45102a8fe11a1cbb2202eaed96effff33ced0a4bf50fb8
+  data.tar.gz: 437ad6925e13b168a2980fb883574bd68b6cc14c722d8dfcb44fd39b46a42fcc
 SHA512:
-  metadata.gz: d0b032a03165acc0fdae449d501d849925254a54c8bd88c27160672f0ca1aad189cf927c2ed10617b74d961e873a57019ddbaf8c47119d71b0830c455514b482
-  data.tar.gz: f111513bafd58c972ca246fdb07f6236b898058202542f6baf10d5dce54d26c15cc3acecd4e4dc9504ec7fabb52f586be56fe74b2f25dc63350c14c4346f16bb
+  metadata.gz: 4e88c0ae54973b4dbed104edf17936193cfb763ee322ab9afb4bf1596fa7df0d6f7f437e129870f8795ad8855e33b513d432f28185fe071072b287b73a0061db
+  data.tar.gz: 45c9438e591086e856d216eeb696e28f7daf7af6fae56dae259610a651cb78c6fefc7d9826f5e00c57da3950a0db20c7067f6e4ac6e1eb88bcad94f49c79188e

data/lib/pandocomatic/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright 2017-2024, Huub de Beer <huub@heerdebeer.org>
+# Copyright 2017-2025, Huub de Beer <huub@heerdebeer.org>
 #
 # This file is part of pandocomatic.
 #
@@ -24,6 +24,8 @@ module Pandocomatic
   require_relative 'error/cli_error'
   require_relative 'configuration'
 
+  # rubocop:disable Metrics
+
   ##
   # Command line options parser for pandocomatic using optimist.
   #
@@ -49,8 +51,6 @@ module Pandocomatic
       end
     end
 
-    # rubocop:disable Metrics
-
     # Parse pandocomatic's global options.
     #
     # @return [Configuration]
@@ -70,6 +70,7 @@ module Pandocomatic
         opt :data_dir, 'Data dir', short: '-d', type: String
         opt :config, 'Configuration file', short: '-c', type: String
         opt :root_path, 'Root path', short: '-r', type: String
+        opt :template, 'Template to use for conversion', short: '-t', type: String, multi: true
 
         # What to convert and where to put it
         opt :output, 'Output', short: '-o', type: String
@@ -106,7 +107,7 @@ module Pandocomatic
 
         # if no input option is specified, all items following the last option
         # are treated as input files.
-        if !(options[:input_given])
+        if !options[:input_given]
           Pandocomatic::LOG.debug '✓  Option \'--input\' not used:  ' \
                                   'treat all arguments after last option as input files or directories.'
           options[:input] = args
@@ -143,12 +144,30 @@ module Pandocomatic
         Pandocomatic::LOG.debug '✓  Input files and directories exist.'
 
         # You cannot use the --stdout option while converting directories
-        if options[:stdout_given] && File.directory?(input.first)
+        if convert_directory?(input) && options[:stdout_given]
           options[:stdout] = false
           raise CLIError, :cannot_use_stdout_with_directory
         end
         Pandocomatic::LOG.debug '✓  Write output to STDOUT.' if options[:stdout_given]
 
+        # You cannot use the --template option while converting directories
+        if convert_directory?(input) && options[:template_given]
+          options[:template] = nil
+          raise CLIError, :cannot_use_template_with_directory
+        end
+
+        # Postponing checking for existence of template until configuration
+        # hierarchy has been loaded.
+        if options[:template_given]
+          templates = options[:template]
+          duplicates = templates.select { |t| templates.count(t) > 1 }
+
+          options[:template] = templates.uniq
+
+          Pandocomatic::LOG.debug "✓  Use templates '#{options[:template]}' for conversion."
+          Pandocomatic::LOG.warn " !  Ignoring duplicate templates: #{duplicates}." unless duplicates.empty?
+        end
+
         if options[:output_given]
           # You cannot use --stdout with --output
           if options[:stdout_given]
@@ -224,7 +243,7 @@ module Pandocomatic
     # rubocop:enable Metrics
 
     private_class_method def self.options_need_to_be_validated?(options)
-      !(options[:version_given]) and !(options[:help_given])
+      !options[:version_given] and !options[:help_given]
     end
 
     #--
@@ -267,5 +286,9 @@ module Pandocomatic
       raise CLIError.new(:output_is_not_a_file, nil, input) if File.file? input
       raise CLIError.new(:output_is_not_a_directory, nil, input) if File.directory? input
     end
+
+    private_class_method def self.convert_directory?(input)
+      File.directory? input.first
+    end
   end
 end

data/lib/pandocomatic/command/convert_file_command.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright 2017-2024, Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2017-2025, Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of pandocomatic.
 #
@@ -127,10 +127,11 @@ module Pandocomatic
       str
     end
 
-    private
-
+    # Name of the anonymous inner template.
     INTERNAL_TEMPLATE = 'internal template'
 
+    private
+
     def convert_file
       pandoc_options = @metadata.pandoc_options || {}
       template = nil
@@ -164,11 +165,16 @@ module Pandocomatic
              '"--enable pandoc-verbose".'
       end
 
-      template.merge! Template.new(INTERNAL_TEMPLATE, @metadata.pandocomatic) if @metadata.pandocomatic?
+      template_log = Pandocomatic::LOG.indent(YAML.dump(template.to_h).sub('---', ''), 34)
 
-      Pandocomatic::LOG.debug '  #  Selected template mixed with internal template and pandocomatic metadata ' \
-                              "gives final template:#{Pandocomatic::LOG.indent(YAML.dump(template.to_h).sub('---', ''),
-                                                                               34)}"
+      if @metadata.pandocomatic?
+        template.merge! Template.new(INTERNAL_TEMPLATE, @metadata.pandocomatic)
+
+        Pandocomatic::LOG.debug '  #  Selected template mixed with internal template and pandocomatic metadata ' \
+                                "gives final template:#{template_log}"
+      else
+        Pandocomatic::LOG.debug "  #  Selected template:#{template_log}"
+      end
 
       # Write out the results of the conversion process to file.
       @dst = @metadata.pandoc_options['output'] if @dst.to_s.empty? && @metadata.pandoc_options.key?('output')

data/lib/pandocomatic/command/convert_file_multiple_command.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright 2017—2024 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2017—2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of pandocomatic.
 #
@@ -49,31 +49,40 @@ module Pandocomatic
       @config = config
       @src = src
 
-      metadata = @config.get_metadata @src
-
       subcommands = []
 
-      if metadata&.template?
-        # There are templates in this document's metadata, try to use
-        # those.
-        metadata.templates.each do |template_name|
-          unless template_name.empty? || config.template?(template_name)
-            raise ConfigurationError.new(:no_such_template, nil,
-                                         template_name)
-          end
+      if @config.use_templates?
+        # Command-line specified template overrides all internal templates
+        Pandocomatic::LOG.info 'Ignoring any internal pandocomatic configuration from input\'s YAML blocks'
 
-          subcommands.push ConvertFileCommand.new(@config, @src, dst, template_name)
+        @config.selected_templates.each do |template|
+          subcommands.push ConvertFileCommand.new(@config, @src, dst, template)
         end
       else
-        # Try to match any global templates using the glob patterns
-        global_templates = @config.determine_templates(@src)
+        metadata = @config.get_metadata @src
+
+        if metadata&.template?
+          # There are templates in this document's metadata, try to use
+          # those.
+          metadata.templates.each do |template_name|
+            unless template_name.empty? || config.template?(template_name)
+              raise ConfigurationError.new(:no_such_template, nil,
+                                           template_name)
+            end
 
-        if global_templates.empty?
-          subcommands.push ConvertFileCommand.new(@config, @src, dst)
-        else
-          global_templates.each do |template_name|
             subcommands.push ConvertFileCommand.new(@config, @src, dst, template_name)
           end
+        else
+          # Try to match any global templates using the glob patterns
+          global_templates = @config.determine_templates(@src)
+
+          if global_templates.empty?
+            subcommands.push ConvertFileCommand.new(@config, @src, dst)
+          else
+            global_templates.each do |template_name|
+              subcommands.push ConvertFileCommand.new(@config, @src, dst, template_name)
+            end
+          end
         end
       end
 
@@ -101,7 +110,7 @@ module Pandocomatic
 
       description = CommandPrinter.new(self)
       Pandocomatic::LOG.info description
-      description.print unless quiet? || (@subcommands.size == 1)
+
       run if !dry_run? && runnable?
 
       @subcommands.each(&:execute)

data/lib/pandocomatic/configuration.rb

@@ -2,7 +2,7 @@
 
 # rubocop:disable Metrics
 #--
-# Copyright 2014—2024 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2014—2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of pandocomatic.
 #
@@ -109,6 +109,7 @@ module Pandocomatic
     'tei' => 'tei',
     'texinfo' => 'texi',
     'textile' => 'textile',
+    'typst' => 'typ',
     'xwiki' => 'xwiki',
     'zimwiki' => 'zimwiki'
   }.freeze
@@ -197,6 +198,15 @@ module Pandocomatic
 
       load_configuration_hierarchy options, data_dirs
 
+      # Check if template selected via CLI option exists
+      if use_templates?
+        non_existing_templates = selected_templates.reject { |t| template? t }
+
+        unless non_existing_templates.empty?
+          raise ConfigurationError.new(:templates_do_not_exist, nil, non_existing_templates)
+        end
+      end
+
       @input = if input.nil? || input.empty?
                  nil
                elsif input.size > 1
@@ -377,6 +387,24 @@ module Pandocomatic
       !@options.nil? and @options[:output_given] and @options[:output]
     end
 
+    # Is the template CLI option given?
+    #
+    # @return [Boolean]
+    def use_templates?
+      !@options.nil? and @options[:template_given] and @options[:template] and !@options[:template].empty?
+    end
+
+    # Get the selected templates
+    #
+    # @return [String[]]
+    def selected_templates
+      if use_templates?
+        @options[:template]
+      else
+        []
+      end
+    end
+
     # Get the output file name
     #
     # @return [String]
@@ -439,8 +467,8 @@ module Pandocomatic
     # @param template_name [String] template used; optional parameter
     # @return [PandocMetadata] Pandoc's metadata for given file and template.
     def get_metadata(src, template_name = nil)
-      if extract_metadata_from? src
-        PandocMetadata.load_file src
+      if extract_metadata_from?(src)
+        PandocMetadata.load_file src, ignore_pandocomatic: use_templates?
       else
         src_format = nil
 
@@ -460,9 +488,9 @@ module Pandocomatic
 
         if !src_format || src_format == 'markdown'
           # Behave like pandoc: If no source format can be determined, assume markdown
-          PandocMetadata.load_file src
+          PandocMetadata.load_file src, ignore_pandocomatic: use_templates?
         else
-          PandocMetadata.empty src_format
+          PandocMetadata.empty src_format, ignore_pandocomatic: use_templates?
         end
       end
     end

data/lib/pandocomatic/error/cli_error.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
-#
+# Copyright 2017-2025, Huub de Beer <Huub@heerdebeer.org>
 # This file is part of pandocomatic.
 #
 # Pandocomatic is free software: you can redistribute it and/or modify
@@ -40,6 +39,7 @@ module Pandocomatic
     # :output_it_not_writable,
 
     # :cannot_use_stdout_with_directory
+    # :cannot_use_template_with_directory
     # :cannot_use_both_output_and_stdout
 
     # :unknown_option,

data/lib/pandocomatic/error/configuration_error.rb

@@ -38,5 +38,6 @@ module Pandocomatic
     # :unable_to_load_config_file
 
     # :no_such_template
+    # :templates_do_not_exist
   end
 end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -49,10 +49,14 @@ module Pandocomatic
     # Create an empty metadata object with only the source format set.
     #
     # @param src_format [String] the source format
+    # @param ignore_pandocomatic [Boolean] when true, ignore pandocomatic
+    # configuration in YAML metadata blocks
     # @return [PandocMetadata[ empty metadata with only pandoc's source format
     # set.
-    def self.empty(src_format)
-      PandocMetadata.new({ 'pandocomatic_' => { 'pandoc' => { 'from' => src_format } } })
+    def self.empty(src_format, ignore_pandocomatic: false)
+      metadata = PandocMetadata.new
+      metadata['pandocomatic_'] = { 'pandoc' => { 'from' => src_format } } unless ignore_pandocomatic
+      metadata
     end
 
     # Collect the metadata embedded in the src file and create a new
@@ -61,8 +65,8 @@ module Pandocomatic
     # @param src [String] the path to the file to load metadata from
     # @return [PandocMetadata] the metadata in the source file, or an empty
     #   one if no such metadata is contained in the source file.
-    def self.load_file(src)
-      self.load File.read(src), src
+    def self.load_file(src, ignore_pandocomatic: false)
+      self.load File.read(src), path: src, ignore_pandocomatic:
     end
 
     # Collect the metadata embedded in the src file and create a new
@@ -70,18 +74,27 @@ module Pandocomatic
     #
     # @param input [String] the string to load the metadata from
     # @param path [String|Nil] the path to the source of the input, if any
+    # @param ignore_pandocomatic [Boolean] when true, ignore pandocomatic
+    # configuration in YAML metadata blocks
     # @return [PandocMetadata] the metadata in the source file, or an empty
     #   one if no such metadata is contained in the source file.
     #
     # @raise [PandocomaticError] when the pandoc metadata cannot be
     # extracted.
-    def self.load(input, path = nil)
+    def self.load(input, path: nil, ignore_pandocomatic: false)
       yaml, pandocomatic_blocks = extract_metadata(input, path)
 
       if yaml.empty?
         PandocMetadata.new
       else
-        PandocMetadata.new PandocomaticYAML.load(yaml, path), unique: pandocomatic_blocks <= 1
+        metadata = PandocMetadata.new PandocomaticYAML.load(yaml, path), unique: pandocomatic_blocks <= 1
+
+        if ignore_pandocomatic
+          metadata.delete('pandocomatic')
+          metadata.delete('pandocomatic_')
+        end
+
+        metadata
       end
     end
 

data/lib/pandocomatic/pandocomatic.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright 2014—2024, Huub de Beer <huub@heerdebeer.org>
+# Copyright 2014—2025, Huub de Beer <huub@heerdebeer.org>
 #
 # This file is part of pandocomatic.
 #
@@ -216,11 +216,10 @@ module Pandocomatic
       ErrorPrinter.new(e).print
       exit ERROR_STATUS + 1
     rescue StandardError => e
-      warn e
-      warn e.backtrace
       # An unexpected error has occurred; break off the program drastically
       # for now. This is likely a bug: ask the user to report it.
       UnknownErrorPrinter.new(e).print
+      LOG.error e.backtrace.join("\n")
       exit ERROR_STATUS + 2
     ensure
       configuration&.clean_up!

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

@@ -14,6 +14,8 @@ See `pandocomatic --help` which options are allowed.
 <%=@error.error.message%>.
 <% when :cannot_use_stdout_with_directory %>
 Using `--stdout/-s` with an input directory is not allowed.
+<% when :cannot_use_template_with_directory %>
+Using `--template/-t` 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.

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

@@ -97,6 +97,19 @@ OPTIONS
                   respectively. In a file, the property 'use-template' tells
                   pandocomatic which template to use.
 
+  -t TEMPLATE, --template TEMPLATE
+                  Use given TEMPLATE for conversion. TEMPLATE should be
+                  defined in pandocomatic's configuration hierarchy. TEMPLATE
+                  will override any internal template. More so pandocomatic 
+                  configuration in YAML block will be ignored.
+
+                  Only allowed when converting files; option not allowed when
+                  converting directories.
+
+                  You can use this option multiple times. For each given 
+                  TEMPLATE a separate conversion is run. Duplicate TEMPLATEs
+                  are ignored.
+
   -m, --modified-only
         
                   Only convert files that have been modified. Only source files
@@ -179,7 +192,7 @@ AUTHOR
 
 LICENSE
 
-  Copyright 2014—2024 Huub de Beer <huub@heerdebeer.org>
+  Copyright 2014—2025 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/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright 2023—2024 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2023—2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of pandocomatic.
 #
@@ -20,5 +20,5 @@
 #++
 module Pandocomatic
   # Pandocomatic's current version.
-  VERSION = [2, 1, 0].freeze
+  VERSION = [2, 2, 0].freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Huub de Beer
@@ -13,36 +13,36 @@ dependencies:
   name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: paru
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -62,91 +62,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.25.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.25.1
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.2.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.2.1
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.66.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.66.1
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.37
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.37
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
 description: Pandocomatic is a tool to automate using pandoc. With pandocomatic you
   can express common patterns of using pandoc for generating your documents. Applied
   to a directory, pandocomatic can act as a static site generator.
@@ -216,7 +132,7 @@ files:
 - lib/pandocomatic/warning.rb
 homepage: https://heerdebeer.org/Software/markdown/pandocomatic/
 licenses:
-- GPL-3.0
+- GPL-3.0-or-later
 metadata:
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -234,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - pandoc, a universal document converter
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Automate the use of pandoc
 test_files: []