Module: Term::ANSIColor

Extended by:

ANSIColor

Included in:

ANSIColor

Defined in:

lib/term/ansicolor.rb

Overview

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

Constant Summary

ATTRIBUTES =

:stopdoc:

[
  [ :clear        ,   0 ], 
  [ :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 ], 
]

ATTRIBUTE_NAMES =

ATTRIBUTES.transpose.first

COLORED_REGEXP =

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

/\e\[([34][0-7]|[0-9])m/

Class Method Summary

• .attributes ⇒ Object

  Returns an array of all Term::ANSIColor attributes as symbols.

• .coloring=(val) ⇒ Object

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

• .coloring? ⇒ Boolean

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

Instance Method Summary

• #uncolored(string = nil) ⇒ Object

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

Class Method Details

.attributes ⇒ Object

Returns an array of all Term::ANSIColor attributes as symbols.

# File 'lib/term/ansicolor.rb', line 214

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

# File 'lib/term/ansicolor.rb', line 168

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)

# File 'lib/term/ansicolor.rb', line 161

def self.coloring?
  @coloring
end

Instance Method Details

#uncolored(string = nil) ⇒ Object

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

# File 'lib/term/ansicolor.rb', line 199

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