pandocomatic 0.1.4.10 → 0.1.4.11

data/lib/pandocomatic/printer/finish_printer.rb

@@ -19,8 +19,12 @@
 module Pandocomatic
   require_relative './summary_printer.rb'
 
+  # Printer for the end of the conversion process in non-quiet mode
   class FinishPrinter < SummaryPrinter
-    MINUTE = 60 # seconds
+    # A minute has 60 seconds
+    MINUTE = 60
+
+    # Create a new FinishPrinter
     def initialize(command, input, output, start_time)
       super command, input, output
       set_template 'finish.txt'
@@ -29,6 +33,7 @@ module Pandocomatic
       @end_time = Time.now
     end
 
+    # Calculate the duration of the whole conversion process
     def duration()
       seconds = @end_time - @start_time
       if seconds > MINUTE

data/lib/pandocomatic/printer/help_printer.rb

@@ -19,7 +19,9 @@
 module Pandocomatic
   require_relative './printer.rb'
 
+  # Printer for pandocomatic's help
   class HelpPrinter < Printer
+    # Create a new HelpPrinter
     def initialize()
       super 'help.txt'
     end

data/lib/pandocomatic/printer/printer.rb

@@ -17,27 +17,39 @@
 # with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
-  require 'erb'
+    require 'erb'
 
-  class Printer
+    # Printer base class for printing information from pandocomatic
+    class Printer
 
-    def initialize(template_file = 'help.txt')
-      set_template template_file
-    end
+        # Create a new Printer
+        # 
+        # @param template_file [String = 'help.txt'] the template to use when
+        #   printing.
+        def initialize(template_file = 'help.txt')
+            set_template template_file
+        end
 
-    def set_template(template_file)
-      dir = File.dirname(__FILE__)
-      @template = File.absolute_path(File.join(dir, 'views', template_file))
-    end
+        # Set the template used by this Printer
+        #
+        # @param template_file [String] the template to use
+        def set_template(template_file)
+            dir = File.dirname(__FILE__)
+            @template = File.absolute_path(File.join(dir, 'views', template_file))
+        end
 
-    def to_s()
-      erb = ERB.new(File.read(@template), 0, '>')
-      erb.result(binding())
-    end
+        # Create a string based on this printer's template
+        #
+        # @return [String]
+        def to_s()
+            erb = ERB.new(File.read(@template), 0, '>')
+            erb.result(binding())
+        end
 
-    def print()
-      puts to_s()
-    end
+        # Print to STDOUT
+        def print()
+            puts to_s()
+        end
 
-  end
+    end
 end

data/lib/pandocomatic/printer/summary_printer.rb

@@ -17,23 +17,37 @@
 # with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
-  require_relative './printer.rb'
+    require_relative './printer.rb'
 
-  class SummaryPrinter < Printer
-    def initialize(command, input, output)
-      super 'summary.txt'
-      @command = command
-      @input = input
-      @output = output
-    end
+    # Printer for printing a summary of the conversion process in non-quiet mode
+    class SummaryPrinter < Printer
 
-    def commands()
-      "#{@command.count} command#{'s' if @command.count != 1}"
-    end
+        # Create a new SummaryPrinter
+        # 
+        # @param command [Command] the command to summarize
+        # @param input [String] the filename of the input file
+        # @param output [String] the filename of the output file
+        def initialize(command, input, output)
+            super 'summary.txt'
+            @command = command
+            @input = input
+            @output = output
+        end
 
-    def has_output?()
-      not @output.nil? and not @output.empty?
-    end
+        # A string representation of the commands being executed
+        #
+        # @return [String]
+        def commands()
+            "#{@command.count} command#{'s' if @command.count != 1}"
+        end
 
-  end
+        # Is there an output file?
+        #
+        # @return [Boolean] True if there is an output defined in this
+        #   SummaryPrinter, false otherwise
+        def has_output?()
+            not @output.nil? and not @output.empty?
+        end
+
+    end
 end

data/lib/pandocomatic/printer/version_printer.rb

@@ -19,8 +19,10 @@
 module Pandocomatic
   require_relative './printer.rb'
 
+  # Printer to print pandocomatic's version
   class VersionPrinter < Printer
 
+    # Create a new VersionPrinter
     def initialize version
       super 'version.txt'
       @version = version

data/lib/pandocomatic/printer/warning_printer.rb

@@ -17,17 +17,22 @@
 # with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
-  require_relative './printer.rb'
+    require_relative './printer.rb'
 
-  class WarningPrinter < Printer
-    def initialize(warning)
-      template = 'warning.txt'
-      super template
-      @warning = warning
-    end
+    # Printer for warnings
+    class WarningPrinter < Printer
+        # Create a new WarningPrinter
+        #
+        # @param warning [Warning] the warning to print
+        def initialize(warning)
+            template = 'warning.txt'
+            super template
+            @warning = warning
+        end
 
-    def print
-      warn to_s
+        # Print warnings to STDERR rather than STDOUT
+        def print
+            warn to_s
+        end
     end
-  end
 end

data/lib/pandocomatic/processor.rb

@@ -17,14 +17,26 @@
 # with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
-  require 'open3'
+    require 'open3'
 
-  class Processor
+    # Generic class for processors used to preprocess, postproces, setup, and
+    # cleanup with external scripts or programs during the conversion process.
+    #
+    # For preprocessors and postprocessors it is assumed that the input is the
+    # contents of the file to convert and the output the processed input. In
+    # the end, the output will be put through pandoc.
+    class Processor
 
-    def self.run script, input
-      output, _ = Open3.capture2(script, :stdin_data => input)
-      output
-    end
+        # Run script on input and return captured output
+        #
+        # @param script [String] path to script to run
+        # @param input [String] input to process in the script
+        # 
+        # @return [String] output of script.
+        def self.run script, input
+            output, _ = Open3.capture2(script, :stdin_data => input)
+            output
+        end
 
-  end
+    end
 end

data/lib/pandocomatic/processors/fileinfo_preprocessor.rb

@@ -18,30 +18,32 @@
 #++
 module Pandocomatic
 
-  require_relative '../processor.rb'
+    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
-      modified_at = File.stat(path).mtime
-      output = input
-      output << "\n\n---\n"
-      output << "pandocomatic-fileinfo:\n"
-      output << "  from: #{options['from']}\n" if options.has_key? 'from'
-      output << "  to: #{options['to']}\n" if options.has_key? 'to'
-      output << "  template: #{options['template']}\n" if options.has_key? 'template'
-      output << "  path: '#{path}'\n"
-      output << "  created: #{created_at.strftime '%Y-%m-%d'}\n"
-      output << "  modified: #{modified_at.strftime '%Y-%m-%d'}\n"
-      output << "...\n\n"
+    # FileInfoPreprocessor collects information about a file to be converted and
+    # mixes that information into that file's metadata. It is a default
+    # preprocessor.
+    #
+    class FileInfoPreprocessor < Processor
+        # Run this FileInfoPreprocessor
+        #
+        # @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
+        def self.run input, path, options
+            created_at = File.stat(path).ctime
+            modified_at = File.stat(path).mtime
+            output = input
+            output << "\n\n---\n"
+            output << "pandocomatic-fileinfo:\n"
+            output << "  from: #{options['from']}\n" if options.has_key? 'from'
+            output << "  to: #{options['to']}\n" if options.has_key? 'to'
+            output << "  template: #{options['template']}\n" if options.has_key? 'template'
+            output << "  path: '#{path}'\n"
+            output << "  created: #{created_at.strftime '%Y-%m-%d'}\n"
+            output << "  modified: #{modified_at.strftime '%Y-%m-%d'}\n"
+            output << "...\n\n"
+        end
     end
-  end
 end

data/lib/pandocomatic/processors/metadata_preprocessor.rb

@@ -18,22 +18,23 @@
 #++
 module Pandocomatic
 
-  require 'yaml'
-  require_relative '../processor.rb'
+    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"
+    # 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.
+    class MetadataPreprocessor < Processor 
+        # Run this MetadataPreprocessor
+        # 
+        # @param input [String] the contents of the document that is being
+        #   preprocessed
+        # @param metadata [Hash = {}] the metadata to mix-in
+        def self.run input, metadata = {}
+            output = input
+            output << "\n\n"
+            output << YAML.dump(metadata)
+            output << "...\n\n"
+        end
     end
-  end
 end

data/lib/pandocomatic/warning.rb

@@ -17,20 +17,27 @@
 # with pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
-  
-  class Warning
 
-    # :skipping_link_because_it_points_outside_the_source_tree
-    
-    def initialize(message = :unknown, data = nil)
-      @message = message
-      @data = data
-    end
+    # A warning given during the conversion process.  
+    class Warning
 
-    def has_data?
-      not @data.nil?
-    end
+        # :skipping_link_because_it_points_outside_the_source_tree
+        
+        # Create a new Warning with message and some extra data
+        #
+        # @param message [Symbol = :unknown] the message translation key.
+        # @param data [Object = nil] optional data attached to the message.
+        def initialize(message = :unknown, data = nil)
+            @message = message
+            @data = data
+        end
 
-  end
+        # Does this Warning have any data associated with it?
+        #
+        # @return [Boolean] True if there is data attached, false otherwise.
+        def has_data?
+            not @data.nil?
+        end
 
+    end
 end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandocomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.4.10
+  version: 0.1.4.11
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-15 00:00:00.000000000 Z
+date: 2017-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paru
@@ -153,7 +153,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