colours 0.8.12 → 0.9.8

data/lib/colours/e/README.md

@@ -1,13 +1,13 @@
 The directory here exists for the submodule called E.
 
-The reason for this strange name is that I used to do
-this a lot in ruby:
+The reason for this strange name is that I used to do this
+a lot in ruby:
 
     alias e puts
 
-So in other words, I would be using "e" rather than
-puts, in order to do output onto the commandline.
+So in other words, I would be using "e" rather than puts,
+in order to do output onto the commandline.
 
 I also used to have this in another project called AliasE,
-but eventually I decided that I should put this right
-into the Colours project.
+but eventually I decided that I should put this right into
+the Colours project.

data/lib/colours/eparse/eparse.rb

@@ -7,7 +7,8 @@
 module Colours
 
   require 'colours/toplevel_methods/e.rb'
-  require 'colours/constants/misc.rb'
+  require 'colours/toplevel_methods/rev.rb'
+  require 'colours/constants/constants.rb'
 
   # ========================================================================= #
   # === Colours::Eparse

data/lib/colours/essentials/README.md

@@ -0,0 +1,5 @@
+module Colours::Essentials carries code that can be considered to be
+"basic" - aka essential - colour support in terminals.
+
+This primarily refers to plain ANSI escape codes, such as 0;33m for
+the colour yellow.

data/lib/colours/{basic_colours/basic_colours.rb → essentials/essentials.rb}

@@ -2,86 +2,37 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
+# === Colours::Essentials
+# =========================================================================== #
 # Note that the primary ANSI colours are:
 #
-#  black, red, green, yellow, blue, magenta, cyan, white
+#   black, red, green, yellow, blue, magenta, cyan, white
 #
 # =========================================================================== #
-# require 'colours/basic_colours/basic_colours.rb'
-# include ::Colours::BasicColours
+# require 'colours/essentials/essentials.rb'
+# include ::Colours::Essentials
 # =========================================================================== #
 module Colours
 
-module BasicColours # === Colours::BasicColours
+module Essentials # === Colours::Essentials
 
   require 'colours/constants/constants.rb'
-  require 'colours/constants/hash_simple_colours.rb'
 
   # ========================================================================= #
-  # === NAMESPACE
+  # === Colours::Essentials::NAMESPACE
   # ========================================================================= #
   NAMESPACE = const_get(inspect)
 
   # ========================================================================= #
-  # === Colours.cyan
-  # ========================================================================= #
-  def self.cyan(i = '')
-    "#{COLOUR_CYAN}#{i}#{REVERT}"
-  end; self.instance_eval { alias teal cyan } # === Colours.teal
-
-  # ========================================================================= #
-  # === cyan
-  # ========================================================================= #
-  def cyan(i = '')
-    NAMESPACE.cyan(i)
-  end
-
-  # ========================================================================= #
-  # === Colours.grey
+  # === Colours::Essentials.yellow
   # ========================================================================= #
-  def self.grey(i = '')
-    "#{COLOUR_GRAY}#{i}#{REVERT}"
-  end; self.instance_eval { alias gray grey } # === Colours.gray
-
-  # ========================================================================= #
-  # === grey
-  # ========================================================================= #
-  def grey(i = '')
-    NAMESPACE.grey(i)
-  end; alias gray grey # === gray
-
-  # ========================================================================= #
-  # === Colours::BasicColours.white
-  # ========================================================================= #
-  def self.white(i = '')
-    "#{COLOUR_WHITE}#{i}#{REVERT}"
-  end; self.instance_eval { alias bold_white white } # === Colours::BasicColours.bold_white
-
-  # ========================================================================= #
-  # === bold_white
-  # ========================================================================= #
-  def bold_white(i = '')
-    NAMESPACE.bold_white(i)
-  end; alias whiteb bold_white # === whiteb
-
-  # ========================================================================= #
-  # === Colours.light_red
-  # ========================================================================= #
-  def self.light_red(i = '')
-    "#{COLOUR_LIGHT_RED}#{i}#{REVERT}"
-  end; self.instance_eval { alias lightred light_red } # === Colours.lightred
-       self.instance_eval { alias bold_red light_red } # === Colours.bold_red
-
-  # ========================================================================= #
-  # === bold_red
-  # ========================================================================= #
-  def bold_red(i = '')
-    NAMESPACE.bold_red(i)
-  end; alias lightred bold_red # === lightred
-       alias redb     bold_red # === redb
+  def self.yellow(i = '')
+    "#{COLOUR_YELLOW}#{i}#{REVERT}"
+  end; self.instance_eval { alias yel   yellow } # === Colours.yel
+       self.instance_eval { alias brown yellow } # === Colours.brown
 
   # ========================================================================= #
-  # === Colours.light_blue
+  # === Colours::Essentials.light_blue
   # ========================================================================= #
   def self.light_blue(i = '')
     "#{COLOUR_LIGHT_BLUE}#{i}#{REVERT}"
@@ -97,7 +48,7 @@ module BasicColours # === Colours::BasicColours
        alias bold_blue light_blue # === bold_blue
 
   # ========================================================================= #
-  # === Colours.magenta
+  # === Colours::Essentials.magenta
   # ========================================================================= #
   def self.magenta(i = '')
     "#{COLOUR_MAGENTA}#{i}#{REVERT}"
@@ -111,12 +62,12 @@ module BasicColours # === Colours::BasicColours
   end; alias purple magenta # === purple
 
   # ========================================================================= #
-  # === Colours.light_green
+  # === Colours::Essentials.light_green
   # ========================================================================= #
   def self.light_green(i = '')
     "#{COLOUR_LIGHT_GREEN}#{i}#{REVERT}"
-  end; self.instance_eval { alias lightgreen light_green } # === Colours::BasicColours.lightgreen
-       self.instance_eval { alias bold_green light_green } # === Colours::BasicColours.bold_green
+  end; self.instance_eval { alias lightgreen light_green } # === Colours::Essentials.lightgreen
+       self.instance_eval { alias bold_green light_green } # === Colours::Essentials.bold_green
 
   # ========================================================================= #
   # === bold_green
@@ -126,7 +77,7 @@ module BasicColours # === Colours::BasicColours
   end; alias greenb bold_green # === greenb
 
   # ========================================================================= #
-  # === Colours.red
+  # === Colours::Essentials.red
   # ========================================================================= #
   def self.red(i = '')
     "#{COLOUR_RED}#{i}#{REVERT}"
@@ -175,14 +126,6 @@ module BasicColours # === Colours::BasicColours
     NAMESPACE.light_magenta(i)
   end
 
-  # ========================================================================= #
-  # === Colours.yellow
-  # ========================================================================= #
-  def self.yellow(i = '')
-    "#{COLOUR_YELLOW}#{i}#{REVERT}"
-  end; self.instance_eval { alias yel yellow } # === Colours.yel
-       self.instance_eval { alias brown yellow } # === Colours.brown
-
   # ========================================================================= #
   # === yellow
   # ========================================================================= #
@@ -208,6 +151,8 @@ module BasicColours # === Colours::BasicColours
 
   # ========================================================================= #
   # === Colours.brown
+  #
+  # Note that Colours.bold_yellow is an alias to this method.
   # ========================================================================= #
   def self.brown(i = '')
     "#{COLOUR_BROWN}#{i}#{REVERT}"
@@ -229,7 +174,7 @@ module BasicColours # === Colours::BasicColours
   end
 
   # ========================================================================= #
-  # === Colours::BasicColours.light_gray
+  # === Colours::Essentials.light_gray
   # ========================================================================= #
   def self.light_gray(i = '')
     "#{COLOUR_LIGHT_GRAY}#{i}#{REVERT}"
@@ -238,7 +183,7 @@ module BasicColours # === Colours::BasicColours
        self.instance_eval { alias lightgrey  light_gray } # === Colours.lightgrey
 
   # ========================================================================= #
-  # === Colours::BasicColours.dark_gray
+  # === Colours::Essentials.dark_gray
   # ========================================================================= #
   def self.dark_gray(i = '')
     "#{COLOUR_DARK_GRAY}#{i}#{REVERT}"
@@ -246,6 +191,64 @@ module BasicColours # === Colours::BasicColours
        self.instance_eval { alias dark_grey dark_gray } # === Colours.dark_grey
        self.instance_eval { alias darkgrey  dark_gray } # === Colours.darkgrey
 
+  # ========================================================================= #
+  # === Colours.cyan
+  # ========================================================================= #
+  def self.cyan(i = '')
+    "#{COLOUR_CYAN}#{i}#{REVERT}"
+  end; self.instance_eval { alias teal cyan } # === Colours.teal
+
+  # ========================================================================= #
+  # === cyan
+  # ========================================================================= #
+  def cyan(i = '')
+    NAMESPACE.cyan(i)
+  end
+
+  # ========================================================================= #
+  # === Colours.grey
+  # ========================================================================= #
+  def self.grey(i = '')
+    "#{COLOUR_GRAY}#{i}#{REVERT}"
+  end; self.instance_eval { alias gray grey } # === Colours.gray
+
+  # ========================================================================= #
+  # === grey
+  # ========================================================================= #
+  def grey(i = '')
+    NAMESPACE.grey(i)
+  end; alias gray grey # === gray
+
+  # ========================================================================= #
+  # === Colours::Essentials.white
+  # ========================================================================= #
+  def self.white(i = '')
+    "#{COLOUR_WHITE}#{i}#{REVERT}"
+  end; self.instance_eval { alias bold_white white } # === Colours::Essentials.bold_white
+
+  # ========================================================================= #
+  # === bold_white
+  # ========================================================================= #
+  def bold_white(i = '')
+    NAMESPACE.bold_white(i)
+  end; alias whiteb bold_white # === whiteb
+
+  # ========================================================================= #
+  # === Colours.light_red
+  # ========================================================================= #
+  def self.light_red(i = '')
+    "#{COLOUR_LIGHT_RED}#{i}#{REVERT}"
+  end; self.instance_eval { alias lightred light_red } # === Colours.lightred
+       self.instance_eval { alias bold_red light_red } # === Colours.bold_red
+
+  # ========================================================================= #
+  # === bold_red
+  # ========================================================================= #
+  def bold_red(i = '')
+    NAMESPACE.bold_red(i)
+  end; alias lightred bold_red # === lightred
+       alias redb     bold_red # === redb
+
   # ========================================================================= #
   # === bold_yellow
   # ========================================================================= #
@@ -291,20 +294,19 @@ module BasicColours # === Colours::BasicColours
         }
       end
     }
-  end
-
-  define_colour_methods_that_can_be_included # Invoke it at once.
+  end; define_colour_methods_that_can_be_included # Invoke the above-defined method at once.
 
 end; end
 
 if __FILE__ == $PROGRAM_NAME
   alias e puts
-  x = Colours::BasicColours
+  x = Colours::Essentials
   # ========================================================================= #
   # Bold variants:
   # ========================================================================= #
   test_this_string = '  Hello world!'
   e
+  e x.light_magenta(test_this_string)
   e x.bold_blue(test_this_string)
   e x.bold_green(test_this_string)
   e x.bold_red(test_this_string)
@@ -322,13 +324,13 @@ if __FILE__ == $PROGRAM_NAME
   e
   e 'Next, we will create a class with Colours included:'
   e
-  e '   class Foo; include Colours; def test; e bold_yellow("hi there"); end; end'
+  e '   class TestClass; include Colours::Essentials; def test; e bold_yellow("hi there"); end; end'
   e
-  class Foo
-    include Colours::BasicColours
+  class TestClass
+    include Colours::Essentials
     def test
       e bold_yellow("hi there")
     end
   end
-  Foo.new.test
+  TestClass.new.test
 end # rb basic_colours.rb

data/lib/colours/html_colours/README.md

@@ -1 +1,2 @@
-This directory has code for the html "colours". 
+This directory has code for the html "colours", such as
+"steelblue" or "tomato".

data/lib/colours/html_colours/hash_html_colours.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/html_colours/hash_html_colours.rb'
+# Colours.array_html_colours?
+# =========================================================================== #
+module Colours
+
+module HtmlColours # === Colours::HtmlColours
+
+  require 'colours/requires/require_yaml.rb'
+  require 'colours/constants/constants.rb'
+
+  # ========================================================================= #
+  # === @dataset
+  #
+  # This must be a Hash at all times.
+  # ========================================================================= #
+  @dataset = {}
+
+  # ========================================================================= #
+  # === Colours::HtmlColours.dataset?
+  # ========================================================================= #
+  def self.dataset?
+    @dataset
+  end; self.instance_eval { alias main_hash?         dataset? } # === Colours::HtmlColours.main_hash?
+       self.instance_eval { alias hash_html_colours? dataset? } # === Colours::HtmlColours.hash_html_colours?
+
+  # ========================================================================= #
+  # === Colours::HtmlColours.load_the_dataset_containing_the_html_colours (load tag)
+  #
+  # This method can be used to load all registered HTML-colours, from a
+  # yaml file.
+  #
+  # The colours in the yaml file are stored in a
+  #
+  #     name: hexvalue
+  #
+  # format.
+  # ========================================================================= #
+  def self.load_the_dataset_containing_the_html_colours(
+      use_this_file = ::Colours.file_html_colours
+    )
+    if File.exist? use_this_file
+      @dataset = YAML.load_file(use_this_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
+    end
+  end
+
+  # ========================================================================= #
+  # Always try to load the dataset whenever this file is required.
+  # ========================================================================= #
+  ::Colours::HtmlColours.load_the_dataset_containing_the_html_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 @dataset.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.available_html_colours?
+  #
+  # This method will return an Array containing all available
+  # HTML colours.
+  # ========================================================================= #
+  def self.available_html_colours?
+    @dataset.keys
+  end; self.instance_eval { alias all?                    available_html_colours? } # === Colours::HtmlColours.all?
+       self.instance_eval { alias html_colours            available_html_colours? } # === Colours::HtmlColours.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? } # === Colours::HtmlColours.all_colours
+       self.instance_eval { alias all_colours?            available_html_colours? } # === Colours::HtmlColours.all_colours?
+       self.instance_eval { alias colours?                available_html_colours? } # === Colours::HtmlColours.colours?
+       self.instance_eval { alias colours                 available_html_colours? } # === Colours::HtmlColours.colours
+       self.instance_eval { alias registered_colours?     available_html_colours? } # === Colours::HtmlColours.registered_colours?
+       self.instance_eval { alias all_html_colours?       available_html_colours? } # === Colours::HtmlColours.all_html_colours?
+       self.instance_eval { alias all_html_colours        available_html_colours? } # === Colours::HtmlColours.all_html_colours
+
+end
+
+# =========================================================================== #
+# === Colours.hash_html_colours?
+#
+# Query-method to return the Hash containing all HTML colours, including
+# their respective RGB values.
+# =========================================================================== #
+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?
+
+# =========================================================================== #
+# === 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?
+     self.instance_eval { alias array_html_colours?     available_html_colours? } # === Colours.array_html_colours?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  dataset = Colours::HtmlColours.dataset?
+  pp dataset
+end