command_exec 0.1.3 → 0.2.0

data/lib/command_exec/formatter/hash.rb

@@ -0,0 +1,78 @@
+#encoding: utf-8
+
+#Main
+module CommandExec
+  #Formatting output
+  module Formatter
+    #Style hash
+    class Hash
+
+      include FieldHelper
+
+      # @!attribute [r] output
+      #   return the formatted output
+      attr_reader :output
+      # @!attribute [w] logger
+      #   set the logger after object creation
+      attr_writer :logger
+
+      public
+
+      # Create new hash formatter
+      # 
+      # @param [Hash] options
+      #   Options for formatter
+      #
+      # @option options [Symbol] :logger
+      #   Logger to output information. Needs to have the same interface like
+      #   the ruby `Logger`-class.
+      def initialize(options={})
+        @options = {
+          logger: Logger.new($stdout),
+        }.deep_merge options
+
+        @logger = @options[:logger]
+
+        super()
+      end
+
+      def status(value)
+        prepare_status(value)
+      end
+
+      private
+
+      # Build the data structure for output
+      #
+      # @param [Array] fields
+      #   which fields should be outputted
+      #
+      # @return [Hash] 
+      #   the formatted output
+      def prepare_output(fields=[])
+        out = {}
+
+        fields = default_fields if fields.blank?
+
+        fields.each do |f|
+          out[f] = available_fields[f] if available_fields.has_key?(f)
+        end
+
+        out
+      end
+
+      public
+
+      # Output the prepared output
+      #
+      # @param [Array,Symbol) fields
+      #   the fields which should be outputted
+      #
+      # @return [Hash] 
+      #   the formatted output
+      def output(*fields)
+        prepare_output(fields.flatten)
+      end
+    end
+  end
+end

data/lib/command_exec/formatter/json.rb

@@ -0,0 +1,22 @@
+#encoding: utf-8
+
+#Main
+module CommandExec
+  #Formatting output
+  module Formatter
+    #Style as json string
+    class JSON < CommandExec::Formatter::Hash
+
+      # convert the prepared output to json
+      #
+      # @param [Array,Symbol) fields
+      #   the fields which should be outputted
+      #
+      # @return [String] 
+      #   the output formatted as json string
+      def output(*fields)
+        ::JSON.generate prepare_output(fields.flatten) 
+      end
+    end
+  end
+end

data/lib/command_exec/formatter/string.rb

@@ -0,0 +1,22 @@
+#encoding: utf-8
+
+#Main
+module CommandExec
+  #Formatting output
+  module Formatter
+    #Style as simple string
+    class String < CommandExec::Formatter::Array
+
+      # convert the prepared output to single string
+      #
+      # @param [Array,Symbol) fields
+      #   the fields which should be outputted
+      #
+      # @return [String] 
+      #   the output formatted as simple string
+      def output(*fields)
+        prepare_output(fields.flatten).join("\n")
+      end
+    end
+  end
+end

data/lib/command_exec/formatter/xml.rb

@@ -0,0 +1,22 @@
+#encoding: utf-8
+
+#Main
+module CommandExec
+  #Formatting output
+  module Formatter
+    #Style as xml string
+    class XML < CommandExec::Formatter::Hash
+
+      # convert the prepared output to a xml string
+      #
+      # @param [Array,Symbol) fields
+      #   the fields which should be outputted
+      #
+      # @return [String] 
+      #   the output formatted as a xml string
+      def output(*fields)
+        XmlSimple.xml_out(prepare_output(fields.flatten), 'RootName' => 'command', 'NoAttr' => true)
+      end
+    end
+  end
+end

data/lib/command_exec/formatter/yaml.rb

@@ -0,0 +1,22 @@
+#encoding: utf-8
+
+#Main
+module CommandExec
+  #Formatting output
+  module Formatter
+    #Style as yaml string
+    class YAML < CommandExec::Formatter::Hash
+
+      # convert the prepared output to a yaml string
+      #
+      # @param [Array,Symbol) fields
+      #   the fields which should be outputted
+      #
+      # @return [String] 
+      #   the output formatted as a xml string
+      def output(*fields)
+        Psych.dump prepare_output(fields.flatten) 
+      end
+    end
+  end
+end

data/lib/command_exec/logger.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+#ruby's logging class
+class Logger
+  #container for extra severities
+  module Severity
+    #keep logger silent
+    SILENT = 999999
+  end
+end

data/lib/command_exec/process.rb

@@ -0,0 +1,294 @@
+#encoding: utf-8
+
+#Main
+module CommandExec
+  # The class used to save the data about
+  # the executed command
+  class Process
+
+    include FieldHelper
+
+    # @!attribute [rw] executable
+    #   Set/Get the executable of the command
+    attr_accessor :executable 
+
+    # @!attribute [r] status
+    #   Get the status of the command
+    #
+    # @!attribute [r] stdout
+    #   Get stdout of the command
+    #
+    # @!attribute [r] stderr
+    #   Get stderr of the command
+    #
+    # @!attribute [r] reason_for_failure
+    #   Get the reason why `command_exec` thinks a command failed
+    #
+    # @!attribute [r] return_code
+    #   Get the exit code of the command
+    #
+    # @!attribute [r] pid
+    #   Get the pid of the command
+    #
+    # @!attribute [r] start_time
+    #   Return the time when the execution of the command started
+    #
+    # @!attribute [r] end_time
+    #   Return the time when the execution of the command finished
+    attr_reader :status, :log_file, :stdout, :stderr, :reason_for_failure, :return_code, :pid, :start_time, :end_time
+
+    # Create a process object
+    #
+    # @param [Hash] options
+    #   options for the process
+    #
+    # @option options [Logger] lib_logger
+    #   The logger which is used to output information generated by the
+    #   library. The logger which is provided needs to be compatible with api
+    #   of the Ruby `Logger`-class.
+    #
+    # @option options [Array] stderr
+    #   content of stderr of the process
+    #
+    # @option options [Array] stdout
+    #   content of stdout of the process
+    #
+    # @option options [Array] log_file
+    #   content of the log file of the process
+    #
+    # @option options [Number,String] pid
+    #   the pid of the process
+    #
+    # @option options [Number,String] return_code
+    #   the exit status of the process
+    #
+    # @option options [Array] reason_for_failure
+    #   the reason for failure
+    #
+    # @option options [Symbol] status
+    #   execution was successful, failed
+    def initialize(options={})
+      @options = {
+        lib_logger: Logger.new($stderr),
+        stderr: [],
+        stdout: [],
+        log_file: [],
+        pid: nil,
+        return_code: nil,
+        reason_for_failure: [],
+        status: :success,
+        executable: nil,
+      }.merge options
+
+      @logger = @options[:lib_logger]
+
+      @stderr = @options[:stderr]
+      @stdout = @options[:stdout]
+      @status = @options[:status]
+      @log_file = @options[:log_file]
+      @pid = @options[:pid]
+      @reason_for_failure = @options[:reason_for_failure]
+      @return_code = @options[:return_code]
+      @executable = @options[:executable]
+
+      @start_time = nil
+      @end_time = nil
+    end
+
+    # Set the name of the log file
+    #
+    # @param [String] filename
+    #   the name of the log file
+    def log_file=(filename=nil)
+        if filename.blank?
+          file = StringIO.new 
+          @logger.debug "No file name for log file given. Using empty String"
+        else
+          begin
+            file = File.open(filename)
+            @logger.debug "read logfile \"#{file}\" "
+          rescue Errno::ENOENT
+            file = StringIO.new
+            @logger.warn "Logfile #{filename} not found!"
+          rescue Exception => e
+            file = StringIO.new
+            @logger.warn "An error happen while reading log_file \"#{filename}\": #{e.message}"
+          end
+        end
+
+      @log_file = file.readlines.map(&:chomp)
+    end
+
+    # Set the pid of the process
+    #
+    # @param [Number,String] value
+    def pid=(value)
+      @pid = value.to_s
+    end
+
+    # Set the value of stdout
+    #
+    # @param [Array, String] content
+    #   the content of stdout
+    def stdout=(*content)
+      @stdout += content.flatten
+    end
+
+    # Set the value of stderr
+    #
+    # @param [Array, String] content
+    #   the content of stderr
+    def stderr=(*content)
+      @stderr += content.flatten
+    end
+
+    # Set the status of command execution
+    #
+    # @param [Array, String] value
+    #   the status
+    def status=(value)
+      case value.to_s
+      when 'success'
+        @status = :success
+      when 'failed'
+        @status = :failed
+      else
+        @status = :failed
+      end
+
+      @status
+    end
+
+    # Why the execution failed
+    #
+    # @param [String] content
+    #   the reason for failure. When you run it mulitple times, the string is
+    #   added at the end.
+    def reason_for_failure=(content)
+      @reason_for_failure << content.to_s
+    end
+
+    # Set the exit status of the command
+    #
+    # @param [Number,String] value
+    #   the exit status of the command 
+    def return_code=(value)
+      @return_code = value
+    end
+    
+    # Set the path to the executable
+    #
+    # @param [Number,String] value
+    #   the path to the executable of the command 
+    def executable=(value)
+      @executable = value
+    end
+      
+    # Set the start time of the command execution
+    #
+    # @param [Number,String] value
+    #   the path to the executable of the command 
+    def start_time=(value)
+      @start_time = value
+    end
+
+    # Set the end time of the command execution
+    #
+    # @param [Number,String] value
+    #   the path to the executable of the command 
+    def end_time=(value)
+      @end_time = value
+    end
+
+    def run_time
+      end_time - start_time
+    end
+
+    private 
+
+    # Generate formatted output
+    #
+    # @param [Symbol,Array of Symbols] fields
+    #   the field which should be part of the output
+    #
+    # @param [Formatter] formatter
+    #   the formatter which is used to format the output
+    def output(*fields,formatter)
+
+      fields.flatten.each do |f|
+        formatter.public_send(f, available_fields[f])
+      end
+
+      formatter.output(fields.flatten)
+    end
+
+    public 
+
+    # Output process data as array
+    #
+    # @param [Array of Symbols] fields
+    #   the fields which should be outputed
+    #
+    # @param [Formatter] formatter (Formatter::Array.new)
+    #   the formatter which is used the format the output
+    def to_a(fields=default_fields, formatter=Formatter::Array.new)
+      output(fields, formatter)
+    end
+
+    # Output process data as hash
+    #
+    # @param [Array of Symbols] fields
+    #   the fields which should be outputed
+    #
+    # @param [Formatter] formatter (Formatter::Hash.new)
+    #   the formatter which is used the format the output
+    def to_h(fields=default_fields, formatter=Formatter::Hash.new)
+      output(fields, formatter)
+    end
+
+    # Output process data as string
+    #
+    # @param [Array of Symbols] fields
+    #   the fields which should be outputed
+    #
+    # @param [Formatter] formatter (Formatter::String.new)
+    #   the formatter which is used the format the output
+    def to_s(fields=default_fields, formatter=Formatter::String.new)
+      output(fields, formatter)
+    end
+
+    # Output process data as xml
+    #
+    # @param [Array of Symbols] fields
+    #   the fields which should be outputed
+    #
+    # @param [Formatter] formatter (Formatter::XML.new)
+    #   the formatter which is used the format the output
+    def to_xml(fields=default_fields, formatter=Formatter::XML.new)
+      output(fields, formatter)
+    end
+
+    # Output process data as json
+    #
+    # @param [Array of Symbols] fields
+    #   the fields which should be outputed
+    #
+    # @param [Formatter] formatter (Formatter::JSON.new)
+    #   the formatter which is used the format the output
+    def to_json(fields=default_fields, formatter=Formatter::JSON.new)
+      output(fields, formatter)
+    end
+
+    # Output process data as yaml
+    #
+    # @param [Array of Symbols] fields
+    #   the fields which should be outputed
+    #
+    # @param [Formatter] formatter (Formatter::YAML.new)
+    #   the formatter which is used the format the output
+    def to_yaml(fields=default_fields, formatter=Formatter::YAML.new)
+      output(fields, formatter)
+    end
+  end
+end
+