pandocomatic 0.1.4.9 → 0.1.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b790fdc99211b28030f3e6c2fb83ec9a68dcbf2c
-  data.tar.gz: b3bce488828fd3f610b922d012022b9fa2c880ff
+  metadata.gz: 11bf26bcbf6d79b0583eca48c30e1b685314f514
+  data.tar.gz: c26dd9a4433581a6154df33096d993fe56208338
 SHA512:
-  metadata.gz: daa6fea415f430f87d4806e15d405a8b2bd469005eec21530c1799ccde8dc19736ff8af34559a0d91e1ef6f9814531193301697c8f209bbb75dcd1f655672ac3
-  data.tar.gz: cd9553189cb5f60350073d79192980e5ed4d205df5f79cf87a582f1bf6177b91fa875e535e6d05a722e80de93aa2ab6bca704c5e705773214bf693d4c9553a58
+  metadata.gz: 5b1d7bcd5051193689a09812c45a7e4155d06e47ca9d6906b5d02ba0dbb628cdaa952ae613206b1eb59d3dfc3f21a81c102006743cc53895cc0b51500a078d9a
+  data.tar.gz: cc8a459844153351c30749c2d0ff215ec8ff64655661b74f893acffcd7ecf1fba447d7d063a399dbf43a89b94862cd964b6e2c52c3ebc50c6872b672472ea8b1

data/lib/pandocomatic/configuration.rb

@@ -18,271 +18,415 @@
 #++
 module Pandocomatic
 
-  require 'yaml'
-  require 'paru/pandoc'
+    require 'yaml'
+    require 'paru/pandoc'
+
+    # The default configuration for pandocomatic is read from
+    # default_configuration.yaml.
+    DEFAULT_CONFIG = YAML.load_file File.join(__dir__, 'default_configuration.yaml')
+
+    # Maps pandoc output formats to an extension.
+    FORMAT_TO_EXT = {
+        'native' => 'hs',
+        'markdown' => 'md',
+        'markdown_strict' => 'md',
+        'markdown_phpextra' => 'md',
+        'markdown_github' => 'md',
+        'html5' => 'html',
+        'docx' => 'docx',
+        'latex' => 'tex'
+    }
+
+    # A Configuration object models a pandocomatic configuration.
+    class Configuration
+
+        # Create a new Configuration instance based on the command-line
+        # options, a data_dir, and a configuration file.
+        def initialize options, data_dir, configuration_file
+            @data_dir = data_dir
 
-  DEFAULT_CONFIG = YAML.load_file File.join(__dir__, 'default_configuration.yaml')
+            load configuration_file
+        end
 
-  FORMAT_TO_EXT = {
-    'native' => 'hs',
-    'markdown' => 'md',
-    'markdown_strict' => 'md',
-    'markdown_phpextra' => 'md',
-    'markdown_github' => 'md',
-    'html5' => 'html',
-    'docx' => 'docx',
-    'latex' => 'tex'
-  }
+        # Read a configuration file and create a pandocomatic configuration object
+        #
+        # @param [String] filename Path to the configuration yaml file
+        # @return [Configuration] a pandocomatic configuration object
+        def load(filename)
+            begin
+                path = File.absolute_path filename
+                settings = YAML.load_file path
+                if settings['settings'] and settings['settings']['data-dir'] then
+                    data_dir = settings['settings']['data-dir']
+                    src_dir = File.dirname filename
+                    if data_dir.start_with? '.' then
+                        @data_dir = File.absolute_path data_dir, src_dir
+                    else
+                        @data_dir = data_dir
+                    end
+                end
+            rescue StandardError => e
+                raise ConfigurationError.new(:unable_to_load_config_file, e, filename)
+            end
 
-  # Configuration describes a pandocomatic configuration.
-  class Configuration
+            # hidden files will always be skipped, as will pandocomatic
+            # configuration files, unless explicitly set to not skip via the
+            # "unskip" option
 
-    def initialize options, data_dir, configuration_file
-      @data_dir = data_dir
+            @settings = {'skip' => ['.*', 'pandocomatic.yaml']} 
 
-      load configuration_file
-    end
+            @templates = {}
+            @convert_patterns = {}
 
-    # Read a configuration file and create a pandocomatic configuration object
-    #
-    # @param [String] filename Path to the configuration yaml file
-    # @return [Configuration] a pandocomatic configuration object
-    def load(filename)
-      begin
-        path = File.absolute_path filename
-        settings = YAML.load_file path
-        if settings['settings'] and settings['settings']['data-dir'] then
-          data_dir = settings['settings']['data-dir']
-          src_dir = File.dirname filename
-          if data_dir.start_with? '.' then
-            @data_dir = File.absolute_path data_dir, src_dir
-          else
-            @data_dir = data_dir
-          end
+            configure settings
         end
-      rescue StandardError => e
-        raise ConfigurationError.new(:unable_to_load_config_file, e, filename)
-      end
 
-      # hidden files will always be skipped, as will pandocomatic
-      # configuration files, unless explicitly set to not skip via the
-      # "unskip" option
+        # Update this configuration with a configuration file
+        #
+        # @param [String] filename path to the configuration file
+        #
+        # @return [Configuration] a new configuration
+        def reconfigure(filename)
+            begin
+                settings = YAML.load_file filename
+                new_config = Marshal.load(Marshal.dump(self))
+                new_config.configure settings
+                new_config
+            rescue StandardError => e
+                raise ConfigurationError.new(:unable_to_load_config_file, e, filename)
+            end
+        end
 
-      @settings = {'skip' => ['.*', 'pandocomatic.yaml']} 
+        # Configure pandocomatic based on a settings Hash
+        #
+        # @param settings [Hash] a settings Hash to mixin in this
+        # Configuration.
+        def configure(settings)
+            reset_settings settings['settings'] if settings.has_key? 'settings'
+            if settings.has_key? 'templates' then
+                settings['templates'].each do |name, template|
+                    full_template = {
+                        'extends' => [],
+                        'glob' => [],
+                        'setup' => [],
+                        'preprocessors' => [],
+                        'metadata' => {},
+                        'pandoc' => {},
+                        'postprocessors' => [],
+                        'cleanup' => []
+                    }
+
+                    reset_template name, full_template.merge(template)
+                end
+            end
+        end
 
-      @templates = {}
-      @convert_patterns = {}
+        # Convert this Configuration to a String
+        #
+        # @return [String]
+        def to_s()
+            marshal_dump
+        end
 
-      configure settings
-    end
+        # Should the source file be skipped given this Configuration?
+        #
+        # @param src [String] path to a source file
+        # @return [Boolean] True if this source file matches the pattern in
+        #   the 'skip' setting, false otherwise.
+        def skip?(src)
+            if @settings.has_key? 'skip' then
+                @settings['skip'].any? {|glob| File.fnmatch glob, File.basename(src)}
+            else
+                false
+            end
+        end
 
-    # Update this configuration with a configuration file
-    #
-    # @param [String] filename path to the configuration file
-    #
-    # @return [Configuration] a new configuration
-    def reconfigure(filename)
-      begin
-        settings = YAML.load_file filename
-        new_config = Marshal.load(Marshal.dump(self))
-        new_config.configure settings
-        new_config
-      rescue StandardError => e
-        raise ConfigurationError.new(:unable_to_load_config_file, e, filename)
-      end
-    end
+        # Should the source file be converted given this Configuration?
+        #
+        # @param src [String] True if this source file matches the 'glob'
+        #   patterns in a template, false otherwise.
+        def convert?(src)
+            @convert_patterns.values.flatten.any? {|glob| File.fnmatch glob, File.basename(src)}
+        end
 
-    def configure(settings)
-      reset_settings settings['settings'] if settings.has_key? 'settings'
-      if settings.has_key? 'templates' then
-        settings['templates'].each do |name, template|
-          full_template = {
-            'glob' => [],
-            'setup' => [],
-            'preprocessors' => [],
-            'metadata' => {},
-            'pandoc' => {},
-            'postprocessors' => [],
-            'cleanup' => []
-          }
-
-          reset_template name, full_template.merge(template)
+        # Should pandocomatic be run recursively given this Configuration?
+        #
+        # @return [Boolean] True if the setting 'recursive' is true, false
+        #   otherwise
+        def recursive?()
+            @settings['recursive']
         end
-      end
-    end
 
-    def marshal_dump()
-      [@data_dir, @settings, @templates, @convert_patterns]
-    end
+        # Should pandocomatic follow symbolic links given this Configuration?
+        #
+        # @return [Boolean] True if the setting 'follow_links' is true, false
+        #   otherwise
+        def follow_links?()
+            @settings['follow_links']
+        end
 
-    def marshal_load(array)
-      @data_dir, @settings, @templates, @convert_patterns = array
-    end
+        # Set the extension of the destination file given this Confguration,
+        # template, and metadata
+        #
+        # @param dst [String] path to a destination file
+        # @param template_name [String] the name of the template used to
+        #   convert to destination
+        # @param metadata [PandocMetadata] the metadata in the source file
+        def set_extension(dst, template_name, metadata)
+            dir = File.dirname dst
+            ext = File.extname dst
+            basename = File.basename dst, ext
+            File.join dir, "#{basename}.#{find_extension(dst, template_name, metadata)}"
+        end
 
-    def to_s()
-      marshal_dump
-    end
+        # Find the extension of the destination file given this Confguration,
+        # template, and metadata
+        #
+        # @param dst [String] path to a destination file
+        # @param template_name [String] the name of the template used to
+        #   convert to destination
+        # @param metadata [PandocMetadata] the metadata in the source file
+        #
+        # @return [String] the extension to use for the destination file
+        def find_extension(dst, template_name, metadata)
+            extension = "html"
+            if template_name.nil? or template_name.empty? then
+                if metadata.has_pandocomatic? 
+                    pandocomatic = metadata.pandocomatic
+                    if pandocomatic.has_key? "pandoc"
+                        pandoc = pandocomatic["pandoc"]
+
+                        if pandoc.has_key? "to"
+                            extension = pandoc["to"]
+                        end
+                    end
+                end 
+            else
+                # TODO: what if there is no pandoc.to?
+                if @templates[template_name].has_key? "pandoc"
+                    pandoc = @templates[template_name]["pandoc"]
+                    if pandoc.has_key? "to"
+                        extension = pandoc["to"]
+                    end
+                end
+            end
 
-    def skip?(src)
-      if @settings.has_key? 'skip' then
-        @settings['skip'].any? {|glob| File.fnmatch glob, File.basename(src)}
-      else
-        false
-      end
-    end
+            extension = FORMAT_TO_EXT[extension] || extension
+            return extension
+        end
 
-    def convert?(src)
-      @convert_patterns.values.flatten.any? {|glob| File.fnmatch glob, File.basename(src)}
-    end
+        # Is there a template with template_name in this Configuration?
+        #
+        # @param template_name [String] a template's name
+        #
+        # @return [Boolean] True if there is a template with name equal to
+        #   template_name in this Configuration
+        def has_template?(template_name)
+            @templates.has_key? template_name
+        end
 
-    def recursive?()
-      @settings['recursive']
-    end
+        # Get the template with template_name from this Configuration
+        #
+        # @param template_name [String] a template's name
+        #
+        # @return [Hash] The template with template_name.
+        def get_template(template_name)
+            @templates[template_name]
+        end
 
-    def follow_links?()
-      @settings['follow_links']
-    end
+        # Determine the template to use with this source document given this
+        # Configuration.
+        #
+        # @param src [String] path to the source document
+        # @return [String] the template's name to use
+        def determine_template(src)
+            @convert_patterns.select do |template_name, globs|
+                globs.any? {|glob| File.fnmatch glob, File.basename(src)}
+            end.keys.first
+        end
 
-    def set_extension(dst, template_name, metadata)
-      dir = File.dirname dst
-      ext = File.extname dst
-      basename = File.basename dst, ext
-      File.join dir, "#{basename}.#{find_extension(dst, template_name, metadata)}"
-    end
+        # Update the path to an executable processor or executor given this
+        # Configuration
+        #
+        # @param path [String] path to the executable
+        # @param src_dir [String] the source directory from which pandocomatic
+        #   conversion process has been started
+        # @param check_executable [Booelan = false] Should the executable be
+        #   verified to be executable? Defaults to false.
+        #
+        # @return [String] the updated path.
+        def update_path(path, src_dir, check_executable = false)
+            updated_path = path
+            if path.start_with? './' 
+                # refers to a local (to file) dir
+                updated_path = File.join src_dir, path
+            else
+                if path.start_with? '/'
+                    updated_path = path
+                else 
+                    if check_executable
+                        updated_path = Configuration.which path
+                    end
+
+                    if updated_path.nil? or not updated_path.start_with? '/' then
+                        # refers to data-dir
+                        updated_path = File.join @data_dir, path
+                    end
+                end
+            end
 
-    def find_extension(dst, template_name, metadata)
-      extension = "html"
-      if template_name.nil? or template_name.empty? then
-        if metadata.has_pandocomatic? 
-            pandocomatic = metadata.pandocomatic
-            if pandocomatic.has_key? "pandoc"
-                pandoc = pandocomatic["pandoc"]
+            updated_path
+        end
 
-                if pandoc.has_key? "to"
-                    extension = pandoc["to"]
+        private 
+
+        # Reset the settings for pandocomatic based on a new settings Hash
+        #
+        # @settings [Hash] the new settings to use to reset the settings in
+        #   this Configuration with.
+        def reset_settings(settings)
+            settings.each do |setting, value|
+                case setting
+                when 'skip'
+                    @settings['skip'] = @settings['skip'].concat(value).uniq
+                when 'data-dir'
+                    next # skip data-dir setting; is set once in initialization
+                else
+                    @settings[setting] = value
                 end
             end
-        end 
-      else
-        # TODO: what if there is no pandoc.to?
-        if @templates[template_name].has_key? "pandoc"
-            pandoc = @templates[template_name]["pandoc"]
-            if pandoc.has_key? "to"
-                extension = pandoc["to"]
-            end
         end
-      end
-
-      extension = FORMAT_TO_EXT[extension] || extension
-      return extension
-    end
-
-    def has_template?(template_name)
-      @templates.has_key? template_name
-    end
 
-    def get_template(template_name)
-      @templates[template_name]
-    end
+        # Merge two templates
+        #
+        # @param base_template [Hash] the base template
+        # @param mixin_template [Hash] the template to mixin into the base template
+        # @return [Hash] the merged templates
+        def merge(base_template, mixin_template)
+            fields = [
+                'extends', 
+                'glob', 
+                'metadata',
+                'setup', 
+                'preprocessors', 
+                'pandoc', 
+                'postprocessors', 
+                'cleanup'
+            ]
+            
+            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]
+                        end
+                    end
+                when 'pandoc', 'metadata'
+                    # Merge Hashes
+                    if base_template[field] then
+                        if mixin_template[field] then
+                            base_template[field].merge! mixin_template[field]
+                        end
+                    else
+                        if mixin_template[field] then
+                            base_template[field] = mixin_template[field]
+                        end
+                    end
+                end
+            end
 
-    def determine_template(src)
-      @convert_patterns.select do |template_name, globs|
-        globs.any? {|glob| File.fnmatch glob, File.basename(src)}
-      end.keys.first
-    end
+            base_template
+        end
 
-    def update_path(path, src_dir, check_executable = false)
-        updated_path = path
-        if path.start_with? './' 
-            # refers to a local (to file) dir
-            updated_path = File.join src_dir, path
-        else
-            if path.start_with? '/'
-                updated_path = path
-            else 
-                if check_executable
-                    updated_path = Configuration.which path
+        # Resolve the templates the templates extends and mixes them in, in
+        # order of occurrence.
+        #
+        # @param template [Hash] the template to extend
+        # @return [Hash] the resolved template
+        def extend_template(template)
+            resolved_template = {};
+            if template.has_key? 'extends' and not template['extends'].empty?
+                to_extend = template['extends']
+                to_extend = [to_extend] if to_extend.is_a? String
+
+                to_extend.each do |name|
+                    if @templates.has_key? name
+                        resolved_template = merge resolved_template, @templates[name]
+                    else 
+                        warn "Cannot find template with name '#{parent_template_name}'. Skipping this template while extending: '#{template.to_s}'."
+                    end
                 end
 
-                if updated_path.nil? or not updated_path.start_with? '/' then
-                    # refers to data-dir
-                    updated_path = File.join @data_dir, path
-                end
+                resolved_template
             end
-        end
 
-        updated_path
-    end
-
-    private 
-
-    def reset_settings(settings)
-      settings.each do |setting, value|
-        case setting
-        when 'skip'
-          @settings['skip'] = @settings['skip'].concat(value).uniq
-        when 'data-dir'
-          next # skip data-dir setting; is set once in initialization
-        else
-          @settings[setting] = value
+            merge resolved_template, template
         end
-      end
-    end
 
-    def reset_template(name, template)
-      if @templates.has_key? name then
-        fields = ['glob', 'cleanup', 'setup', 'preprocessors', 'pandoc', 'postprocessors']
-        fields.each do |field|
-          case field
-          when 'cleanup', 'setup', 'preprocessors', 'postprocessors', 'glob'
-            if @templates[name][field] then
-              if template[field] then
-                @templates[name][field].concat(template[field]).uniq!
-              end
+        # Reset the template with name in this Configuration based on a new
+        # template
+        #
+        # @param name [String] the name of the template in this Configuration
+        # @param template [Hash] the template to use to update the template in
+        #   this Configuarion with
+        def reset_template(name, template)
+            extended_template = extend_template template
+            
+            if @templates.has_key? name then
+                @templates[name] = merge @templates[name], extended_template
             else
-              if template[field] then
-                @templates[name][field] = template[field]
-              end
+                @templates[name] = extended_template
             end
-          when 'pandoc', 'metadata'
-            if @templates[name][field] then
-              if template[field] then
-                @templates[name][field].merge! template[field]
-              end
-            else
-              if template[field] then
-                @templates[name][field] = template[field]
-              end
+
+            if extended_template.has_key? 'glob' then
+                @convert_patterns[name] = extended_template['glob']
             end
-          end
         end
-      else
-        @templates[name] = template
-      end
-
-      if template.has_key? 'glob' then
-        @convert_patterns[name] = template['glob']
-      end
-    end
 
-    # Cross-platform way of finding an executable in the $PATH.
-    # 
-    # which('ruby') #=> /usr/bin/ruby
-    #
-    # Taken from:
-    # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby#5471032
-    def self.which(cmd)
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-            exts.each { |ext|
-                exe = File.join(path, "#{cmd}#{ext}")
-                return exe if File.executable?(exe) &&
-                    !File.directory?(exe)
-            }
+        # Cross-platform way of finding an executable in the $PATH.
+        # 
+        # which('ruby') #=> /usr/bin/ruby
+        #
+        # Taken from:
+        # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby#5471032
+        def self.which(cmd)
+            exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+            ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+                exts.each { |ext|
+                    exe = File.join(path, "#{cmd}#{ext}")
+                    return exe if File.executable?(exe) &&
+                        !File.directory?(exe)
+                }
+            end
+            return nil
+        end
+        
+        def marshal_dump()
+            [@data_dir, @settings, @templates, @convert_patterns]
         end
-        return nil
-    end
 
-  end
+        def marshal_load(array)
+            @data_dir, @settings, @templates, @convert_patterns = array
+        end
 
+    end
 end

data/lib/pandocomatic/pandoc_metadata.rb

@@ -18,93 +18,149 @@
 #++
 module Pandocomatic
 
-  require 'json'
-  require 'yaml'
-  require 'paru'
-  require 'paru/pandoc2yaml'
-
-  require_relative './error/pandoc_error.rb'
-  require_relative './error/io_error.rb'
-
-  class PandocMetadata < Hash
-
-    def self.extract_metadata input_document
-      begin
-        Paru::Pandoc2Yaml.extract_metadata(input_document)
-      rescue StandardError => e
-        raise IOError.new(:error_opening_file, e, input_document)
-      end
-    end
+    require 'json'
+    require 'yaml'
+    require 'paru'
+
+    require_relative './error/pandoc_error.rb'
+    require_relative './error/io_error.rb'
+
+    # PandocMetadata represents the metadata with pandoc options set in
+    # templates and input files.
+    class PandocMetadata < Hash
+
+        # Extract the metadata from an input file
+        #
+        # @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
+            begin
+                pandoc2yaml File.read(input_document)
+            rescue StandardError => e
+                raise IOError.new(:error_opening_file, e, input_document)
+            end
+        end
 
-    # Collect the metadata embedded in the src file
-    def self.load_file src
-      yaml_metadata = extract_metadata src
+        # 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)
+            input
+                .scan(/^---[ \t]*\n(.+?)^(?:---|\.\.\.)[ \t]*\n/m)
+                .flatten
+                .map{|yaml| yaml.strip}
+                .join("\n")
+        end
 
-      if yaml_metadata.empty? then
-        return PandocMetadata.new
-      else
-        return PandocMetadata.new YAML.load(yaml_metadata)
-      end
-    end
-    
-    def initialize hash = {}
-      super
-      merge! hash
-    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
+
+            if yaml_metadata.empty? then
+                return PandocMetadata.new
+            else
+                return PandocMetadata.new YAML.load(yaml_metadata)
+            end
+        end
 
-    def has_template?()
-      has_pandocomatic? and pandocomatic.has_key? 'use-template' and not 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
+        # @return [PandocMetadata] 
+        def initialize hash = {}
+            super
+            merge! hash
+        end
 
-    def templates() 
-        if has_template?
-            if pandocomatic['use-template'].is_a? Array
-                pandocomatic['use-template']
+        # 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
+
+        # 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
-                [pandocomatic['use-template']]
+                [""]
             end
-        else
-            [""]
         end
-    end
-
-    def template_name()
-      if has_template? then
-        pandocomatic['use-template']
-      else
-        ''
-      end
-    end
 
-    # TODO: allow a pandoc block outside a pandocomatic block to make
-    # pandocomatic work like paru's do-pandoc.rb.
+        # 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
 
-    def has_pandoc_options?()
-      has_pandocomatic? and pandocomatic.has_key? 'pandoc'
-    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
 
-    def pandoc_options()
-      if has_pandoc_options? then
-        pandocomatic['pandoc']
-      else
-        {}
-      end
-    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
 
-    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
+        # 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'
+        end
 
-    def pandocomatic()
-      return self['pandocomatic'] if has_key? 'pandocomatic'
-      return self['pandocomatic_'] if has_key? 'pandocomatic_'
     end
 
-  end
-
 end

data/lib/pandocomatic/pandocomatic.rb

@@ -44,7 +44,7 @@ module Pandocomatic
   require_relative './command/convert_file_multiple_command.rb'
 
   class Pandocomatic
-    VERSION = [0, 1, 4, 9]
+    VERSION = [0, 1, 4, 10]
     CONFIG_FILE = 'pandocomatic.yaml'
 
     def self.run(args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.4.9
+  version: 0.1.4.10
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru