Contents

class Cmds
  # a {Result} is a simple data structure returned from calling {Cmds#capture} 
  # on a {Cmds} instance.
  # 
  # it contains the exit status code, standard output and standard error,
  # as well as the actual string command issued (after all substitutions).
  #
  # instances also have a few convenience methods.
  #
  # @!attribute [r] cmd
  #   @return [String] the command string that was executed.
  #
  # @!attribute [r] status
  #   @return [Fixnum] the command process' exit status code.
  #
  # @!attribute [r] out
  #   @return [String] the command process' standard output.
  #
  # @!attribute [r] err
  #   @return [String] the command process' standard error.
  #
  class Result
    attr_reader :cmd, :status, :out, :err
    
    # @param cmd [String] {#cmd} attribute.
    # @param status [Fixnum] {#status} attribute.
    # @param out [String] {#out} attribute.
    # @param err [String] {#err} attribute.
    def initialize cmd, status, out, err
      @cmd = cmd
      @status = status
      @out = out
      @err = err
    end
    
    # @return [Boolean] true if {#status} is `0`.
    def ok?
      @status == 0
    end
    
    # @return [Boolean] true if {#status} is not `0`.
    def error?
      ! ok?
    end
    
    # raises an error if the command failed (exited with a {#status} other 
    # than `0`).
    #
    # @return [Result] it's self (so that it can be chained).
    #
    # @raise [SystemCallError] if the command failed.
    #
    def assert
      if error?
        msg = NRSER.squish <<-BLOCK
          command `#{ @cmd }` exited with status #{ @status }
          and stderr #{ err.inspect }
        BLOCK

        raise SystemCallError.new msg, @status
      end
      self
    end # raise_error
  end
end # class Cmds

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
cmds-0.0.9	lib/cmds/result.rb
cmds-0.0.8	lib/cmds/result.rb
cmds-0.0.7	lib/cmds/result.rb
cmds-0.0.6	lib/cmds/result.rb
cmds-0.0.5	lib/cmds/result.rb