colours 0.8.12 → 0.9.8

data/lib/colours/requires/require_the_project.rb

@@ -2,52 +2,54 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
+# require 'colours/requires/require_the_project.rb'
+# =========================================================================== #
 require 'colours/project/project.rb'
 require 'colours/requires/require_the_constants.rb'
+require 'colours/requires/require_commandline.rb'
+require 'colours/html_colours/html_colours.rb'
 require 'colours/class/colours.rb'
-require 'colours/base/base.rb'
-require 'colours/requires/require_the_basic_colours.rb'
+require 'colours/requires/require_rgb.rb'
 require 'colours/requires/require_the_toplevel_methods.rb'
-require 'colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
-require 'colours/256_colours/support_for_256_colours.rb'
+require 'colours/requires/require_the_256_colours_module.rb'
 # =========================================================================== #
-# Next require the colour-methods:
+# Load up the testing-relevant code:
 # =========================================================================== #
-require 'colours/requires/require_the_colour_methods.rb'
+require 'colours/testing/testing.rb'
+require 'colours/version/version.rb'
+require 'colours/requires/require_eparse.rb'
 # =========================================================================== #
 # Next require the html-colours components of the colours project:
 # =========================================================================== #
 require 'colours/requires/require_the_html_colours.rb'
-require 'colours/requires/require_eparse.rb'
-require 'colours/requires/require_commandline.rb'
-require 'colours/requires/require_the_colour_table.rb'
-require 'colours/requires/require_rgb.rb'
-require 'colours/requires/require_the_256_colours_module.rb'
-require 'colours/requires/require_the_kde_colour_palette.rb'
-require 'colours/version/version.rb'
-require 'colours/requires/require_autogenerated_colour_methods.rb'
-require 'colours/html_colours/add_html_colours_onto_the_toplevel_namespace.rb'
-# =========================================================================== #
-# Require the big "symbol-mapper" next:
-# =========================================================================== #
-require 'colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
+
 # =========================================================================== #
-# Load up the testing-relevant code:
+# Next require the colour-methods - these include Colours.sfancy(),
+# Colours.sdir() and so forth:
 # =========================================================================== #
-require 'colours/testing/testing.rb'
+require 'colours/requires/require_the_colour_methods.rb'
+
+require 'colours/requires/require_the_kde_colour_palette.rb'
+
 # =========================================================================== #
 # Next, add the submodule at "Colours::E":
 # =========================================================================== #
 require 'colours/e/e.rb'
 
-module Colours
+# =========================================================================== #
+# Require the big "symbol-mapper" next:
+# =========================================================================== #
+require 'colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
 
-  # ========================================================================= #
-  # We have to put the ColourMethods into the toplevel namespace at once,
-  # so that methods such as slateblue() are defined.
-  # ========================================================================= #
-  extend ::Colours::AllColourMethods
+require 'colours/replace_tokens_with_colour_code/replace_tokens_with_colour_code.rb'
 
-  include ::Colours::AllColourMethods
+# =========================================================================== #
+# Requiring the autogenerated methods may not be what the user wants to
+# have. For instance, the 256-colours module is only relevant if the user
+# makes use of these methods, which is most likely not the default
+# case.
+# =========================================================================== #
+# require 'colours/requires/require_autogenerated_colour_methods.rb'
+# =========================================================================== #
 
-end
+require 'colours/html_colours/push_the_html_colours_methods_onto_the_toplevel_namespace.rb'

data/lib/colours/requires/require_the_toplevel_methods.rb

@@ -7,7 +7,7 @@
 # =========================================================================== #
 require 'colours/project/project.rb'
 
-require_these_files = Dir["#{Colours::PROJECT_BASE_DIRECTORY}toplevel_methods/*.rb"]
+require_these_files = Dir["#{Colours.project_base_directory?}toplevel_methods/*.rb"]
 
 if require_these_files.empty?
   # ===================================================================== #
@@ -15,25 +15,7 @@ if require_these_files.empty?
   # approach, which follows next.
   # ===================================================================== #
   require_these_files = %w(
-    bold_and_italic.rb
-    bold.rb
-    cat.rb
-    clear_screen.rb
-    cliner.rb
-    col.rb
-    e.rb
-    html_colourize.rb
-    is_on_roebe.rb
-    italic.rb
-    make_colour.rb
-    misc.rb
-    prefer_this_colour_schemata.rb
-    random_html_colour.rb
-    random_value.rb
-    remove_escape_sequence.rb
-    show_basic_colour_palette.rb
-    underline.rb
-    use_colours.rb
+    toplevel_methods.rb
   )
 end
 

data/lib/colours/rgb/rgb.rb

@@ -4,9 +4,10 @@
 # =========================================================================== #
 # === Colours::RGB
 #
-# The Colours::RBG class was used to convert from RGB values to hex
-# format. However had these days it is not as widely used anymore
-# within the colours project.
+# The Colours::RBG class can be used to convert a RGB value into its
+# corresponding hex format. However had these days it is not as widely
+# used anymore within the colours project, excluding those cases where
+# this is indeed necessary.
 #
 # Code in this .rb file here in general can be used for RGB-related
 # functionality. A good example for what can be done with this is to
@@ -15,13 +16,13 @@
 # =========================================================================== #
 # require 'colours/rgb/rgb.rb'
 # =========================================================================== #
+require 'colours/base/base.rb'
+
 module Colours
 
-class RGB # === Colours::RGB
+class RGB < Base # === Colours::RGB
 
-  require 'colours/constants/misc.rb' # For methods such as left?.
-  require 'colours/html_colours/html_colours.rb'
-  require 'colours/toplevel_methods/random_value.rb'
+  require 'colours/html_colours/hash_html_colours.rb'
 
   # ========================================================================= #
   # === DEFAULT_VALUES
@@ -33,15 +34,15 @@ class RGB # === Colours::RGB
   # ========================================================================= #
   DEFAULT_VALUE = 0
 
-  # =========================================================================== #
+  # ========================================================================= #
   # === initialize
   #
   # Keep in mind that the first argument could be something like:
   #
   #   [106, 90, 205]
   #
-  # In that case, we need to continue differently.
-  # =========================================================================== #
+  # In that case, we need to handle this situation differently.
+  # ========================================================================= #
   def initialize(
       original_input = ARGV,
       run_already    = true
@@ -53,66 +54,72 @@ class RGB # === Colours::RGB
     run if run_already
   end
 
-  # =========================================================================== #
-  # === set_commandline_arguments
-  # =========================================================================== #
-  def set_commandline_arguments(i)
-    @commandline_arguments = [i].flatten.compact
-  end
-
-  # =========================================================================== #
-  # === reset
-  # =========================================================================== #
-  def reset
-    @r, @g, @b = 0, 0, 0 # Use default values for RGB.
-  end
-
   # ========================================================================= #
-  # === b?
+  # === reset                                                     (reset tag)
   # ========================================================================= #
-  def b?
-    @b
-  end; alias b b? # === b
+  def reset
+    # ======================================================================= #
+    # === @hexstring
+    # ======================================================================= #
+    @hexstring = nil
+    # ======================================================================= #
+    # Use default values for RGB - all 0.
+    # ======================================================================= #
+    @r = 0
+    @g = 0
+    @b = 0
+  end
 
   # ========================================================================= #
-  # === g?
+  # === set_rgb
   # ========================================================================= #
-  def g?
-    @g
-  end; alias g g? # === g
+  def set_rgb(r,g,b)
+    set_r(r)
+    set_g(g)
+    set_b(b)
+  end
 
   # ========================================================================= #
-  # === hexstring?
+  # === set_r
   # ========================================================================= #
-  def hexstring?
-    @hexstring
-  end; alias hexstring hexstring? # === hexstring
+  def set_r(i = DEFAULT_VALUES[0])
+    i = i.to_i
+    check_validity_of(i)
+    @r = i
+  end
 
   # ========================================================================= #
-  # === r?
+  # === set_g
   # ========================================================================= #
-  def r?
-    @r
-  end; alias r r? # === r
+  def set_g(i = nil)
+    i = DEFAULT_VALUE if i.nil?
+    i = i.to_i
+    check_validity_of(i)
+    @g = i
+  end
 
   # ========================================================================= #
-  # === determine_rgb_values_from_the_commandline_arguments
+  # === set_b
   # ========================================================================= #
-  def determine_rgb_values_from_the_commandline_arguments
-    _ = @commandline_arguments
-    first = _.first
-    if first.is_? Array
-      set_r(first[0])
-      set_g(first[1])
-      set_b(first[2])
-    end
+  def set_b(i = nil)
+    i = DEFAULT_VALUE if i.nil?
+    i = i.to_i
+    check_validity_of(i)
+    @b = i
   end
 
   # ========================================================================= #
-  # === rgb
+  # === lighten
+  #
+  # This method will lighten up a colour.
+  #
+  # Usage example:
+  #
+  #   Colours::RgbToHex.new('#ffffff').lighten # => "#232323"
+  #
   # ========================================================================= #
-  def rgb
-    [ @r, @g, @b ]
+  def lighten(i = 35)
+    add(i) # Hardcoded to add +35 to each of R, G and B.
   end
 
   # ========================================================================= #
@@ -137,53 +144,54 @@ class RGB # === Colours::RGB
   end; alias update_hexstring do_the_conversion # === update_hexstring
 
   # ========================================================================= #
-  # === set_rgb
+  # === b?
   # ========================================================================= #
-  def set_rgb(r,g,b)
-    set_r(r)
-    set_g(g)
-    set_b(b)
-  end
+  def b?
+    @b
+  end; alias b b? # === b
 
   # ========================================================================= #
-  # === set_r
+  # === g?
   # ========================================================================= #
-  def set_r(i = DEFAULT_VALUES[0])
-    i = i.to_i
-    check_validity_of(i)
-    @r = i
-  end
+  def g?
+    @g
+  end; alias g g? # === g
 
   # ========================================================================= #
-  # === set_g
+  # === r?
   # ========================================================================= #
-  def set_g(i = nil)
-    i = DEFAULT_VALUE if i.nil?
-    i = i.to_i
-    check_validity_of(i)
-    @g = i
-  end
+  def r?
+    @r
+  end; alias r r? # === r
 
   # ========================================================================= #
-  # === set_b
+  # === determine_rgb_values_from_the_commandline_arguments
   # ========================================================================= #
-  def set_b(i = nil)
-    i = DEFAULT_VALUE if i.nil?
-    i = i.to_i
-    check_validity_of(i)
-    @b = i
+  def determine_rgb_values_from_the_commandline_arguments(
+      _ = commandline_arguments?
+    )
+    first = _.first
+    if first.is_? Array
+      set_r(first[0])
+      set_g(first[1])
+      set_b(first[2])
+    end
   end
 
   # ========================================================================= #
-  # === lighten
-  #
-  # This lightens up a colour.
-  #   RgbToHex.new('#ffffff').lighten # => "#232323"
+  # === rgb
   # ========================================================================= #
-  def lighten
-    add(35) # Hardcoded to add +35 to each of R, G and B.
+  def rgb
+    [ @r, @g, @b ]
   end
 
+  # ========================================================================= #
+  # === hexstring?
+  # ========================================================================= #
+  def hexstring?
+    @hexstring
+  end; alias hexstring hexstring? # === hexstring
+
   # ========================================================================= #
   # === add
   #
@@ -198,9 +206,9 @@ class RGB # === Colours::RGB
     update_hexstring
   end
 
-  # =========================================================================== #
+  # ========================================================================= #
   # === run
-  # =========================================================================== #
+  # ========================================================================= #
   def run
     determine_rgb_values_from_the_commandline_arguments
     do_the_conversion
@@ -216,7 +224,11 @@ class RGB # === Colours::RGB
   #   Colours::RgbToHex[22,33,44] # => "#16212C"
   #
   # ========================================================================= #
-  def self.[](r = 255, g = 0, b = 0)
+  def self.[](
+      r = 255,
+      g =   0,
+      b =   0
+    )
     _ = new(r,g,b)
     return '#%02x%02x%02x'.upcase % _.rgb
   end
@@ -265,7 +277,11 @@ end
 def self.convert_this_html_colour_into_an_array_of_rgb_values(
     html_colour = :random
   )
+  require 'colours/html_colours/random_html_colour.rb'
   case html_colour
+  # ========================================================================= #
+  # === :random
+  # ========================================================================= #
   when :random
     html_colour = return_random_html_colour
   end
@@ -378,7 +394,9 @@ end
 # === Colours.return_this_text_in_random_colour
 #
 # Invocation example:
+#
 #   puts Colours.return_this_text_in_random_colour('Hello World!')
+#
 # =========================================================================== #
 def self.return_this_text_in_random_colour(
     show_this_text = ''
@@ -503,14 +521,14 @@ def self.rgb_value_as_escape_code_string(
       set_last_colour_used(array)
       r, g, b = ::Colours.convert_this_html_colour_into_an_array_of_rgb_values(array)
     else
-      puts 'The input is not a HTML colour:'
+      e 'The input is not a HTML colour:'
       pp array
     end
   end
-  # =========================================================================== #
+  # ========================================================================= #
   # The String that we build up in this method will have the ANSI escape
   # code on the left side.
-  # =========================================================================== #
+  # ========================================================================= #
   return "#{left?}#{r};#{g};#{b}m"
 end; self.instance_eval { alias build_this_rgb_string rgb_value_as_escape_code_string } # === Colours.build_this_rgb_string
      self.instance_eval { alias rgb_value_as_string   rgb_value_as_escape_code_string } # === Colours.rgb_value_as_string