Module: Term::NoColor

Extended by:
NoColor
Included in:
NoColor
Defined in:
lib/texas/core_ext/string.rb

Overview

The ANSIColor module can be used for namespacing and mixed into your own classes.

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 ], 
  [ :on_black           ,  40 ], 
  [ :on_red             ,  41 ], 
  [ :on_green           ,  42 ], 
  [ :on_yellow          ,  43 ], 
  [ :on_blue            ,  44 ], 
  [ :on_magenta         ,  45 ], 
  [ :on_cyan            ,  46 ], 
  [ :on_white           ,  47 ],
  [ :intense_black      ,  90 ],    # High intensity, aixterm (works in OS X)
  [ :intense_red        ,  91 ], 
  [ :intense_green      ,  92 ], 
  [ :intense_yellow     ,  93 ], 
  [ :intense_blue       ,  94 ], 
  [ :intense_magenta    ,  95 ], 
  [ :intense_cyan       ,  96 ], 
  [ :intense_white      ,  97 ], 
  [ :on_intense_black   , 100 ],    # High intensity background, aixterm (works in OS X)
  [ :on_intense_red     , 101 ], 
  [ :on_intense_green   , 102 ], 
  [ :on_intense_yellow  , 103 ], 
  [ :on_intense_blue    , 104 ], 
  [ :on_intense_magenta , 105 ], 
  [ :on_intense_cyan    , 106 ], 
  [ :on_intense_white   , 107 ]
]
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 Term::ANSIColor attributes as symbols.



127
128
129
 
# File 'lib/texas/core_ext/string.rb', line 127

def attributes
  ATTRIBUTE_NAMES
end

.coloring=(val) ⇒ Object

Turns the coloring on or off globally, so you can easily do this for example:

Term::ANSIColor::coloring = STDOUT.isatty



83
84
85
 
# File 'lib/texas/core_ext/string.rb', line 83

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

.coloring? ⇒ Boolean

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

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/texas/core_ext/string.rb', line 76

def self.coloring?
  @coloring
end

Instance Method Details

#support?(feature) ⇒ Boolean

Returns true if Term::ANSIColor 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:

  • (Boolean) 


68
69
70
71
72
73
 
# File 'lib/texas/core_ext/string.rb', line 68

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

#uncolored(string = nil) ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/texas/core_ext/string.rb', line 112

def uncolored(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