colours 0.8.12 → 0.9.8

data/lib/colours/html_colours/html_colours.rb

@@ -3,15 +3,28 @@
 # frozen_string_literal: true
 # =========================================================================== #
 # require 'colours/html_colours/html_colours.rb'
+# Colours.map_this_symbol_to_that_html_colour
+# Colours.autogenerate_html_colours_methods
 # =========================================================================== #
 module Colours
 
 module HtmlColours # === Colours::HtmlColours
 
-  require 'yaml'
-  require 'colours/constants/file_constants.rb'
+  # ========================================================================= #
+  # This module will also try to pull in the autogenerated
+  # Colours::HtmlColoursMethods module, if available.
+  # ========================================================================= #
+  begin
+    require 'colours/autogenerated/html_colours_methods.rb'
+  rescue LoadError
+    # puts 'No file exists at `colours/autogenerated/html_colours_methods.rb`.'
+  end
+
   require 'colours/toplevel_methods/e.rb'
-  require 'colours/toplevel_methods/revert.rb'
+  require 'colours/toplevel_methods/map_this_symbol_to_that_html_colour.rb'
+  require 'colours/toplevel_methods/rev.rb'
+  require 'colours/html_colours/hash_html_colours.rb'
+  require 'colours/html_colours/random_html_colour.rb'
 
   # ========================================================================= #
   # === Colours::HtmlColours.rev
@@ -20,47 +33,133 @@ module HtmlColours # === Colours::HtmlColours
     ::Colours.rev
   end
 
-  # =========================================================================== #
-  # === Colours::HtmlColours::HASH_HTML_COLOURS
+  # ========================================================================= #
+  # === Colours::HtmlColours.e
+  # ========================================================================= #
+  def self.e(i = '')
+    ::Colours.e(i)
+  end
+
+  # ========================================================================= #
+  # === all_html_colours
+  #
+  # This method will feedback all html colours known.
+  # ========================================================================= #
+  def all_html_colours
+    ::Colours::HtmlColours.available_html_colours?
+  end; alias all_html_colours? all_html_colours # === all_html_colours?
+       alias html_colours?     all_html_colours # === html_colours?
+       alias all_colours       all_html_colours # === all_colours
+
+  # ========================================================================= #
+  # === Colours::HtmlColours.autogenerate_html_colours_methods (autogenerate tag)
   #
-  # The colours in the yaml file are stored in a:
+  # This method will autogenerated all HTML colours, onto the toplevel
+  # namespace called "Colours".
   #
-  #     name: hexvalue
+  # Commandline invocation example:
   #
-  # format.
-  # =========================================================================== #
-  _ = FILE_HTML_COLOURS
-
-  # =========================================================================== #
-  # === @hash_html_colours
-  # =========================================================================== #
-  @hash_html_colours = {}
+  #   colours --autogenerate_html_colours_methods
+  #
+  # ========================================================================= #
+  def self.autogenerate_html_colours_methods(
+      into = HOME_DIRECTORY_OF_USER_X+
+             'programming/ruby/src/'\
+             'colours/lib/colours/autogenerated/'\
+             'html_colours_methods.rb'
+    )
+    require 'colours/requires/require_save_file.rb'
+    dataset_from_the_yaml_file = YAML.load_file(::Colours.file_html_colours)
+    _ = "#{RUBY_HEADER}\n".dup
+    _ << "# require 'colours/autogenerated/#{File.basename(into)}'\n"
+    _ << "# =========================================================================== #\n"
+    _ << "# include ::Colours::HtmlColoursMethods\n"
+    _ << "# =========================================================================== #\n"
+    _ << "module Colours\n\n"
+    _ << "module HtmlColoursMethods # === ::Colours::HtmlColoursMethods\n\n"
 
-  if File.exist? _
-    @hash_html_colours = YAML.load_file(_)
-  else
-    # ======================================================================= #
-    # The second check is not ideal but I think that I only need this
-    # on my home system anyway.
-    # ======================================================================= #
-    if ("#{ENV['IS_ROEBE']}" == '1')
-      puts "Colours::HtmlColours: We could not find any "\
-           "file at `#{_}`."
-    end
+    ::Colours::HtmlColours.all_html_colours?.each {|this_html_colour|
+      # ===================================================================== #
+      # We must obtain the proper entry from the .yml file next:
+      # ===================================================================== #
+      pointer = dataset_from_the_yaml_file[this_html_colour.to_s]
+      r = pointer[0]
+      g = pointer[1]
+      b = pointer[2]
+      _ << "  # ========================================================================= #\n"
+      _ << "  # === Colours::HtmlColoursMethods.#{this_html_colour}\n"
+      _ << "  # ========================================================================= #\n"
+      _ << "  def self.#{this_html_colour}(i = '', &block)\n"
+      # ===================================================================== #
+      # The colour code goes like this:
+      #
+      #   \033[38;2;<R>;<G>;<B>m
+      #
+      # ===================================================================== #
+      _ << '    return "'+
+           '\e[38;2;'+
+           "#{r};#{g};#{b}m"+ # ← Here the r,g,b values. 'm' terminates the escape sequence.
+           "#\{i\}\""+
+           " if block_given? and (yield == :omit_end)"+
+           "\n"
+      _ << '    return "'+
+           '\e[38;2;'+
+           "#{r};#{g};#{b}m"+ # ← Here the r,g,b values. 'm' terminates the escape sequence.
+           "#\{i\}"+
+           "\\e[0m"+
+           "\"\n"
+      _ << "  end\n\n"
+    }
+    _ << "end\n\n"
+    _ << "end\n"
+    e "Storing into the file `#{into}` next."
+    SaveFile.write_what_into(_, into)
+    autogenerate_html_colours_methods_for_instance_methods
   end
 
-  # =========================================================================== #
-  # === Colours::HtmlColours.hash_html_colours?
-  # =========================================================================== #
-  def self.hash_html_colours?
-    @hash_html_colours
-  end; self.instance_eval { alias main_hash? hash_html_colours? } # === Colours::HtmlColours.main_hash?
+  # ========================================================================= #
+  # === Colours::HtmlColours.autogenerate_html_colours_methods_for_instance_methods
+  #
+  # On my home system I can use this command to trigger this method:
+  #
+  #   autogenerate_html_colours_methods
+  #
+  # ========================================================================= #
+  def self.autogenerate_html_colours_methods_for_instance_methods(
+      into = HOME_DIRECTORY_OF_USER_X+
+             'programming/ruby/src/'\
+             'colours/lib/colours/autogenerated/'\
+             'html_colours_instance_methods.rb'
+    )
+    require 'colours/requires/require_save_file.rb'
+    _ = "#{RUBY_HEADER}\n".dup
+    _ << "# require 'colours/autogenerated/#{File.basename(into)}'\n"
+    _ << "# =========================================================================== #\n"
+    _ << "# include ::Colours::HtmlColoursMethods\n"
+    _ << "# =========================================================================== #\n"
+    _ << "module Colours\n\n"
+    _ << "module HtmlColoursMethods # === ::Colours::HtmlColoursMethods\n\n"
+
+    ::Colours::HtmlColours.all_html_colours?.each {|this_html_colour|
+      _ << "  # ========================================================================= #\n"
+      _ << "  # === #{this_html_colour}\n"
+      _ << "  # ========================================================================= #\n"
+      _ << "  def #{this_html_colour}(i = '', &block)\n"
+      _ << "    return ::Colours::HtmlColoursMethods.#{this_html_colour}(i, &block)\n"
+      _ << "  end; alias konsole_colour_#{this_html_colour} #{this_html_colour}\n"
+      _ << "       alias konsole_#{this_html_colour} #{this_html_colour}\n\n"
+    }
+    _ << "end\n\n"
+    _ << "end\n"
+    e "Storing into the file `#{into}` next."
+    SaveFile.write_what_into(_, into)
+  end
 
   # ========================================================================= #
   # === Colours::HtmlColours.show_html_colours
   #
   # This can be used to output the colours. It requires the method
-  # html_colours().
+  # html_colours() as well as support for RGB values.
   #
   # To invoke this method from the commandline, try:
   #
@@ -96,100 +195,6 @@ module HtmlColours # === Colours::HtmlColours
        self.instance_eval { alias test                show_html_colours } # === Colours::HtmlColours.test
        self.instance_eval { alias show_all_colours    show_html_colours } # === Colours::HtmlColours.show_all_colours
 
-  # =========================================================================== #
-  # === Colours::HtmlColours.does_include?
-  #
-  # This method will return true if the given input is included in the
-  # HTML colours.
-  #
-  # Usage examples:
-  #
-  #   Colours::HtmlColours.does_include? 'slateblue'                 # => true
-  #   Colours::HtmlColours.is_this_html_colour_included? 'royalblue' # => true
-  #   Colours::HtmlColours.is_this_html_colour_included? 'megawhite' # => false
-  #
-  # =========================================================================== #
-  def self.does_include?(i = :slateblue)
-    return true if @hash_html_colours.has_key?(i.to_s)
-    false # else return false.
-  end; self.instance_eval { alias is_this_html_colour_included? does_include? } # === Colours::HtmlColours.is_this_html_colour_included?
-       self.instance_eval { alias is_a_html_colour?             does_include? } # === Colours::HtmlColours.is_a_html_colour?
-       self.instance_eval { alias is_a_HTML_colour?             does_include? } # === Colours::HtmlColours.is_a_HTML_colour?
-       self.instance_eval { alias is_this_a_html_colour?        does_include? } # === Colours::HtmlColours.is_this_a_html_colour?
-       self.instance_eval { alias html_colours_include?         does_include? } # === Colours::HtmlColours.html_colours_include?
-       self.instance_eval { alias include_this_html_colour?     does_include? } # === Colours::HtmlColours.include_this_html_colour?
-       self.instance_eval { alias is_this_a_valid_html_colour?  does_include? } # === Colours::HtmlColours.is_this_a_valid_html_colour?
-       self.instance_eval { alias is_this_input_a_html_colour?  does_include? } # === Colours::HtmlColours.is_this_input_a_html_colour?
-       self.instance_eval { alias has_colour?                   does_include? } # === Colours::HtmlColours.has_colour?
-       self.instance_eval { alias registered_colour?            does_include? } # === Colours::HtmlColours.registered_colour?
-
-  # =========================================================================== #
-  # === Colours::HtmlColours.e
-  # =========================================================================== #
-  def self.e(i = '')
-    ::Colours.e(i)
-  end
-
-  # =========================================================================== #
-  # === Colours::HtmlColours.available_html_colours?
-  #
-  # This method will return an Array with all available HTML colours.
-  # =========================================================================== #
-  def self.available_html_colours?
-    @hash_html_colours.keys
-  end; self.instance_eval { alias html_colours            available_html_colours? } # === Colours::HtmlColours.html_colours
-       self.instance_eval { alias all_html_colours        available_html_colours? } # === Colours::HtmlColours.all_html_colours
-       self.instance_eval { alias return_all_html_colours available_html_colours? } # === Colours::HtmlColours.return_all_html_colours
-       self.instance_eval { alias all_colours             available_html_colours? } # === HtmlColours.all_colours
-       self.instance_eval { alias all_colours?            available_html_colours? } # === HtmlColours.all_colours?
-       self.instance_eval { alias colours                 available_html_colours? } # === HtmlColours.colours
-       self.instance_eval { alias colours?                available_html_colours? } # === HtmlColours.colours?
-       self.instance_eval { alias all?                    available_html_colours? } # === HtmlColours.all?
-       self.instance_eval { alias registered_colours?     available_html_colours? } # === HtmlColours.registered_colours?
-
-  # =========================================================================== #
-  # === all_html_colours
-  #
-  # This method will feedback all html colours known.
-  # =========================================================================== #
-  def all_html_colours
-    ::Colours::HtmlColours.available_html_colours?
-  end; alias html_colours? all_html_colours # === html_colours?
-       alias all_colours   all_html_colours # === all_colours
-
-  begin
-    require 'colours/autogenerated/support_for_html_colours.rb'
-  rescue LoadError
-    puts 'No file exists at colours/autogenerated/support_for_html_colours.rb.'
-  end
-  # ========================================================================= #
-  # === Colours::HtmlColours[]
-  #
-  # Usage examples:
-  #
-  #   Colours::HtmlColours['slateblue','Hello World!'] # works as Example 1
-  #   Colours::HtmlColours['slateblue']
-  #   Colours::HtmlColours['lightgreen','Hello World!']
-  #   Colours::HtmlColours[:random]
-  #   e Colours::HtmlColours[:random, 'yo there']
-  #
-  # ========================================================================= #
-  def self.[](
-      which_colour_to_use, optional_text_to_display = ''
-    )
-    case which_colour_to_use
-    when :random
-      which_colour_to_use = random_html_colour
-    end
-    if ::Colours.use_html_colours?
-      ::Colours::SupportForHTMLColours.send(
-        which_colour_to_use, optional_text_to_display
-      )
-    else # else return it unmodified.
-      optional_text_to_display
-    end
-  end
-
   # ========================================================================= #
   # === Colours::HtmlColours.html_colourize
   # ========================================================================= #
@@ -220,8 +225,8 @@ module HtmlColours # === Colours::HtmlColours
     e i
   end
 
-  # =========================================================================== #
-  # === Colours::HtmlColours.colour_to_rgb('royalblue')
+  # ========================================================================= #
+  # === Colours::HtmlColours.colour_to_rgb
   #
   # This method will convert the long colour name to an Array
   # with R,G,B values.
@@ -232,29 +237,64 @@ module HtmlColours # === Colours::HtmlColours
   #  Colours::HtmlColours.colour_to_rgb('slateblue')  # => [106, 90, 205]
   #  Colours::HtmlColours.colour_to_rgb(:royalblue)   # => [65, 105, 225]
   #
-  # =========================================================================== #
-  def self.colour_to_rgb(long_name = :slateblue)
-    pointer = @hash_html_colours[long_name.to_s] # This will be an Array.
+  # ========================================================================= #
+  def self.colour_to_rgb(
+      long_name = :slateblue
+    )
+    pointer = @dataset[long_name.to_s] # This will be an Array.
     return [pointer[0], pointer[1], pointer[2]]
   end; self.instance_eval { alias to_rgb colour_to_rgb } # === HtmlColours.to_rgb()
 
-  # =========================================================================== #
-  # === Colours::HtmlColours.random_colour?
+  # ========================================================================= #
+  # === Colours::HtmlColours[]
+  #
+  # Easier toplevel-access method, through [].
+  #
+  # The second message is the text that you wish to display.
+  #
+  # Usage examples:
+  #
+  #   Colours::HtmlColours['slateblue','Hello World!'] # works as Example 1
+  #   Colours::HtmlColours['slateblue']
+  #   Colours::HtmlColours['lightgreen','Hello World!']
+  #   Colours::HtmlColours[:random]
+  #   e Colours::HtmlColours[:random, 'yo there']
+  #   e Colours::HtmlColours[:steelblue, 'yo there']
   #
-  # Obtain a random sample, aka a random colour, from all the registered
-  # html colours.
-  # =========================================================================== #
-  def self.random_colour?
-    available_html_colours?.sample
-  end; self.instance_eval { alias random_colour             random_colour? } # === Colours::HtmlColours.random_colour
-       self.instance_eval { alias random                    random_colour? } # === Colours::HtmlColours.random
-       self.instance_eval { alias sample                    random_colour? } # === Colours::HtmlColours.sample
-       self.instance_eval { alias random_html_colour        random_colour? } # === Colours::HtmlColours.random_html_colour
-       self.instance_eval { alias return_random_html_colour random_colour? } # === Colours::HtmlColours.return_random_html_colour
-       self.instance_eval { alias return_random_colour      random_colour? } # === Colours::HtmlColours.return_random_colour
+  # ========================================================================= #
+  def self.[](
+      use_this_colour   = :slateblue,
+      display_this_text = ''
+    )
+    case use_this_colour
+    # ======================================================================= #
+    # === :random
+    # ======================================================================= #
+    when :random
+      use_this_colour = random_html_colour
+    end
+    ::Colours::HtmlColoursMethods.send(
+      use_this_colour,
+      display_this_text
+    )
+  end
 
 end
 
+# =========================================================================== #
+# === available_html_colours?
+# =========================================================================== #
+def available_html_colours?
+  ::Colours.available_html_colours?
+end; alias all_html_colours?       available_html_colours? # === all_html_colours?
+     alias html_colours?           available_html_colours? # === html_colours?
+     alias html_colours            available_html_colours? # === html_colours
+     alias all_html_colours        available_html_colours? # === all_html_colours
+     alias return_all_html_colours available_html_colours? # === return_all_html_colours
+     alias colours?                available_html_colours? # === colours?
+     alias colours                 available_html_colours? # === colours
+     alias registered_colours?     available_html_colours? # === registered_colours?
+
 # =========================================================================== #
 # === Colours.show_html_colours
 # =========================================================================== #
@@ -272,21 +312,6 @@ def show_html_colours
   ::Colours.show_html_colours
 end
 
-# =========================================================================== #
-# === Colours.random_colour?
-#
-# Obtain a random sample, aka a random colour, from all the registered
-# html colours.
-# =========================================================================== #
-def self.random_colour?
-  ::Colours::HtmlColours.random_colour?
-end; self.instance_eval { alias random_colour             random_colour? } # === Colours.random_colour
-     self.instance_eval { alias random                    random_colour? } # === Colours.random
-     self.instance_eval { alias sample                    random_colour? } # === Colours.sample
-     self.instance_eval { alias random_html_colour        random_colour? } # === Colours.random_html_colour
-     self.instance_eval { alias return_random_html_colour random_colour? } # === Colours.return_random_html_colour
-     self.instance_eval { alias return_random_colour      random_colour? } # === Colours.return_random_colour
-
 # =========================================================================== #
 # === Colours.colour_to_rgb
 # =========================================================================== #
@@ -295,109 +320,67 @@ def self.colour_to_rgb(i = :slateblue)
 end; self.instance_eval { alias to_rgb colour_to_rgb } # === Colours.to_rgb()
 
 # =========================================================================== #
-# === Colours.available_html_colours?
-# =========================================================================== #
-def self.available_html_colours?
-  ::Colours::HtmlColours.available_html_colours?
-end; self.instance_eval { alias html_colours?           available_html_colours? } # === Colours.html_colours?
-     self.instance_eval { alias html_colours            available_html_colours? } # === Colours.html_colours
-     self.instance_eval { alias all_html_colours        available_html_colours? } # === Colours.all_html_colours
-     self.instance_eval { alias return_all_html_colours available_html_colours? } # === Colours.return_all_html_colours
-     self.instance_eval { alias colours?                available_html_colours? } # === Colours.colours?
-     self.instance_eval { alias colours                 available_html_colours? } # === Colours.colours
-     self.instance_eval { alias registered_colours?     available_html_colours? } # === Colours.registered_colours?
-
-# =========================================================================== #
-# === Colours.hash_html_colours?
-# =========================================================================== #
-def self.hash_html_colours?
-  ::Colours::HtmlColours.hash_html_colours?
-end
-
-# =========================================================================== #
-# === Colours.does_include?
-#
-# Usage examples:
-#
-#   Colours.does_include? 'slateblue'
-#   Colours.is_this_html_colour_included? 'royalblue' # => true
-#   Colours.is_this_html_colour_included? 'megawhite' # => false
-#
-# =========================================================================== #
-def self.does_include?(i = :slateblue)
-  i = i.to_sym unless i.is_a? Symbol
-  ::Colours::HtmlColours.does_include?(i)
-end; self.instance_eval { alias is_this_html_colour_included? does_include? } # === Colours.is_this_html_colour_included?
-     self.instance_eval { alias is_a_html_colour?             does_include? } # === Colours.is_a_html_colour?
-     self.instance_eval { alias is_a_HTML_colour?             does_include? } # === Colours.is_a_HTML_colour?
-     self.instance_eval { alias is_this_a_html_colour?        does_include? } # === Colours.is_this_a_html_colour?
-     self.instance_eval { alias html_colours_include?         does_include? } # === Colours.html_colours_include?
-     self.instance_eval { alias include_this_html_colour?     does_include? } # === Colours.include_this_html_colour?
-     self.instance_eval { alias is_this_a_valid_html_colour?  does_include? } # === Colours.is_this_a_valid_html_colour?
-     self.instance_eval { alias is_this_input_a_html_colour?  does_include? } # === Colours.is_this_input_a_html_colour?
-     self.instance_eval { alias has_colour?                   does_include? } # === Colours.has_colour?
-     self.instance_eval { alias registered_colour?            does_include? } # === Colours.registered_colour?
-
-# =========================================================================== #
-# === available_html_colours?
-# =========================================================================== #
-def available_html_colours?
-  ::Colours.available_html_colours?
-end; alias html_colours?           available_html_colours? # === html_colours?
-     alias html_colours            available_html_colours? # === html_colours
-     alias all_html_colours        available_html_colours? # === all_html_colours
-     alias return_all_html_colours available_html_colours? # === return_all_html_colours
-     alias colours?                available_html_colours? # === colours?
-     alias colours                 available_html_colours? # === colours
-     alias registered_colours?     available_html_colours? # === registered_colours?
-
-# =========================================================================== #
-# === Colours.random_html_colour
+# === Colours.does_this_line_include_a_html_colour?
 #
-# This method will simply return a (one) random HTML colour, in long
-# format, e. g. "teal" or "slateblue".
+# This method can be used to determine whether the given input-string
+# contains a valid HTML colour or whether it does not.
 #
-# If you wish to have it colourized properly, you need to use another
-# method.
+# Returns: a boolean.
 #
-# Usage examples:
+# Invocation examples:
 #
-#   Colours.random_colour? # => "teal"
-#   Colours.random_colour? # => "blueviolet"
+#   Colours.does_this_line_include_a_html_colour? "<green>yo there</green> <orange>getline() function</orange>" # => true
+#   Colours.does_this_line_include_a_html_colour? "foo bar" # => false
 #
-# =========================================================================== # 
-def self.random_html_colour
-  ::Colours::HtmlColours.random_colour?
-end; self.instance_eval { alias random_colour?            random_html_colour } # === Colours.random_colour?
-     self.instance_eval { alias return_html_colour?       random_html_colour } # === Colours.return_html_colour?
-     self.instance_eval { alias random_html_colour?       random_html_colour } # === Colours.random_html_colour?
-     self.instance_eval { alias return_random_html_colour random_html_colour } # === Colours.return_random_html_colour
+# =========================================================================== #
+def self.does_this_line_include_a_html_colour?(
+    line
+  )
+  html_colours?.any? {|entry|
+    line.include? entry
+  }
+end
 
 # =========================================================================== #
 # === random_colour?
 # =========================================================================== #
 def random_colour?
   return Colours.random_html_colour
-end; alias random_colour             random_colour? # === random_colour
+end; alias return_random_html_colour random_colour? # === return_random_html_colour
+     alias random_html_colour        random_colour? # === random_html_colour
+     alias random_colour             random_colour? # === random_colour
      alias random                    random_colour? # === random
      alias sample                    random_colour? # === sample
-     alias random_html_colour        random_colour? # === random_html_colour
-     alias return_random_html_colour random_colour? # === return_random_html_colour
 
-# # =========================================================================== #
-# # === Colours[]
-# # =========================================================================== #
-# def self.[](i = :slateblue, optional_text_to_display = '')
-#   ::Colours::HtmlColours[i, optional_text_to_display]
-# end
+# =========================================================================== #
+# === Colours.autogenerate_html_colours_methods
+# =========================================================================== #
+def self.autogenerate_html_colours_methods
+  ::Colours::HtmlColours.autogenerate_html_colours_methods
+end; self.instance_eval { alias autogenerate_the_module_for_the_html_colours autogenerate_html_colours_methods } # === Colours.autogenerate_the_module_for_the_html_colours
 
 end
 
 if __FILE__ == $PROGRAM_NAME
   alias e puts
+  dataset = Colours::HtmlColours.dataset?
+  pp dataset
+  _ = Colours::HtmlColours.available_html_colours?
+  e _.size.to_s+' HTML colours are registered.'
+  e 'Is slateblue a HTML colour? '+
+    Colours::HtmlColours.does_include?('slateblue').to_s
+  e
+  pp Colours::HtmlColours.colour_to_rgb('whitesmoke') # => [245, 245, 245]
+  pp Colours::HtmlColours.colour_to_rgb('slateblue')  # => [106, 90, 205]
+  pp Colours::HtmlColours.colour_to_rgb(:royalblue)   # => [65, 105, 225]
+  e
+  e 'Picking a random HTML colour next: '+
+    Colours::HtmlColours.random_colour?
+  e
   pp Colours::HtmlColours.return_all_html_colours
   p Colours.return_all_html_colours
   pp Colours::HtmlColours.colour_to_rgb('royalblue')
+  e
   if ARGV.first
     p Colours::HtmlColours[ARGV.first]
   else
@@ -417,8 +400,7 @@ if __FILE__ == $PROGRAM_NAME
   e
   Colours::HtmlColours.html_colourize(ARGF)
   e
-  e 'Random HTML colour: '+Colours.random_html_colour.to_s
+  e Colours.does_this_line_include_a_html_colour? "<green>yo there</green> <orange>getline() function</orange>" # => true
+  e Colours.does_this_line_include_a_html_colour? "foo bar" # => false
   e
-  e Colours.random_colour? # => "teal"
-  e Colours.random_colour? # => "steelblue"
 end

data/lib/colours/html_colours/push_the_html_colours_methods_onto_the_toplevel_namespace.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will add the autogenerated HTML-colours onto the toplevel
+# module "namespace". By default it is NOT required, so you may have
+# to do so on your own.
+# =========================================================================== #
+# require 'colours/html_colours/push_the_html_colours_methods_onto_the_toplevel_namespace.rb'
+# Colours.push_the_html_colours_methods_onto_the_toplevel_namespace
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours.push_the_html_colours_methods_onto_the_toplevel_namespace
+  # ========================================================================= #
+  def self.push_the_html_colours_methods_onto_the_toplevel_namespace
+    require 'colours/autogenerated/html_colours_methods.rb'
+    require 'colours/autogenerated/html_colours_instance_methods.rb'
+    # ========================================================================= #
+    # We have to put the ColourMethods into the toplevel namespace at once,
+    # so that methods such as slateblue() are defined.
+    # ========================================================================= #
+    extend ::Colours::HtmlColoursMethods
+
+    include ::Colours::HtmlColoursMethods
+
+  end; self.instance_eval { alias add_html_colours_onto_the_toplevel_namespace push_the_html_colours_methods_onto_the_toplevel_namespace } # === Colours.add_html_colours_onto_the_toplevel_namespace
+
+end