Module: RSpec::Core::Formatters::ConsoleCodes

Defined in:
lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/formatters/console_codes.rb

Overview

ConsoleCodes provides helpers for formatting console output with ANSI codes, e.g. color’s and bold.

Constant Summary collapse

VT100_CODES = 
{
  :black         => 30,
  :red           => 31,
  :green         => 32,
  :yellow        => 33,
  :blue          => 34,
  :magenta       => 35,
  :cyan          => 36,
  :white         => 37,
  :bold_black   => '1;30',
  :bold_red     => '1;31',
  :bold_green   => '1;32',
  :bold_yellow  => '1;33',
  :bold_blue    => '1;34',
  :bold_magenta => '1;35',
  :bold_cyan    => '1;36',
  :bold_white   => '1;37',
  :bold          => 1,
}
VT100_CODE_VALUES = 
VT100_CODES.invert

Class Method Summary collapse

Class Method Details

.config_colors_to_methods ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/formatters/console_codes.rb', line 34

def config_colors_to_methods
  @config_colors_to_methods ||=
    Configuration.instance_methods.grep(/_color\z/).inject({}) do |hash, method|
      hash[method.to_s.sub(/_color\z/, '').to_sym] = method
      hash
    end
end

.console_code_for(code_or_symbol) ⇒ Fixnum

Fetches the correct code for the supplied symbol, or checks that a code is valid. Defaults to white (37).

Parameters:

  • code_or_symbol (Symbol, Fixnum) —

    Symbol or code to check

Returns:



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/formatters/console_codes.rb', line 47

def console_code_for(code_or_symbol)
  if (config_method = config_colors_to_methods[code_or_symbol])
    console_code_for RSpec.configuration.__send__(config_method)
  elsif VT100_CODE_VALUES.key?(code_or_symbol)
    code_or_symbol
  else
    VT100_CODES.fetch(code_or_symbol) do
      console_code_for(:white)
    end
  end
end

.wrap(text, code_or_symbol) ⇒ String

Wraps a piece of text in ANSI codes with the supplied code. Will only apply the control code if ‘RSpec.configuration.color_enabled?` returns true.

Parameters:

  • text (String) —

    the text to wrap

  • code_or_symbol (Symbol, Fixnum) —

    the desired control code

Returns:

  • (String) —

    the wrapped text



66
67
68
69
70
71
72
 
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/formatters/console_codes.rb', line 66

def wrap(text, code_or_symbol)
  if RSpec.configuration.color_enabled?
    "\e[#{console_code_for(code_or_symbol)}m#{text}\e[0m"
  else
    text
  end
end