colours 0.8.12 → 0.9.8

data/lib/colours/base/base.rb

@@ -2,28 +2,76 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# This is a "dummy" class from which you can quickly subclass if you
-# need methods such as royalblue() to work in your class.
+# This class can be used if you want to subclass directly from the
+# colours gem. It is in many ways a "dummy" class, but it also allows
+# you to quickly subclass from it, if you  need methods such as
+# royalblue() to work in your class. Other than that it may be better
+# to work with the modules instead, e. g. "include Colours" specifically.
 # =========================================================================== #
 # require 'colours/base/base.rb'
 # class Foobar < Colours::Base
 # =========================================================================== #
 module Colours
 
-begin
-  require 'colours/autogenerated/toplevel_basic_colour_methods.rb'
-rescue LoadError => error
-  pp error
-end
-
 class Base # === Colours::Base
 
-  begin
-    include Colours::AllColourMethods 
-  rescue; end # This is ok, as there is a begin/rescue above.
+  require 'colours/constants/constants.rb' # For methods such as left?.
+  require 'colours/requires/require_essentials.rb'
+  require 'colours/toplevel_methods/toplevel_methods.rb'
+  require 'colours/toplevel_methods/e.rb'
+  require 'colours/module_256_colours/module_256_colours.rb'
+  require 'colours/sfile_sdir_sfancy_swarn_simp_scomments_and_ssymlink/sfile_sdir_sfancy_swarn_simp_scomments_and_ssymlink.rb'
+  require 'colours/html_colours/html_colours.rb'
+  
+  # =========================================================================== #
+  # === e
+  # =========================================================================== #
+  def e(i = '')
+    ::Colours.e(i)
+  end
+
+  # =========================================================================== #
+  # === set_commandline_arguments
+  # =========================================================================== #
+  def set_commandline_arguments(i)
+    @commandline_arguments = [i].flatten.compact
+  end
+
+  # =========================================================================== #
+  # === commandline_arguments?
+  # =========================================================================== #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # =========================================================================== #
+  # === first_argument?
+  # =========================================================================== #
+  def first_argument?
+    @commandline_arguments.first
+  end
+
+  # =========================================================================== #
+  # === second_argument?
+  # =========================================================================== #
+  def second_argument?
+    @commandline_arguments[1]
+  end
+
+  # =========================================================================== #
+  # === extend_module_256_colours
+  # =========================================================================== #
+  def extend_module_256_colours
+    extend ::Colours::Module256Colours
+  end
 
 end; end
 
 if __FILE__ == $PROGRAM_NAME
-  puts Colours::Base.new.royalblue('hi there')
-end
+  alias e puts
+  base = Colours::Base.new
+  base.extend_module_256_colours
+  e base.is_this_a_256_colour? 'LightSteelBlue3'
+  e base.royalblue('hi there')
+  e base.royalblue('hi there')
+end # base.rb

data/lib/colours/class/colours.rb

@@ -26,14 +26,11 @@
 # require 'colours/class/colours.rb'
 # Colours.fancy_parse '<i><red>E. coli</red></i>'
 # =========================================================================== #
-module Colours
-
-class Colours
+require 'colours/base/base.rb'
 
-  alias e puts
+module Colours
 
-  require 'colours/constants/hash_ansi_colours.rb'
-  require 'colours/toplevel_methods/methods_related_to_html_colours.rb'
+class Colours < Base # === Colours::Colours
 
   # ========================================================================= #
   # === LEADING_PART
@@ -450,6 +447,8 @@ end
 
 # =========================================================================== #
 # === Colours.new
+#
+# Easier toplevel-instantiation.
 # =========================================================================== #
 def self.new(i = ARGV)
   ::Colours::Colours.new(i)
@@ -459,6 +458,9 @@ end
 
 # =========================================================================== #
 # === Colours()
+#
+# And a toplevel method that can be used to create a new instance of
+# class Colours::Colours.
 # =========================================================================== #
 def Colours(i)
   ::Colours::Colours.new(i)

data/lib/colours/{toplevel_methods/use_colours.rb → colour/colour.rb}

@@ -2,134 +2,13 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# require 'colours/toplevel_methods/use_colours.rb'
+# === Colours::Colour
+#
+# This file includes a standalone Colour class, as part of the Colours
+# namespace.
 # =========================================================================== #
 module Colours
 
-  require 'colours/toplevel_methods/set_last_colour_used.rb'
-
-  # ========================================================================= #
-  # === @use_colours
-  #
-  # Whether we will use colours or whether we will not. This can be
-  # used to globally disable colours in every project using the
-  # Colours gem.
-  # ========================================================================= #
-  @use_colours = true
-
-  # ========================================================================= #
-  # === @use_html_colours
-  #
-  # This is a separate variable so that we can selectively disable or
-  # enable the colours for the Konsole submodule. Some terminals do
-  # not respond nicely to the R,G,B values that the Konsole submodule
-  # may require.
-  # ========================================================================= #
-  @use_html_colours = true
-
-  # ========================================================================= #
-  # === Colours.use_colours?
-  #
-  # Use this method to find out whether we wish to use colours or
-  # whether we do not.
-  # ========================================================================= #
-  def self.use_colours?
-    @use_colours
-  end
-
-  # ========================================================================= #
-  # === Colours.enable_html_colours
-  #
-  # Use this method to specifically enable konsole-colours.
-  # ========================================================================= #
-  def self.enable_html_colours
-    @use_html_colours = true
-  end; self.instance_eval { alias enable_konsole_colours enable_html_colours } # === Colours.enable_konsole_colours
-
-  # ========================================================================= #
-  # === Colours.use_html_colours?
-  #
-  # Query whether we will use the HTML colours or whether we will not.
-  # ========================================================================= #
-  def self.use_html_colours?
-    @use_html_colours
-  end; self.instance_eval { alias use_konsole?         use_html_colours? } # === Colours.use_konsole?
-       self.instance_eval { alias use_konsole_colours? use_html_colours? } # === Colours.use_konsole_colours??
-
-  # ========================================================================= #
-  # === Colours.disable_html_colours
-  #
-  # Disable the HTML colours.
-  # ========================================================================= #
-  def self.disable_html_colours
-    @use_html_colours = false
-  end
-
-  # ========================================================================= #
-  # === Colours.disable_colours
-  #
-  # This method can be used to disable the colours on the Colours
-  # namespace.
-  # ========================================================================= #
-  def self.disable_colours(
-      be_verbose = false
-    )
-    puts 'Disabling colours next.' if be_verbose
-    @use_colours = false
-  end; self.instance_eval { alias disable disable_colours } # === Colours.disable
-
-  # ========================================================================= #
-  # === Colours.enable_colours
-  #
-  # Use this method to enable colours for the whole Colours namespace.
-  # ========================================================================= #
-  def self.enable_colours(
-      be_verbose = false
-    )
-    puts 'Enabling colours next.' if be_verbose
-    @use_colours = true # Defined below.
-  end; self.instance_eval { alias enable enable_colours } # === Colours.enable
-
-  # ========================================================================= #
-  # === Colours.use_colours=
-  #
-  # Determine whether we will use colours or whether we will not.
-  #
-  # The first input argument to this method should be a Bool, such
-  # as true or false.
-  # ========================================================================= #
-  def self.use_colours=(
-      new_value = true
-    )
-    @use_colours = new_value
-  end; self.instance_eval { alias set_use_colours use_colours= } # === Colours.set_use_colours
-
-  # ========================================================================= #
-  # === use_colours?
-  #
-  # Delegate towards the class-method here. Unsure whether this method
-  # is really needed, but let's keep it for now. After all we can
-  # use "include Colours" to add that method.
-  # ========================================================================= #
-  def use_colours?
-    ::Colours.use_colours?
-  end
-
-  # ========================================================================= #
-  # === Colours.report_whether_colours_will_be_used
-  # ========================================================================= #
-  def self.report_whether_colours_will_be_used
-    if @use_colours
-      puts 'Yes, colours will be used.'
-    else
-      puts 'Colours are currently disabled.'
-    end
-  end
-
-# =========================================================================== #
-# This file includes a standalone Colour class, as part of the
-# Colours namespace.
-# =========================================================================== #
 class Colour # === Colours::Colour
 
   # ========================================================================= #

data/lib/colours/commandline/README.md

@@ -1,2 +1,3 @@
 This directory collects code that can be used for Colours.commandline()
-input, including the menu() functionality of it.
+input, including the menu() functionality of it. This is handled by
+a distinct class called Commandline since as of November 2023.

data/lib/colours/commandline/commandline.rb

@@ -2,57 +2,200 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
+# Although this is a class, the functionality must be made available
+# on the toplevel module called "Colours" as well. So the class is
+# just the wrapper over that toplevel functionality.
+# =========================================================================== #
 # require 'colours/commandline/commandline.rb'
+# Colours::Commandline.new
 # =========================================================================== #
+require 'colours/base/base.rb'
+
 module Colours
 
-  require 'colours/commandline/menu.rb'
-  require 'colours/eparse/eparse.rb'
-
-  alias e puts
+class Commandline < Colours::Base # === Colours::Commandline
 
   # ========================================================================= #
-  # === Colours.set_commandline
+  # === initialize
   # ========================================================================= #
-  def self.set_commandline(i = ARGV)
-    @commandline = [i].flatten.compact
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already          = true
+    )
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    # ======================================================================= #
+    # Also store it on the toplevel since as of November 2023.
+    # ======================================================================= #
+    ::Colours.set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
   end
 
   # ========================================================================= #
-  # === Colours.commandline?
+  # === menu                                                       (menu tag)
   # ========================================================================= #
-  def self.commandline?
-    @commandline
-  end
+  def menu(
+      i = ARGV
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === colours --autogenerate_html_colours_methods
+      # ===================================================================== #
+      when /^-?-?autogenerate(-|_)?html(-|_)?colours(-|_)?methods$/i,
+           /^-?-?autogenerate$/i
+        ::Colours.autogenerate_html_colours_methods
+      # ===================================================================== #
+      # === colours --autogenerate_256_colours_methods
+      # ===================================================================== #
+      when /^-?-?autogenerate(-|_)?256(-|_)?colours(-|_)?methods$/i,
+           /^-?-?256$/
+        require 'colours/module_256_colours/module_256_colours.rb'
+        ::Colours.autogenerate_256_colours_methods
+      # ===================================================================== #
+      # === colours --generate_shell_file_containing_the_html_colours
+      #
+      # This entry point will autogenerate the shell-file that contains
+      # the HTML colours (RGB colours).
+      # ===================================================================== #
+      when /^-?-?generate(-|_)?shell(-|_)?file(-|_)?containing(-|_)?the(-|_)?html(-|_)?colours$/i,
+           /^-?-?create(-|_)?shell(-|_)?file$/i # === colours --create-shell-file
+        ::Colours.generate_shell_file_containing_the_html_colours
+      # ===================================================================== #
+      # === colours --show-html_colours
+      # ===================================================================== #
+      when /^-?-?show(-|_)?html(-|_)?colours$/i,
+           /^-?-?show(-|_)?all(-|_)?html(-|_)?colours$/i,
+           /^-?-?show(-|_)?all(-|_)?colours$/i,
+           /^-?-?html(-|_)?colours$/i,
+           'hcolours',
+           'scolours',
+           'all',
+           'ALL',
+           '1',
+           'ALL_COLOURS',
+           'colours?',
+           'all_colours',
+           'COLOURS',
+           'html',
+           '' # Show all colours here
+        ::Colours.show_html_colours
+        exit
+      # ===================================================================== #
+      # === colours --basics
+      # ===================================================================== #
+      when /^-?-?basics?$/i
+        ::Colours.show_basic_colour_palette
+        exit
+      # ===================================================================== #
+      # === colours --open
+      # ===================================================================== #
+      when /^-?-?open$/i
+        open_this_file :then_exit
+      # ===================================================================== #
+      # === colours --file?
+      # ===================================================================== #
+      when /^-?-?file\??$/i
+        cliner {
+          e 'We will next read in from the default file, from:'
+          e
+          e "  #{sfile(TEST_FILE)}"
+          e
+          read_and_display_this_file
+        }
+      # ===================================================================== #
+      # === colours --show-colour-palette
+      # === colours --palette
+      #
+      # This entry point will show the basic colour palette.
+      # ===================================================================== #
+      when /^-?-?show(-|_)?colou?r(-|_)?palette$/i,
+           /^-?-?show(-|_)?palette$/i,
+           /^-?-?palette$/i
+        show_colour_palette
+      # ===================================================================== #
+      # === colours --help
+      # ===================================================================== #
+      when /^-?-?help$/i
+        show_help
+      # ===================================================================== #
+      # === colours --project_base_directory?
+      # ===================================================================== #
+      when /^-?-?project(_|-)?base(_|-)?dir\??$/i,
+           /^-?-?project(_|-)?base(_|-)?directory\??$/i,
+           /^-?-?base(_|-)?dir\??$/i
+        e Colours.project_base_directory?
+      # ===================================================================== #
+      # === ruby commandline.rb --version
+      # ===================================================================== #
+      when /-?-?version/i
+        Colours.show_the_version
+      # ===================================================================== #
+      # === colours --version
+      #
+      # Show the current version of the colours gem.
+      # ===================================================================== #
+      when /^-?-?versions?\??$/i
+        show_the_version
+      end
+    end
+  end; alias check_against_menu menu # === check_against_menu
 
   # ========================================================================= #
-  # === Colours.show_the_version
-  #
-  # Invocation example:
-  #
-  #   colours --version?
-  #
+  # === show_help
   # ========================================================================= #
-  def self.show_the_version
-    e steelblue(VERSION)
+  def show_help
+    ::Colours.show_help
   end
 
   # ========================================================================= #
-  # === Colours.show_help                                          (help tag)
+  # === run                                                         (run tag)
   # ========================================================================= #
-  def self.show_help
-    e
-    e 'This menu supports the following commands:'
-    e
-    eparse '  file?               # read in from the default test file'
-    eparse '  html_colours        # show all html colours'
-    eparse '  open                # open this file here in your editor'
-    eparse '  --version?          # report the current version of '\
-           'the colours gem'
-    eparse '  --base-dir?         # show the project base directory '\
-           'of the Colours namespace'
-    eparse '  --show-html-colours # show the available HTML colours'
-    e
-  end; self.instance_eval { alias help show_help } # === Colours.help
+  def run
+    menu
+  end
+
+end
+
+# =========================================================================== #
+# === Colours.set_commandline_arguments
+# =========================================================================== #
+def self.set_commandline_arguments(i = ARGV)
+  @commandline_arguments = [i].flatten.compact
+end
 
+# =========================================================================== #
+# === Colours.commandline_arguments?
+# =========================================================================== #
+def self.commandline_arguments?
+  @commandline_arguments
+end; self.instance_eval { alias commandline? commandline_arguments? } # === Colours.commandline?
+
+# =========================================================================== #
+# === Colours.menu                                                 (menu tag)
+#
+#
+# To invoke this method, try:
+#
+#   colours --show_html_colours
+#   colours file?
+#
+# =========================================================================== #
+def self.menu(
+    i = ARGV
+  )
+  _ = ::Colours::Commandline.new(i, :do_not_run_yet)
+  _.menu(i) # Directly pass it into the menu-method here.
+end; self.instance_eval { alias check_against_menu menu } # === Colours.check_against_menu
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  Colours::Commandline.new(ARGV)
 end