command_exec 0.1.3 → 0.2.0

data/lib/command_exec/exceptions.rb

@@ -1,20 +1,30 @@
+# encoding: utf-8
+
 # Main
 module CommandExec
   # Classed concerning pdflatex exceptions
   module Exceptions
     # Class used to indicate that a command 
     # could not be found in file system
-    class CommandNotFound < RuntimeError
-    end
+    class CommandNotFound < RuntimeError; end
+    
+    # Class used to indicate that a command 
+    # is not flagged as executable
+    #
+    # @example Counter measure for this error
+    #   chmod +x <executable>
+    class CommandNotExecutable < RuntimeError; end
+    
+    # Class used to indicate that a command 
+    # is not a file
+    class CommandIsNotAFile < RuntimeError; end
     
     # Class used to indicate that a command run
     # ended with a failure 
-    class ExecuteCommandFailed < RuntimeError
-    end
+    class CommandExecutionFailed < RuntimeError; end
     
     # Class used to indicate that a logfile
     # could not be found in file system
-    class LogfileNotFound < RuntimeError
-    end
+    class LogfileNotFound < RuntimeError; end
   end
 end

data/lib/command_exec/field_helper.rb

@@ -0,0 +1,263 @@
+#encoding: utf-8
+
+#Main
+module CommandExec
+  # Shared methods for fields
+  module FieldHelper
+
+    # Initialize helper
+    #
+    # will be used from array and hash via super call although there's no
+    # inheritance.
+    # See for more information http://stackoverflow.com/questions/1645398/ruby-include-question
+    def initialize
+      @end_time = []
+      @executable = []
+      @log_file = []
+      @pid = []
+      @reason_for_failure = []
+      @return_code = []
+      @start_time = []
+      @status = []
+      @stderr = []
+      @stdout = []
+    end
+
+    private
+
+    # Return the available header names
+    #
+    # @return [Hash] the names of the headers
+    #
+    #   * :status [String]: 'STATUS'
+    #   * :return_code [String]: 'RETURN CODE'
+    #   * :log_file [String]: 'LOG FILE'
+    #   * :stderr [String]: 'STDERR'
+    #   * :stdout [String]: 'STDOUT'
+    #   * :pid [String]: 'PID'
+    #   * :reason\_for\_failure [String]: 'REASON FOR FAILURE'
+    #   * :executable [String]: 'EXECUTABLE'
+    #
+    def header_names
+      {
+        headers: {
+          names: {
+            status:       'STATUS',
+            return_code:  'RETURN CODE',
+            log_file:     'LOG FILE',
+            stderr:       'STDERR',
+            stdout:       'STDOUT',
+            pid:          'PID',
+            reason_for_failure: 'REASON FOR FAILURE',
+            executable:   'EXECUTABLE',
+            start_time:   'START TIME',
+            end_time:     'END TIME',
+          },
+        }
+      }
+    end
+
+    # Return the available fields for output
+    #
+    # @return [Hash] the available fields with the corresponding instance
+    #   variable
+    def available_fields
+      {
+        :status => @status,
+        :return_code => @return_code,
+        :stderr => @stderr,
+        :stdout => @stdout,
+        :log_file => @log_file,
+        :pid => @pid,
+        :reason_for_failure => @reason_for_failure,
+        :executable => @executable,
+        :start_time => @start_time,
+        :end_time => @end_time,
+      }
+    end
+
+    # Return the default fields for output
+    #
+    # @return [Array] the names of the fields which should be outputted by
+    #   default 
+    def default_fields
+      [:status,
+       :return_code,
+       :stderr,
+       :stdout,
+       :log_file,
+       :pid,
+       :reason_for_failure,
+       :executable,
+       :start_time,
+       :end_time,
+      ] 
+    end
+    
+    # Set the status of the command
+    #
+    # @param [String,Symbol] value
+    #   Set the status of the command based on input.
+    #
+    # @param [Hash] options
+    #   Options for status
+    #
+    # @option options [True,False] :color
+    #   Should the output be colored
+    #
+    # @return [Array] 
+    #   the formatted status. It returns `OK` (in bold and green) if status is
+    #   `:success` and `FAILED` (in bold and red) if status is `:failed`.
+    #
+    def prepare_status(value,options={})
+
+      case value.to_s
+      when 'success'
+        @status[0] = message_success(color: options[:color])
+      when 'failed'
+        @status[0] = message_failure(color: options[:color])
+      else
+        @status[0] = message_failure(color: options[:color])
+      end
+
+      @status
+    end
+
+    # Returns the success message
+    #
+    # @param [Hash] options
+    #   options
+    #
+    # @option options [True,False] :color
+    #   should the message return in color
+    #
+    # @return [String] the message
+    def message_success(options={})
+      message = 'OK'
+
+      if options[:color] 
+        return message.green.bold
+      else
+        return message
+      end
+    end
+
+    # Returns the failure message
+    #
+    # @param [Hash] options
+    #   options
+    #
+    # @option options [True,False] :color
+    #   should the message return in color
+    #
+    # @return [String] the message
+    def message_failure(options)
+      message = 'FAILED'
+
+      if options[:color] 
+        return message.red.bold
+      else
+        return message
+      end
+    end
+
+    public
+
+    # Set the content of the log file
+    #
+    # @param content [Array,String]
+    #   The content of log file
+    #
+    # @return [Array] the content of the log file
+    def log_file(*content)
+      @log_file += content.flatten
+    end
+
+    # Set the return code of the command
+    #
+    # @param value [Number,String]
+    #   Set the return code(s) of the command. 
+    #
+    # @return [Array] the return code
+    def return_code(value)
+      @return_code[0] = value.to_s
+
+      @return_code
+    end
+
+    # Set the content of stdout
+    #
+    # @param content [Array,String]
+    #   The content of stdout
+    #
+    # @return [Array]
+    def stdout(*content)
+      @stdout += content.flatten
+    end
+
+    # Set the content of stderr
+    #
+    # @param content [Array,String]
+    #   The content of stderr
+    #
+    # @return [Array]
+    def stderr(*content)
+      @stderr += content.flatten
+    end
+
+    # Set the pid of the command
+    #
+    # @param value [Number,String]
+    #   Set the pid of the command. 
+    #
+    # @return [Array]
+    def pid(value)
+      @pid[0] = value.to_s
+
+      @pid
+    end
+
+    # Set the reason for failure
+    #
+    # @param content [Array, String] 
+    #   Set the reason for failure.
+    #
+    # @return [Array]
+    def reason_for_failure(*content)
+      @reason_for_failure += content.flatten
+    end
+      
+    # Set the path to the executable of the command
+    #
+    # @param [String] value
+    #  the path to the executable
+    #
+    # @return [Array]
+    #   the executable
+    def executable(value)
+      @executable[0] = value
+    end
+    
+    # Set the start time of command execution 
+    #
+    # @param [Time] value
+    #  the start time  of command execution
+    #
+    # @return [Array]
+    #   the start time
+    def start_time(value)
+      @start_time[0] = value
+    end
+    
+    # Set the end time of command execution 
+    #
+    # @param [Time] value
+    #  the end time  of command execution
+    #
+    # @return [Array]
+    #   the end time
+    def end_time(value)
+      @end_time[0] = value
+    end
+  end
+end

data/lib/command_exec/formatter/array.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+
+#Main
+module CommandExec
+  #Formatting output
+  module Formatter
+    #Style array
+    class Array
+
+      include FieldHelper
+
+      # @!attribute [r] output
+      #   return the formatted output
+      attr_reader :output
+      # @!attribute [w] logger
+      #   set the logger after object creation
+      attr_writer :logger
+
+      # Create new array formatter
+      # 
+      # @param [Hash] options
+      #   Options for formatter
+      #
+      # @option options [Hash] :headers
+      #   It is used to configure how the headers will be formatted
+      #
+      #   There are several sub-options:
+      #
+      #   * :names  [Hash]: What should be output as name for the header (filled via deep_merge and FieldHelper-Module)
+      #   * :prefix [String]: What is placed before the header ('=' * 5)
+      #   * :suffix [String]: What is placed after the header ('=' * 5)
+      #   * :halign [Symbol]: How to align the header: :center [default], :left, :right
+      #   * :show (Boolean): Should the header be shown (true)
+      #
+      # @option options [Symbol] :logger
+      #   Logger to output information. Needs to have the same interface like
+      #   the ruby `Logger`-class.
+      #   
+      def initialize(options={})
+        @options = {
+          headers: {
+            names: {}, 
+            prefix: '=' * 5,
+            suffix: '=' * 5,
+            halign: :center,
+            show: true,
+          },
+          logger: Logger.new($stdout),
+        }.deep_merge(header_names.deep_merge(options))
+
+        @headers_options = @options[:headers]
+        @logger = @options[:logger]
+
+        super()
+      end
+
+      def status(value)
+        prepare_status(value, color: true)
+      end
+
+      private 
+
+      # Get the maximum length over all headers
+      #
+      # @return [Number] the maxium header length
+      def max_header_length
+        @max_header_length ||= @headers_options[:names].values.inject(0) { |max_length, name|  max_length < name.length ? name.length : max_length }
+      end
+
+      # Align header names
+      #
+      # @param [String] name
+      #   the name which should be aligned
+      # 
+      # @param max_length [Number]
+      #   the maximum length which is used to align the name
+      #
+      # @param orientation [Symbol]
+      #   how to align the header name
+      #
+      # @return [String] the aligned header name
+      def halign(name, max_length, orientation)
+
+        name = name.to_s
+
+        case orientation
+        when :center
+          name.center(max_length)
+        when :left
+          name.ljust(max_length)
+        when :right
+          name.rjust(max_length)
+        else
+          name.center(max_length)
+        end
+      end
+
+      # Format header but only if given header is defined.
+      #
+      # @param [Symbol] header
+      #   the name of the header. It has to be defined in opts[:names]
+      #
+      # @param [Hash] options
+      #   used to change format options like `prefix`, `suffix` etc. after the
+      #   creation of the `Formatter::Array`-object. Those options defined at the
+      #   creation of the `Formatter`-object are default and can be overwritten 
+      #   using this `Hash`.
+      #
+      # @return [String] the formatted header
+      def format_header(header,options={})
+        opts = @headers_options.deep_merge options
+
+        output=""
+        unless opts[:names][header] == ""
+          output += "#{opts[:prefix]} " unless opts[:prefix].blank?
+          output += halign(opts[:names][header], max_header_length, opts[:halign])
+          output += " #{opts[:suffix]}" unless opts[:suffix].blank?
+        end
+
+        output
+      end
+
+      # Build the data structure for output
+      #
+      # @param [Array] fields
+      #   which fields should be outputted
+      #
+      # @return [Array] 
+      #   the formatted output
+      def prepare_output(fields=[])
+        out = []
+        fields = fields.flatten
+
+        fields = default_fields if fields.blank?
+
+        fields.each do |var|
+          out << format_header(var,@headers_options) if @headers_options[:show] = true and available_fields.has_key?(var)
+          out += available_fields[var] if available_fields.has_key?(var)
+        end
+
+        out
+      end
+
+      public
+
+      # Output the prepared output
+      #
+      # @param [Array,Symbol) fields
+      #   the fields which should be outputted
+      #
+      # @return [Array] 
+      #   the formatted output
+      def output(*fields)
+        prepare_output(fields.flatten)
+      end
+    end
+  end
+end