colours 0.8.12 → 0.9.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (108) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +331 -200
  3. data/bin/colours +2 -2
  4. data/bin/show_basic_colour_palette +7 -0
  5. data/colours.gemspec +1 -2
  6. data/doc/README.gen +294 -178
  7. data/doc/how_to_pick_your_own_colours/how_to_pick_your_own_colours.md +33 -0
  8. data/lib/colours/autoalias_e.rb +4 -1
  9. data/lib/colours/autogenerated/256_colours_instance_methods.rb +1429 -0
  10. data/lib/colours/autogenerated/256_colours_methods.rb +1429 -0
  11. data/lib/colours/autogenerated/html_colours_instance_methods.rb +1191 -0
  12. data/lib/colours/autogenerated/html_colours_methods.rb +1191 -0
  13. data/lib/colours/base/base.rb +61 -13
  14. data/lib/colours/class/colours.rb +8 -6
  15. data/lib/colours/{toplevel_methods/use_colours.rb → colour/colour.rb} +4 -125
  16. data/lib/colours/commandline/README.md +2 -1
  17. data/lib/colours/commandline/commandline.rb +177 -34
  18. data/lib/colours/constants/constants.rb +752 -6
  19. data/lib/colours/e/README.md +6 -6
  20. data/lib/colours/eparse/eparse.rb +2 -1
  21. data/lib/colours/essentials/README.md +5 -0
  22. data/lib/colours/{basic_colours/basic_colours.rb → essentials/essentials.rb} +87 -85
  23. data/lib/colours/html_colours/README.md +2 -1
  24. data/lib/colours/html_colours/hash_html_colours.rb +168 -0
  25. data/lib/colours/html_colours/html_colours.rb +226 -244
  26. data/lib/colours/html_colours/push_the_html_colours_methods_onto_the_toplevel_namespace.rb +30 -0
  27. data/lib/colours/html_colours/random_html_colour.rb +67 -0
  28. data/lib/colours/{requires/require_the_basic_colours.rb → html_colours.rb} +4 -2
  29. data/lib/colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb +12 -10
  30. data/lib/colours/module_256_colours/module_256_colours.rb +465 -0
  31. data/lib/colours/project/project.rb +3 -1
  32. data/lib/colours/rainbow_colours/check_for_trollop_being_available_or_exit.rb +4 -0
  33. data/lib/colours/rainbow_colours/constants.rb +3 -3
  34. data/lib/colours/rainbow_colours/do_parse_via_rainbow_colours.rb +9 -10
  35. data/lib/colours/rainbow_colours/print_rainbow_line.rb +4 -4
  36. data/lib/colours/rainbow_colours/println_ani.rb +7 -7
  37. data/lib/colours/rainbow_colours/println_plain.rb +2 -2
  38. data/lib/colours/rainbow_colours/rainbow.rb +31 -1
  39. data/lib/colours/rainbow_colours/report_errors.rb +7 -7
  40. data/lib/colours/rainbow_colours/returnln_plain.rb +3 -3
  41. data/lib/colours/replace_tokens_with_colour_code/replace_tokens_with_colour_code.rb +409 -0
  42. data/lib/colours/requires/require_autogenerated_colour_methods.rb +4 -1
  43. data/lib/colours/requires/{require_the_colour_table.rb → require_essentials.rb} +2 -2
  44. data/lib/colours/requires/require_save_file.rb +11 -0
  45. data/lib/colours/requires/require_the_256_colours_module.rb +1 -3
  46. data/lib/colours/requires/require_the_colour_methods.rb +1 -22
  47. data/lib/colours/requires/require_the_project.rb +31 -29
  48. data/lib/colours/requires/require_the_toplevel_methods.rb +2 -20
  49. data/lib/colours/rgb/rgb.rb +107 -89
  50. data/lib/colours/{colour_methods/colour_methods.rb → sfile_sdir_sfancy_swarn_simp_scomments_and_ssymlink/sfile_sdir_sfancy_swarn_simp_scomments_and_ssymlink.rb} +467 -405
  51. data/lib/colours/testing/testing.rb +1 -3
  52. data/lib/colours/toplevel_methods/e.rb +9 -13
  53. data/lib/colours/toplevel_methods/map_this_symbol_to_that_html_colour.rb +57 -0
  54. data/lib/colours/toplevel_methods/{revert.rb → rev.rb} +5 -48
  55. data/lib/colours/toplevel_methods/toplevel_methods.rb +1204 -0
  56. data/lib/colours/version/version.rb +2 -2
  57. data/lib/colours/yaml/256_colours.yml +776 -257
  58. data/lib/colours/yaml/html_colours.yml +1 -1
  59. data/lib/colours/yaml/prefer_this_colour_schemata.yml +1 -1
  60. data/lib/colours/yaml/use_these_values_for_the_colour_methods.yml +5 -1
  61. data/lib/colours.rb +1 -1
  62. data/test/testing_256_colours_support.rb +10 -1
  63. data/test/testing_replace_number_words_with_the_corresponding_html_colour.rb +15 -9
  64. data/test/testing_the_colour_methods_such_as_simp_sdir_sfile_swarn_sfancy_sargument_and_ssymlink.rb +53 -0
  65. metadata +30 -57
  66. data/doc/HOW_TO_PICK_YOUR_OWN_COLOURS.md +0 -28
  67. data/lib/colours/256_colours/support_for_256_colours.rb +0 -196
  68. data/lib/colours/autogenerated/support_for_256_colours.rb +0 -2235
  69. data/lib/colours/autogenerated/support_for_html_colours.rb +0 -1778
  70. data/lib/colours/autogenerated/toplevel_basic_colour_methods.rb +0 -7001
  71. data/lib/colours/basic_colours/README.md +0 -4
  72. data/lib/colours/colour_methods/README.md +0 -11
  73. data/lib/colours/colour_table/README.md +0 -2
  74. data/lib/colours/colour_table/colour_table.rb +0 -282
  75. data/lib/colours/commandline/menu.rb +0 -122
  76. data/lib/colours/constants/escape.rb +0 -22
  77. data/lib/colours/constants/file_constants.rb +0 -73
  78. data/lib/colours/constants/hash_ansi_colours.rb +0 -39
  79. data/lib/colours/constants/hash_simple_colours.rb +0 -148
  80. data/lib/colours/constants/misc.rb +0 -361
  81. data/lib/colours/constants/newline.rb +0 -14
  82. data/lib/colours/constants/registered_colour_methods.rb +0 -53
  83. data/lib/colours/html_colours/add_html_colours_onto_the_toplevel_namespace.rb +0 -22
  84. data/lib/colours/toplevel_methods/autogenerate.rb +0 -310
  85. data/lib/colours/toplevel_methods/bold.rb +0 -41
  86. data/lib/colours/toplevel_methods/bold_and_italic.rb +0 -38
  87. data/lib/colours/toplevel_methods/cat.rb +0 -39
  88. data/lib/colours/toplevel_methods/clear_screen.rb +0 -18
  89. data/lib/colours/toplevel_methods/cliner.rb +0 -17
  90. data/lib/colours/toplevel_methods/col.rb +0 -54
  91. data/lib/colours/toplevel_methods/esystem.rb +0 -19
  92. data/lib/colours/toplevel_methods/html_colour_to_hex_value.rb +0 -41
  93. data/lib/colours/toplevel_methods/html_colourize.rb +0 -69
  94. data/lib/colours/toplevel_methods/is_on_roebe.rb +0 -16
  95. data/lib/colours/toplevel_methods/italic.rb +0 -110
  96. data/lib/colours/toplevel_methods/make_colour.rb +0 -28
  97. data/lib/colours/toplevel_methods/methods_related_to_html_colours.rb +0 -336
  98. data/lib/colours/toplevel_methods/misc.rb +0 -226
  99. data/lib/colours/toplevel_methods/open_this_file.rb +0 -26
  100. data/lib/colours/toplevel_methods/prefer_this_colour_schemata.rb +0 -88
  101. data/lib/colours/toplevel_methods/random_value.rb +0 -37
  102. data/lib/colours/toplevel_methods/remove_escape_sequence.rb +0 -112
  103. data/lib/colours/toplevel_methods/set_last_colour_used.rb +0 -32
  104. data/lib/colours/toplevel_methods/shell_file_containing_the_html_colours.sh +0 -148
  105. data/lib/colours/toplevel_methods/show_basic_colour_palette.rb +0 -36
  106. data/lib/colours/toplevel_methods/underline.rb +0 -130
  107. data/test/testing_the_colour_methods.rb +0 -36
  108. /data/doc/{COLOUR_CODES_CHART.md → colour_codes_chart/colour_codes_chart.md} +0 -0
@@ -1,36 +0,0 @@
1
- #!/usr/bin/ruby -w
2
- # Encoding: UTF-8
3
- # frozen_string_literal = true
4
- # =========================================================================== #
5
- # require 'colours/toplevel_methods/show_basic_colour_palette.rb'
6
- # =========================================================================== #
7
- module Colours
8
-
9
- require 'colours/constants/hash_simple_colours.rb'
10
- require 'colours/toplevel_methods/cliner.rb'
11
- require 'colours/toplevel_methods/e.rb'
12
- require 'colours/toplevel_methods/make_colour.rb'
13
-
14
- # ========================================================================= #
15
- # === Colours.show_basic_colour_palette
16
- #
17
- # This will show a colour palette on the commandline.
18
- # ========================================================================= #
19
- def self.show_basic_colour_palette
20
- e
21
- MAIN_COLOURS.reject {|e| e == :black }.each { |entry|
22
- make_colour(entry) # make_colour() is defined in this file here.
23
- }
24
- cliner
25
- SECONDARY_COLOURS.each { |entry|
26
- make_colour(entry)
27
- }
28
- e
29
- end; self.instance_eval { alias show_palette show_basic_colour_palette } # === Colours.show_palette
30
- self.instance_eval { alias show_colour_palette show_basic_colour_palette } # === Colours.show_colour_palette
31
-
32
- end
33
-
34
- if __FILE__ == $PROGRAM_NAME
35
- Colours.show_basic_colour_palette
36
- end # showbasiccolourpalette
@@ -1,130 +0,0 @@
1
- #!/usr/bin/ruby -w
2
- # Encoding: UTF-8
3
- # frozen_string_literal: true
4
- # =========================================================================== #
5
- # This file will handline underline-functionality in a terminal. It
6
- # supports basic colours and the HTML colours.
7
- # =========================================================================== #
8
- # require 'colours/toplevel_methods/underline.rb'
9
- # Colours.return_underline
10
- # =========================================================================== #
11
- module Colours
12
-
13
- require 'colours/toplevel_methods/revert.rb'
14
- require 'colours/toplevel_methods/e.rb'
15
- require 'colours/rgb/rgb.rb'
16
-
17
- # ========================================================================= #
18
- # === UNDERLINE_CODE
19
- #
20
- # To quickly test the underline-functionality, you can try:
21
- #
22
- # echo -e "\e[4mone two three\e[23m"
23
- #
24
- # ========================================================================= #
25
- UNDERLINE_CODE = '4'
26
-
27
- # ========================================================================= #
28
- # === Colours.underline
29
- #
30
- # This method will "puts" the result of applying underline to a string,
31
- # on the console/terminal. If you wish to do the output on your own
32
- # then you have to use the method Colours.return_underline or its
33
- # alias called Colours.string_underline.
34
- #
35
- # To test this, try:
36
- #
37
- # Colours.underline('Hello world!')
38
- #
39
- # ========================================================================= #
40
- def self.underline(
41
- i = '',
42
- make_newline = false,
43
- &block
44
- )
45
- e return_underline(i, make_newline, &block)
46
- end
47
-
48
- # ========================================================================= #
49
- # === underline
50
- # ========================================================================= #
51
- def underline(
52
- i = '',
53
- make_newline = false
54
- )
55
- Colours.underline(i, make_newline)
56
- end
57
-
58
- # ========================================================================= #
59
- # === Colours.return_underline
60
- #
61
- # The point of this method here is to make a given text (String) appear
62
- # "underlined", via ANSI escape sequences. For underline the String
63
- # that should be used is "\u001b[4m".
64
- #
65
- # This can be tested on the commandline such as via:
66
- #
67
- # echoen "\u001b[4m Underline \u001b[0m"
68
- #
69
- # Usage examples:
70
- #
71
- # puts ' ok | '+Colours.return_underline('Hello world!')+' | ok'
72
- # puts ' ok | '+Colours.return_underline('Hello world!') { :slateblue }+' | ok'
73
- #
74
- # In January 2022 the second variant was removed, though. Let's keep things
75
- # simple for now - perhaps in the future this may be re-enabled.
76
- # ========================================================================= #
77
- def self.return_underline(
78
- show_this_text = 'This must be underline.',
79
- make_newline = false,
80
- use_this_as_revert_code = REVERT
81
- )
82
- # ===================================================================== #
83
- # Build up our main string that codes for underline.
84
- # ===================================================================== #
85
- result = "\u001b[#{UNDERLINE_CODE}m".dup
86
- # if block_given?
87
- # # ===================================================================== #
88
- # # Right now we assume that this must be a colour if it is supplied
89
- # # via a block. However had, in January 2022 I realised that this
90
- # # assumption is not always correct, so this was disabled for now.
91
- # # At a later moment in time we may reconsider this.
92
- # # ===================================================================== #
93
- # result << ";38;2;"
94
- # colour_replacement = colour_to_rgb_value(yield)
95
- # result << colour_replacement
96
- # end
97
- # result << 'm'
98
- if make_newline # Append a newline in this case.
99
- show_this_text = "#{show_this_text}\n"
100
- end
101
- result << show_this_text
102
- result << use_this_as_revert_code
103
- return result
104
- end; self.instance_eval { alias string_underline return_underline } # === Colours.string_underline
105
-
106
- end
107
-
108
- if __FILE__ == $PROGRAM_NAME
109
- alias e puts
110
- if ARGV.empty?
111
- e Colours.underline('Hello world!')
112
- e 'Hello world!'
113
- # ======================================================================= #
114
- # And then run some more tests:
115
- # ======================================================================= #
116
- require 'colours/toplevel_methods/use_colours.rb'
117
- Colours.enable_html_colours
118
- e Colours.palegreen('in palegreen:')
119
- print ' '; print Colours.underline(txt) { :palegreen }
120
- e Colours.slateblue('in slateblue:')
121
- print ' '; print Colours.underline(txt) { :slateblue }
122
- e Colours.orange('in orange:')
123
- print ' '; print Colours.underline(txt) { :orange }
124
- e Colours.crimson('in crimson:')
125
- print ' '; print Colours.underline(txt) { :crimson }
126
- else
127
- puts Colours.underline(ARGV.join(' ').strip)
128
- puts Colours.underline(ARGV.join(' ').strip) { :crimson }
129
- end
130
- end # underline one TWO three
@@ -1,36 +0,0 @@
1
- #!/usr/bin/ruby -w
2
- # Encoding: UTF-8
3
- # frozen_string_literal: true
4
- # =========================================================================== #
5
- alias e puts
6
- e
7
- e 'The code in this file will test the various colour-methods, such as'
8
- e 'sfancy(), sdir() and so forth.'
9
- e
10
- require 'new_colours'
11
- e
12
- e NewColours.sfancy( 'Hello world (through sfancy())')+NewColours.sfancy('').inspect
13
- e NewColours.sdir( 'Hello world (through sdir())')+NewColours.sdir('').inspect
14
- e NewColours.simportant('Hello world (through simportant())')+NewColours.simportant('').inspect
15
- e NewColours.swarn( 'Hello world (through swarn())')+NewColours.swarn('').inspect
16
- e NewColours.snormal( 'Hello world (through snormal())')+NewColours.snormal('').inspect
17
- e NewColours.sargument( 'Hello world (through sargument())')+NewColours.sargument('').inspect
18
- e NewColours.sfile( 'Hello world (through sfile())')+NewColours.sfile('').inspect
19
- e NewColours.ssymlink( 'Hello world (through ssymlink())')+NewColours.ssymlink('').inspect
20
- e NewColours.scomments( 'Hello world (through scomments())')+NewColours.scomments('').inspect
21
-
22
- e
23
- e 'Next we will use Colours.use_new_colour_table and hope'
24
- e 'that this will change the above colours:'
25
- e
26
- NewColours.use_new_colour_table
27
- e NewColours.sfancy( 'Hello world (through sfancy())')+NewColours.sfancy('').inspect
28
- e NewColours.sdir( 'Hello world (through sdir())')+NewColours.sdir('').inspect
29
- e NewColours.simportant('Hello world (through simportant())')+NewColours.simportant('').inspect
30
- e NewColours.swarn( 'Hello world (through swarn())')+NewColours.swarn('').inspect
31
- e NewColours.snormal( 'Hello world (through snormal())')+NewColours.snormal('').inspect
32
- e NewColours.sargument( 'Hello world (through sargument())')+NewColours.sargument('').inspect
33
- e NewColours.sfile( 'Hello world (through sfile())')+NewColours.sfile('').inspect
34
- e NewColours.ssymlink( 'Hello world (through ssymlink())')+NewColours.ssymlink('').inspect
35
- e NewColours.scomments( 'Hello world (through scomments())')+NewColours.scomments('').inspect
36
- e