pandocomatic 0.2.5.0.alpha → 0.2.5.0.betad

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0830abb917ca87c8d072ee5a4f88fee1f2f2d8da6359f14e74f9160614b23f9
-  data.tar.gz: 68f2dbf9325b3ccaeeeae4c2c99b3de4486ff00a2e6c1951a6b14f3f4260232a
+  metadata.gz: c46b6b2c7d745668a59b28bb2f38823ece50c90f24bd53e31c586489e429cb88
+  data.tar.gz: 336889e4f77b7511034f62cb21ab42c01095818e79ebd3d758f30aecc8e10278
 SHA512:
-  metadata.gz: e8c034acc735d84f56c95765a070a129bb522bfe2b6536d407dc067c86f954fad64c7679cb561551689f837d1c54186a9e6c69e7f9fa192eaf548dc948395a0b
-  data.tar.gz: a625b92f99fdccfc5786cb8e2e234b572f4157f4efc894bdc6ed2be39eaad54cb4d33895014e410abfc37e3e983fa9bb6b9de805fa693fa5e1bab54a1f0cebf0
+  metadata.gz: f1f6304e2838a32387b88fd4a18f855e1ee90159262635b9f2cd2b3f568523868dcb157499dcd6fb886f77769ca5a687f68427f24ffb233cb8e6f914e0de9e00
+  data.tar.gz: 5f13e1a64e6b012726d55053df8bf0eb9a7bca879201f3c71d164ae526f6ad7db721b0032616471223e7910d88b202cc44791361ec1812e1fc06ae459e16bcc1

data/lib/pandocomatic/cli.rb

@@ -22,7 +22,6 @@ module Pandocomatic
   require_relative './error/cli_error.rb'
   require_relative './configuration.rb'
 
-
   ##
   # Command line options parser for pandocomatic using optimist.
   #

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/configuration.rb

@@ -61,6 +61,8 @@ module Pandocomatic
     # A Configuration object models a pandocomatic configuration.
     class Configuration
 
+        attr_reader :input
+
         # Pandocomatic's default configuration file
         CONFIG_FILE = 'pandocomatic.yaml'
 
@@ -75,7 +77,7 @@ module Pandocomatic
             @input = if input.nil? or input.empty? then
                          nil
                      elsif 1 < input.size then
-                         MultipleFilesInput.new(input)
+                         MultipleFilesInput.new(input, self)
                      else
                          Input.new(input)
                      end
@@ -265,7 +267,7 @@ module Pandocomatic
         # Get the input file name
         #
         # @return [String]
-        def input()
+        def input_file()
             if @input.nil? then
                 nil
             else
@@ -347,7 +349,6 @@ module Pandocomatic
             @settings.has_key? 'match-files' and 'first' == @settings['match-files']
         end
 
-
         # Set the extension of the destination file given this Confguration,
         # template, and metadata
         #
@@ -386,22 +387,13 @@ module Pandocomatic
                 end
             end
 
-            destination = nil
-            rename_script = nil
-
-            # Output option in pandoc property has precedence
-            if metadata.has_pandocomatic?
-                pandocomatic = metadata.pandocomatic
-                if pandocomatic.has_key? "pandoc"
-                    pandoc = pandocomatic["pandoc"]
-                    destination = determine_output_in_pandoc.call pandoc
-                    rename_script = pandoc["rename"]
-                end
-            end
+            # Output options in pandoc property have precedence
+            destination = determine_output_in_pandoc.call metadata.pandoc_options
+            rename_script = metadata.pandoc_options["rename"]
 
             # Output option in template's pandoc property is next
             if destination.nil? and not template_name.nil? and not template_name.empty? then
-                if @templates[template_name].has_key? "pandoc"
+                if @templates[template_name].has_key? "pandoc" and not @templates[template_name]["pandoc"].nil?
                     pandoc = @templates[template_name]["pandoc"]
                     destination = determine_output_in_pandoc.call pandoc
                     rename_script ||= pandoc["rename"]
@@ -445,21 +437,14 @@ module Pandocomatic
             end
 
             if template_name.nil? or template_name.empty? then
-                if metadata.has_pandocomatic? 
-                    pandocomatic = metadata.pandocomatic
-                    if pandocomatic.has_key? "pandoc"
-                        pandoc = pandocomatic["pandoc"]
-                        
-                        ext = use_extension.call pandoc
-                        if not ext.nil?
-                            extension = ext
-                        elsif pandoc.has_key? "to"
-                            extension = strip_extensions.call(pandoc["to"])
-                        end
-                    end
-                end 
+                ext = use_extension.call metadata.pandoc_options
+                if not ext.nil?
+                    extension = ext
+                elsif metadata.pandoc_options.has_key? "to"
+                    extension = strip_extensions.call(metadata.pandoc_options["to"])
+                end
             else
-                if @templates[template_name].has_key? "pandoc"
+                if @templates[template_name].has_key? "pandoc" and not @templates[template_name]["pandoc"].nil?
                     pandoc = @templates[template_name]["pandoc"]
                     ext = use_extension.call pandoc
 
@@ -475,6 +460,15 @@ module Pandocomatic
             extension
         end
 
+        def is_markdown_file?(filename)
+            if filename.nil? then
+                false
+            else
+                ext = File.extname(filename).delete_prefix(".");
+                "markdown" == DEFAULT_EXTENSION.key(ext)
+            end
+        end
+
         # Is there a template with template_name in this Configuration?
         #
         # @param template_name [String] a template's name
@@ -885,6 +879,5 @@ module Pandocomatic
 
             path
         end
-
     end
 end

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

@@ -28,8 +28,9 @@ module Pandocomatic
         # is created as well containing the content of all the files in input.
         #
         # @param input [String[]] a list with input files
-        def initialize(input)
+        def initialize(input, config)
             super(input)
+            @config = config
             create_temp_file
         end
 
@@ -37,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
@@ -60,7 +61,19 @@ module Pandocomatic
         #
         # @return String
         def to_s()
-            @input_files.join(" + ")
+            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
 
         private 
@@ -69,13 +82,19 @@ module Pandocomatic
             # Concatenate all input files into one (temporary) input file
             # created in the same directory as the first input file
             @tmp_file = Tempfile.new(@input_files.first, File.dirname(self.absolute_path))
-            
-            @input_files.each_with_index do |filename, index|
-                input = File.read File.absolute_path(filename)
-                input = if 0 === index then input else PandocMetadata.remove_metadata(input) end
-                @tmp_file.write input
+
+            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")
+
+            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?
@@ -170,7 +193,7 @@ module Pandocomatic
         # @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'
+            has_pandocomatic? and pandocomatic.has_key? 'pandoc' and not pandocomatic['pandoc'].nil?
         end
 
     end

data/lib/pandocomatic/pandocomatic.rb

@@ -47,8 +47,8 @@ module Pandocomatic
         ERROR_STATUS = 1266 # This is the sum of the ascii values of the characters in 'pandocomatic'
 
         # Pandocomatic's current version
-        VERSION = [0, 2, 5, 0, "α"]
-        
+        VERSION = [0, 2, 5, 0, "beta"]
+
         # Run pandocomatic given options
         #
         # @param args [String[]] list of options to configure pandocomatic
@@ -66,15 +66,23 @@ 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.
                     #
                     # 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, configuration.output)
+                        command = ConvertDirCommand.new(configuration, configuration.input_file, configuration.output)
                     else
-                        command = ConvertFileMultipleCommand.new(configuration, configuration.input, configuration.output)
+                        command = ConvertFileMultipleCommand.new(configuration, configuration.input_file, configuration.output)
                         command.make_quiet unless command.subcommands.size > 1
                     end
 
@@ -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

data/lib/pandocomatic/printer/finish_printer.rb

@@ -40,7 +40,7 @@ module Pandocomatic
 
     # Calculate the duration of the whole conversion process
     #
-    # @erturn [Number]
+    # @return [Number]
     def duration()
       seconds = @end_time - @start_time
       if seconds > MINUTE

metadata

@@ -1,53 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.2.5.0.alpha
+  version: 0.2.5.0.betad
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-09 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
@@ -56,28 +56,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: 0.9.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: 0.9.18
 description: Pandocomatic is a tool to automate using pandoc (<http://pandoc.org>).
   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.
@@ -147,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -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