pandocomatic 0.2.5.0.betac → 0.2.5.0.betad

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83da5ac4d9f87c0b60d2ec6275604fbc8c840448a0d4b2e8bcd3d814f43851a1
-  data.tar.gz: 6c2aa725f3476c529b743a337b26e19c3135440e6972a5d8121c100cd8c95202
+  metadata.gz: c46b6b2c7d745668a59b28bb2f38823ece50c90f24bd53e31c586489e429cb88
+  data.tar.gz: 336889e4f77b7511034f62cb21ab42c01095818e79ebd3d758f30aecc8e10278
 SHA512:
-  metadata.gz: 142b4f1a64096eb3ae1b7311d2639020d6af74af98c0cc28acf90fe6018dcdb9b7685408114452ba4b50f54acbc8629afb1a40ebf64a886e0f7bdaf4a388b8aa
-  data.tar.gz: 1aa6c6e996c8c667f738ce40b09d5dafc2251536a1b2481502dca6627262fe2c84ca16597c0f62afcefec86b513e44bfaae2ec35926765b64f01d9f0061a6701
+  metadata.gz: f1f6304e2838a32387b88fd4a18f855e1ee90159262635b9f2cd2b3f568523868dcb157499dcd6fb886f77769ca5a687f68427f24ffb233cb8e6f914e0de9e00
+  data.tar.gz: 5f13e1a64e6b012726d55053df8bf0eb9a7bca879201f3c71d164ae526f6ad7db721b0032616471223e7910d88b202cc44791361ec1812e1fc06ae459e16bcc1

data/lib/pandocomatic/command/convert_file_command.rb

@@ -90,7 +90,9 @@ module Pandocomatic
         #
         # @return [String]
         def to_s
-            "convert #{File.basename @src} #{"-> #{File.basename @dst}" unless @dst.nil?}"
+            str = "convert #{File.basename @src} #{"-> #{File.basename @dst}" unless @dst.nil?}"
+            str += "\n\t encountered multiple pandocomatic properties in the metadata. Only the last occurring pandocomatic property is being used." unless @metadata.unique?
+            str
         end
 
         private

data/lib/pandocomatic/command/convert_file_multiple_command.rb

@@ -46,7 +46,7 @@ module Pandocomatic
         super()
         @config = config
         @src = src
-        
+
         metadata = PandocMetadata.load_file @src
 
         subcommands = []

data/lib/pandocomatic/input.rb

@@ -23,11 +23,14 @@ module Pandocomatic
     # Generic class to handle input files and directories in a general manner.
     class Input
 
+        attr_reader :errors
+
         # Create a new Input
         #
         # @param input [String[]] a list of input files
         def initialize(input)
             @input_files = input
+            @errors = []
         end
 
         # The absolute path to this Input
@@ -57,6 +60,13 @@ module Pandocomatic
         def directory?()
             File.directory? @input_files.first
         end
+        
+        # Does this input have encountered any errors?
+        #
+        # @return Boolean
+        def has_errors?()
+            not @errors.empty?
+        end
 
         # A string representation of this Input
         #

data/lib/pandocomatic/multiple_files_input.rb

@@ -38,7 +38,7 @@ module Pandocomatic
         #
         # @return String
         def name()
-            @tmp_file
+            @tmp_file.path
         end
 
         # Is this input a directory? A MultipleFilesInput cannot be a
@@ -83,35 +83,18 @@ module Pandocomatic
             # created in the same directory as the first input file
             @tmp_file = Tempfile.new(@input_files.first, File.dirname(self.absolute_path))
 
-            # Read first file and its metadata
-            metadata = PandocMetadata.load_file @input_files.first
+            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")
 
-            strip_metadata = 
-                "markdown" == if metadata.pandoc_options.has_key? "from" then
-                                  metadata.pandoc_options["from"]
-                              else
-                                  template = @config.determine_template @input_files.first
-                                  if not template.nil? and not template.dig("pandoc", "from").nil? then
-                                      template["pandoc"]["from"]
-                                  else
-                                      if @config.is_markdown_file? @input_files.first then
-                                          "markdown"
-                                      else
-                                          "unknown"
-                                      end
-                                  end
-                              end
-
-            @input_files.each_with_index do |filename, index|
-                input = File.read File.absolute_path(filename)
-                input = if 0 == index or not strip_metadata or not @config.is_markdown_file? filename then 
-                            input 
-                        else 
-                            PandocMetadata.remove_metadata(input) 
-                        end
-                @tmp_file.write input
+            if not PandocMetadata.unique_pandocomatic_property? contents
+                warn "\nWarning: Encountered the pandocomatic metadata property more than once. Only the last occurrence of the pandocomatic metadata property is being used. Most likely you only want to use a pandocomatic metadata property in the first input file.\n\n"
             end
 
+            @tmp_file.write contents
             @tmp_file.rewind
         end
     end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -36,7 +36,7 @@ module Pandocomatic
         #
         # @param input_document [String] a path to an input file
         # @return [String] the input document's metadata in the YAML format.
-        def self.extract_metadata input_document
+        def self.extract_metadata(input_document)
             begin
                 pandoc2yaml File.read(input_document)
             rescue StandardError => e
@@ -65,19 +65,31 @@ module Pandocomatic
                 .join("\n")
         end
 
+        # Does the pandocomatic metadata property occur at most once?
+        #
+        # @return [Boolean] False if the pandocomatic metadata property does
+        # occur multiple times.
+        def self.unique_pandocomatic_property?(input)
+            1 >= input
+                .scan(METADATA_BLOCK)
+                .map {|match| YAML.load "---#{match.join()}..."}
+                .count {|yaml| yaml.key? "pandocomatic_" or yaml.key? "pandocomatic"}
+        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
-            yaml_metadata = extract_metadata src
+        def self.load_file(src)
+            input = File.read src
+            yaml_metadata = pandoc2yaml input
 
             if yaml_metadata.empty? then
-                return PandocMetadata.new
+                PandocMetadata.new
             else
-                return PandocMetadata.new YAML.load(yaml_metadata)
+                PandocMetadata.new YAML.load(yaml_metadata), unique_pandocomatic_property?(input)
             end
         end
 
@@ -86,10 +98,21 @@ module Pandocomatic
         #
         # @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 = {}
-            super
+        def initialize(hash = {}, unique = true)
+            super()
             merge! hash
+            @unique = unique
+        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
 
         # Does this PandocMetadata object use a template?

data/lib/pandocomatic/pandocomatic.rb

@@ -66,6 +66,14 @@ module Pandocomatic
                     # 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.
                     #
@@ -108,7 +116,7 @@ module Pandocomatic
                 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!
+                configuration.clean_up! unless configuration.nil?
             end
         end
     end

metadata

@@ -1,53 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.2.5.0.betac
+  version: 0.2.5.0.betad
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.2
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.2
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - pandoc, a universal document converer <http://pandoc.org>
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.0.beta1
 signing_key: 
 specification_version: 4
 summary: Automating the use of pandoc