colours 0.5.52

data/lib/colours/toplevel_methods/misc.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/misc.rb'
+# =========================================================================== #
+module Colours
+
+  require 'colours/toplevel_methods/esystem.rb'
+  require 'colours/toplevel_methods/open_this_file.rb'
+  require 'colours/html_colours/misc.rb'
+
+  # ========================================================================= #
+  # === Colours.sanitize_line
+  #
+  # This method will replace one line with the proper R,G,B valid entries.
+  # ========================================================================= #
+  def self.sanitize_line(entry)
+    all_potential_matches = entry.scan(/<(\w+)>/).flatten
+    all_potential_matches.each {|substring|
+      entry.gsub!(/<\/>/, rev)
+      entry.gsub!(/<#{substring}>/, rgb_format(substring))
+    }
+    begin
+      require 'roebe/modules/remove_html.rb'
+    rescue LoadError; end
+    if Object.const_defined?(:Roebe) and
+       Roebe.respond_to?(:remove_html)
+      entry = Roebe.remove_html[entry]
+    end
+    return entry
+  end
+
+  # ========================================================================= #
+  # === Colours.read_and_display_this_file
+  #
+  # This method accepts a file path - in other words, the input should be
+  # the location of a specific file on your filesystem - and then simply
+  # reads in the content of said file via File.readlines().
+  #
+  # Content such as <slateblue> found in this file will be replaced
+  # with the respective R,G,B substring value.
+  #
+  # In the test/ subdirectory there is an example file for this - have
+  # a look there for more information.
+  # ========================================================================= #
+  def self.read_and_display_this_file(
+      i = TEST_FILE
+    )
+    i = i.to_s
+    if File.exist? i
+      new_array = []
+      data = File.readlines(i)
+      data.each {|entry|
+        # ======================================================================= #
+        # Check whether the entry has a <> tag:
+        # ======================================================================= #
+        if entry.include?('<') and entry.include?('>') and 
+           entry.include?('</>')
+          # ================================================================= #
+          # Ok, we may assume that something like <slateblue> is there.
+          # ================================================================= #
+          entry = sanitize_line(entry)
+        end
+        new_array << entry
+      }
+      e new_array # For now we will simply output that modified Array.
+    else
+      e "Notice: The file at `#{sfile(i)}` does not exist."
+    end
+  end; self.instance_eval { alias read_file read_and_display_this_file } # === Colours.read_file
+
+  # ========================================================================= #
+  # === Colours.does_this_line_include_a_html_colour?
+  #
+  # This method can be used to determine whether the given input-string
+  # contains a valid HTML colour or whether it does not.
+  #
+  # Returns: a boolean.
+  #
+  # Invocation examples:
+  #
+  #   Colours.does_this_line_include_a_html_colour? "<green>yo there</green> <orange>getline() function</orange>" # => true
+  #   Colours.does_this_line_include_a_html_colour? "foo bar" # => false
+  #
+  # ========================================================================= #
+  def self.does_this_line_include_a_html_colour?(
+      line
+    )
+    Colours.html_colours?.any? {|entry|
+      line.include? entry
+    }
+  end
+
+  # ========================================================================= #
+  # === Colours.convert_hex_to_rgb
+  #
+  # This method will convert e. g. #baf185 to [186, 241, 133]. Thus it
+  # will return an Array, denoting the R, G, B values.
+  #
+  # How to do this conversion on your own?
+  #
+  #   (1) Get the 2 left digits of the hex color code and convert
+  #       to decimal value to get the red color level.
+  #   (2) Get the 2 middle digits of the hex color code and
+  #       convert to decimal value to get the green color level.
+  #   (3) Get the 2 right digits of the hex color code and
+  #       convert to decimal value to get the blue color level.
+  #
+  # Usage example:
+  #
+  #   Colours.convert_hex_to_rgb('#baf185') # => [186, 241, 133]
+  #
+  # ========================================================================= #
+  def self.convert_hex_to_rgb(hex)
+    if hex.is_a? Array
+      hex = hex.first
+    end
+    hex = hex.to_s.dup
+    hex.delete!('#') if hex.include? '#'
+    array = [] # We will return this Array.
+    r = hex[0,2].to_i(16)
+    g = hex[2,2].to_i(16)
+    b = hex[4,2].to_i(16)
+    array << r << g << b
+    return array
+  end; self.instance_eval { alias hex_to_rgb convert_hex_to_rgb } # === Colours.hex_to_rgb
+
+end

data/lib/colours/toplevel_methods/open_this_file.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/open_this_file.rb'
+# =========================================================================== #
+require 'colours/toplevel_methods/esystem.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === self.open_this_file
+  # ========================================================================= #
+  def open_this_file(
+      shall_we_exit = false
+    )
+    case shall_we_exit
+    when :then_exit
+      shall_we_exit = true
+    end
+    _ = "bluefish #{__FILE__}"
+    esystem(_)
+    exit if shall_we_exit
+  end
+
+end

data/lib/colours/toplevel_methods/prefer_this_colour_schemata.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+# =========================================================================== #
+require 'colours/html_colours/add_html_colours_onto_the_toplevel_namespace.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === @prefer_this_colour_schemata
+  #
+  # The following Array ranks which colour schemata we will try to use.
+  # More important entries should come on top.
+  #
+  # Konsole will be the default, normally, followed by the 256 colours; and
+  # then the basic colours.
+  #
+  # Of course you can decide on your own via the .yml file, and other
+  # methods that allow us to change this setting, but when it comes
+  # to implementations such as for simp() or sfancy() then we will
+  # honour the setting in the yaml file (if we use any colours at all,
+  # that is). The yaml file is typically called
+  # "prefer_this_colour_schemata.yml".
+  # ========================================================================= #
+  @prefer_this_colour_schemata = YAML.load_file(FILE_PREFER_THIS_COLOUR_SCHEMATA)
+
+  # ========================================================================= #
+  # === @use_html_colours
+  #
+  # If the following variable is set to true then the HTML colours will
+  # be used, if available. These are colours such as 'slateblue' or
+  # 'crimson'.
+  # ========================================================================= #
+  @use_html_colours = false
+
+  # ========================================================================= #
+  # === @use_256_colours
+  # ========================================================================= #
+  @use_256_colours = false
+
+  # ========================================================================= #
+  # === @use_basic_colours
+  # ========================================================================= #
+  @use_basic_colours = false
+
+  # ========================================================================= #
+  # Next, we will set some other toplevel instance variables based on
+  # the value of this yaml file.
+  # ========================================================================= #
+  first_entry  = @prefer_this_colour_schemata[1]
+  _second_entry = @prefer_this_colour_schemata[2]
+  _third_entry  = @prefer_this_colour_schemata[3]
+
+  case first_entry
+  when :html_colours
+    @use_html_colours = true
+  when :support_for_256_colours
+    @use_256_colours = true
+  when :basic_colours
+    @use_basic_colours = true
+  end
+
+  # ========================================================================= #
+  # === Colours.prefer_which_colour_schemata?
+  # ========================================================================= #
+  def self.prefer_which_colour_schemata?
+    @prefer_this_colour_schemata[1]
+  end; self.instance_eval { alias prefer_which_colour_scheme? prefer_which_colour_schemata? } # === Colours.prefer_which_colour_scheme
+
+  # ========================================================================= #
+  # Designate @use_256_colours to true:
+  # ========================================================================= #
+  if prefer_which_colour_schemata? == :support_for_256_colours
+    @use_256_colours = true
+  end
+
+end

data/lib/colours/toplevel_methods/random_html_colour.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/random_html_colour.rb'
+# =========================================================================== #
+require 'colours/html_colours/misc.rb'
+
+module Colours
+
+# =========================================================================== #
+# === Colours.random_html_colour
+#
+# This method will simply return a (one) random HTML colour, in long
+# format, e. g. "teal" or "slateblue".
+#
+# If you wish to have it colourized properly, you need to use another
+# method.
+#
+# Usage examples:
+#   Colours.random_colour? # => "teal"
+#   Colours.random_colour? # => "blueviolet"
+# =========================================================================== # 
+def self.random_html_colour
+  ::Colours::HtmlColours.random_colour?
+end; self.instance_eval { alias random_colour?            random_html_colour } # === Colours.random_colour?
+     self.instance_eval { alias return_random_html_colour random_html_colour } # === Colours.return_random_html_colour
+
+# =========================================================================== #
+# === random_colour?
+# =========================================================================== #
+def random_colour?
+  ::Colours::HtmlColours.random_colour?
+end; alias random_colour             random_colour? # === random_colour
+     alias random                    random_colour? # === random
+     alias sample                    random_colour? # === sample
+     alias random_html_colour        random_colour? # === random_html_colour
+     alias return_random_html_colour random_colour? # === return_random_html_colour
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.random_colour? # => "teal" 
+end

data/lib/colours/toplevel_methods/random_value.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/random_value.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours.random_value?
+  #
+  # We will obtain a random value between 0 and 255, hence why we will
+  # use rand(256).
+  # ========================================================================= #
+  def self.random_value?
+    rand(256)
+  end; self.instance_eval { alias random_value random_value? } # === Colours.random_value
+       self.instance_eval { alias rvalue       random_value? } # === Colours.rvalue
+       self.instance_eval { alias r?           random_value? } # === Colours.r?
+       self.instance_eval { alias g?           random_value? } # === Colours.g?
+       self.instance_eval { alias b?           random_value? } # === Colours.b?
+
+  # ========================================================================= #
+  # === random_value
+  #
+  # We will obtain a random value between 0 and 255, hence why we will
+  # use rand(256). 
+  # ========================================================================= #
+  def random_value?
+    Colours.random_value?
+  end; alias rvalue       random_value? # === rvalue
+       alias random_value random_value? # === random_value
+       alias r?           random_value? # === r?
+       alias g?           random_value? # === g?
+       alias b?           random_value? # === b?
+
+end

data/lib/colours/toplevel_methods/remove_escape_sequence.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/remove_escape_sequence.rb'
+# =========================================================================== #
+module Colours
+
+  require 'colours/constants/colour_constants.rb'
+
+  # ========================================================================= #
+  # === Colours.remove_escape_sequence
+  #
+  # The method Colours.remove_escape_sequence() will remove all Ansi 
+  # Escape sequences from a given string.
+  # ========================================================================= #
+  def self.remove_escape_sequence(i)
+    i = i.to_s.dup
+    # ======================================================================= #
+    # Iterate over the registered ansi-colours next.
+    # ======================================================================= #
+    ARRAY_REGISTERED_ANSI_COLOURS.each {|entry|
+      if i.include? entry
+        entry = Regexp.quote(entry)
+        i.sub!(/#{entry}/, '')
+      end
+      # ===================================================================== #
+      # Next, check for KDE konsole colours. We must use "" there, not ''.
+      # ===================================================================== #
+      if i.include?("\e[") and i =~ /\d+m/ # Such as: "\e[38;2;220;20;60m|"
+        # =================================================================== #
+        # The next regex will (hopefully) remove all escape-characters
+        # from the given String.
+        # =================================================================== #
+        regex_for_html_colours = # Detect entries such as: \e[38;2;106;90;205m
+          /(\e\[\d{2};\d{1};\d{3};\d{1,2};\d{3}m)/ # See: https://rubular.com/r/tG3XeOK5NPsfmI
+        i.gsub!(regex_for_html_colours, '')
+        # =================================================================== #
+        # See: https://rubular.com/r/SdS28fAGSxIELn
+        # =================================================================== #
+        # /(\\e\[\d{1,2};?\d{1,2};?\d{0,3};?\d{0,3};?\d{1,2}m|\\e\[\d{0,2}m|\\e\[K|\\e\[\d{0,2};\d{0,2}m|(\\e\[.+\dm)|\\e\[0;37m)/
+        [
+          /\e\[\d{1,2};?\d{1,2};?\d{0,3};?\d{0,3};?\d{1,2}m/,
+          /\\e\[\d{0,2}m|\\e\[K|\\e\[\d{0,2};\d{0,2}m/,
+          /\\e\[.+\dm/,
+          /\\e\[0;37m/
+        ].each {|regex_to_use|
+          i.gsub!(regex_to_use, '')
+        }
+      end
+    }
+    return i
+  end; self.instance_eval { alias remove                  remove_escape_sequence } # === Colours.remove
+       self.instance_eval { alias remove_escape_sequences remove_escape_sequence } # === Colours.remove_escape_sequences
+       self.instance_eval { alias remove_colours          remove_escape_sequence } # === Colours.remove_colours
+       self.instance_eval { alias escape                  remove_escape_sequence } # === Colours.escape
+
+  # ========================================================================= #
+  # === Colours.remove_trailing_end_from
+  #
+  # The second argument to this method can be the escape sequence that you
+  # wish to remove.
+  #
+  # Invocation example:
+  #
+  #   x = Colours.remove_trailing_end_from("\e[38;2;70;130;180m\e[0;37m") # => "\e[38;2;70;130;180m"
+  #
+  # ========================================================================= #
+  def self.remove_trailing_end_from(
+      i,
+      remove_this_escape_sequence = Colours.revert?
+    )
+    quoted = Regexp.quote(remove_this_escape_sequence)
+    # ======================================================================= #
+    # Anchor it at the end via $.
+    # ======================================================================= #
+    return i.sub(
+      /#{quoted}$/, ''
+    )
+  end; self.instance_eval { alias remove_trailing_escape_part       remove_trailing_end_from } # === Colours.remove_trailing_escape_part
+       self.instance_eval { alias remove_trailing_ansii_escape_code remove_trailing_end_from } # === Colours.remove_trailing_ansii_escape_code
+       self.instance_eval { alias remove_trailing_ANSII_escape_code remove_trailing_end_from } # === Colours.remove_trailing_ANSII_escape_code
+       self.instance_eval { alias remove_trailing_escape_code       remove_trailing_end_from } # === Colours.remove_trailing_escape_code
+       self.instance_eval { alias remove_trailing_code              remove_trailing_end_from } # === Colours.remove_trailing_code
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  begin
+    require 'colours/autoinclude'
+  rescue LoadError; e 'the colours gem is not available.'; end
+  include Colours
+  e
+  e 'Next testing an escape sequence (which will be shown via pp only):'
+  e
+  x = "\e[01m\e[Kcc1:\e[m\e[K \e[01;35m\e[Kwarning: \e[m\e[K-Wabi won't warn about anything [\e[01;35m\e[K-Wabi\e[m\e[K]
+
+A\e[38;2;220;20;60m|AGCTT"
+  pp x
+  e
+  x = Colours.remove_escape_sequence(x)
+  e
+  pp x
+  e x
+  pp Colours.remove_escape_sequences(Colours.slateblue('Hello world!')) # => "\e[38;2;106;90;205mHello world!"
+  p Colours.slateblue('Hello world!') # => "\e[38;2;106;90;205mHello world!\e[0;37m"
+end

data/lib/colours/toplevel_methods/set_last_colour_used.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/set_last_colour_used.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === @last_colour_used
+  #
+  # This instance variable keeps track what the last colour used was.
+  # ========================================================================= #
+  @last_colour_used = nil
+
+  # ========================================================================= #
+  # === last_colour_used?
+  #
+  # Tell us which colour was used last.
+  # ========================================================================= #
+  def last_colour_used?
+    @last_colour_used.to_s # Always required a string.
+  end
+
+  # ========================================================================= #
+  # === Colours.set_last_colour_used
+  # ========================================================================= #
+  def self.set_last_colour_used(i)
+    @last_colour_used = i
+  end
+
+end