pandocomatic 0.1.4.10 → 0.1.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11bf26bcbf6d79b0583eca48c30e1b685314f514
-  data.tar.gz: c26dd9a4433581a6154df33096d993fe56208338
+  metadata.gz: 0f420d7805d00a32e2c3d512ef5e417e0d271747
+  data.tar.gz: 1f24021a1464b79431dc35fc7d65e208074e3914
 SHA512:
-  metadata.gz: 5b1d7bcd5051193689a09812c45a7e4155d06e47ca9d6906b5d02ba0dbb628cdaa952ae613206b1eb59d3dfc3f21a81c102006743cc53895cc0b51500a078d9a
-  data.tar.gz: cc8a459844153351c30749c2d0ff215ec8ff64655661b74f893acffcd7ecf1fba447d7d063a399dbf43a89b94862cd964b6e2c52c3ebc50c6872b672472ea8b1
+  metadata.gz: 831b0ebc2839e740b9d66a0b80938ec4ba98da4d0a7ba68101ff5293f58d5604d9991154c01af16f2a62c33469b97e10b47c9f433e9997cd8cb45106ea03f413
+  data.tar.gz: 70b08044e7a6810d4ed48f5d787c2fe182917aeaa3c8d1b256da5bd80a3652b313c61561825bb7e1e6ffae0b4aebff346242eaf1f8b95d79e47e6109a4c8cfeb

data/lib/pandocomatic/command/command.rb

@@ -30,7 +30,6 @@ module Pandocomatic
   # @!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

data/lib/pandocomatic/command/convert_dir_command.rb

@@ -28,10 +28,26 @@ module Pandocomatic
   require_relative 'copy_file_command.rb'
   require_relative 'skip_command.rb'
 
+  # Commmand to convert a directory
+  #
+  # @!attribute config
+  #   @return [Configuration] configuration to use when converting directory
+  #
+  # @!attribute src_dir
+  #   @return [String] the source directory to convert from
+  #
+  # @!attribute dst_dir
+  #   @return [String] the destination directory to convert to
   class ConvertDirCommand < ConvertListCommand
 
     attr_reader :config, :src_dir, :dst_dir
 
+    # Create a new ConvertDirCommand
+    #
+    # @param current_config [Configuration] The configuration of pandocomatic
+    #   as it was before entering the source directory
+    # @param src_dir [String] the directory to convert
+    # @param dst_dir [String] the directory to convert to
     def initialize(current_config, src_dir, dst_dir)
       super()
       @src_dir = src_dir
@@ -87,18 +103,28 @@ module Pandocomatic
       uncount if skip?
     end
 
+    # Should this command be skipped?
+    #
+    # @return [Boolean] True if this command has no sub commands
     def skip?()
       @subcommands.empty?
     end
 
+    # Converts this command a directory?
+    #
+    # @return [Boolean] true
     def directory?()
       true
     end
 
+    # Convert this command to a String representation for a Printer
+    #
+    # @return [String]
     def to_s()
       "convert #{@src_dir}" + '; ' + if create_directory? then 'create and ' else '' end + "enter #{@dst_dir}"
     end
 
+    # Run this command
     def run()
       begin
         Dir.mkdir @dst_dir if create_directory?

data/lib/pandocomatic/command/convert_file_command.rb

@@ -35,8 +35,20 @@ module Pandocomatic
 
     require_relative 'command.rb'
 
+    # Output formats used in pandocomatic
     OUTPUT_FORMATS = ["docx", "odt", "pdf", "beamer"]
 
+    # Command to convert a file
+    #
+    # @!attribute config
+    #   @return [Configuration] the configuration of pandocomatic used to
+    #     convert the file
+    #
+    # @!attribute src
+    #   @return [String] the path to the file to convert
+    #
+    # @!attribute dst
+    #   @return [String] the path to the output file
     class ConvertFileCommand < Command
 
         attr_reader :config, :src, :dst

data/lib/pandocomatic/command/convert_file_multiple_command.rb

@@ -27,10 +27,21 @@ module Pandocomatic
   require_relative 'copy_file_command.rb'
   require_relative 'skip_command.rb'
 
+  # Create a command to convert one file multiple times
+  #
+  # @!attribute subcommands
+  #   @return [Command[]] the subcommands to execute when running this
+  #   ConvertFileMultipleCommand
   class ConvertFileMultipleCommand < ConvertListCommand
 
     attr_reader :subcommands
 
+    # Create a new ConvertFileMultipleCommand
+    #
+    # @param config [Configuration] Pandocomatic's configuration used to
+    #   convert the source file
+    # @param src [String] the file to convert
+    # @param dst [String] the output file
     def initialize(config, src, dst)
         super()
         @config = config
@@ -48,30 +59,15 @@ module Pandocomatic
         end
     end
 
-    def push(command)
-        @subcommands.push command
-    end
-
-    def skip?()
-      @subcommands.empty?
-    end
-
-    def count()
-      @subcommands.reduce(if skip? then 0 else 1 end) do |total, subcommand|
-        total += subcommand.count
-      end
-    end
-
-    def all_errors()
-      @subcommands.reduce(@errors) do |total, subcommand|
-        total += subcommand.all_errors
-      end
-    end
 
+    # A string representation of this command
+    #
+    # @return [String]
     def to_s()
         "converting #{@src} #{@subcommands.size} time#{'s' if @subcommands.size != 1}:"
     end
 
+    # Execute this ConvertFileMultipleCommand
     def execute()
       if not @subcommands.empty?
         CommandPrinter.new(self).print unless quiet? or @subcommands.size == 1

data/lib/pandocomatic/command/convert_list_command.rb

@@ -26,43 +26,66 @@ module Pandocomatic
   require_relative 'copy_file_command.rb'
   require_relative 'skip_command.rb'
 
+  # A Command with sub commands
+  #
+  # @!attribute subcommands
+  #   @return [Command[]] the subcommands of this ConvertListCommand
   class ConvertListCommand < Command
 
     attr_reader :subcommands
 
+    # Create a new ConvertListCommand
     def initialize()
       super()
       @subcommands = []
     end
 
+    # Push a command to this ConvertListCommand
+    #
+    # @param command [Command] command to add
     def push(command)
         @subcommands.push command
     end
 
+    # Skip this ConvertListCommand when there are no sub commands
+    #
+    # @return [Boolean]
     def skip?()
       @subcommands.empty?
     end
 
+    # The number of commands to execute when this ConvertListCommand
+    # is executed.
     def count()
       @subcommands.reduce(if skip? then 0 else 1 end) do |total, subcommand|
         total += subcommand.count
       end
     end
 
+    # Get a list of all errors generated while running this command
+    #
+    # @return [Error[]]  
     def all_errors()
       @subcommands.reduce(@errors) do |total, subcommand|
         total += subcommand.all_errors
       end
     end
 
+    # A string representation of this ConvertListCommand
+    #
+    # @return [String]
     def to_s()
         "converting #{@subcommands.size} items:"
     end
 
+    # Can this command have multiple commands?
+    #
+    # @return [Boolean] true
     def multiple?
         true
     end
 
+    # Execute this ConvertListCommand
     def execute()
       if not @subcommands.empty?
         CommandPrinter.new(self).print unless quiet?

data/lib/pandocomatic/command/copy_file_command.rb

@@ -22,9 +22,17 @@ module Pandocomatic
   require_relative '../error/io_error.rb'
   require_relative 'command.rb'
 
+  # A command to copy a file
+  #
+  # @!attribute src
+  #   @return [String] path to the file to copy
   class CopyFileCommand < Command
     attr_reader :src
 
+    # Create a new CopyFileCommand
+    #
+    # @param src [String] path to the file to copy
+    # @param dst [String] path to the place to copy the source file to
     def initialize(src, dst)
       super()
       @src = src
@@ -33,6 +41,7 @@ module Pandocomatic
       @errors.push IOError.new(:file_is_not_writable, nil, @dst) unless not File.exist?(@dst) or File.writable?(@dst)
     end
 
+    # Run this CopyFileCommand
     def run()
       begin
         FileUtils.cp(@src, @dst) if file_modified?(@src, @dst)
@@ -41,6 +50,9 @@ module Pandocomatic
       end
     end
 
+    # A string representation of this CopyFileCommand
+    #
+    # @return [String]
     def to_s()
       "copy #{File.basename @src}"
     end

data/lib/pandocomatic/command/create_link_command.rb

@@ -24,10 +24,24 @@ module Pandocomatic
   require_relative '../error/io_error.rb'
   require_relative '../printer/warning_printer.rb'
 
+  # A command to create a link to a file
+  #
+  # @!attribute src
+  #   @return [String] the path to the file to link to
+  #
+  # @!attribute dst
+  #   @return [String] the link name to create
+  #
+  # @!attribute dst_target
+  #   @return [String] the link in the destination tree to link to
   class CreateLinkCommand < Command
 
     attr_reader :src, :dst, :dst_target
 
+    # Create a new CreateLinkCommand
+    #
+    # @param src [String] the path to the file to link
+    # @param dst [String] the path to the name of the link to create
     def initialize(src, dst)
       super()
       @src = src
@@ -51,6 +65,7 @@ module Pandocomatic
       end
     end
 
+    # Run this CreateLinkCommand
     def run()
       begin
         File.symlink @dst_target, @dst unless File.exist? @dst
@@ -59,18 +74,29 @@ module Pandocomatic
       end
     end
 
+    # Can this CreateLinkCommand be run?
+    #
+    # @return [Boolean] True if there are no errors and both source and
+    #   destination do exist
     def runnable?()
       not (has_errors? or @dst.nil? or @dst_target.nil? or @src.nil?)
     end
 
+    # Create a string representation of this CreateLinkCommand
     def to_s()
       "link #{File.basename @dst} -> #{@dst_target}"
     end
 
+    # Should this CreateLinkCommand be skipped?
+    #
+    # @return [Boolean]
     def skip?()
       not modified_only? or not modified?
     end
     
+    # Has the source file been modified?
+    #
+    # @return [Boolean]
     def modified?()
       if File.exist? @dst then
         absolute_dst = File.realpath @dst

data/lib/pandocomatic/command/skip_command.rb

@@ -20,26 +20,48 @@ module Pandocomatic
 
   require_relative 'command.rb'
 
+  # A command to skip a file or directory
+  #
+  # @!attribute src
+  #   @return [String] the file or directory to skip
+  #
+  # @!attribute message
+  #   @return [String] message explaining why the file or directory is being skipped.
   class SkipCommand < Command
     attr_reader :src, :message
 
+    # Create a new SkipCommand
+    #
+    # @param src [String] path to the file to skip
+    # @param message [String] the message explaining why this file is being
+    #   skipped
     def initialize(src, message)
       super()
       @src = src
       @message = message
     end
 
+    # Has this SkipCommand a message?
+    #
+    # @return [Boolean]
     def has_message?()
       not(@message.nil? or @message.empty?)
     end
 
+    # 'Run' this SkipCommand by doing nothing
     def run()
     end
 
+    # Skip this command
+    #
+    # @return [Boolean] true
     def skip?()
       true
     end
 
+    # A string representation of this SkipCommand
+    #
+    # @return [String]
     def to_s
       "skipping #{File.basename @src}" + if has_message?
         ": #{@message.to_s}"

data/lib/pandocomatic/configuration.rb

@@ -282,7 +282,7 @@ module Pandocomatic
 
         # Reset the settings for pandocomatic based on a new settings Hash
         #
-        # @settings [Hash] the new settings to use to reset the settings in
+        # @param settings [Hash] the new settings to use to reset the settings in
         #   this Configuration with.
         def reset_settings(settings)
             settings.each do |setting, value|
@@ -297,6 +297,14 @@ module Pandocomatic
             end
         end
 
+        # Deep copy a template
+        #
+        # @param template [Hash]  the template to clone
+        # @return [Hash]
+        def clone_template(template)
+            Marshal.load(Marshal.dump(template))
+        end
+
         # Merge two templates
         #
         # @param base_template [Hash] the base template
@@ -370,7 +378,7 @@ module Pandocomatic
 
                 to_extend.each do |name|
                     if @templates.has_key? name
-                        resolved_template = merge resolved_template, @templates[name]
+                        merge resolved_template, clone_template(@templates[name])
                     else 
                         warn "Cannot find template with name '#{parent_template_name}'. Skipping this template while extending: '#{template.to_s}'."
                     end
@@ -392,7 +400,7 @@ module Pandocomatic
             extended_template = extend_template template
             
             if @templates.has_key? name then
-                @templates[name] = merge @templates[name], extended_template
+                merge @templates[name], extended_template
             else
                 @templates[name] = extended_template
             end

data/lib/pandocomatic/error/cli_error.rb

@@ -19,8 +19,10 @@
 module Pandocomatic
   require_relative './pandocomatic_error.rb'
 
+  # A command line error.
   class CLIError < PandocomaticError
 
+    # Get the template used to print this CLIError
     def template()
       'cli_error.txt'
     end

data/lib/pandocomatic/error/configuration_error.rb

@@ -19,8 +19,10 @@
 module Pandocomatic
   require_relative './pandocomatic_error.rb'
 
+  # A ConfigurationError
   class ConfigurationError < PandocomaticError
     
+    # The template to print this ConfigurationError
     def template()
       'configuration_error.txt'
     end

data/lib/pandocomatic/error/io_error.rb

@@ -19,8 +19,10 @@
 module Pandocomatic
   require_relative './pandocomatic_error.rb'
 
+  # An IOError
   class IOError < PandocomaticError
 
+    # The template to use when printing this IOError
     def template()
       'io_error.txt'
     end