Module: Doing::Color

Extended by:
Color
Included in:
Color, String
Defined in:
lib/doing/colors.rb

Constant Summary collapse

ATTRIBUTES =

:stopdoc:

[
  [ :clear              ,   0 ],     # String#clear is already used to empty string in Ruby 1.9
  [ :reset              ,   0 ],     # synonym for :clear
  [ :bold               ,   1 ],
  [ :dark               ,   2 ],
  [ :italic             ,   3 ],     # not widely implemented
  [ :underline          ,   4 ],
  [ :underscore         ,   4 ],     # synonym for :underline
  [ :blink              ,   5 ],
  [ :rapid_blink        ,   6 ],     # not widely implemented
  [ :negative           ,   7 ],     # no reverse because of String#reverse
  [ :concealed          ,   8 ],
  [ :strikethrough      ,   9 ],     # not widely implemented
  [ :black              ,  30 ],
  [ :red                ,  31 ],
  [ :green              ,  32 ],
  [ :yellow             ,  33 ],
  [ :blue               ,  34 ],
  [ :magenta            ,  35 ],
  [ :cyan               ,  36 ],
  [ :white              ,  37 ],
  [ :bgblack            ,  40 ],
  [ :bgred              ,  41 ],
  [ :bggreen            ,  42 ],
  [ :bgyellow           ,  43 ],
  [ :bgblue             ,  44 ],
  [ :bgmagenta          ,  45 ],
  [ :bgcyan             ,  46 ],
  [ :bgwhite            ,  47 ],
  [ :boldblack          ,  90 ],    # High intensity, aixterm (works in OS X)
  [ :boldred            ,  91 ],
  [ :boldgreen          ,  92 ],
  [ :boldyellow         ,  93 ],
  [ :boldblue           ,  94 ],
  [ :boldmagenta        ,  95 ],
  [ :boldcyan           ,  96 ],
  [ :boldwhite          ,  97 ],
  [ :boldbgblack        , 100 ],    # High intensity background, aixterm (works in OS X)
  [ :boldbgred          , 101 ],
  [ :boldbggreen        , 102 ],
  [ :boldbgyellow       , 103 ],
  [ :boldbgblue         , 104 ],
  [ :boldbgmagenta      , 105 ],
  [ :boldbgcyan         , 106 ],
  [ :boldbgwhite        , 107 ],
  [ :softpurple    , '0;35;40'],
  [ :hotpants      , '7;34;40'],
  [ :knightrider   , '7;30;40'],
  [ :flamingo      , '7;31;47'],
  [ :yeller        , '1;37;43'],
  [ :whiteboard    , '1;30;47'],
  [ :default         , '0;39' ]
]
ATTRIBUTE_NAMES = 
ATTRIBUTES.transpose.first
COLORED_REGEXP =

Regular expression that is used to scan for ANSI-sequences while uncoloring strings.

/\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.attributes ⇒ Object

Returns an array of all Doing::Color attributes as symbols.



130
131
132
 
# File 'lib/doing/colors.rb', line 130

def attributes
  ATTRIBUTE_NAMES
end

.coloring=(val) ⇒ Object

Turns the coloring on or off globally, so you can easily do this for example: Doing::Color::coloring = STDOUT.isatty



84
85
86
 
# File 'lib/doing/colors.rb', line 84

def self.coloring=(val)
  @coloring = val
end

.coloring? ⇒ Boolean

Returns true, if the coloring function of this module is switched on, false otherwise.

Returns:



77
78
79
 
# File 'lib/doing/colors.rb', line 77

def self.coloring?
  @coloring
end

Instance Method Details

#support?(feature) ⇒ Boolean

Returns true if Doing::Color supports the feature.

The feature :clear, that is mixing the clear color attribute into String, is only supported on ruby implementations, that do not already implement the String#clear method. It's better to use the reset color attribute instead.

Returns:



69
70
71
72
73
74
 
# File 'lib/doing/colors.rb', line 69

def support?(feature)
  case feature
  when :clear
    !String.instance_methods(false).map(&:to_sym).include?(:clear)
  end
end

#uncolor(string = nil) ⇒ Object

Returns an uncolored version of the string, that is all ANSI-sequences are stripped from the string.



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/doing/colors.rb', line 115

def uncolor(string = nil) # :yields:
  if block_given?
    yield.to_str.gsub(COLORED_REGEXP, '')
  elsif string.respond_to?(:to_str)
    string.to_str.gsub(COLORED_REGEXP, '')
  elsif respond_to?(:to_str)
    to_str.gsub(COLORED_REGEXP, '')
  else
    ''
  end
end