module Protest::Utils::ColorfulOutput

Mixin that provides colorful output to your console based reports. This uses bash’s escape sequences, so it won’t work on windows.

TODO: Make this work on windows with ansicolor or whatever the gem is named

Attributes

colorize[RW]

Whether to use colors in the output or not. The default is true.

Public Class Methods

colors() click to toggle source

Returns a hash with the color values for different states. Override this method safely to change the output colors. The defaults are:

:passed

Light green

:pending

Light yellow

:errored

Light purple

:failed

Light red

See www.hypexr.org/bash_tutorial.php#colors for a description of Bash color codes.

# File lib/protest/utils/colorful_output.rb, line 18
def self.colors
  { :passed => "1;32",
    :pending => "1;33",
    :errored => "1;35",
    :failed => "1;31" }
end

Public Instance Methods

print(string=nil, state=:normal) click to toggle source

Print the string to whatever IO stream is defined in the method stream using the correct color depending on the state passed.

puts(string=nil, state=:normal) click to toggle source

Print the string followed by a newline to whatever IO stream is defined in the method stream using the correct color depending on the state passed.

# File lib/protest/utils/colorful_output.rb, line 34
def puts(string=nil, state=:normal)
  if string.nil? # calling IO#puts with nil is not the same as with no args
    stream.puts
  else
    stream.puts colorize(string, state)
  end
end