pandocomatic 0.2.8 → 1.0.0

data/lib/pandocomatic/multiple_files_input.rb

@@ -1,103 +1,110 @@
+# 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 'tempfile'
+  require_relative './input'
 
-    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, config)
+      super(input)
+      @config = config
+      create_temp_file
+    end
 
-    # A specific Input class to handle multiple input files
-    class MultipleFilesInput < Input
+    # The name of this input
+    #
+    # @return String
+    def name
+      @tmp_file.path
+    end
 
-        # 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, config)
-            super(input)
-            @config = config
-            create_temp_file
-        end
+    # Is this input a directory? A MultipleFilesInput cannot be a
+    # directory
+    #
+    # @return Boolean
+    def directory?
+      false
+    end
 
-        # The name of this input
-        #
-        # @return String
-        def name()
-            @tmp_file.path
-        end
+    # Destroy the temporary file created for this MultipleFilesInput
+    def destroy!
+      return if @tmp_file.nil?
 
-        # Is this input a directory? A MultipleFilesInput cannot be a
-        # directory
-        #
-        # @return Boolean
-        def directory?()
-            false
-        end
+      @tmp_file.close
+      @tmp_file.unlink
+    end
 
-        # Destroy the temporary file created for this MultipleFilesInput
-        def destroy!()
-            if not @tmp_file.nil?
-                @tmp_file.close
-                @tmp_file.unlink
-            end
+    # A string representation of this Input
+    #
+    # @return String
+    def to_s
+      input_string = @input_files.first
+      previous_dir = File.dirname @input_files.first
+      @input_files.slice(1..-1).each do |f|
+        current_dir = File.dirname f
+        if current_dir == previous_dir
+          input_string += " + #{File.basename f}"
+        else
+          previous_dir = current_dir
+          input_string += " + #{f}"
         end
+      end
 
-        # A string representation of this Input
-        #
-        # @return String
-        def to_s()
-            input_string = @input_files.first
-            previous_dir = File.dirname @input_files.first
-            @input_files.slice(1..-1).each do |f|
-                current_dir = File.dirname f
-                if current_dir == previous_dir
-                    input_string += " + #{File.basename f}"
-                else
-                    previous_dir = current_dir
-                    input_string += " + #{f}"
-                end
-            end
-
-            input_string
-        end
+      input_string
+    end
 
-        private 
+    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("pandocomatic_tmp_", File.dirname(self.absolute_path))
+    # rubocop:disable Metrics/AbcSize
 
-            contents = @input_files.map{|file| 
-                @errors.push IOError.new(:file_does_not_exist, nil, file) unless File.exist? file
-                @errors.push IOError.new(:file_is_not_a_file, nil, file) unless File.file? file
-                @errors.push IOError.new(:file_is_not_readable, nil, file) unless File.readable? file
-                File.read File.absolute_path(file)
-            }.join("\n\n")
+    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('pandocomatic_tmp_', File.dirname(absolute_path))
 
-            metadata = PandocMetadata.load contents
+      contents = @input_files.map do |file|
+        @errors.push IOError.new(:file_does_not_exist, nil, file) unless File.exist? file
+        @errors.push IOError.new(:file_is_not_a_file, nil, file) unless File.file? file
+        @errors.push IOError.new(:file_is_not_readable, nil, file) unless File.readable? file
+        File.read File.absolute_path(file)
+      end.join("\n\n")
 
-            if not metadata.unique?
-                warn "\nWarning: Encountered the pandocomatic metadata property in more than one YAML metadata block. Only the pandocomatic property from the first YAML metadata block is being used; the other pandocomatic properties have been discarded.\n\n"
-            end
+      metadata = PandocMetadata.load contents
 
-            @tmp_file.write contents
-            @tmp_file.rewind
-        end
+      unless metadata.unique?
+        warn "\nWarning: Encountered the pandocomatic metadata property in"\
+             ' more than one YAML metadata block. Only the pandocomatic property'\
+             ' from the first YAML metadata block is being used; the other'\
+             " pandocomatic properties have been discarded.\n\n"
+      end
+
+      @tmp_file.write contents
+      @tmp_file.rewind
     end
+
+    # rubocop:enable Metrics/AbcSize
+  end
 end

data/lib/pandocomatic/output.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#--
+# Copyright 2021 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'
+
+  # Generic class to handle output in a general manner.
+  class Output
+    # Create a new Output
+    def initialize; end
+  end
+end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -1,214 +1,226 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2014, 2015, 2016, 2017, 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
+  require 'json'
+  require 'paru'
+  require 'yaml'
+
+  require_relative './error/pandoc_error'
+  require_relative './error/io_error'
+  require_relative './pandocomatic_yaml'
+
+  # 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.
+  class PandocMetadata < Hash
+    # 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)
+      extract_metadata(input).first
+    end
 
-    require 'json'
-    require 'yaml'
-    require 'paru'
+    # Collect the metadata embedded in the src file and create a new
+    # PandocMetadata instance
+    #
+    # @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
+    end
 
-    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
+    # Collect the metadata embedded in the src file and create a new
+    # PandocMetadata instance
+    #
+    # @param input [String] the string to load the metadata from
+    # @param path [String|Nil] the path to the source of the input, if any
+    # @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(input, path = nil)
+      yaml, pandocomatic_blocks = extract_metadata(input, path)
+
+      if yaml.empty?
+        PandocMetadata.new
+      else
+        PandocMetadata.new PandocomaticYAML.load(yaml, path), unique: pandocomatic_blocks <= 1
+      end
+    end
 
-    # PandocMetadata represents the metadata with pandoc options set in
-    # templates and input files.
-    class PandocMetadata < Hash
+    # Creat e new PandocMetadata object based on the properties contained
+    # in a Hash
+    #
+    # @param hash [Hash] initial properties for this new PandocMetadata
+    #   object
+    # @param unique [Boolean = true] the pandocomatic property did occur
+    # at most once.
+    # @return [PandocMetadata]
+    def initialize(hash = {}, unique: true)
+      super()
+      merge! hash
+      @unique = unique
+    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)
-            extract_metadata(input).first
-        end
+    # Did the metadata contain multiple pandocomatic blocks?
+    #
+    # @return [Boolean] True if at most one pandocomatic block was present
+    # in the metadata
+    def unique?
+      @unique
+    end
 
-        # Collect the metadata embedded in the src file and create a new
-        # PandocMetadata instance
-        #
-        # @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)
-            load(File.read src)
-        end
-        
-        # Collect the metadata embedded in the src file and create a new
-        # PandocMetadata instance
-        #
-        # @param input [String] the string to load the 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(input)
-            yaml, pandocomatic_blocks = extract_metadata(input)
-
-            if yaml.empty? then
-                PandocMetadata.new
-            else
-                PandocMetadata.new YAML.load(yaml), 1 >= pandocomatic_blocks
-            end
-        end
+    # Does this PandocMetadata object use a template?
+    #
+    # @return [Boolean] true if it has a key 'use-template' among the
+    #   pandocomatic template properties.
+    def template?
+      pandocomatic? and pandocomatic.key? 'use-template' and !pandocomatic['use-template'].empty?
+    end
 
-        # Creat e new PandocMetadata object based on the properties contained
-        # in a Hash
-        #
-        # @param hash [Hash] initial properties for this new PandocMetadata
-        #   object
-        # @param unique [Boolean = true] the pandocomatic property did occur
-        # at most once.
-        # @return [PandocMetadata] 
-        def initialize(hash = {}, unique = true)
-            super()
-            merge! hash
-            @unique = unique
+    # Get all the templates of this PandocMetadata oject
+    #
+    # @return [Array] an array of templates used in this PandocMetadata
+    #   object
+    def templates
+      if template?
+        if pandocomatic['use-template'].is_a? Array
+          pandocomatic['use-template']
+        else
+          [pandocomatic['use-template']]
         end
+      else
+        ['']
+      end
+    end
 
-        # Did the metadata contain multiple pandocomatic blocks?
-        #
-        # @return [Boolean] True if at most one pandocomatic block was present
-        # in the metadata
-        def unique?()
-            @unique
-        end
+    # Get the used template's name
+    #
+    # @return [String] the name of the template used, if any, "" otherwise.
+    def template_name
+      if template?
+        pandocomatic['use-template']
+      else
+        ''
+      end
+    end
 
-        # Does this PandocMetadata object use a template?
-        #
-        # @return [Boolean] true if it has a key 'use-template' among the
-        #   pandocomatic template properties.
-        def has_template?()
-            has_pandocomatic? and pandocomatic.has_key? 'use-template' and not pandocomatic['use-template'].empty?
-        end
+    # Does this PandocMetadata object have a pandocomatic property?
+    #
+    # @return [Boolean] True if this PandocMetadata object has a Hash
+    # property named "pandocomatic_". False otherwise.
+    #
+    # Note. For backward compatibility with older versions of
+    # pandocomatic, properties named "pandocomatic" (without the trailing
+    # underscore) are also accepted.
+    def pandocomatic?
+      config = nil
+      if key?('pandocomatic') || key?('pandocomatic_')
+        config = self['pandocomatic'] if key? 'pandocomatic'
+        config = self['pandocomatic_'] if key? 'pandocomatic_'
+      end
+      config.is_a? Hash
+    end
 
-        # Get all the templates of this PandocMetadata oject
-        #
-        # @return [Array] an array of templates used in this PandocMetadata
-        #   object
-        def templates() 
-            if has_template?
-                if pandocomatic['use-template'].is_a? Array
-                    pandocomatic['use-template']
-                else
-                    [pandocomatic['use-template']]
-                end
-            else
-                [""]
-            end
-        end
+    # Get the pandoc options for this PandocMetadata object
+    #
+    # @return [Hash] the pandoc options if there are any, an empty Hash
+    #   otherwise.
+    def pandoc_options
+      if pandoc_options?
+        pandocomatic['pandoc']
+      else
+        {}
+      end
+    end
 
-        # Get the used template's name
-        #
-        # @return [String] the name of the template used, if any, "" otherwise.
-        def template_name()
-            if has_template? then
-                pandocomatic['use-template']
-            else
-                ''
-            end
-        end
-        
-        # Does this PandocMetadata object have a pandocomatic property?
-        #
-        # @return [Boolean] True if this PandocMetadata object has a Hash
-        # property named "pandocomatic_". False otherwise.
-        #
-        # Note. For backward compatibility with older versions of
-        # pandocomatic, properties named "pandocomatic" (without the trailing
-        # underscore) are also accepted.
-        def has_pandocomatic?()
-            config = nil
-            if has_key? 'pandocomatic' or has_key? 'pandocomatic_'
-                config = self['pandocomatic'] if has_key? 'pandocomatic'
-                config = self['pandocomatic_'] if has_key? 'pandocomatic_'
-            end
-            config.is_a? Hash
-        end
+    # Get the pandocomatic property of this PandocMetadata object
+    #
+    # @return [Hash] the pandocomatic property as a Hash, if any, an empty
+    #   Hash otherwise.
+    def pandocomatic
+      return self['pandocomatic'] if key? 'pandocomatic'
+      return self['pandocomatic_'] if key? 'pandocomatic_'
+    end
 
-        # Get the pandoc options for this PandocMetadata object
-        #
-        # @return [Hash] the pandoc options if there are any, an empty Hash
-        #   otherwise.
-        def pandoc_options()
-            if has_pandoc_options? then
-                pandocomatic['pandoc']
-            else
-                {}
-            end
-        end
+    # Does this PandocMetadata object has a pandoc options property?
+    #
+    # @return [Boolean] True if there is a pandoc options property in this
+    #   PandocMetadata object. False otherwise.
+    def pandoc_options?
+      pandocomatic? and pandocomatic.key? 'pandoc' and !pandocomatic['pandoc'].nil?
+    end
 
-        # Get the pandocomatic property of this PandocMetadata object
-        #
-        # @return [Hash] the pandocomatic property as a Hash, if any, an empty
-        #   Hash otherwise.
-        def pandocomatic()
-            return self['pandocomatic'] if has_key? 'pandocomatic'
-            return self['pandocomatic_'] if has_key? 'pandocomatic_'
-        end
+    # Extract the metadata from an input file
+    #
+    # @param input [String] the string to extract metadata from
+    # @return [Array] The return value is an array with the following two
+    # values:
+    #
+    # 1. The extracted metadata as a YAML string
+    # 2. The number of times the pandocomatic properties did occur in the
+    #    input.
+    #
+    # If more than one pandocomatic property is contained in the input,
+    # all but the first are discarded and are not present in the
+    # extracted metadata YAML string.
+    private_class_method def self.extract_metadata(input, path)
+      metadata_blocks = MetadataBlockList.new input, path
+
+      ["#{YAML.dump(metadata_blocks.full)}...", metadata_blocks.count_pandocomatic_blocks]
+    end
 
-        # Does this PandocMetadata object has a pandoc options property?
-        #
-        # @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?
+    # List of YAML metadata blocks present in some input source file
+    class MetadataBlockList
+      def initialize(input, path)
+        @metadata_blocks = input
+                           .scan(METADATA_BLOCK)
+                           .map { |match| PandocomaticYAML.load "---#{match.join}...", path }
+                           .select { |block| !block.nil? and !block.empty? }
+      end
+
+      # Count the number of metadata blocks with a "pandocomatic_" property.
+      def count_pandocomatic_blocks
+        @metadata_blocks.count do |block|
+          block.key? 'pandocomatic_' or block.key? 'pandocomatic'
         end
-
-        private 
-
-        # Extract the metadata from an input file
-        #
-        # @param input [String] the string to extract metadata from
-        # @return [Array] The return value is an array with the following two
-        # values:
-        #  
-        # 1. The extracted metadata as a YAML string
-        # 2. The number of times the pandocomatic properties did occur in the
-        #    input.
+      end
+
+      # Combine all metadata blocks into a single metadata block
+      # @return [Hash]
+      def full
+        # According to the pandoc manual: "A document may contain multiple
+        # metadata blocks. The metadata fields will be combined through a
+        # left-biased union: if two metadata blocks attempt to set the
+        # same field, the value from the first block will be taken."
         #
-        # If more than one pandocomatic property is contained in the input,
-        # all but the first are discarded and are not present in the
-        # extracted metadata YAML string.
-        def self.extract_metadata(input)
-            metadata_blocks = input
-                .scan(METADATA_BLOCK)
-                .map {|match| YAML.load "---#{match.join()}..."}
-                .select {|block| not block.nil? and not block.empty?}
-            
-            pandocomatic_blocks = metadata_blocks.count do |block|
-                block.key? "pandocomatic_" or block.key? "pandocomatic"
-            end
-
-            # According to the pandoc manual: "A document may contain multiple
-            # metadata blocks. The metadata fields will be combined through a
-            # left-biased union: if two metadata blocks attempt to set the
-            # same field, the value from the first block will be taken."
-            #
-            # Here we do the same
-            full_metadata = metadata_blocks
-                .reverse
-                .reduce(Hash.new) {|metadata, block| metadata.merge!(block)}
-
-            yaml_string = YAML.dump(full_metadata) + "..."
-
-            return [yaml_string, pandocomatic_blocks]
-        end
-
+        # Here we do the same
+        @metadata_blocks
+          .reverse
+          .reduce({}) { |metadata, block| metadata.merge!(block) }
+      end
     end
 
+    private_constant :MetadataBlockList
+  end
 end