colours 0.5.52

data/lib/colours/constants/file_constants.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/constants/file_constants.rb'
+# Colours.file_html_colours_to_rgb?
+# =========================================================================== #
+require 'colours/project/project_base_directory.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === 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_simple_colours.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal =  true
+# =========================================================================== #
+# require 'colours/constants/hash_simple_colours.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours::HASH_SIMPLE_COLOURS
+  #
+  # This hash will only store one name for the corresponding colour code.
+  # ========================================================================= #
+  HASH_SIMPLE_COLOURS = {
+    black:         '0;30',
+    red:           '0;31',
+    green:         '0;32',
+    yellow:        '0;33',
+    blue:          '0;34',
+    magenta:       '0;35',
+    cyan:          '0;36',
+    light_gray:    '0;37',
+    # ======================================================================= #
+    # Next, the secondary-colours:
+    # ======================================================================= #
+    dark_gray:     '1;30',
+    light_red:     '1;31',
+    light_green:   '1;32',
+    brown:         '1;33',
+    light_blue:    '1;34',
+    light_magenta: '1;35',
+    light_cyan:    '1;36',
+    white:         '1;37'
+  }
+
+  # ========================================================================= #
+  # === Colours::MAIN_COLOURS
+  #
+  # The main colours come next.
+  #
+  # Eight main colours are currently defined, according to:
+  #
+  #   http://en.wikipedia.org/wiki/ANSI_escape_code#Colors
+  #
+  # The range is:
+  #
+  #   Intensity:     0    1    2      3     4      5      6    7
+  #   Normal:     Black  Red Green Yellow  Blue  Magenta Cyan White
+  #
+  # Yellow, in my opinion, looks more like brown.
+  # ========================================================================= #
+  MAIN_COLOURS = %i(
+    black red green yellow blue magenta teal white
+  ) # ^^^ An Array of Symbols.
+
+  # ========================================================================= #
+  # === Colours.available_main_colours?
+  #
+  # Feedback which main colours are available.
+  # ========================================================================= #
+  def self.available_main_colours?
+    MAIN_COLOURS
+  end; self.instance_eval { alias available_basic_colours? available_main_colours? } # === Colours.available_basic_colours?
+
+  # ========================================================================= #
+  # === main_colours
+  #
+  # This will return an Array with the symbols such as
+  # :black, :red etc.. 
+  # ========================================================================= #
+  def main_colours
+    ::Colours.available_main_colours?
+  end
+
+  # ========================================================================= #
+  # === Colours::SECONDARY_COLOURS
+  #
+  # The secondary Colours.
+  #
+  # Colours which are not part of the MAIN_COLOURS Array.
+  #
+  # The secondary colours are:
+  #
+  #   Bright Black
+  #   Bright Red
+  #   Bright Green
+  #   Bright Yellow
+  #   Bright Blue
+  #   Bright Magenta
+  #   Bright Cyan
+  #   Bright White
+  #
+  # ========================================================================= #
+  SECONDARY_COLOURS = [
+    :bright_black,
+    :bright_red,
+    :bright_green,
+    :bright_yellow,
+    :bright_blue,
+    :bright_magenta,
+    :bright_cyan,
+    :bright_white
+  ]
+
+  # ========================================================================= #
+  # === ALL_COLOURS
+  #
+  # Simply combine the two Arrays, MAIN_COLOURS and SECONDARY_COLOURS,
+  # into one aggregate Array.
+  # ========================================================================= #
+  ALL_COLOURS = MAIN_COLOURS +
+                SECONDARY_COLOURS
+
+  # ========================================================================= #
+  # === Colours.really_all_colours
+  #
+  # This method will return an Array that may look like this:
+  #
+  #   [:black, :red, :green, :yellow, :blue, :magenta, :teal,
+  #    :white, :bright_black, :bright_red, :bright_green,
+  #    :bright_yellow, :bright_blue, :bright_magenta,
+  #    :bright_cyan, :bright_white]
+  #
+  # ========================================================================= #
+  def self.really_all_colours
+    ALL_COLOURS # This is the conjoint Array.
+  end; self.instance_eval { alias all_available_colours really_all_colours } # === Colours.all_available_colours
+
+  # ========================================================================= #
+  # === Colours.is_a_valid_colour?
+  #
+  # This method allows you to check if a given input-string is a
+  # valid colour.
+  #
+  # A "valid" colour is one that the colours project supports.
+  #
+  # For example, the string "lightblue" is a valid colour.
+  #
+  # Usage example:
+  #   Colours.is_a_valid_colour? 'lightblue'
+  # ========================================================================= #
+  def self.is_a_valid_colour?(i)
+    ALL_COLOURS.include? i.to_sym
+  end
+
+end

data/lib/colours/constants/misc.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal =  true
+# =========================================================================== #
+# require 'colours/constants/misc.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === HOME_DIRECTORY_OF_USER_X
+  # ========================================================================= #
+  HOME_DIRECTORY_OF_USER_X = '/home/x/'
+
+  # ========================================================================= #
+  # === Colours::DEFAULT_TEXT
+  # ========================================================================= #
+  DEFAULT_TEXT = 'Hello World!'
+
+  # ========================================================================= #
+  # === Colours::IS_A_TEST
+  # ========================================================================= #
+  IS_A_TEST = ' This is just a simple colour test.' 
+
+  # ========================================================================= #
+  # === Colours::TEST_FILE
+  # ========================================================================= #
+  TEST_FILE =
+    "#{HOME_DIRECTORY_OF_USER_X}DATA/PROGRAMMING_LANGUAGES/RUBY/src/colours/test/testing_konsole_submodule.rb"
+
+  # ========================================================================= #
+  # === LEFT
+  #
+  # Leading on the left side, for RGB value setting. This is the beginning
+  # of a special instruction. Note that "\e[38" should be equal to "\x1b",
+  # but IRB reports that this is not the case so.
+  #
+  # Examples on the www show usage such as this:
+  #
+  #   printf "\x1b[${bg};2;${red};${green};${blue}m\n"
+  #   printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"
+  # 
+  # ========================================================================= #
+  LEFT = "\e[38;2;".dup
+
+  # ========================================================================= #
+  # === Colours.left?
+  # ========================================================================= #
+  def self.left?
+    LEFT
+  end
+
+  # ========================================================================= #
+  # === left?
+  # ========================================================================= #
+  def left?
+    Colours.left?
+  end
+
+end

data/lib/colours/constants/newline.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/constants/newline.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+end

data/lib/colours/constants/registered_colour_methods.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/constants/registered_colour_methods.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours::REGISTERED_COLOUR_METHODS
+  #
+  # These methods constitute the registered colour methods.
+  #
+  # These have a corresponding method, such as snormal() or sdir() or
+  # sfile().
+  #
+  # snormal() stands for the "normal" colour, aka the "default
+  # colour".
+  # ========================================================================= #
+  REGISTERED_COLOUR_METHODS = %i(
+    snormal
+    sargument
+    scomments
+    ssymlink
+    sdir
+    sfile
+    sfancy
+    simportant
+    swarn
+  )
+
+  # ========================================================================= #
+  # === REGISTERED_COLOUR_METHODS_ALIASES
+  #
+  # This Array should hold all aliases to the main colour-methods,
+  # such as simportant() or sargument().
+  # ========================================================================= #
+  REGISTERED_COLOUR_METHODS_ALIASES = %i(
+    argument
+    ssym
+    simp
+    sarg
+    normal
+    comments
+    symlink
+    dir
+    file
+    fancy
+    important
+    warn
+  )
+
+end

data/lib/colours/e.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/e/e.rb'

data/lib/colours/e/README.md

@@ -0,0 +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:
+
+    alias e puts
+
+So in other words, I would be using "e" rather than
+puts, in order to do output.
+
+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.

data/lib/colours/e/autoinclude.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This .rb file will just autoinclude Colours::E into the main namespace.
+# =========================================================================== #
+# require 'colours/e/autoinclude.rb'
+# =========================================================================== #
+require 'colours/e/e.rb'
+
+include Colours::E

data/lib/colours/e/e.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Colours::E
+#
+# require 'colours/e/e.rb'
+# include ::Colours::E
+# =========================================================================== #
+module Colours
+
+module E # === Colours::E
+
+  # ========================================================================= #
+  # === Colours::E.e
+  # ========================================================================= #
+  def self.e(i = '')
+    if i.is_a? Array
+      i = i.join(' ')
+    end
+    puts i
+  end; self.instance_eval { alias [] e } # === Colours::E[]
+
+  # ========================================================================= #
+  # === e
+  # ========================================================================= #
+  def e(i = '')
+    ::Colours::E.e(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Colours::E.e(ARGV)
+end

data/lib/colours/eparse/eparse.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/eparse/eparse.rb'
+# =========================================================================== #
+require 'colours/toplevel_methods/e.rb'
+require 'colours/constants/colour_constants.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.eparse
+  #
+  # This method primarily exists because we can easily split a string
+  # if it has a '#' token. The part that comes after the '#' token is
+  # assumed to be a comment or an explanation.
+  # ========================================================================= #
+  def self.eparse(i = '')
+    Colours.e(rparse(i))
+  end
+
+  # ========================================================================= #
+  # === Colours.rparse
+  #
+  # This method will return a string; the method eparse will output that
+  # (colourized) String.
+  # ========================================================================= #
+  def self.rparse(i = '')
+    _ = i.to_s # We require a String.
+    split_at = ':' # <- Split at this character.
+    # ======================================================================== #
+    # If the input does not include a ':' but it does include a '#', then
+    # we will use that character instead.
+    #
+    # However had, as of Jun 2017, I have disabled that check. Now '#' will
+    # always overrule. My reasoning now is that '#' is more important than
+    # ':', if it is part of the input-string.
+    # ======================================================================== #
+    split_at = '#' if _.include? '#'
+    first_colour  = COLOUR_GREEN
+    second_colour = COLOUR_TEAL
+    if i.include? split_at
+      splitted = _.split(split_at)
+      _ = first_colour+
+          splitted.first+
+          split_at+
+          second_colour+
+          splitted[1..-1].join(split_at).dup
+      _ << REVERT
+    elsif i.include? ' '
+      split_at = ' '
+      splitted = _.split(/ /)
+      index = splitted.find_index {|e| ! e.empty? }
+      _ = first_colour+splitted[0..index].join(' ')+split_at+
+          second_colour+splitted[index+1..-1].join(' ').dup
+      _ << REVERT
+    end
+    return _
+  end
+
+  # ========================================================================== #
+  # === eparse                                                    (eparse tag)
+  #
+  # Input could be like this:
+  #   eparse 'Foo: bla'
+  #   eparse 'Foo: '+bla
+  # ========================================================================== #
+  def eparse(i = '')
+    Colours.eparse(i)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Colours.eparse('Hello there # how do you do, this is a test')
+end