pandocomatic 0.1.4.15 → 0.1.4.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5240cbf162a995ea3d305fe47322f77205148547
-  data.tar.gz: 1be3dfdb812155812f80e9cbcbc5e76c0ff9f688
+  metadata.gz: 5c02545012823b03faea6b75bd1eefe4f0321f87
+  data.tar.gz: e20c1f0fb820d2372a549bdeae47b8ef97207e9c
 SHA512:
-  metadata.gz: d2750ea57e8ba18f517577efbe07544624f79f99b272a58de0c7a504768e3a9971f96dd7cfcbc2813bb140ae530a714956b78ba3834246d7461824466092a15f
-  data.tar.gz: 7bc0149c21b7ccdf7ee2938519a0873e264ba06ca115df615fd5d460a37511c8e09a9d1f3414b0f4121cbaf94ff6cc6154e682d225b6c34c9f0e29bf405ed65c
+  metadata.gz: dffc42a133303448e4e0fb8c2921231b5c59de5b50b2506e1babdc8b4499f11d724e48615f60cd0449206e26bf6dbc69d97933bea6efd195a1c8b16445dc9598
+  data.tar.gz: c7f3608f963daa702eeec4f3203bf8eba373f31aae316fafe9bdee1d3bd4cbccbff00137c6cb2758e24ddfd82512e0feca30143b766dc1bc3ff286dd3cbb9794

data/lib/pandocomatic/configuration.rb

@@ -311,8 +311,11 @@ module Pandocomatic
         # @param mixin_template [Hash] the template to mixin into the base template
         # @return [Hash] the merged templates
         def merge(base_template, mixin_template)
+            if mixin_template['extends'] and mixin_template['extends'].is_a? String
+                mixin_template['extends'] = [mixin_template['extends']]
+            end
+
             fields = [
-                'extends', 
                 'glob', 
                 'metadata',
                 'setup', 
@@ -323,46 +326,104 @@ module Pandocomatic
             ]
             
             fields.each do |field|
-                case field
-                when    'extends'
-                    if mixin_template[field] and mixin_template[field].is_a? String
-                        mixin_template[field] = [mixin_template[field]]
-                    end
-                when
-                        'cleanup', 
-                        'setup', 
-                        'preprocessors', 
-                        'postprocessors', 
-                        'glob'
-
-                    if base_template[field] then
-                        # If both templates have this field, concat the arrays
-                        # and remove duplicates
-                        if mixin_template[field] then
-                            base_template[field].concat(mixin_template[field]).uniq!
-                        end
-                    else
-                        # If the base does not have this fiel yet, assign it
-                        # the mixin's
-                        if mixin_template[field] then
-                            base_template[field] = mixin_template[field]
+                parent = base_template[field]
+                current = mixin_template[field]
+                extended_value = extend_value current, parent
+
+                if extended_value.nil?
+                    base_template.delete field
+                else
+                    base_template[field] = extended_value
+                end
+            end
+
+            base_template
+        end
+
+        # Extend the current value with the parent value. Depending on the
+        # value and type of the current and parent values, the extension
+        # differs.
+        #
+        # For simple values, the current value takes precedence over the
+        # parent value
+        #
+        # For Hash values, each parent value's property is extended as well
+        #
+        # For Arrays, the current overwrites and adds to parent value's items
+        # unless the current value is a Hash with a 'remove' and 'add'
+        # property. Then the 'add' items are added to the parent value and the
+        # 'remove' items are removed from the parent value.
+        #
+        # @param current [Object] the current value
+        # @param parent [Object] the parent value the current might extend
+        # @return [Object] the extended value
+        def extend_value(current, parent)
+            if parent.nil?
+                # If no parent value is specified, the current takes
+                # precedence
+                current
+            else
+                if current.nil?
+                    # Current nil removes value of parent; follows YAML spec.
+                    # Note. take care to actually remove this value from a
+                    # Hash. (Like it is done in the next case)
+                    nil
+                else
+                    if parent.is_a? Hash
+                        if current.is_a? Hash
+                            # Mixin current and parent values
+                            parent.each_pair do |property, value|
+                                if current.has_key? property
+                                    extended_value = extend_value(current[property], value)
+                                    if extended_value.nil?
+                                        current.delete property
+                                    else
+                                        current[property] = extended_value
+                                    end
+                                else
+                                    current[property] = value
+                                end
+                            end
                         end
-                    end
-                when 'pandoc', 'metadata'
-                    # Merge Hashes
-                    if base_template[field] then
-                        if mixin_template[field] then
-                            base_template[field].merge! mixin_template[field]
+                        current
+                    elsif parent.is_a? Array
+                        if current.is_a? Hash
+                            if current.has_key? 'remove'
+                                to_remove = current['remove']
+
+                                if to_remove.is_a? Array
+                                    parent = parent.delete_if {|v| current['remove'].include? v}
+                                else
+                                    parent = parent.delete to_remove
+                                end
+                            end
+
+                            if current.has_key? 'add'
+                                to_add = current['add']
+                                
+                                if to_add.is_a? Array
+                                    parent = current['add'].concat(parent).uniq
+                                else
+                                    parent.push(to_add).uniq
+                                end
+                            end
+
+                            parent
+                        elsif current.is_a? Array
+                            # Just combine parent and current arrays, current
+                            # values take precedence
+                            current.concat(parent).uniq
+                        else
+                            # Unknown what to do, assuming current should take
+                            # precedence
+                            current
                         end
                     else
-                        if mixin_template[field] then
-                            base_template[field] = mixin_template[field]
-                        end
+                        # Simple values: current replaces parent
+                        current
                     end
                 end
             end
-
-            base_template
         end
 
         # Resolve the templates the templates extends and mixes them in, in

data/lib/pandocomatic/pandocomatic.rb

@@ -45,9 +45,12 @@ module Pandocomatic
 
     # The Pandocomatic class controlls the pandocomatic conversion process
     class Pandocomatic
+        
+        # Pandocomatic error status codes start from ERROR_STATUS
+        ERROR_STATUS = 1266 # This is the sum of the ascii values of the characters in 'pandocomatic'
 
         # Pandocomatic's current version
-        VERSION = [0, 1, 4, 15]
+        VERSION = [0, 1, 4, 16]
 
         # Pandocomatic's default configuration file
         CONFIG_FILE = 'pandocomatic.yaml'
@@ -103,11 +106,12 @@ module Pandocomatic
                     # conversion.
                     if command.all_errors.size > 0
                         ConfigurationErrorsPrinter.new(command.all_errors).print
-                        exit
+                        exit ERROR_STATUS
                     end
 
                     # Pandocomatic is successfully configured: running the
-                    # actual conversion now.
+                    # actual conversion now. But first a short summary of the
+                    # process to execute is printed.
                     SummaryPrinter.new(command, input, output).print unless quiet or not command.directory?
 
                     # Depending on the options dry-run and quiet, the command.execute
@@ -120,9 +124,11 @@ module Pandocomatic
             rescue PandocomaticError => e
                 # Report the error and break off the conversion process.
                 ErrorPrinter.new(e).print
+                exit ERROR_STATUS + 1
             rescue StandardError => e
                 # An unexpected error has occurred; break off the program drastically
-                # for now
+                # for now. This is likely a bug: ask the user to report it.
+                warn "An unexpected error has occurred. You can report this bug via https://github.com/htdebeer/pandocomatic/issues/new."
                 raise e
             end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.4.15
+  version: 0.1.4.16
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-09 00:00:00.000000000 Z
+date: 2017-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
@@ -19,7 +19,7 @@ dependencies:
         version: 0.2.5
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5.6
+        version: 0.2.5.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.2.5
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5.6
+        version: 0.2.5.7
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -78,8 +78,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.8
-description: 'Automating the use of pandoc <http://pandoc.org>: use pandocomatic to
-  convert one file or a directory with files and sub directories.'
+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.
 email: Huub@heerdebeer.org
 executables:
 - pandocomatic
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - pandoc, a universal document converer <http://pandoc.org>
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Automating the use of pandoc