module Cucumber::Term::ANSIColor

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

Constants

COLORED_REGEXP

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

Public Class Methods

coloring=(val) click to toggle source

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

Cucumber::Term::ANSIColor::coloring = STDOUT.isatty
# File lib/cucumber/term/ansicolor.rb, line 51
def self.coloring=(val)
  @coloring = val
end
coloring?() click to toggle source

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

# File lib/cucumber/term/ansicolor.rb, line 44
def self.coloring?
  @coloring
end
included(klass) click to toggle source
# File lib/cucumber/term/ansicolor.rb, line 82
def self.included(klass)
  return unless klass == String
  ATTRIBUTES.delete(:clear)
  ATTRIBUTE_NAMES.delete(:clear)
end

Public Instance Methods

attributes() click to toggle source

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

# File lib/cucumber/term/ansicolor.rb, line 105
def attributes
  ATTRIBUTE_NAMES
end
uncolored(string = nil) { || ... } click to toggle source

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

# File lib/cucumber/term/ansicolor.rb, line 90
def uncolored(string = nil)
  if block_given?
    yield.gsub(COLORED_REGEXP, '')
  elsif string
    string.gsub(COLORED_REGEXP, '')
  elsif respond_to?(:to_str)
    to_str.gsub(COLORED_REGEXP, '')
  else
    ''
  end
end