pandocomatic 0.1.4.4 → 0.1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8928f929e83b3ac62ed3f679c3d98aafd7a6914
-  data.tar.gz: 68e8de19c03ed89c05ba74cba5c13bcde9bb2dbf
+  metadata.gz: 1f08978eb4a68143d4e153d76f4a4beddda54d68
+  data.tar.gz: 40ceb29138023555c57298a186552b9f2a601fba
 SHA512:
-  metadata.gz: 0aaa3f82416f0879d29b762a845c402b14cab19629f3136a21dcfd5313b7f24f2bb2c3e2fe4346ef6cf8849a67f0ee51b1fca3462f7e91cb1e8c781473fcc33b
-  data.tar.gz: 2353782f70b437c92d665b7f90ca6ebee9a0aa5ba2f66e1730705a40e6706db5c5a613801cba33b2148a2a7fc384f180c8467c8020245145cec90753767610ec
+  metadata.gz: dd4d77c97a2f3fa6df7a09600bf15907cf1e7ee44b9bd6350aa53e895a02e44589dc35aa273ff3051b1d8b3fc663f9a07fc6cf89d8d199ed1fce46186de467c9
+  data.tar.gz: 2a99078d6afd28190cd586a73cb3d2600e1b63cf9127ee0bb4e403698e14e8c8c0d3a6451097348e521ea487232572c9dcd35b79a84eb4aeaadad43a44d2886b

data/lib/pandocomatic/command/command.rb

@@ -20,6 +20,17 @@ module Pandocomatic
 
   require_relative '../printer/command_printer.rb'
 
+  # Command is a base class of all actions pandocomatic executes while
+  # converting a file or a directory of files.
+  #
+  # @!attribute errors
+  #   @return [Error[]] list of errors created while preparing and running a
+  #     command
+  #
+  # @!attribute index
+  #   @return [Number] the index of this Command in the list with all commands
+  #     to run when running pandocomatic.
+      
   class Command
 
     attr_reader :errors, :index
@@ -31,13 +42,22 @@ module Pandocomatic
     @@src_root = "."
     @@modified_only = false
 
+    # Create a new Command
     def initialize()
       @errors = []
       @@total += 1
       @index = @@total
     end
 
-    def self.reset(src_root = ".", dry_run = false, quiet = false, debug = false, modified_only)
+    # Reset all Commands
+    #
+    # @param src_root [String = "."] the root directory to convert
+    # @param dry_run [Boolean = false] should Commands actually run or not?
+    # @param quiet [Boolean = false] should Commands run silently?
+    # @param debug [Boolean = false] should Commands be run in debug mode?
+    # @param modified_only [Boolean = false] should only modified files be
+    #   converted?
+    def self.reset(src_root = ".", dry_run = false, quiet = false, debug = false, modified_only = false)
       @@src_root = src_root
       @@dry_run = dry_run
       @@quiet = quiet
@@ -46,79 +66,133 @@ module Pandocomatic
       @@total = 0
     end
 
+    # Get the root directory of this Command's conversion process
+    #
+    # @return [String]
     def src_root()
       @@src_root
     end
 
+    # Does this Command not actually execute?
+    #
+    # @return [Boolean]
     def dry_run?()
       @@dry_run
     end
 
+    # Is this Command executed silently?
+    #
+    # @return [Boolean]
     def quiet?()
       @@quiet
     end
 
+    # Is this Command executed in debug mode?
+    #
+    # @return [Boolean]
     def debug?()
       @@debug
     end
 
+    # Is this Command only executed on modified files?
+    #
+    # @return [Boolean]
     def modified_only?()
       @@modified_only
     end
 
+    # The number of commands executed by this Command; a Command can have sub
+    # commands as well.
+    #
+    # @return [Number]
     def count()
       1
     end
 
+    # Get all the errors generated while executing this Command
+    #
+    # @return [Error[]]
     def all_errors()
       @errors
     end
 
+    # Make this Command run quietly
     def make_quiet()
       @@quiet = true
     end
 
+    # Convert this Command's index to a string representation
+    #
+    # @return [String]
     def index_to_s()
       "#{@@total - @index + 1}".rjust(@@total.to_s.size)
     end
 
+    # Execute this Command. A Command can be dry-run as well, in which it is
+    # not actually run.
     def execute()
       CommandPrinter.new(self).print unless quiet?
       run if not dry_run? and runnable?
     end
 
+    # Actually run this Command
     def run()
     end
 
+    # Are there any errors while configuring this Command? If not, this
+    # Command is runnable.
+    #
+    # @return [Boolean]
     def runnable?()
       not has_errors?
     end
 
+    # Create a String representation of this Command
+    #
+    # @return [String]
     def to_s()
       'command'
     end
     
+    # Is this Command converting a directory?
+    #
+    # @return [Boolean] false
     def directory?()
       false
     end
 
+    # Does this Command convert a file multiple times?
+    #
+    # @return [Boolean] false
     def multiple?()
       false
     end
 
+    # Will this Command be skipped, thus not executed?
+    #
+    # @return [Boolean] false
     def skip?()
       false
     end
 
+    # Decrement the total number of conversion commands by 1
     def uncount()
       @@total -= 1
     end
 
+    # Has this Command run in any errors?
+    #
+    # @return [Error[]]
     def has_errors?()
       not @errors.empty?
     end
 
-    # src file is newer than the dstination file?
+    # Is the source file newer than the destination file?
+    #
+    # @param src [String] the source file
+    # @param dst [String] the destination file
+    #
+    # @return [Boolean] True if src has been modified after dst has been last
     def file_modified?(src, dst)
       not File.exist? dst or File.mtime(src) > File.mtime(dst)
     end

data/lib/pandocomatic/command/convert_file_command.rb

@@ -21,8 +21,10 @@ module Pandocomatic
   require 'paru'
 
   require_relative '../pandoc_metadata.rb'
+
   require_relative '../processor.rb'
-  require_relative '../fileinfo_preprocessor'
+  require_relative '../processors/fileinfo_preprocessor'
+  require_relative '../processors/metadata_preprocessor'
 
   require_relative '../configuration.rb'
 
@@ -38,6 +40,13 @@ module Pandocomatic
 
     attr_reader :config, :src, :dst
 
+    # Create a new ConvertFileCommand
+    #
+    # @param config [Configuration] pandocomatic's configuration
+    # @param src [String] the path to the file to convert
+    # @param dst [String] the path to save the output of the conversion
+    # @param template_name [String = nil] the template to use while converting
+    #   this file
     def initialize(config, src, dst, template_name = nil)
       super()
       @config = config
@@ -55,10 +64,14 @@ module Pandocomatic
       @errors.push IOError.new(:file_is_not_readable, nil, @src) unless File.readable? @src
     end
 
+    # Execute this ConvertFileCommand
     def run
       convert_file
     end
 
+    # Create a string representation of this ConvertFileCommand
+    #
+    # @return [String]
     def to_s
       "convert #{File.basename @src} #{"-> #{File.basename @dst}" unless @dst.nil?}"
     end
@@ -70,6 +83,8 @@ module Pandocomatic
       pandoc_options = metadata.pandoc_options || {}
       template = {}
 
+      # Determine the actual options and settings to use when converting this
+      # file.
       if not @template_name.nil? and not @template_name.empty?
         raise ConfigurationError.new(:no_such_template, nil, @template_name) unless @config.has_template? @template_name
         template = @config.get_template @template_name
@@ -86,12 +101,22 @@ module Pandocomatic
         end
       end
 
+      # Read in the file to convert
       input = File.read @src
+
+      # Run the default preprocessors to mix-in information about the file
+      # that is being converted and mix-in the template's metadata section as
+      # well
       input = FileInfoPreprocessor.run input, @src, pandoc_options
+      input = MetadataPreprocessor.run input, template['metadata'] if template.has_key? 'metadata' and not template['metadata'].empty?
+
+      # Convert the file by preprocessing it, run pandoc on it, and
+      # postprocessing the output
       input = preprocess input, template
       input = pandoc input, pandoc_options, File.dirname(@src)
       output = postprocess input, template
 
+      # Write out the results of the conversion process to file.
       if @dst.to_s.empty? and metadata.pandoc_options.has_key? 'output'
         @dst = metadata.pandoc_options['output']
       end
@@ -123,6 +148,7 @@ module Pandocomatic
       'epub-cover-image',
       'epub-metadata',
       'epub-embed-font',
+      'epub-subdirectory',
       'bibliography',
       'csl',
       'syntax-definition',

data/lib/pandocomatic/configuration.rb

@@ -99,6 +99,7 @@ module Pandocomatic
           full_template = {
             'glob' => [],
             'preprocessors' => [],
+            'metadata' => {},
             'pandoc' => {},
             'postprocessors' => []
           }
@@ -241,7 +242,7 @@ module Pandocomatic
                 @templates[name][field] = template[field]
               end
             end
-          when 'pandoc'
+          when 'pandoc', 'metadata'
             if @templates[name][field] then
               if template[field] then
                 @templates[name][field].merge! template[field]

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, 3]
+    VERSION = [0, 1, 4, 5]
     CONFIG_FILE = 'pandocomatic.yaml'
 
     def self.run(args)

data/lib/pandocomatic/{fileinfo_preprocessor.rb → processors/fileinfo_preprocessor.rb}

@@ -18,9 +18,16 @@
 #++
 module Pandocomatic
 
+  require_relative '../processor.rb'
+
   # FileInfoPreprocessor collects information about a file to be converted and
   # mixes that information into that file's metadata. It is a default
   # preprocessor.
+  #
+  # @param input [String] the contents of the document being preprocessed
+  # @param path [String] the path to the input document
+  # @param options [Hash] pandoc options collected by pandocomatic to run on
+  #   this file
   class FileInfoPreprocessor < Processor
     def self.run input, path, options
       created_at = File.stat(path).ctime

data/lib/pandocomatic/processors/metadata_preprocessor.rb

@@ -0,0 +1,39 @@
+#--
+# Copyright 2017, 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 'yaml'
+  require_relative '../processor.rb'
+
+  # MetadataPreprocessor mixes in the metadata section of a template into a
+  # document before pandoc is run to convert that document. It is a default
+  # preprocessor.
+  #
+  # @param input [String] the contents of the document that is being
+  #   preprocessed
+  # @param metadata [Hash = {}] the metadata to mix-in
+  class MetadataPreprocessor < Processor
+    def self.run input, metadata = {}
+      output = input
+      output << "\n\n"
+      output << YAML.dump(metadata)
+      output << "...\n\n"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.4.4
+  version: 0.1.4.5
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
@@ -104,7 +104,6 @@ files:
 - lib/pandocomatic/error/pandoc_error.rb
 - lib/pandocomatic/error/pandocomatic_error.rb
 - lib/pandocomatic/error/processor_error.rb
-- lib/pandocomatic/fileinfo_preprocessor.rb
 - lib/pandocomatic/pandoc_metadata.rb
 - lib/pandocomatic/pandocomatic.rb
 - lib/pandocomatic/printer/command_printer.rb
@@ -130,6 +129,8 @@ files:
 - lib/pandocomatic/printer/views/warning.txt
 - lib/pandocomatic/printer/warning_printer.rb
 - lib/pandocomatic/processor.rb
+- lib/pandocomatic/processors/fileinfo_preprocessor.rb
+- lib/pandocomatic/processors/metadata_preprocessor.rb
 - lib/pandocomatic/warning.rb
 homepage: https://heerdebeer.org/Software/markdown/pandocomatic/
 licenses: