colours 0.5.41

data/lib/colours/toplevel_methods/remove_escape_sequence.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/remove_escape_sequence.rb'
+# =========================================================================== #
+require 'colours/constants/colour_constants.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === 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
+
+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/show_basic_colour_palette.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal =  true
+# =========================================================================== #
+# require 'colours/toplevel_methods/show_basic_colour_palette.rb'
+# =========================================================================== #
+require 'colours/constants/hash_simple_colours.rb'
+require 'colours/toplevel_methods/cliner.rb'
+require 'colours/toplevel_methods/e.rb'
+require 'colours/toplevel_methods/make_colour.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.show_basic_colour_palette
+  #
+  # This will show a colour palette on the commandline.
+  # ========================================================================= #
+  def self.show_basic_colour_palette
+    e
+    MAIN_COLOURS.reject {|e| e == :black }.each { |entry|
+      make_colour(entry) # make_colour() is defined in this file here.
+    }
+    cliner
+    SECONDARY_COLOURS.each { |entry|
+      make_colour(entry)
+    }
+    e
+  end; self.instance_eval { alias show_palette        show_basic_colour_palette } # === Colours.show_palette
+       self.instance_eval { alias show_colour_palette show_basic_colour_palette } # === Colours.show_colour_palette
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Colours.show_basic_colour_palette
+end # show_basic_colour_palette

data/lib/colours/toplevel_methods/underline.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will handline underline-functionality in a terminal. It
+# supports basic colours and the HTML colours.
+# =========================================================================== #
+# require 'colours/toplevel_methods/underline.rb'
+# Colours.return_underline
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/toplevel_methods/e.rb'
+require 'colours/rgb/rgb.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === UNDERLINE_CODE
+  #
+  # To quickly test the underline-functionality, you can try:
+  #
+  #   echo -e "\e[4mone two three\e[23m" 
+  #
+  # ========================================================================= #
+  UNDERLINE_CODE = '4'
+
+  # ========================================================================= #
+  # === Colours.return_underline
+  #
+  # Usage example:
+  #
+  #   puts ' ok | '+Colours.return_underline('Hello world!')+' | ok'
+  #   puts ' ok | '+Colours.return_underline('Hello world!') { :slateblue }+' | ok'
+  #
+  # ========================================================================= #
+  def self.return_underline(
+      show_this_text = 'This must be underline.',
+      make_newline   = false
+    )
+    # ===================================================================== #
+    # Build up our main string that codes for underline.
+    # ===================================================================== #
+    result = "\x1b".dup
+    result << '['
+    result << UNDERLINE_CODE
+    if block_given?
+      # ===================================================================== #
+      # Right now we assume that this must be a colour.
+      # ===================================================================== #
+      result << ";38;2;"
+      result << colour_to_rgb_value(yield)
+    end
+    result << 'm'
+    if make_newline
+      show_this_text = "#{show_this_text}\n"
+    end
+    result << show_this_text
+    result << REVERT
+    result
+  end; self.instance_eval { alias string_underline return_underline } # === Colours.string_underline
+
+  # ========================================================================= #
+  # === Colours.underline
+  #
+  # This method will "puts" the result of applying underline to a string,
+  # on the console/terminal. If you wish to do the output on your own
+  # then you have to use the method Colours.return_underline or its
+  # alias called Colours.string_underline.
+  #
+  # To test this, try:
+  #   Colours.underline('Hello world!')
+  # ========================================================================= #
+  def self.underline(
+      i            = '', 
+      make_newline = false,
+      &block
+    )
+    e return_underline(i, make_newline, &block)
+  end
+
+  # ========================================================================= #
+  # === underline
+  # ========================================================================= #
+  def underline(
+      i            = '',
+      make_newline = false
+    )
+    Colours.underline(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  if ARGV.empty?
+    puts Colours.underline('Hello world!')
+    puts 'Hello world!'
+    # ======================================================================= #
+    # And then run some more tests:
+    # ======================================================================= #
+    require 'colours/toplevel_methods/use_colours.rb'
+    Colours.enable_html_colours
+    e Colours.palegreen('in palegreen:')
+    print '  '; print Colours.underline(txt) { :palegreen }
+    e Colours.slateblue('in slateblue:')
+    print '  '; print Colours.underline(txt) { :slateblue }
+    e Colours.orange('in orange:')
+    print '  '; print Colours.underline(txt) { :orange }
+    e Colours.crimson('in crimson:')
+    print '  '; print Colours.underline(txt) { :crimson }
+  else
+    puts Colours.underline(ARGV.join(' ').strip)
+    puts Colours.underline(ARGV.join(' ').strip) { :crimson }
+  end
+end # underline one TWO three

data/lib/colours/toplevel_methods/use_colours.rb

@@ -0,0 +1,311 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/use_colours.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === @last_colour_used
+  #
+  # This instance variable keeps track what the last colour used was.
+  # ========================================================================= #
+  @last_colour_used = nil
+
+  # ========================================================================= #
+  # === @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.disable_konsole_colours
+  #
+  # Disable the KDE-Konsole colours.
+  # ========================================================================= #
+  def self.disable_konsole_colours
+    @use_html_colours = false
+  end
+
+  # ========================================================================= #
+  # === 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_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
+
+  # ========================================================================= #
+  # === 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
+
+# =========================================================================== #
+# This file includes a standalone Colour class, as part of the
+# Colours namespace.
+# =========================================================================== #
+class Colour # === Colours::Colour
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      optional_input = nil
+    )
+    reset
+    set_input(optional_input) if optional_input
+  end
+
+  # ========================================================================= #
+  # === set_r
+  # ========================================================================= #
+  def set_r(i = nil)
+    @r = i
+  end
+
+  # ========================================================================= #
+  # === set_g
+  # ========================================================================= #
+  def set_g(i = nil)
+    @g = i
+  end
+
+  # ========================================================================= #
+  # === set_b
+  # ========================================================================= #
+  def set_b(i = nil)
+    @b = i
+  end
+
+  # ========================================================================= #
+  # === random_colour?
+  # ========================================================================= #
+  def random_colour?(
+      optional_text = nil
+    )
+    if optional_text
+      write_this_in_random_colour(optional_text)
+    else
+      ::Colours.random_colour?
+    end
+  end
+
+  # ========================================================================= #
+  # === set_rgb
+  # ========================================================================= #
+  def set_rgb(r,g,b)
+    set_r(r)
+    set_g(g)
+    set_b(b)
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = nil)
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    set_r
+    set_g
+    set_b
+  end
+
+  # ========================================================================= #
+  # === r?
+  # ========================================================================= #
+  def r?
+    @r
+  end
+
+  # ========================================================================= #
+  # === g?
+  # ========================================================================= #
+  def g?
+    @g
+  end
+
+  # ========================================================================= #
+  # === b?
+  # ========================================================================= #
+  def b?
+    @b
+  end
+
+  # ========================================================================= #
+  # === output_this_string
+  # ========================================================================= #
+  def output_this_string(
+      i = DEFAULT_TEXT+N,
+      r = r?,
+      g = g?,
+      b = b?
+    )
+    result = return_this_string(i,r,g,b)
+    e result
+  end; alias output_this                 output_this_string # === output_this
+       alias output                      output_this_string # === output
+       alias write_this_in_random_colour output_this_string # === write_this_in_random_colour
+
+  # ========================================================================= #
+  # === return_this_string
+  # ========================================================================= #
+  def return_this_string(
+      i = DEFAULT_TEXT+N,
+      r = r?,
+      g = g?,
+      b = b?
+    )
+    i = DEFAULT_TEXT if i == :default
+    i = i.join(' ') if i.is_a? Array
+    i = i.to_s.dup
+    i = build_this_rgb_string(r, g, b)+i
+    return i
+  end
+
+  # ========================================================================= #
+  # === build_this_rgb_string
+  # ========================================================================= #
+  def build_this_rgb_string(r, g, b)
+    Colours.build_this_rgb_string(r,g,b)
+  end
+
+  # ========================================================================= #
+  # === random_colour
+  #
+  # Return a random colour here.
+  # ========================================================================= #
+  def random_colour(this_string_to_display = 'test')
+    return_this_string(
+      this_string_to_display, random_value, random_value, random_value
+    )
+  end; alias return_random_colour random_colour # === return_random_colour
+
+  # ========================================================================= #
+  # === seed_rgb_values
+  #
+  # Use this method to randomly obtain R,G,B values.
+  # ========================================================================= #
+  def seed_rgb_values
+    set_rgb(random_value, random_value, random_value)
+  end
+
+  # ========================================================================= #
+  # === random_value
+  # ========================================================================= #
+  def random_value
+    rand(255)
+  end
+
+end; end

data/lib/colours/utility_scripts/README.md

@@ -0,0 +1,2 @@
+This directory will contain code that is mostly "supportive" of the
+Colours project, but normally won't be needed for most users.