colours 0.5.55

data/lib/colours/kde_colour_palette/kde_colour_palette.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/kde_colour_palette/kde_colour_palette.rb'
+# =========================================================================== #
+require 'yaml'
+require 'colours/constants/file_constants.rb'
+require 'colours/rgb/rgb.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours::KDE_COLOUR_PALETTE
+  #
+  # The format for the following Hash is this:
+  #   - The key is the name of the colour at hand
+  #   - There are two values per name. The first is the hex value,
+  #     and the second is the R,G,B value stored as a Hash.
+  # ========================================================================= #
+  if File.exist? FILE_KDE_COLOUR_PALETTE
+    KDE_COLOUR_PALETTE = YAML.load_file(FILE_KDE_COLOUR_PALETTE)
+  else
+    KDE_COLOUR_PALETTE = {}
+  end
+
+  # ========================================================================= #
+  # Next, we will batch-define the KDE colour palette as class methods.
+  #
+  # To test this, you can try:
+  #
+  #   Colours.kde_colour_palette_icon_yellow 'Hello world!'
+  #
+  # ========================================================================= #
+  KDE_COLOUR_PALETTE.keys.each {|this_key|
+    short_symbol_name_for_the_key = this_key.downcase.tr(' ','_').to_sym
+    use_this_as_method_name = ('kde_colour_palette_'+short_symbol_name_for_the_key.to_s).to_sym
+    unless Colours.respond_to? use_this_as_method_name
+      self.class.class_eval {
+        define_method(use_this_as_method_name) {|output_this_text = ''| # Allow input.
+          Colours.return_this_via_kde_colour_palette(output_this_text, short_symbol_name_for_the_key)
+        }
+        # =================================================================== #
+        # The next enables colours such as:
+        #
+        #   Colours.pimpinella 'Hello cats!'
+        #
+        # =================================================================== #
+        define_method(short_symbol_name_for_the_key.to_sym) {|output_this_text = ''| # Allow input.
+          Colours.return_this_via_kde_colour_palette(output_this_text, short_symbol_name_for_the_key.to_sym)
+        }
+        # =================================================================== #
+        # The next enables colours such as:
+        #   Colours.epimpinella 'Hello cats!'
+        # =================================================================== #
+        define_method(('e'+short_symbol_name_for_the_key.to_s).to_sym) {|output_this_text = ''| # Allow input.
+          Colours.write_this_via_kde_colour_palette(output_this_text, short_symbol_name_for_the_key.to_sym)
+        }
+      }
+    end
+  }
+      
+  # ========================================================================= #
+  # === Colours.return_this_via_kde_colour_palette
+  #
+  # To invoke this method, try:
+  #
+  #   Colours.return_this_via_kde_colour_palette 'Hello world!'
+  #   Colours.return_this_via_kde_colour_palette 'Hello world!', :random
+  #   Colours.return_this_via_kde_colour_palette 'Hello world!', :plasma_blue
+  #
+  # ========================================================================= #
+  def self.return_this_via_kde_colour_palette(
+      this_text   = '',
+      this_colour = 'Pimpinella'
+    )
+    use_this_rgb_value_array = []
+    case this_colour
+    when :random # Pick a random colour in this case.
+      this_colour = KDE_COLOUR_PALETTE.keys.sample
+    else
+      if this_colour.is_a? Symbol
+        if this_colour.to_s.include? '_'
+          # ================================================================= #
+          # In this case, try to convert it.
+          # ================================================================= #
+          this_colour = this_colour.to_s.split('_').map(&:capitalize).join(' ')
+        else
+          this_colour = this_colour.to_s.capitalize
+        end
+      end
+    end
+    if KDE_COLOUR_PALETTE.has_key? this_colour
+      use_this_rgb_value_array = KDE_COLOUR_PALETTE[this_colour][1]
+    end
+    # ======================================================================= #
+    # Finally return the text, in the corresponding colour at hand.
+    # ======================================================================= #
+    return Colours.rgb_value_as_escape_code_string(use_this_rgb_value_array)+
+           this_text+
+           rev
+  end
+
+  # ========================================================================= #
+  # === Colours.write_this_via_kde_colour_palette
+  #
+  # To invoke this method, try:
+  #   Colours.write_this_via_kde_colour_palette 'Hello world!'
+  #   Colours.write_this_via_kde_colour_palette 'Hello world!', :random
+  #   Colours.write_this_via_kde_colour_palette 'Hello world!', :plasma_blue
+  # ========================================================================= #
+  def self.write_this_via_kde_colour_palette(
+      this_text      = '',
+      this_colour    = 'Pimpinella',
+      append_newline = true
+    )
+    result = Colours.return_this_via_kde_colour_palette(this_text, this_colour)
+    if append_newline
+      result << "#{N}"
+    end
+    print result
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp Colours::KDE_COLOUR_PALETTE.keys
+end

data/lib/colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb

@@ -0,0 +1,219 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
+# =========================================================================== #
+require 'colours/constants/colour_constants.rb'
+require 'colours/constants/hash_simple_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.map_symbol_to_corresponding_colour                 (menu tag)
+  #
+  # This method will accept a symbol as input, such as :bold_blue, and
+  # return the corresponding CONSTANT (or rather, the value this constant
+  # refers to). This allows us to "map" the respective symbol to the
+  # corresponding constant.
+  #
+  # For example, the Symbol :bold_blue will correspond to the BOLD_BLUE
+  # constant. The Symbol :bold_green will correspond to the BOLD_GREEN
+  # constant (or COLOUR_BOLD_GREEN; there are some "aliases" on the
+  # constant-level as well). This constant thus represents the symbol
+  # at hand.
+  #
+  # Take note that this method here has several aliases:
+  #
+  #   Colours.translate()
+  #   Colours.beautify()
+  #   Colours.convert()
+  #   Colours.parse()
+  #   Colours.map_colour_to_constant()
+  #
+  # This is partially due to historic reasons; and partially simply
+  #  because some of them are shorter and hence easier to type.
+  #
+  # Usage example for this method:
+  #
+  #   Colours.beautiful(:bold_blue)
+  #
+  # ========================================================================= #
+  def self.map_symbol_to_corresponding_colour(i)
+    if i.is_a? String # Handle Strings as well.
+      # ===================================================================== #
+      # === random
+      # ===================================================================== #
+      if i == 'random' # Fetch a random entry in this case.
+        i = MAIN_COLOURS.sample
+      end
+      i = i.tr(' ','_').to_sym
+    end
+    case i # case tag
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default,
+         :si,
+         :default_colour,
+         :defaultcolour,
+         :normal,
+         nil
+      return DEFAULT_COLOUR
+    # ======================================================================= #
+    # === :bold_green
+    # ======================================================================= #
+    when :bold_green,
+         :boldgreen,
+         :bright_green,
+         :greenb,
+         :lightgreen
+      return BOLD_GREEN
+    # ======================================================================= #
+    # === :bold_brown
+    # ======================================================================= #
+    when :bold_brown,
+         :bbrown,
+         :gold,
+         :saddlebrown
+      return BOLD_BROWN
+    # ======================================================================= #
+    # === :white
+    # ======================================================================= #
+    when :white,
+         :whitebonblack
+      return WHITE
+    # ======================================================================= #
+    # === :red
+    # ======================================================================= #
+    when :red
+      return RED
+    # ======================================================================= #
+    # === :light_grey
+    # ======================================================================= #
+    when :light_grey,
+         :grey
+      return COLOUR_LIGHT_GREY
+    # ======================================================================= #
+    # === :pink
+    # ======================================================================= #
+    when :pink,
+         :bright_magenta
+      return BRIGHT_MAGENTA
+    # ======================================================================= #
+    # === :bright_cyan
+    # ======================================================================= #
+    when :bright_cyan,
+         :cyanb,
+         :cyan
+      return BOLD_CYAN
+    # ======================================================================= #
+    # === :brown
+    # ======================================================================= #
+    when :brown
+      return BROWN
+    # ======================================================================= #
+    # === :yellow
+    # ======================================================================= #
+    when :yellow,
+         :yel
+      return YELLOW
+    # ======================================================================= #
+    # === :green
+    # ======================================================================= #
+    when :green,
+         :greengreen
+      return GREEN
+    # ======================================================================= #
+    # === :blue
+    # ======================================================================= #
+    when :blue
+      return BLUE
+    # ======================================================================= #
+    # === :magenta
+    # ======================================================================= #
+    when :magenta
+      return MAGENTA
+    # ======================================================================= #
+    # === :teal
+    # ======================================================================= #
+    when :teal
+      return TEAL
+    # ======================================================================= #
+    # === :revert
+    # ======================================================================= #
+    when :revert,
+         :reset,
+         :clear
+      return REVERT
+    # ======================================================================= #
+    # === :bold_red
+    # ======================================================================= #
+    when :bold_red,
+         :boldred,
+         :bright_red,
+         :lightred,
+         :redb
+      return BOLD_RED
+    # ======================================================================= #
+    # === :lightblue
+    # ======================================================================= #
+    when :lightblue
+      return LIGHTBLUE
+    # ======================================================================= #
+    # === :bold_yellow
+    # ======================================================================= #
+    when :bold_yellow,
+         :boldyellow,
+         :yelb,
+         :bright_yellow,
+         :byellow
+      return BOLD_YELLOW
+    # ======================================================================= #
+    # === :bold_blue
+    # ======================================================================= #
+    when :bold_blue,
+         :boldblue,
+         :bright_blue,
+         :blueb
+      return BOLD_BLUE
+    # ======================================================================= #
+    # === :bold_white
+    # ======================================================================= #
+    when :bold_white,
+         :boldwhite,
+         :bright_white
+      return BOLD_WHITE
+    # ======================================================================= #
+    # === :black
+    # ======================================================================= #
+    when :black,
+         :bold_black,
+         :boldblack,
+         :bright_black
+      return COLOUR_BLACK
+    else
+      puts "Unknown symbol given as input: #{i}"
+      pp i
+    end
+    i # else return the input-argument again.
+  end; self.instance_eval { alias beautiful              map_symbol_to_corresponding_colour } # === Colours.beautiful
+       self.instance_eval { alias beautify               map_symbol_to_corresponding_colour } # === Colours.beautify
+       self.instance_eval { alias translate              map_symbol_to_corresponding_colour } # === Colours.translate
+       self.instance_eval { alias convert                map_symbol_to_corresponding_colour } # === Colours.convert
+       self.instance_eval { alias parse                  map_symbol_to_corresponding_colour } # === Colours.parse
+       self.instance_eval { alias map_colour_to_constant map_symbol_to_corresponding_colour } # === Colours.map_colour_to_constant
+       self.instance_eval { alias map_this_symbol        map_symbol_to_corresponding_colour } # === Colours.map_this_symbol
+       self.instance_eval { alias map_symbol_to_colour   map_symbol_to_corresponding_colour } # === Colours.map_symbol_to_colour
+       self.instance_eval { alias corresponding_colour?  map_symbol_to_corresponding_colour } # === Colours.corresponding_colour?  
+
+  # ========================================================================= #
+  # === map_symbol_to_corresponding_colour
+  #
+  # This maps a colour (string) to the respective constant.
+  # ========================================================================= #
+  def map_symbol_to_corresponding_colour(i)
+    ::Colours.map_symbol_to_corresponding_colour(i)
+  end; alias map_colour_to_constant map_symbol_to_corresponding_colour # === map_colour_to_constant
+
+end

data/lib/colours/module.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/module.rb'
+# =========================================================================== #
+module Colours
+
+  include Colours::E
+
+end

data/lib/colours/project/project_base_directory.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/project/project_base_directory.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours::PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY =
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === Colours.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    PROJECT_BASE_DIRECTORY
+  end
+
+end

data/lib/colours/rainbow_colours/README.md

@@ -0,0 +1,2 @@
+This directory contains code that can be used for displaying
+text in a rainbow-colourspray variant, on the commandline.

data/lib/colours/rainbow_colours/check_for_trollop_being_available_or_exit.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.check_for_trollop_being_available_or_exit
+  # ========================================================================= #
+  def self.check_for_trollop_being_available_or_exit
+    # ======================================================================= #
+    # First check whether the user has the Trollop gem installed.
+    # ======================================================================= #
+    unless Object.const_defined? :Trollop
+      e
+      e 'Trollop is not installed. Please install it via:'
+      e
+      e '  gem install trollop'
+      e
+      exit
+    end
+  end
+
+end; end

data/lib/colours/rainbow_colours/constants.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/rainbow_colours/constants.rb'
+# =========================================================================== #
+require 'colours/constants/newline.rb'
+
+module Colours
+
+module RainbowColours # === Colours::RainbowColours
+
+  # ========================================================================= #
+  # === DEFAULT_RAINBOW_SPREAD
+  # ========================================================================= #
+  DEFAULT_RAINBOW_SPREAD = 3.0
+
+  # ========================================================================= #
+  # === Colours::RainbowColours::STRIP_ANSI
+  #
+  # Checking for escape sequences (and a number).
+  #
+  # Official documentation can be seen here:
+  #
+  #   https://ruby-doc.org/core/Regexp.html#method-c-new
+  #
+  # ========================================================================= #
+  STRIP_ANSI = Regexp.new('\e\[[\d;]*[m|K]', nil)
+
+end; end

data/lib/colours/rainbow_colours/do_parse_via_rainbow_colours.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Colours::RainbowColours
+# =========================================================================== #
+# require 'colours/rainbow_colours/do_parse_via_rainbow_colours.rb'
+# =========================================================================== #
+require 'colours/toplevel_methods/cat.rb'
+require 'colours/toplevel_methods/clear_screen.rb'
+require 'colours/toplevel_methods/e.rb'
+# =========================================================================== #
+# Require rainbow_colours specific code next:
+# =========================================================================== #
+require 'colours/rainbow_colours/check_for_trollop_being_available_or_exit.rb'
+require 'colours/rainbow_colours/constants.rb'
+require 'colours/rainbow_colours/paint_detected_mode.rb'
+require 'colours/rainbow_colours/report_errors.rb'
+
+module Colours
+
+module RainbowColours
+
+  begin
+    require 'stringio'
+  rescue LoadError; end
+
+  begin
+    require 'trollop'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.do_parse_via_rainbow_colours
+  #
+  # This is the rainbow_colours initializer.
+  # ========================================================================= #
+  def self.do_parse_via_rainbow_colours(
+      i = ARGV
+    )
+    check_for_trollop_being_available_or_exit
+    # ======================================================================= #
+    # Setup the trollop-parser instance next.
+    # ======================================================================= #
+    trollop_parser = Trollop::Parser.new {
+      banner <<HEADER
+
+Usage: rainbow_colours [OPTION]... [FILE]...
+
+Display one or several files. Alternatively, obtain input via STDIN.
+
+With no FILE, or when FILE is -, read standard input.
+
+HEADER
+      banner ''
+      # ll | rainbowc -a
+      opt :animate,   'Enable psychedelics',        short: 'a', :default => false
+      opt :spread,    'Rainbow spread',             short: 'p', :default => DEFAULT_RAINBOW_SPREAD
+      opt :freq,      'Rainbow frequency',          short: 'F', :default => 0.1
+      opt :seed,      'Rainbow seed, 0 = random',   short: 'S', :default => 0
+      opt :duration,  'Animation duration',         short: 'd', :default => 12
+      opt :speed,     'Animation speed',            short: 's', :default => 20.0
+      opt :invert,    'Invert fg and bg',           short: 'i', :default => false
+      opt :truecolor, '24-bit (truecolor)',         short: 't', :default => false
+      opt :force,     'Force color even when stdout is not a tty', short: 'f', :default => false
+      opt :help,      'Show this help menu',        short: 'h'
+      banner <<FOOTER
+
+Examples:
+
+  rainbow_colours f - g      Output f's contents, then stdin, then g's contents.
+  rainbow_colours            Copy standard input to standard output.
+  fortune | rainbow_colours  Display a rainbow cookie.
+
+FOOTER
+    } # End of the help-banner.
+    # ======================================================================= #
+    # Keep the Trollop instance assigned to the variable opts.
+    # ======================================================================= #
+    opts = Trollop.with_standard_exception_handling(trollop_parser) {
+      begin
+        o = trollop_parser.parse(i) # Parse the given input here.
+      rescue Trollop::HelpNeeded # If we need some more help.
+        string_io_buffer = StringIO.new
+        trollop_parser.educate(string_io_buffer) # <- display the help message and then exit.
+        string_io_buffer.rewind
+        opts = {
+          animate:  false,
+          speed:     20,
+          duration:  12,
+          os:       rand(256),
+          spread:   8.0,
+          freq:     0.3
+        }
+        splitted = string_io_buffer.read.split("\n")
+        ::Colours.cat(splitted, opts)
+        e
+        string_io_buffer.close # Close the buffer again.
+        exit 1
+      end
+      o
+    }
+
+    p.die(:spread,   'must be >= 0.1') if opts[:spread]   < 0.1
+    p.die(:duration, 'must be >= 0.1') if opts[:duration] < 0.1
+    p.die(:speed,    'must be >= 0.1') if opts[:speed]    < 0.1
+
+    # ======================================================================= #
+    # Build up the option-hash next.
+    # ======================================================================= #
+    opts[:os] = opts[:seed]
+    opts[:os] = rand(256) if opts[:os] == 0
+
+    begin
+      if ARGV.empty?
+        files = [:stdin]
+      else
+        files = ARGV[0..-1]
+      end
+      files.each { |file|
+        case file
+        when '-', :stdin
+          fd = ARGF
+        end
+        begin
+          fd = File.open(file) unless fd == ARGF
+          if $stdout.tty? or opts[:force]
+            # =============================================================== #
+            # Work on TTY terminals. This also includes terminals such
+            # as KDE Konsole. The second argument are the options passed
+            # towards Colours.cat().
+            # =============================================================== #
+            ::Colours.cat(fd, opts)
+          else
+            until fd.eof? do
+              # ============================================================= #
+              # Keep on writing the input to $stdout here.
+              # ============================================================= #
+              $stdout.write(fd.read(8192))
+            end
+          end
+        rescue Errno::ENOENT
+          report_no_such_file_or_directory(file)
+          exit 1
+        rescue Errno::EACCES
+          report_permission_denied(file)
+          exit 1
+        rescue Errno::EISDIR
+          report_is_a_directory(file)
+          exit 1
+        rescue Errno::EPIPE
+          exit 1
+        end
+      }
+    rescue Interrupt
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Colours::RainbowColours.do_parse_via_rainbow_colours(ARGV)
+end # rainbow_colours
+    # ll | rainbow_colours
+    # ll | rainbow_colours -a

data/lib/colours/rainbow_colours/paint_detected_mode.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'paint_detected_mode.rb'
+# =========================================================================== #
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === @paint_detected_mode
+  # ========================================================================= #
+  if Object.const_defined? :Paint
+    @paint_detected_mode = Paint.detect_mode
+  else
+    @paint_detected_mode = nil
+  end
+
+end; end