colours 0.8.12 → 0.9.8

data/lib/colours/basic_colours/README.md

@@ -1,4 +0,0 @@
-Code in this directory will be for "basic" colour support in terminals.
-
-This primarily refers to plain ANSI escape codes, such as 0;33m for
-the colour yellow.

data/lib/colours/colour_methods/README.md

@@ -1,11 +0,0 @@
-This directory will hold the representations for sdir(), sfancy(),
-sfile() and so forth. These methods are the default "colour methods",
-string methods that can be used on the "Colours" namespace directly,
-such as:
-
-    Colours.sfancy()
-    Colours.simportant()
-    Colours.sdir()
-    Colours.swarn()
-
-and so forth.

data/lib/colours/colour_table/README.md

@@ -1,2 +0,0 @@
-This directory will contain code for the colour-table, that is a table that
-maps from e. g. sfancy() to the corresponding colour at hand.

data/lib/colours/colour_table/colour_table.rb

@@ -1,282 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'colours/colour_table/colour_table.rb'
-# =========================================================================== #
-module Colours
-
-  require 'colours/toplevel_methods/use_colours.rb'
-  require 'colours/html_colours/html_colours.rb'
-
-  # ========================================================================= #
-  # === HASH_NEW_COLOURS
-  #
-  # This is the new hash, which we can transition-into when necessary.
-  #
-  # It is only rarely used these days, though (as of the year 2018).
-  #
-  # If you want to use these colours, you can use this simpler API:
-  #
-  #    Colourss.set_method_to_colour_table :new_colours
-  #
-  # ========================================================================= #
-  HASH_NEW_COLOURS = {
-    default_colour: :green,        
-    sargument:      :bold_brown,    # === sarg()
-    scomments:      :bold_blue,     # === scomments()
-    sdir:           :bold_green,    # === sdir()
-    sfancy:         :bold_yellow,   # === sfancy()
-    sfile:          :brown,         # === sfile()
-    simportant:     :pink,          # === simportant()
-    ssymlink:       :teal,          # === ssymlink()
-    swarn:          :bold_red,      # === swarn
-    snormal:        :light_grey     # === snormal()
-  }
-
-  # ========================================================================= #
-  # === Colours.update_the_colour_codes_with                     (update tag)
-  # ========================================================================= #
-  def self.update_the_colour_codes_with(i = HASH_NEW_COLOURS)
-    @colour_table.update(i)
-  end; self.instance_eval { alias update_colour_table_with update_the_colour_codes_with } # === Colours.update_colour_table_with
-       self.instance_eval { alias update_the_colour_codes  update_the_colour_codes_with } # === Colours.update_the_colour_codes
-       self.instance_eval { alias update_colour_codes      update_the_colour_codes_with } # === Colours.update_colour_codes
-
-  # ========================================================================= #
-  # === @colour_table                      (default tag, default colours tag)
-  #
-  # This toplevel instance variable has the default colours assigned to
-  # the different methods. If you ever wish to change the default colours
-  # in use, you can do so by manipulating this instance variable.
-  #
-  # Keep it sorted alphabetically.
-  # ========================================================================= #
-  @colour_table = {
-    default_colour:  :green,
-    sfancy:          :bold_green,   # === sfancy()
-    sargument:       :bold_green,   # === sargument()
-    scomments:       :grey,         # === scomments()
-    sdir:            :chocolate,    # === sdir()
-    sfile:           :saddlebrown,  # === sfile()
-    simportant:      :gold,         # === simportant()
-    ssymlink:        :lightblue,    # === ssymlink()
-    swarn:           :bold_red,     # === swarn()
-    snormal:         :light_grey    # === snormal()
-  }
-
-  if @use_html_colours and File.exist?(FILE_USE_THESE_VALUES_FOR_THE_COLOUR_METHODS)
-    these_colours = YAML.load_file(FILE_USE_THESE_VALUES_FOR_THE_COLOUR_METHODS).
-                    transform_keys(&:to_sym)
-    update_colour_table_with(these_colours)
-  end
-
-  # ========================================================================= #
-  # === Colours.map_this_symbol_to_that_html_colour
-  #
-  # The job of this method is to map entries such as :bold_green to
-  # a corresponding HTML colour.
-  # ========================================================================= #
-  def self.map_this_symbol_to_that_html_colour(i)
-    if is_a_html_colour? i
-      i
-    else
-      case i
-      # === :cyanb
-      when :cyanb
-        :lightseagreen
-      # === :light_grey
-      when :light_grey
-        :lightgray
-      # === :bold_blue
-      when :bold_blue
-        :slateblue
-      when :bold_red, :redb
-        :crimson
-      when :bold_yellow
-        :goldenrod
-      when :bold_green
-        :seagreen
-      else
-        puts 'Unregistered input into the method '+__method__.to_s+': '+i.to_s
-      end
-    end
-  end
-
-  # ========================================================================= #
-  # === Colours.map_this_symbol_to_that_256_colour
-  #
-  # This method will take input such as :bold_green and associate it with
-  # a corresponding 256-colour. Thus, the resulting Symbol that is
-  # found here should correspond to a method on module SupportFor256Colours.
-  # ========================================================================= #
-  def self.map_this_symbol_to_that_256_colour(i)
-    case i
-    when :boldgreen,
-         :bold_green
-      :chartreuse2
-    when :teal
-      :teal
-    when :bold_yellow
-      :yellow2
-    when :gold
-      :gold3
-    when :bold_blue
-      :lightslateblue
-    when :bold_brown
-      :darkred
-    when :brown
-      :maroon
-    when :pink
-      :hotpink3
-    when :lightgrey,
-         :light_grey
-      :grey66
-    when :bold_red
-      :red1
-    when :lightblue,
-         :light_blue
-      :deepskyblue3
-    when :grey
-      :grey53
-    when :green
-      :chartreuse4
-    else
-      puts "Not known input to method #{__method__.to_s}: #{i}"
-    end
-  end
-
-  # ========================================================================= #
-  # === use_new_colour_codes
-  #
-  # Use this method to assign new colour codes.
-  # We assume that you must pass a hash to this method.
-  #
-  # Usage example:
-  #
-  #   new_hash = {
-  #     :sfancy         => 'green',
-  #     :simportant     => 'teal',
-  #     :default_colour => 'grey',
-  #     :sfile          => 'magenta',
-  #     :sdir           => 'cyan'
-  #   }
-  #   Colours.assign_new_colour_codes(new_hash)
-  #
-  # ========================================================================= #
-  def use_new_colour_codes(
-      i = HASH_NEW_COLOURS
-    )
-    @colour_table.update(i)
-  end; alias assign_new_colour_codes use_new_colour_codes # === assign_new_colour_codes
-
-  # ========================================================================= #
-  # === Colours.set_colour_table
-  #
-  # This method can be used to modify the instance variable
-  # @colour_table.
-  #
-  # The input to this method should be a Hash. It can also be a Symbol,
-  # in which case we will try to find a Hash that corresponds to that
-  # Symbol.
-  #
-  # If in doubt, pass in a Hash though.
-  # ========================================================================= #
-  def self.set_colour_table(
-      i = :new_colours
-    )
-    case i
-    when :new_colours,
-         :new_colour_table,
-         :default
-      i = HASH_NEW_COLOURS
-    end
-    # ======================================================================= #
-    # Note that we must ensure that all the necessary keys are there
-    # in the given input. If this is not the case, then we will
-    # determine which entries are missing, and assign them from the
-    # instance variable @colour_table.
-    # ======================================================================= #
-    missing_entries = (
-      i.keys - @colour_table.keys
-    ).flatten
-    unless missing_entries.empty?
-      # ===================================================================== #
-      # Push them onto i in this case.
-      # ===================================================================== #
-      missing_entries.each {|this_key|
-        if i.has_key? this_key
-          # All fine, pass through in this case.
-        else
-          add_this = missing_entries[this_key]
-          i[key] = add_this
-
-        end
-      }
-    end
-    @colour_table = i
-  end; self.instance_eval { alias assign_new_colour_codes    set_colour_table } # === Colours.assign_new_colour_codes
-       self.instance_eval { alias set_method_to_colour_table set_colour_table } # === Colours.set_method_to_colour_table
-
-  # ========================================================================= #
-  # === Colours.use_new_colour_table
-  # ========================================================================= #
-  def self.use_new_colour_table
-    set_colour_table(:new_colour_table)
-  end
-
-  # ========================================================================= #
-  # === Colours.show_the_colour_table
-  #
-  # This will simply pretty-print the current colour table.
-  # ========================================================================= #
-  def self.show_the_colour_table
-    pp @colour_table
-  end
-
-  # ========================================================================= #
-  # === Colours.shuffle
-  #
-  # Shuffle the above table. The available colours to take here will
-  # be from the HtmlColours namespace.
-  # ========================================================================= #
-  def self.shuffle
-    # ======================================================================= #
-    # Point to the html "table" to use.
-    # ======================================================================= #
-    _ = ::Colours::HtmlColours.all?.shuffle
-    @colour_table = {
-      simp:      _.shift,
-      sdir:      _.shift,
-      sfile:     _.shift,
-      swarn:     _.shift,
-      sfancy:    _.shift,
-      sargument: _.shift,
-      ssymlink:  _.shift
-    }
-  end
-
-  # ========================================================================= #
-  # === Colours.colour_table?
-  #
-  # This method will feedback the available colour-table.
-  #
-  # To invoke this method, try the following code:
-  #
-  #   pp Colours.colours?
-  #
-  # ========================================================================= #
-  def self.colour_table?
-    @colour_table
-  end; self.instance_eval { alias method_to_colour_table                  colour_table? } # === Colours.method_to_colour_table
-       self.instance_eval { alias method_to_colour_table?                 colour_table? } # === Colours.method_to_colour_table?
-       self.instance_eval { alias colours?                                colour_table? } # === Colours.colours?
-       self.instance_eval { alias table?                                  colour_table? } # === Colours.table?
-       self.instance_eval { alias table_colour_methods_to_specific_colour colour_table? } # === Colours.table_colour_methods_to_specific_colour
-       self.instance_eval { alias colour_methods_to_specific_colour?      colour_table? } # === Colours.colour_methods_to_specific_colour?
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  pp Colours::HASH_NEW_COLOURS  
-end

data/lib/colours/commandline/menu.rb

@@ -1,122 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'colours/commandline/menu.rb'
-# =========================================================================== #
-module Colours
-
-  require 'colours/html_colours/html_colours.rb'
-  require 'colours/toplevel_methods/show_basic_colour_palette.rb'
-
-  # ========================================================================= #
-  # === Colours.menu                                               (menu tag)
-  #
-  # To invoke this method, try:
-  #
-  #   colours --show_html_colours
-  #   colours file?
-  #
-  # ========================================================================= #
-  def self.menu(
-      i = ::Colours.commandline?
-    )
-    if i.is_a? Array
-      i.each {|entry| menu(entry) }
-    else
-      case i # case tag
-      # ===================================================================== #
-      # === colours --version
-      #
-      # Show the current version of the colours gem.
-      # ===================================================================== #
-      when /^-?-?versions?\??$/i
-        show_the_version
-      # ===================================================================== #
-      # === 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
-        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',
-           /^-?-?open$/
-        open_this_file :then_exit
-      # ===================================================================== #
-      # === colours --file?
-      # ===================================================================== #
-      when /^-?-?file\??$/i,
-           'file','file?'
-        cliner {
-          e 'We will next read in from the default file, from:'
-          e
-          e "  #{sfile(TEST_FILE)}"
-          e
-          read_and_display_this_file
-        }
-      # ===================================================================== #
-      # === colours --project_base_directory?
-      # ===================================================================== #
-      when /^-?-?project(_|-)?base(_|-)?dir\??$/i,
-           /^-?-?project(_|-)?base(_|-)?directory\??$/i,
-           /^-?-?base(_|-)?dir\??$/i
-        e PROJECT_BASE_DIRECTORY
-      # ===================================================================== #
-      # === 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
-      end
-    end
-  end; self.instance_eval { alias check_against_menu menu } # === Colours.check_against_menu
-                                                            # Add an alias to the above. ^^^
-
-  # ========================================================================= #
-  # === menu                                                       (menu tag)
-  # ========================================================================= #
-  def menu(i = nil)
-    ::Colours.menu(i) # Delegate towards the class method above here.
-  end
-
-end

data/lib/colours/constants/escape.rb

@@ -1,22 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal =  true
-# =========================================================================== #
-# require 'colours/constants/escape.rb'
-# =========================================================================== #
-module Colours
-
-  # ========================================================================= #
-  # === Colours::ESC
-  #
-  # Escape sequences start with the character ESC (ASCII decimal 27/hex
-  # 0x1B/octal 033).
-  #
-  # The characters ESC and [ (left bracket) are called CSI, for "Control
-  # Sequence Initiator".
-  #
-  # Keep in mind that "\e" can be represented via "\u001b" in Ruby, too.
-  # ========================================================================= #
-  ESC = "\e["
-
-end

data/lib/colours/constants/file_constants.rb

@@ -1,73 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'colours/constants/file_constants.rb'
-# Colours.file_html_colours_to_rgb?
-# =========================================================================== #
-module Colours
-
-  require 'colours/project/project.rb'
-
-  # ========================================================================= #
-  # === Colours::FILE_HTML_COLOURS
-  # ========================================================================= #
-  FILE_HTML_COLOURS =
-    "#{PROJECT_BASE_DIRECTORY}yaml/html_colours.yml"
-
-  # ========================================================================= #
-  # === Colours::FILE_KDE_COLOUR_PALETTE
-  # ========================================================================= #
-  FILE_KDE_COLOUR_PALETTE =
-    "#{PROJECT_BASE_DIRECTORY}yaml/kde_colour_palette.yml"
-
-  # ========================================================================= #
-  # === Colours::FILE_256_COLOURS
-  # ========================================================================= #
-  FILE_256_COLOURS =
-    "#{PROJECT_BASE_DIRECTORY}yaml/256_colours.yml"
-
-  # ========================================================================= #
-  # === Colours::FILE_BASIC_COLOURS
-  # ========================================================================= #
-  FILE_BASIC_COLOURS =
-    "#{PROJECT_BASE_DIRECTORY}yaml/basic_colours.yml"
-
-  # ========================================================================= #
-  # === Colours::FILE_USE_THESE_VALUES_FOR_THE_COLOUR_METHODS
-  # ========================================================================= #
-  FILE_USE_THESE_VALUES_FOR_THE_COLOUR_METHODS =
-    "#{PROJECT_BASE_DIRECTORY}yaml/use_these_values_for_the_colour_methods.yml"
-
-  # ========================================================================= #
-  # === Colours::FILE_PREFER_THIS_COLOUR_SCHEMATA
-  # ========================================================================= #
-  FILE_PREFER_THIS_COLOUR_SCHEMATA =
-    "#{PROJECT_BASE_DIRECTORY}yaml/prefer_this_colour_schemata.yml"
-
-  # ========================================================================= #
-  # === Colours.file_html_colours_to_rgb?
-  #
-  # Easier toplevel-getter method to determine where the file for
-  # the html-colours-to-rgb conversion resides.
-  # ========================================================================= #
-  def self.file_html_colours_to_rgb?
-    "#{PROJECT_BASE_DIRECTORY}yaml/html_colours.yml"
-  end; self.instance_eval { alias file_html_colours  file_html_colours_to_rgb? } # === Colours.file_html_colours
-       self.instance_eval { alias file_html_colours? file_html_colours_to_rgb? } # === Colours.file_html_colours?
-
-  # ========================================================================= #
-  # === Colours.available_file_constants
-  # ========================================================================= #
-  def self.available_file_constants
-    [
-      FILE_HTML_COLOURS,
-      FILE_KDE_COLOUR_PALETTE
-    ]
-  end
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  pp Colours.available_file_constants  
-end

data/lib/colours/constants/hash_ansi_colours.rb

@@ -1,39 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'colours/constants/hash_ansi_colours.rb'
-# =========================================================================== #
-module Colours
-
-  # ========================================================================= #
-  # === HASH_ANSI_COLOURS
-  # ========================================================================= #
-  HASH_ANSI_COLOURS = {
-    black:             '30',
-    red:               '31',
-    green:             '32',
-    brown:             '33', # This is also known as yellow.
-    yellow:            '33',
-    blue:              '34',
-    purple:            '35', # Also known as magenta.
-    magenta:           '35',
-    light_magenta:     '35',
-    cyan:              '36',
-    light_gray:        '37',
-    grey:              '37',
-    white:             '37',
-    light_red:         '41',
-    background_black:  '40',
-    background_red:    '41',
-    background_green:  '42',
-    background_brown:  '43',
-    background_yellow: '43',
-    background_blue:   '44',
-    light_blue:        '44', # Alias to the above ^^^.
-    background_purple: '45',
-    background_cyan:   '46',
-    background_white:  '47',
-  }
-
-end