colours 0.6.12

data/lib/colours/yaml/kde_colour_palette.yml

@@ -0,0 +1,183 @@
+# =========================================================================== #
+# === The KDE colour palette
+#
+# This file specifically stores colours defined and used by the "KDE
+# colour palette". This can be found here:
+#
+#   https://community.kde.org/KDE_Visual_Design_Group/HIG/Color
+#
+# Note that we will ONLY store entries that have a simple name associated
+# with them; reason being that human folks will preferentially make use
+# of that name alone.
+#
+# The keys should be sorted alphabetically in this file here.
+# =========================================================================== #
+# x = YAML.load_file('kde_colour_palette.yml')
+# =========================================================================== #
+
+# =========================================================================== #
+# === a tag
+# =========================================================================== #
+Abyss Blue:
+- '#2980b9'
+-
+ - 41
+ - 128
+ - 18
+
+Alternate Grey:
+- '#bdc3c7'
+-
+ - 189
+ - 195
+ - 199
+
+# =========================================================================== #
+# === b tag
+# =========================================================================== #
+Beware Orange:
+- '#f67400'
+-
+ - 246
+ - 116
+ - 0
+
+Burnt Charcoal:
+- '#3b4045'
+-
+ - 59
+ - 64
+ - 69
+
+# =========================================================================== #
+# === c tag
+# =========================================================================== #
+Cardboard Grey:
+- '#eff0f1'
+-
+ - 239
+ - 240
+ - 241
+
+Charcoal Grey:
+- '#31363b'
+-
+ - 49
+ - 54
+ - 59
+
+Coastal Fog:
+- '#7f8c8d'
+-
+ - 127
+ - 140
+ - 141
+
+# =========================================================================== #
+# === d tag
+# =========================================================================== #
+Deco Blue:
+- '#1e92ff'
+-
+ - 30
+ - 146
+ - 255
+
+# =========================================================================== #
+# === h tag
+# =========================================================================== #
+Hover Blue:
+- '#93cee9'
+-
+ - 147
+ - 206
+ - 233
+
+Hyper Blue:
+- '#3daee6'
+-
+ - 61
+ - 174
+ - 230
+
+# =========================================================================== #
+# === i tag
+# =========================================================================== #
+Icon Blue:
+- '#1d99f3'
+-
+ - 29
+ - 153
+ - 243
+
+Icon Green:
+- '#2ecc71'
+-
+ - 46
+ - 204
+ - 113
+
+Icon Grey:
+- '#4d4d4d'
+-
+ - 77
+ - 77
+ - 77
+
+Icon Red:
+- '#da4453'
+-
+ - 218
+ - 68
+ - 83
+
+Icon Yellow:
+- '#fdbc4b'
+-
+ - 253
+ - 188
+ - 75
+
+# =========================================================================== #
+# === l tag
+# =========================================================================== #
+Lazy Grey:
+- '#afb0b3'
+-
+ - 175
+ - 176
+ - 179
+
+# =========================================================================== #
+# === n tag
+# =========================================================================== #
+Noble Fir:
+- '#27ae60'
+-
+ - 39
+ - 174
+ - 96
+
+# =========================================================================== #
+# === p tag
+# =========================================================================== #
+Paper White:
+- '#fcfcfc'
+-
+ - 252
+ - 252
+ - 252
+
+Pimpinella:
+- '#e74c3c'
+-
+ - 231
+ - 76
+ - 60
+
+Plasma Blue:
+- '#3daee9'
+-
+ - 61
+ - 174
+ - 233

data/lib/colours/yaml/prefer_this_colour_schemata.yml

@@ -0,0 +1,15 @@
+# =========================================================================== #
+# This file will determine which colour-schematas the Colours project
+# will prefer, by default. There are only three entries possible,
+# which is :html_colours, :support_for_256_colours and :basic_colours
+#
+# The data structure is kept as a numbered Hash. While it could also be
+# kept as an Array, I wanted to be able to also use [1], [2] and [3]
+# to quickly access these entries.
+# =========================================================================== #
+# x = YAML.load_file('prefer_this_colour_schemata.yml')
+# =========================================================================== #
+ 
+1: !ruby/symbol html_colours
+2: !ruby/symbol support_for_256_colours
+3: !ruby/symbol basic_colours

data/lib/colours/yaml/use_these_values_for_the_colour_methods.yml

@@ -0,0 +1,15 @@
+# =========================================================================== #
+# === use_These_values_for_the_colour_methods.yml
+#
+# This yaml file will contain which colour codes we may use for when we
+# wish to make use of HTML colours.
+# =========================================================================== #
+# x = YAML.load_file('use_these_values_for_the_colour_methods.yml')
+# =========================================================================== #
+simp:      !ruby/symbol steelblue
+sdir:      !ruby/symbol olivedrab
+sfile:     !ruby/symbol slateblue
+swarn:     !ruby/symbol orangered
+sfancy:    !ruby/symbol lightseagreen
+sargument: !ruby/symbol slategray
+ssymlink:  !ruby/symbol mediumorchid

data/lib/colours.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/requires/require_the_colours_project.rb'

data/test/test.html

@@ -0,0 +1,18 @@
+<html>
+
+<p>
+
+This is a paragraph in some <slateblue>slateblue</> colour
+and also in <darkgreen>darkgreen</> colour and, last
+but not least, .
+
+
+It continues here with a <chartreuse>chartreuse</> colour.
+
+</p>
+
+<p>
+And here as well with a <papaya>papaya</> colour.
+</p>
+
+</html>

data/test/testing_256_colours_support.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'new_colours/test/testing_256_colours_support.rb'
+# =========================================================================== #
+require 'colours/256_colours/support_for_256_colours.rb'
+
+alias e puts
+
+e 'Now testing 256 colours support.'
+
+# =========================================================================== #
+# === test_256_colours_support
+# =========================================================================== #
+def test_256_colours_support
+  NewColours.display_this_256_colour(0) { :newline }
+  NewColours.display_this_256_colour(1) { :newline }
+  NewColours.display_this_256_colour(2) { :newline }
+  NewColours.display_this_256_colour(3) { :newline }
+  NewColours.display_this_256_colour(155) { :newline }
+  NewColours.display_this_256_colour(rand(255+1)) { :newline }
+  e
+  NewColours.show_all_256_colours { :newline }
+  e
+end
+
+test_256_colours_support
+# test_256_colours_support

data/test/testing_col.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Code in this file will test the Colours.col() method.
+# =========================================================================== #
+require 'new_colours/toplevel_methods/col.rb'
+
+puts NewColours.col '/home/x/songs/'
+puts NewColours.col '/home/x/songs/Westbam_Sunshine.mp3'

data/test/testing_colours.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The test-code resides in colours/lib/colours/test.rb so we can just
+# call Colours.test
+# =========================================================================== #
+if __FILE__ == $PROGRAM_NAME
+
+  require 'colours/autoinclude'
+
+  alias ee print
+
+  # ========================================================================= #
+  # === cliner
+  # ========================================================================= #
+  def cliner
+    Colours.cliner
+  end
+
+  # ========================================================================= #
+  # === Testing Colours.ecomment() next
+  # ========================================================================= #
+  cliner
+  e 'This file will test the colour gem.'
+  e
+  e 'Next, this file will test for the method Colours.ecomment()'
+  e 'being able to process multiple lines in one go:'
+  cliner
+  Colours.ecomment '
+
+  --ncards?               # How many cards are available
+                          # ^^^ If you pass an argument, then we will use that as name for the card set.
+  merge in all yaml files # To merge in all yaml files
+  html                    # To generate the .html page
+  zip                     # To create a big .zip file
+
+'
+
+  # cliner # <-- This cliner is superfluous because Colours.test() will already show one.
+  e 'Next, Colours.test will be invoked:'
+  e
+  Colours.test # Invoke the Colours.test() class method.
+  e Colours.bold_white('This text here should be in bold white.')
+  cliner
+  e 'Next testing Colours::AnsiColours'
+  i = "08.01.2015, 01:16:25 \e[1;32mNo registered users\e[0;0m\e[0;37m."
+  e 'Available colours:'
+  Colours::ARRAY_REGISTERED_ANSI_COLOURS.each {|colour|
+    e colour.inspect+' '+colour+'<- Colourtest.'
+  }
+  e 'Next we will test a string with AnsiEscape sequences.'
+  e 'We wish to get rid of them.'
+  pp i
+  ee '(1) '
+  e Colours.remove(i)
+  ee '(2) '
+  e i.gsub(REMOVE_ANSI_ESCAPE_CHARACTERS, '') # This regex also works.
+  e Colours::TEAL+'Teal'+Colours::REVERT
+  # ========================================================================= #
+  # === Next test the HtmlColours submodule
+  # ========================================================================= #
+  cliner
+  e 'Next testing the html colours subcomponent of module Colours:'
+  e 'Featuring '+simp('Colours::HtmlColours.sample')+' next:'
+  e Colours::HtmlColours.sample
+  e
+  e Colours::HtmlColours::HTML_COLOURS.size
+  pp Colours::HtmlColours[]
+  cliner
+  # ========================================================================= #
+  # === Next test the old ColourAid module
+  # ========================================================================= #
+  cliner
+  e 'Hello World! We will now test sfancy() simp() swarn() and ssymlink():'
+  cliner
+  e 'How do you '+Colours.sfancy('do')+'?'
+  e 'How do you '+Colours.simp('do')+'?'
+  e 'How do you '+Colours.swarn('do')+'?'
+  e 'How do you '+Colours.ssymlink('do')+'?'
+  cliner
+  e 'How do you '+sfancy('do')+'?'
+  e 'How do you '+simp('do')+'?'
+  e 'How do you '+swarn('do')+'?'
+  e 'How do you '+ssymlink('do')+'?'
+  cliner
+  e 'Next testing efancy(), eimp(), ewarn() and esymlink().'
+  efancy 'All is fine.'
+  eimp 'You are doing great!'
+  ewarn 'Red Alert!'
+  esymlink 'yo there'
+  e 'Next, we will test Colours.eparse()'
+  Colours.eparse(' - s[number]  # start to cut at this '\
+  'start-position in seconds - example: s5')
+end # test_colours

data/test/testing_colours_e.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/everything/autoinclude'
+
+e
+e 'This code-snippet will test the '+Colours.gold('e()')+
+  ' method and various colour-related'
+e 'methods, such as sfancy() or simp()'
+e
+e 'Testing ... '+sfancy('Testing ...')+simp(' some more testing ...')
+e

data/test/testing_eparse.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+alias e puts
+
+require 'colours/eparse/eparse.rb'
+
+e
+Colours.eparse('Hello there # how do you do, this is a test')
+e
+Colours.eparse('And this variant has no special token')
+e

data/test/testing_kde_colour_palette.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/autoinclude'
+
+e 'Now testing the component called `kde_colour_palette`.'
+text = 'The cat jumps over the fence.'
+e
+Colours.eabyss_blue(text+' (abyss_blue)')
+Colours.ealternate_grey(text+' (alternate_grey)')
+Colours.ebeware_orange(text+' (beware_orange)')
+Colours.eburnt_charcoal(text+' (burnt_charcoal)')
+Colours.ecardboard_grey(text+' (cardboard_grey)')
+Colours.echarcoal_grey(text+' (charcoal_grey)')
+Colours.ecoastal_fog(text+' (coastal_fog)')
+Colours.edeco_blue(text+' (deco_blue)')
+Colours.ehover_blue(text+' (hover_blue)')
+Colours.ehyper_blue(text+' (hyper_blue)')
+Colours.eicon_blue(text+' (icon_blue)')
+Colours.eicon_green(text+' (icon_green)')
+Colours.eicon_grey(text+' (icon_grey)')
+Colours.eicon_red(text+' (icon_red)')
+Colours.eicon_yellow(text+' (icon_yellow)')
+Colours.elazy_grey(text+' (lazy_grey)')
+Colours.enoble_fir(text+' (noble_fir)')
+Colours.epaper_white(text+' (paper_white)')
+Colours.epimpinella(text+' (pimpinella)')
+Colours.eplasma_blue(text+' (plasma_blue)')
+e

data/test/testing_konsole_submodule.rb

@@ -0,0 +1,226 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/autoinclude'
+
+class Bar
+  include Colours
+end
+
+N = "\n"
+e 'Now testing the gem called '+sfancy('colours')+rev+'.'
+e
+e 'We will also read in this html file lateron:'
+e
+e '  '+sfile(Colours::TEST_FILE)
+
+# =========================================================================== #
+# === konsole_colour_tests
+# =========================================================================== #
+def konsole_colour_tests(i = ARGV)
+  e 'First, we will display six random colours.'
+  e
+  e Colours[:random]+' heya1'
+  e Colours[:random]+' heya2'
+  e Colours[:random]+' heya3'
+  e Colours.random(' heya4')
+  e Colours.random(' heya5')
+  e Colours.random(' heya6')
+  pp Colours[:slateblue]
+  _ = Colours::Colour.new(ARGV)
+  begin
+    _.show_in_random_colour 'hmm'+N
+    _.show_in_random_colour 'hmm'+N
+    _.show_in_random_colour 'hmm'+N
+  rescue; end
+  # p _.html_colours # Test outputting all HTML colours.
+  # p Colours.html_colours
+  # p _.rvalue
+  _.seed_rgb_values # Get some random values for R,G,B.
+  # _.output_this_string :default, 89, 250, 237
+  _.output_this
+  _.output_this 'Hello World!'+N, :random_colours
+  _.output_this "Hello World!\n", :random_colours
+  _.output_this :random_colours
+  e _.random_colour? 'yeah'
+  # _.slateblue
+  # _.slateblue 'Hello World!'+N+N+N+N
+  # _.slateblue 'yoo!'+N
+  # e _.slateblue+'Direct test 1'
+  # e _.lightcyan+'Direct test 2'
+  # e _.mintcream+'Direct test 3'
+  # e _.slateblue('Direct test 4')
+  begin
+  e '
+  This is a longer paragraph. Some '+_.slateblue(:keywords)+' will
+  be highlighted in '+_.random_colour('a colour')+'.'+N+N+N+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+N+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+N+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+N+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+N+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+N+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')+
+  ' '+_.random_colour('test')
+  e
+  rescue; end
+  e 'Next trying to find out whether slateblue is registered or not:'
+  e _.registered_colour? 'slateblue'
+  e 'Next trying to read in a file:'
+  Colours.cliner {
+    _.read_file(TEST_FILE)
+  }
+  Colours.cliner {
+    e 'The registered colours are (Colours.registered_colours? '+
+      '- showing only 5):'
+    pp Colours.registered_colours?[0..5]
+  }
+  e
+  e 'Next we will show some random colours, just to test whether this'
+  e 'functionaly works properly:'
+  e
+  e '  '+Colours.random_colour?
+  e '  '+Colours.random_colour?
+  e '  '+Colours.random_colour?
+  e '  '+Colours.random_colour?
+  e '  '+Colours.random_colour?
+  e '  '+Colours.random_colour?
+  e
+  e "Next testing Colours :green, 'hello world'"
+  konsole_colours :green, 'hello world'
+  Colours.cliner {
+    e Time.now.strftime('%H:%M:%S')
+    puts kde_colour(:slateblue, Time.now.strftime('%H:%M:%S') ).to_s
+  }
+  puts Colours[:slateblue, Time.now.strftime('%H:%M:%S')]
+  pp REVERT
+  pp rgb
+  pp rgb
+  pp rgb
+  output_in_a_random_colour 'yo there'
+  output_in_a_random_colour 'yo there'
+  output_in_a_random_colour 'yo there'
+  e; Colours.cliner {
+    e 'We will display three random colours next:'
+    e '  '+Colours.random_colour?
+    e '  '+Colours.random_colour?
+    e '  '+Colours.random_colour?
+  }
+  e 'Is darkgreen a registered colour? '+registered_colour?('darkgreen').to_s
+  e Colours.rgb('slateblue')+'yo there'+restore?
+  e Colours.rgb(:random)+'yo there'+restore?+' (<-- '+
+    Colours.colourize(Colours.last_colour_used?)+')'
+    Colours.write_this_in_random_colour('yo man how do you do')
+  Colours.cliner
+  e 'Next testing direct calls such as: Colours.sienna()'
+  e Colours.sienna
+  e Colours.sienna('yo there')
+  e Colours.lightblue('yo there')
+  e Colours.cyan('yo there')
+  p darkgreen('ok')
+  p lightblue('ok')
+  slateblue
+  e Colours_colour_slateblue 'hello world!'
+  e Colours_colour_darkgreen 'hello world!'
+  eslateblue 'yo there'
+  Colours.slateblue
+  Colours.edarkgreen 'This is Colours.edarkgreen'
+  Colours.eslateblue 'This is Colours.eslateblue'
+  Bar.new.slateblue
+  Bar.slateblue
+  e Bar.slateblue('oki doki')
+  e; Colours.cliner {
+    e 'Next testing 4 occurances of slateblue:'
+    e Colours['slateblue','(1) Hello World!']
+    eColours_colour_slateblue '(2) hello world!' # This is the same as the above.
+    e Colours.slateblue '(3) yo'
+    eslateblue '(4) hi world'
+  }
+  e; Colours.cliner {
+    e 'We will next test out Colours.rgb with 3 specific values (R,G,B)'
+    e Colours.rgb(122,56,141)+' ok'+rev
+    e Colours.rgb(125,61,164)+' ok'+rev
+    e Colours.rgb(132,76,198)+' ok'+rev
+    e Colours.rgb(262,86,213)+' ok'+rev
+  }
+  e; Colours.cliner {
+    e 'Next we will test the method: write_this_in_random_colour'
+    write_this_in_random_colour '  hello world'
+    write_this_in_random_colour '  hello world'
+    write_this_in_random_colour '  hello world'
+  }
+  Colours_colours :green, 'Hello world!'
+  e Colours_colour_peru 'hey there - this here is Colours_colour_peru()'
+  e; Colours.cliner {
+    e 'Next testing italic:'
+    e Colours.italic('This must be italic.')
+    e
+    e 'Next testing underline:'
+    e Colours.underline('This must be underlined.')
+  }
+  Colours.display_all_colours # Finally, display all colours here.
+end; alias test_Colours_colours Colours_colour_tests # === test_Colours_colours
+
+if __FILE__ == $PROGRAM_NAME
+  # Testing code comes next:
+  if ARGV.empty?
+    Colours_colour_tests # Here we run the various colour-tests.
+  else
+    Colours.menu(ARGV) # Delegate towards Colours.menu() here.
+  end
+end # tkon

data/test/testing_map_symbol_to_corresponding_colour.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'new_colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
+
+alias e puts
+
+e
+NewColours.available_colours?.each {|this_colour|
+  translated = NewColours.map_symbol_to_corresponding_colour(this_colour)
+  e translated+':'+this_colour.to_s.ljust(8)+' -> '+
+    translated.to_s+' ('+translated.inspect+')'
+}; e