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
@@ -9,9 +9,7 @@
9
9
  module Colours
10
10
 
11
11
  require 'colours/toplevel_methods/e.rb'
12
- require 'colours/toplevel_methods/show_basic_colour_palette.rb'
13
- require 'colours/toplevel_methods/make_colour.rb'
14
- require 'colours/colour_table/colour_table.rb'
12
+ require 'colours/toplevel_methods/toplevel_methods.rb'
15
13
 
16
14
  # ========================================================================= #
17
15
  # === Colours.simple_colours_test
@@ -2,23 +2,12 @@
2
2
  # Encoding: UTF-8
3
3
  # frozen_string_literal: true
4
4
  # =========================================================================== #
5
+ # === Colours
6
+ # =========================================================================== #
5
7
  # require 'colours/toplevel_methods/e.rb'
6
8
  # =========================================================================== #
7
9
  module Colours
8
10
 
9
- require 'colours/constants/newline.rb'
10
-
11
- begin
12
- require 'colours/toplevel_methods/revert.rb'
13
- rescue LoadError; end
14
-
15
- # ========================================================================= #
16
- # === ef
17
- # ========================================================================= #
18
- def ef(i)
19
- e(i, false) # The variant without newlines.
20
- end
21
-
22
11
  # ========================================================================= #
23
12
  # === Colours.e
24
13
  #
@@ -58,6 +47,13 @@ module Colours
58
47
  ::Colours.e(i, append_newline) # Point towards the class method of e().
59
48
  end; alias ci e # === ci
60
49
 
50
+ # ========================================================================= #
51
+ # === ef
52
+ # ========================================================================= #
53
+ def ef(i)
54
+ e(i, false) # The variant without newlines.
55
+ end
56
+
61
57
  end
62
58
 
63
59
  if __FILE__ == $PROGRAM_NAME
@@ -0,0 +1,57 @@
1
+ #!/usr/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # require 'colours/toplevel_methods/map_this_symbol_to_that_html_colour.rb'
6
+ # =========================================================================== #
7
+ module Colours
8
+
9
+ # ========================================================================= #
10
+ # === Colours.map_this_symbol_to_that_html_colour
11
+ #
12
+ # The job of this method is to map entries such as :bold_green to
13
+ # a corresponding HTML colour.
14
+ # ========================================================================= #
15
+ def self.map_this_symbol_to_that_html_colour(i)
16
+ if is_a_html_colour? i
17
+ i
18
+ else
19
+ case i
20
+ # ===================================================================== #
21
+ # === :cyanb
22
+ # ===================================================================== #
23
+ when :cyanb
24
+ :lightseagreen
25
+ # ===================================================================== #
26
+ # === :light_grey
27
+ # ===================================================================== #
28
+ when :light_grey
29
+ :lightgray
30
+ # ===================================================================== #
31
+ # === :bold_blue
32
+ # ===================================================================== #
33
+ when :bold_blue
34
+ :slateblue
35
+ # ===================================================================== #
36
+ # === :bold_red
37
+ # ===================================================================== #
38
+ when :bold_red, :redb
39
+ :crimson
40
+ # ===================================================================== #
41
+ # === :bold_yellow
42
+ # ===================================================================== #
43
+ when :bold_yellow
44
+ :goldenrod
45
+ # ===================================================================== #
46
+ # === :bold_green
47
+ # ===================================================================== #
48
+ when :bold_green
49
+ :seagreen
50
+ else
51
+ puts 'Unregistered input into the method '+__method__.to_s+': '+i.to_s
52
+ return i # We'll still return that input, though.
53
+ end
54
+ end
55
+ end
56
+
57
+ end
@@ -1,42 +1,11 @@
1
1
  #!/usr/bin/ruby -w
2
2
  # Encoding: UTF-8
3
- # frozen_string_literal = true
3
+ # frozen_string_literal: true
4
4
  # =========================================================================== #
5
- # require 'colours/toplevel_methods/revert.rb'
5
+ # require 'colours/toplevel_methods/rev.rb'
6
6
  # =========================================================================== #
7
7
  module Colours
8
8
 
9
- require 'colours/constants/escape.rb'
10
-
11
- # ========================================================================= #
12
- # === Colours::COLOUR_NC
13
- #
14
- # Note that this will actually reset all attributes.
15
- #
16
- # The "\e[0m" sequence removes all attributes, including formatting
17
- # and colours. It may be useful to add it to the end of each colour
18
- # text - and this is what the Colours project is essentially doing.
19
- #
20
- # An alternative may be to assign REVERT to WHITE, but this seems
21
- # to be incorrect according to the specification.
22
- # ========================================================================= #
23
- COLOUR_NC = "#{ESC}0m" # No Colour.
24
- REVERT = COLOUR_NC # === REVERT
25
- REV = COLOUR_NC # === REV
26
- CLOSING_TAG = COLOUR_NC # === CLOSING_TAG (also represented as "#{ESC}0m")
27
- RESET = COLOUR_NC # === RESET
28
- RESET_TERMINAL = COLOUR_NC # === RESET_TERMINAL
29
- CLEAR = COLOUR_NC # === CLEAR
30
- COLOUR_RESET = COLOUR_NC # === COLOUR_RESET
31
- DEFAULT_COLOUR = COLOUR_RESET # === DEFAULT_COLOUR
32
-
33
- # ========================================================================= #
34
- # === RESET_ALL_ATTRIBUTES
35
- #
36
- # This is essentially the same as COLOUR_NC / RESET.
37
- # ========================================================================= #
38
- RESET_ALL_ATTRIBUTES = "\x1b[0m"
39
-
40
9
  # ========================================================================= #
41
10
  # === @revert
42
11
  #
@@ -47,7 +16,9 @@ module Colours
47
16
  # ========================================================================= #
48
17
  # === Colours.set_revert
49
18
  # ========================================================================= #
50
- def self.set_revert(i = :default)
19
+ def self.set_revert(
20
+ i = :default
21
+ )
51
22
  case i
52
23
  # ======================================================================= #
53
24
  # === :default
@@ -87,18 +58,4 @@ module Colours
87
58
  end; alias revert rev # === revert
88
59
  # alias default_colour rev
89
60
 
90
- # ========================================================================= #
91
- # === restore?
92
- #
93
- # This will restore to the default again.
94
- # ========================================================================= #
95
- def restore?
96
- Colours.restore?
97
- end; alias revert restore? # === revert
98
- alias rev? restore? # === rev?
99
-
100
- end
101
-
102
- if __FILE__ == $PROGRAM_NAME
103
- pp Colours.rev
104
61
  end