Class: String
- Inherits:
-
Object
- Object
- String
- Defined in:
- vendor/plugins/blacklight/lib/colorize.rb
Overview
Colorize String class extension.
Constant Summary
- 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)
-
+ (Object) color_matrix(txt = "[X]")
Display color matrix with color names.
-
+ (Object) colors
Return array of available colors used by colorize method.
-
+ (Object) modes
Return array of available modes used by colorize method.
Instance Method Summary (collapse)
-
- (Object) colorize(params)
Change color of string.
-
- (Boolean) colorized?
Return true if sting is colorized.
-
- (Object) uncolorize
Return uncolorized string.
Class Method Details
+ (Object) color_matrix(txt = "[X]")
Display color matrix with color names.
182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'vendor/plugins/blacklight/lib/colorize.rb', line 182 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 |
+ (Object) colors
Return array of available colors used by colorize method
171 172 173 174 175 176 177 |
# File 'vendor/plugins/blacklight/lib/colorize.rb', line 171 def colors keys = [] COLORS.each_key do | key | keys << key end keys end |
+ (Object) modes
Return array of available modes used by colorize method
160 161 162 163 164 165 166 |
# File 'vendor/plugins/blacklight/lib/colorize.rb', line 160 def modes keys = [] MODES.each_key do | key | keys << key end keys end |
Instance Method Details
- (Object) colorize(params)
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
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 112 113 |
# File 'vendor/plugins/blacklight/lib/colorize.rb', line 82 def colorize( params ) return self unless STDOUT.isatty begin require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /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 ||= self.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".set_color_parameters( color_parameters ) end |
- (Boolean) colorized?
Return true if sting is colorized
125 126 127 |
# File 'vendor/plugins/blacklight/lib/colorize.rb', line 125 def colorized? !defined?(@uncolorized).nil? end |
- (Object) uncolorize
Return uncolorized string
118 119 120 |
# File 'vendor/plugins/blacklight/lib/colorize.rb', line 118 def uncolorize @uncolorized || self end |