free_mutant/lib/mutant/color.rb
Markus Schirp dfcabdc279 Fix style of YARD @return tag description
Before there was lots of redundant information. These comments where
very old and my current YARD doc style changed in the meantime. Keep it
DRY.
2013-09-11 20:50:23 +02:00

65 lines
1,001 B
Ruby

# encoding: utf-8
module Mutant
# Class to colorize strings
class Color
include Adamantium::Flat
# Initialize color object
#
# @param [Fixnum] code
#
# @return [undefined]
#
# @api private
#
def initialize(code)
@code = code
end
# Format text with color
#
# @param [String] text
#
# @return [String]
#
# @api private
#
def format(text)
"\e[#{@code}m#{text}\e[0m"
end
Mutant.singleton_subclass_instance('NONE', self) do
# Format null color
#
# @param [String] text
#
# @return [String]
# the argument string
#
# @api private
#
def format(text)
text
end
private
# Initialize null color
#
# @return [undefined]
#
# @api private
#
def initialize
end
end
RED = Color.new(31)
GREEN = Color.new(32)
BLUE = Color.new(34)
end # Color
end # Mutant