colours 0.8.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENCE.md +22 -0
- data/README.md +1152 -0
- data/bin/colours +7 -0
- data/bin/egreen +7 -0
- data/bin/fancy_parse +7 -0
- data/bin/html_colour_to_hex_value +7 -0
- data/bin/html_colourize +7 -0
- data/bin/orange +7 -0
- data/bin/print_rainbow_line +7 -0
- data/bin/rainbow_colours +7 -0
- data/bin/remove_ansii_escape_sequences +7 -0
- data/bin/steelblue +7 -0
- data/colours.gemspec +74 -0
- data/doc/COLOUR_CODES_CHART.md +27 -0
- data/doc/HOW_TO_PICK_YOUR_OWN_COLOURS.md +28 -0
- data/doc/README.gen +1105 -0
- data/doc/todo/todo.md +25 -0
- data/lib/colours/256_colours/support_for_256_colours.rb +196 -0
- data/lib/colours/autoalias_e.rb +10 -0
- data/lib/colours/autogenerated/README.md +2 -0
- data/lib/colours/autogenerated/support_for_256_colours.rb +2235 -0
- data/lib/colours/autogenerated/support_for_html_colours.rb +1778 -0
- data/lib/colours/autogenerated/toplevel_basic_colour_methods.rb +7001 -0
- data/lib/colours/autoinclude.rb +14 -0
- data/lib/colours/base/base.rb +29 -0
- data/lib/colours/basic_colours/README.md +4 -0
- data/lib/colours/basic_colours/basic_colours.rb +334 -0
- data/lib/colours/class/colours.rb +537 -0
- data/lib/colours/colour_methods/README.md +11 -0
- data/lib/colours/colour_methods/colour_methods.rb +685 -0
- data/lib/colours/colour_table/README.md +2 -0
- data/lib/colours/colour_table/colour_table.rb +282 -0
- data/lib/colours/colours_e_autoinclude.rb +9 -0
- data/lib/colours/commandline/README.md +2 -0
- data/lib/colours/commandline/commandline.rb +58 -0
- data/lib/colours/commandline/menu.rb +122 -0
- data/lib/colours/constants/constants.rb +9 -0
- data/lib/colours/constants/escape.rb +22 -0
- data/lib/colours/constants/file_constants.rb +73 -0
- data/lib/colours/constants/hash_ansi_colours.rb +39 -0
- data/lib/colours/constants/hash_simple_colours.rb +148 -0
- data/lib/colours/constants/misc.rb +361 -0
- data/lib/colours/constants/newline.rb +14 -0
- data/lib/colours/constants/registered_colour_methods.rb +53 -0
- data/lib/colours/e/README.md +13 -0
- data/lib/colours/e/autoinclude.rb +11 -0
- data/lib/colours/e/e.rb +35 -0
- data/lib/colours/e.rb +5 -0
- data/lib/colours/eparse/eparse.rb +114 -0
- data/lib/colours/everything/autoinclude.rb +11 -0
- data/lib/colours/html_colours/README.md +1 -0
- data/lib/colours/html_colours/add_html_colours_onto_the_toplevel_namespace.rb +22 -0
- data/lib/colours/html_colours/html_colours.rb +424 -0
- data/lib/colours/kde_colour_palette/kde_colour_palette.rb +132 -0
- data/lib/colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb +224 -0
- data/lib/colours/module.rb +11 -0
- data/lib/colours/project/project.rb +22 -0
- data/lib/colours/rainbow_colours/README.md +2 -0
- data/lib/colours/rainbow_colours/check_for_trollop_being_available_or_exit.rb +26 -0
- data/lib/colours/rainbow_colours/constants.rb +30 -0
- data/lib/colours/rainbow_colours/do_parse_via_rainbow_colours.rb +164 -0
- data/lib/colours/rainbow_colours/paint_detected_mode.rb +20 -0
- data/lib/colours/rainbow_colours/print_rainbow_line.rb +68 -0
- data/lib/colours/rainbow_colours/println_ani.rb +32 -0
- data/lib/colours/rainbow_colours/println_plain.rb +36 -0
- data/lib/colours/rainbow_colours/rainbow.rb +38 -0
- data/lib/colours/rainbow_colours/report_errors.rb +32 -0
- data/lib/colours/rainbow_colours/returnln_plain.rb +63 -0
- data/lib/colours/rainbow_colours/set_mode.rb +24 -0
- data/lib/colours/requires/require_autogenerated_colour_methods.rb +5 -0
- data/lib/colours/requires/require_commandline.rb +7 -0
- data/lib/colours/requires/require_eparse.rb +11 -0
- data/lib/colours/requires/require_rgb.rb +5 -0
- data/lib/colours/requires/require_the_256_colours_module.rb +16 -0
- data/lib/colours/requires/require_the_basic_colours.rb +7 -0
- data/lib/colours/requires/require_the_colour_methods.rb +34 -0
- data/lib/colours/requires/require_the_colour_table.rb +7 -0
- data/lib/colours/requires/require_the_constants.rb +5 -0
- data/lib/colours/requires/require_the_html_colours.rb +11 -0
- data/lib/colours/requires/require_the_kde_colour_palette.rb +7 -0
- data/lib/colours/requires/require_the_project.rb +53 -0
- data/lib/colours/requires/require_the_toplevel_methods.rb +42 -0
- data/lib/colours/requires/require_yaml.rb +9 -0
- data/lib/colours/rgb/rgb.rb +550 -0
- data/lib/colours/testing/README.md +2 -0
- data/lib/colours/testing/testing.rb +168 -0
- data/lib/colours/toplevel_methods/autogenerate.rb +310 -0
- data/lib/colours/toplevel_methods/bold.rb +41 -0
- data/lib/colours/toplevel_methods/bold_and_italic.rb +38 -0
- data/lib/colours/toplevel_methods/cat.rb +39 -0
- data/lib/colours/toplevel_methods/clear_screen.rb +18 -0
- data/lib/colours/toplevel_methods/cliner.rb +17 -0
- data/lib/colours/toplevel_methods/col.rb +54 -0
- data/lib/colours/toplevel_methods/e.rb +69 -0
- data/lib/colours/toplevel_methods/esystem.rb +19 -0
- data/lib/colours/toplevel_methods/html_colour_to_hex_value.rb +41 -0
- data/lib/colours/toplevel_methods/html_colourize.rb +69 -0
- data/lib/colours/toplevel_methods/is_on_roebe.rb +16 -0
- data/lib/colours/toplevel_methods/italic.rb +110 -0
- data/lib/colours/toplevel_methods/make_colour.rb +28 -0
- data/lib/colours/toplevel_methods/methods_related_to_html_colours.rb +336 -0
- data/lib/colours/toplevel_methods/misc.rb +226 -0
- data/lib/colours/toplevel_methods/open_this_file.rb +26 -0
- data/lib/colours/toplevel_methods/prefer_this_colour_schemata.rb +88 -0
- data/lib/colours/toplevel_methods/random_value.rb +37 -0
- data/lib/colours/toplevel_methods/remove_escape_sequence.rb +112 -0
- data/lib/colours/toplevel_methods/revert.rb +104 -0
- data/lib/colours/toplevel_methods/set_last_colour_used.rb +32 -0
- data/lib/colours/toplevel_methods/shell_file_containing_the_html_colours.sh +148 -0
- data/lib/colours/toplevel_methods/show_basic_colour_palette.rb +36 -0
- data/lib/colours/toplevel_methods/underline.rb +130 -0
- data/lib/colours/toplevel_methods/use_colours.rb +290 -0
- data/lib/colours/version/version.rb +25 -0
- data/lib/colours/yaml/256_colours.yml +279 -0
- data/lib/colours/yaml/basic_colours.yml +25 -0
- data/lib/colours/yaml/html_colours.yml +837 -0
- data/lib/colours/yaml/kde_colour_palette.yml +183 -0
- data/lib/colours/yaml/prefer_this_colour_schemata.yml +17 -0
- data/lib/colours/yaml/use_these_values_for_the_colour_methods.yml +15 -0
- data/lib/colours.rb +1 -0
- data/test/test.html +18 -0
- data/test/testing_256_colours_support.rb +29 -0
- data/test/testing_bold_italic_underline.rb +26 -0
- data/test/testing_class_colours.rb +46 -0
- data/test/testing_col.rb +10 -0
- data/test/testing_colours.rb +96 -0
- data/test/testing_colours_e.rb +13 -0
- data/test/testing_eparse.rb +13 -0
- data/test/testing_italic.rb +28 -0
- data/test/testing_kde_colour_palette.rb +30 -0
- data/test/testing_konsole_submodule.rb +226 -0
- data/test/testing_map_symbol_to_corresponding_colour.rb +14 -0
- data/test/testing_replace_number_words_with_the_corresponding_html_colour.rb +39 -0
- data/test/testing_rgb_to_hex.rb +32 -0
- data/test/testing_the_basic_colours_of_the_colours_project.rb +62 -0
- data/test/testing_the_colour_methods.rb +36 -0
- data/test/testing_the_constants_of_the_colours_project.rb +9 -0
- data/test/testing_the_ecomment_method.rb +11 -0
- data/test/testing_the_html_colours_of_the_colours_project.rb +37 -0
- data/test/testing_the_regex_for_capturing_the_commandline_coloured_content.rb +112 -0
- data/test/testing_whether_colours_will_be_used.rb +7 -0
- metadata +225 -0
data/bin/colours
ADDED
data/bin/egreen
ADDED
data/bin/fancy_parse
ADDED
data/bin/html_colourize
ADDED
data/bin/orange
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
#!/usr/bin/ruby -w
|
|
2
|
+
# Encoding: UTF-8
|
|
3
|
+
# frozen_string_literal: true
|
|
4
|
+
# =========================================================================== #
|
|
5
|
+
require 'colours/toplevel_methods/misc.rb'
|
|
6
|
+
|
|
7
|
+
print Colours.colour_method_or_display_the_content_of_the_file_or_use_via_pipe(ARGF, $PROGRAM_NAME)
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
#!/usr/bin/ruby -w
|
|
2
|
+
# Encoding: UTF-8
|
|
3
|
+
# frozen_string_literal: true
|
|
4
|
+
# =========================================================================== #
|
|
5
|
+
require 'colours/rainbow_colours/do_parse_via_rainbow_colours.rb'
|
|
6
|
+
|
|
7
|
+
Colours::RainbowColours.print_rainbow_line(ARGV)
|
data/bin/rainbow_colours
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
#!/usr/bin/ruby -w
|
|
2
|
+
# Encoding: UTF-8
|
|
3
|
+
# frozen_string_literal: true
|
|
4
|
+
# =========================================================================== #
|
|
5
|
+
require 'colours/rainbow_colours/do_parse_via_rainbow_colours.rb'
|
|
6
|
+
|
|
7
|
+
Colours::RainbowColours.do_parse_via_rainbow_colours(ARGV)
|
data/bin/steelblue
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
#!/usr/bin/ruby -w
|
|
2
|
+
# Encoding: UTF-8
|
|
3
|
+
# frozen_string_literal: true
|
|
4
|
+
# =========================================================================== #
|
|
5
|
+
require 'colours/toplevel_methods/misc.rb'
|
|
6
|
+
|
|
7
|
+
print Colours.colour_method_or_display_the_content_of_the_file_or_use_via_pipe(ARGF, $PROGRAM_NAME)
|
data/colours.gemspec
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# =========================================================================== #
|
|
2
|
+
# Gemspec for Project Colours.
|
|
3
|
+
# =========================================================================== #
|
|
4
|
+
require 'colours/version/version.rb'
|
|
5
|
+
require 'roebe/toplevel_methods/misc.rb'
|
|
6
|
+
|
|
7
|
+
Gem::Specification.new { |s|
|
|
8
|
+
|
|
9
|
+
s.name = 'colours'
|
|
10
|
+
s.version = ::Colours::VERSION
|
|
11
|
+
s.date = Time.now.strftime('%Y-%m-%d')
|
|
12
|
+
|
|
13
|
+
DESCRIPTION = <<-EOF
|
|
14
|
+
|
|
15
|
+
This library is called colours. It unifies colour-related constants
|
|
16
|
+
and methods, including R,G,B values for colours and the commonly
|
|
17
|
+
known "HTML colours", such as "slateblue" or "royalblue" and so
|
|
18
|
+
on.
|
|
19
|
+
|
|
20
|
+
The primary use case for this project is to make commandline-scripts
|
|
21
|
+
display text on the terminal with colours.
|
|
22
|
+
|
|
23
|
+
For more information about this project, have a look at the online
|
|
24
|
+
documentation for this gem at the link called "documentation", at
|
|
25
|
+
the bottom right side of the colours
|
|
26
|
+
gem homepage:
|
|
27
|
+
|
|
28
|
+
#{::Colours::URL_TO_THE_DOCUMENTATION}
|
|
29
|
+
|
|
30
|
+
EOF
|
|
31
|
+
|
|
32
|
+
s.summary = DESCRIPTION
|
|
33
|
+
s.description = DESCRIPTION
|
|
34
|
+
|
|
35
|
+
s.authors = ['Robert A. Heiler']
|
|
36
|
+
s.email = Roebe.email?
|
|
37
|
+
s.files = Dir['**/*']
|
|
38
|
+
s.license = 'MIT'
|
|
39
|
+
s.homepage = 'https://rubygems.org/gems/colours'
|
|
40
|
+
|
|
41
|
+
# ========================================================================= #
|
|
42
|
+
# Show this message when a user installs this project.
|
|
43
|
+
# ========================================================================= #
|
|
44
|
+
s.post_install_message = <<-EOF
|
|
45
|
+
|
|
46
|
+
This is the colours gem, a basic gem for colour-related output.
|
|
47
|
+
|
|
48
|
+
Usage example:
|
|
49
|
+
|
|
50
|
+
require 'colours'
|
|
51
|
+
|
|
52
|
+
Have a look at methods such as sfancy() or simp(). These two methods
|
|
53
|
+
are heavily used to colourize important text. The leading "s" stands
|
|
54
|
+
for "string"; imp stands for "important" text.
|
|
55
|
+
|
|
56
|
+
If you wish to test the konsole colours, try:
|
|
57
|
+
|
|
58
|
+
colours --all_colours
|
|
59
|
+
|
|
60
|
+
or
|
|
61
|
+
|
|
62
|
+
Colours.test
|
|
63
|
+
|
|
64
|
+
EOF
|
|
65
|
+
|
|
66
|
+
s.required_ruby_version = '>= '+Roebe.third_most_stable_version_of_ruby
|
|
67
|
+
s.required_rubygems_version = '>= '+Gem::VERSION
|
|
68
|
+
s.rubygems_version = '>= '+Gem::VERSION
|
|
69
|
+
|
|
70
|
+
# ========================================================================= #
|
|
71
|
+
# No dependencies for this project.
|
|
72
|
+
# ========================================================================= #
|
|
73
|
+
|
|
74
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
The available codes are:
|
|
2
|
+
|
|
3
|
+
0 Normal text, foreground and background
|
|
4
|
+
1 Bold text
|
|
5
|
+
4 Underline
|
|
6
|
+
5 Blink
|
|
7
|
+
7 Inverse
|
|
8
|
+
8 Invisible
|
|
9
|
+
|
|
10
|
+
30 Black foreground
|
|
11
|
+
31 Red foreground
|
|
12
|
+
32 Green foreground
|
|
13
|
+
33 Yellow foreground
|
|
14
|
+
34 Blue foreground
|
|
15
|
+
35 Magenta foreground
|
|
16
|
+
36 Cyan foreground
|
|
17
|
+
37 White foreground
|
|
18
|
+
|
|
19
|
+
40 Black background
|
|
20
|
+
41 Red background
|
|
21
|
+
42 Green background
|
|
22
|
+
43 Yellow background
|
|
23
|
+
44 Blue background
|
|
24
|
+
45 Magenta background
|
|
25
|
+
46 Cyan background
|
|
26
|
+
47 White background
|
|
27
|
+
49 default background # Unsure if this one works as-is
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
This file describes how to pick your own colours - or how to use
|
|
2
|
+
the Colours gem.
|
|
3
|
+
|
|
4
|
+
The colours-centric Hash will contain entries such as:
|
|
5
|
+
|
|
6
|
+
sdir: :olivedrab
|
|
7
|
+
|
|
8
|
+
Now, what does this mean?
|
|
9
|
+
|
|
10
|
+
This is a hash entry, a key->value pair, with the key being called
|
|
11
|
+
:sdir, and the value being :olivedrab.
|
|
12
|
+
|
|
13
|
+
"sdir" is an abbreviation for "string_dir", aka "string_directory".
|
|
14
|
+
|
|
15
|
+
:olivedrab is the HTML colour called olivedrab, a beige-green variant.
|
|
16
|
+
|
|
17
|
+
What this thus does means, in english, is to "use the colour olivedrab
|
|
18
|
+
in order to display directories in a coloured fashion".
|
|
19
|
+
|
|
20
|
+
If you wish to use another colour, simply change the Symbol on the
|
|
21
|
+
right hand side, aka :olivedrab, to another name, such as :steelblue
|
|
22
|
+
or :orange. The names that should be chosen here are HTML Colour
|
|
23
|
+
names.
|
|
24
|
+
|
|
25
|
+
If you wish to get an overview of all available HTML colours, in ruby
|
|
26
|
+
code, you can do this via the Colours namespace:
|
|
27
|
+
|
|
28
|
+
Colours.show_html_colours
|