Class: String

Inherits:
Object
  • Object
show all
Defined in:
lib/colorize.rb

Overview

Colorize String class extension.

Borrowed directly from the colorize gem. It hasn’t changed in 4 years and I didn’t want to add a gem dependency.

Constant Summary collapse

COLORS =

Colors Hash

{
  black: 0,
  red: 1,
  green: 2,
  yellow: 3,
  blue: 4,
  magenta: 5,
  cyan: 6,
  white: 7,
  default: 9,

  light_black: 10,
  light_red: 11,
  light_green: 12,
  light_yellow: 13,
  light_blue: 14,
  light_magenta: 15,
  light_cyan: 16,
  light_white: 17
}
MODES =

Modes Hash

{
  default: 0, # Turn off all attributes
  #:bright        => 1, # Set bright mode
  underline: 4, # Set underline mode
  blink: 5, # Set blink mode
  swap: 7, # Exchange foreground and background colors
  hide: 8  # Hide text (foreground color would be the same as background)
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.color_matrix(txt = "[X]") ⇒ Object

Display color matrix with color names.



180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/colorize.rb', line 180

def color_matrix(txt = "[X]")
  size = String.colors.length
  String.colors.each do |color|
    String.colors.each do |back|
      print txt.colorize(color: color, background: back)
    end
    puts " < #{color}"
  end
  String.colors.reverse.each_with_index do |back, index|
    puts "#{"|".rjust(txt.length) * (size - index)} < #{back}"
  end
  ""
end

.colors ⇒ Object

Return array of available colors used by colorize method



169
170
171
172
173
174
175
 
# File 'lib/colorize.rb', line 169

def colors
  keys = []
  COLORS.each_key do |key|
    keys << key
  end
  keys
end

.modes ⇒ Object

Return array of available modes used by colorize method



158
159
160
161
162
163
164
 
# File 'lib/colorize.rb', line 158

def modes
  keys = []
  MODES.each_key do |key|
    keys << key
  end
  keys
end

Instance Method Details

#colorize(params) ⇒ Object

Change color of string

Examples:

puts "This is blue".colorize( :blue )
puts "This is light blue".colorize( :light_blue )
puts "This is also blue".colorize( :color => :blue )
puts "This is light blue with red background".colorize( :color => :light_blue, :background => :red )
puts "This is light blue with red background".colorize( :light_blue ).colorize( :background => :red )
puts "This is blue text on red".blue.on_red
puts "This is red on blue".colorize( :red ).on_blue
puts "This is red on blue and underline".colorize( :red ).on_blue.underline
puts "This is blue text on red".blue.on_red.blink
puts "This is uncolorized".blue.on_red.uncolorize

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/colorize.rb', line 78

def colorize(params)
  return self unless STDOUT.isatty

  begin
    require "Win32/Console/ANSI" if RUBY_PLATFORM.match?(/win32/)
  rescue LoadError
    raise "You must gem install win32console to use colorize on Windows"
  end

  color_parameters = {}

  if params.instance_of?(Hash)
    color_parameters[:color] = COLORS[params[:color]]
    color_parameters[:background] = COLORS[params[:background]]
    color_parameters[:mode] = MODES[params[:mode]]
  elsif params.instance_of?(Symbol)
    color_parameters[:color] = COLORS[params]
  end

  color_parameters[:color] ||= @color ||= COLORS[:default]
  color_parameters[:background] ||= @background ||= COLORS[:default]
  color_parameters[:mode] ||= @mode ||= MODES[:default]

  color_parameters[:uncolorized] ||= @uncolorized ||= dup

  # calculate bright mode
  color_parameters[:color] += 50 if color_parameters[:color] > 10

  color_parameters[:background] += 50 if color_parameters[:background] > 10

  "\033[#{color_parameters[:mode]};#{color_parameters[:color] + 30};"\
  "#{color_parameters[:background] + 40}m#{color_parameters[:uncolorized]}\033[0m"\
    .color_parameters(color_parameters)
end

#colorized? ⇒ Boolean

Return true if sting is colorized

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/colorize.rb', line 124

def colorized?
  !defined?(@uncolorized).nil?
end

#uncolorize ⇒ Object

Return uncolorized string



117
118
119
 
# File 'lib/colorize.rb', line 117

def uncolorize
  @uncolorized || self
end