1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
colorize [](http://badge.fury.io/rb/colorize) [](https://github.com/fazibear/colorize/actions/workflows/release.yml) [](https://codeclimate.com/github/fazibear/colorize) [](https://codeclimate.com/github/fazibear/colorize)
========
Ruby gem for colorizing text using ANSI escape sequences.
Extends `String` class or add a `ColorizedString` with methods to set the text color, background color and text effects.
modes
-----
* `require 'colorize'` - Extends String class
* `require 'colorized_string'` - add ColorizedString class
features
--------
* change string color
* change string background
* change string effect
* chain methods
* display color samples
* disable colorization
* prevent colors
usage
-----
```ruby
require 'colorize'
String.colors # return array of all possible colors names
String.modes # return array of all possible modes
String.color_samples # displays color samples in all combinations
String.disable_colorization # check if colorization is disabled
# disable colorization (false by default)
String.disable_colorization = false # enable colorization
String.disable_colorization false # enable colorization
String.disable_colorization = true # disable colorization
String.disable_colorization true # disable colorization
# prevent colors (false by default)
String.prevent_colors = false # override current string colors
String.prevent_colors false # override current string colors
String.prevent_colors = true # don't colorize colorized strings
String.prevent_colors true # don't colorize colorized strings
# adding aliases (:gray and :grey added by default)
String.add_color_alias(:niebieski, :blue)
String.add_color_alias(:zielony => :green)
String.add_color_alias(czarny: :black)
String.add_color_alias(czerwony: :red, granatowy: :blue)
# examaples
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 bold green".colorize(:color => :green, :mode => :bold)
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 blinking blue text on red".blue.on_red.blink
puts "This is uncolorized".blue.on_red.uncolorize
```
```ruby
require 'colorized_string'
ColorizedString.colors # return array of all possible colors names
ColorizedString.modes # return array of all possible modes
ColorizedString.color_samples # displays color samples in all combinations
ColorizedString.disable_colorization # check if colorization is disabled
# disable colorization (false by default)
ColorizedString.disable_colorization = false # enable colorization
ColorizedString.disable_colorization false # enable colorization
ColorizedString.disable_colorization = true # disable colorization
ColorizedString.disable_colorization true # disable colorization
# prevent colors (false by default)
ColorizedString.prevent_colors = false # override current string colors
ColorizedString.prevent_colors false # override current string colors
ColorizedString.prevent_colors = true # don't colorize colorized strings
ColorizedString.prevent_colors true # don't colorize colorized strings
# adding aliases (:gray and :grey added by default)
ColorizedString.add_color_alias(:niebieski, :blue)
ColorizedString.add_color_alias(:zielony => :green)
ColorizedString.add_color_alias(czarny: :black)
ColorizedString.add_color_alias(czerwony: :red, granatowy: :blue)
# examples
puts ColorizedString["This is blue"].colorize(:blue)
puts ColorizedString["This is light blue"].colorize(:light_blue)
puts ColorizedString["This is also blue"].colorize(:color => :blue)
puts ColorizedString["This is bold green"].colorize(:color => :green, :mode => :bold)
puts ColorizedString["This is light blue with red background"].colorize(:color => :light_blue, :background => :red)
puts ColorizedString["This is light blue with red background"].colorize(:light_blue ).colorize( :background => :red)
puts ColorizedString["This is blue text on red"].blue.on_red
puts ColorizedString["This is red on blue"].colorize(:red).on_blue
puts ColorizedString["This is red on blue and underline"].colorize(:red).on_blue.underline
puts ColorizedString["This is blinking blue text on red"].blue.on_red.blink
puts ColorizedString["This is uncolorized"].blue.on_red.uncolorize
puts ColorizedString.new("This is blue").blue
puts ColorizedString.new("This is light blue").colorize(:light_blue)
```
requirements
------------
* Win32/Console/ANSI (for Windows)
install
-------
* gem install colorize
*Note:* You may need to use sudo to install gems
thank you
---------
[](https://www.patreon.com/bePatron?u=6912974)
license
-------
Copyright (C) 2007-2016 Michał Kalbarczyk
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
