colours 0.5.55

data/lib/colours/autoinclude.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will auto-include the Colours module.
+#
+# The HtmlColours namespace is also automatically included, onto the
+# Colours namespace.
+# =========================================================================== #
+# require 'colours/autoinclude.rb'
+# =========================================================================== #
+require 'colours/requires/require_the_colours_project.rb'
+
+include Colours

data/lib/colours/base/base.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This is a "dummy" class from which you can quickly subclass if you
+# need methods such as royalblue() to work in your class.
+# =========================================================================== #
+# require 'colours/base/base.rb'
+# class Foobar < Colours::Base
+# =========================================================================== #
+require 'colours/autogenerated/toplevel_basic_colour_methods.rb'
+
+module Colours
+
+class Base # === Colours::Base
+
+  include Colours::AllColourMethods 
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours::Base.new.royalblue('hi there')
+end

data/lib/colours/basic_colours/README.md

@@ -0,0 +1,4 @@
+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/basic_colours/basic_colours.rb

@@ -0,0 +1,279 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/basic_colours/basic_colours.rb'
+# =========================================================================== #
+require 'colours/constants/colour_constants.rb'
+require 'colours/constants/hash_simple_colours.rb'
+
+module Colours
+
+module BasicColours # === Colours::BasicColours
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = const_get(inspect)
+
+  # ========================================================================= #
+  # === Colours.red
+  # ========================================================================= #
+  def self.red(i)
+    "#{COLOUR_RED}#{i}#{REVERT}"
+  end
+
+  # ========================================================================= #
+  # === Colours.light_magenta
+  # ========================================================================= #
+  def self.light_magenta(i)
+    "#{COLOUR_LIGHT_MAGENTA}#{i}#{REVERT}"
+  end; self.instance_eval { alias lightmagenta light_magenta } # === Colours.lightmagenta
+       self.instance_eval { alias light_purple light_magenta } # === Colours.light_purple
+
+  # ========================================================================= #
+  # === Colours.yellow
+  # ========================================================================= #
+  def self.yellow(i)
+    "#{COLOUR_YELLOW}#{i}#{REVERT}"
+  end; self.instance_eval { alias yel yellow } # === Colours.yel
+       self.instance_eval { alias brown yellow } # === Colours.brown
+
+  # ========================================================================= #
+  # === Colours.light_red
+  # ========================================================================= #
+  def self.light_red(i)
+    "#{COLOUR_LIGHT_RED}#{i}#{REVERT}"
+  end; self.instance_eval { alias lightred light_red } # === Colours.lightred
+       self.instance_eval { alias bold_red light_red } # === Colours.bold_red
+
+  # ========================================================================= #
+  # === Colours.blue
+  # ========================================================================= #
+  def self.blue(i)
+    "#{COLOUR_BLUE}#{i}#{REVERT}"
+  end
+
+  # ========================================================================= #
+  # === Colours.green
+  # ========================================================================= #
+  def self.green(i)
+    "#{COLOUR_GREEN}#{i}#{REVERT}"
+  end
+
+  # ========================================================================= #
+  # === Colours.magenta
+  # ========================================================================= #
+  def self.magenta(i)
+    "#{COLOUR_MAGENTA}#{i}#{REVERT}"
+  end; self.instance_eval { alias purple magenta } # === Colours.purple
+
+  # ========================================================================= #
+  # === Colours.light_blue
+  # ========================================================================= #
+  def self.light_blue(i)
+    "#{COLOUR_LIGHT_BLUE}#{i}#{REVERT}"
+  end; self.instance_eval { alias lightblue light_blue } # === Colours.lightblue
+       self.instance_eval { alias bold_blue light_blue } # === Colours.bold_blue
+
+  # ========================================================================= #
+  # === Colours.brown
+  # ========================================================================= #
+  def self.brown(i)
+    "#{COLOUR_BROWN}#{i}#{REVERT}"
+  end; self.instance_eval { alias bold_yellow brown } # === Colours.bold_yellow
+       self.instance_eval { alias yellow      brown } # === Colours.yellow
+
+  # ========================================================================= #
+  # === Colours.light_cyan
+  # ========================================================================= #
+  def self.light_cyan(i)
+    "#{COLOUR_LIGHT_CYAN}#{i}#{REVERT}"
+  end; self.instance_eval { alias lightcyan light_cyan } # === Colours.lightcyan
+
+  # ========================================================================= #
+  # === Colours.cyan
+  # ========================================================================= #
+  def self.cyan(i)
+    "#{COLOUR_CYAN}#{i}#{REVERT}"
+  end; self.instance_eval { alias teal cyan } # === Colours.teal
+
+  # ========================================================================= #
+  # === Colours.black
+  # ========================================================================= #
+  def self.black(i)
+    "#{COLOUR_BLACK}#{i}#{REVERT}"
+  end
+
+  # ========================================================================= #
+  # === Colours.light_gray
+  # ========================================================================= #
+  def self.light_gray(i)
+    "#{COLOUR_LIGHT_GRAY}#{i}#{REVERT}"
+  end; self.instance_eval { alias lightgray  light_gray } # === Colours.lightgray
+       self.instance_eval { alias light_grey light_gray } # === Colours.light_grey
+       self.instance_eval { alias lightgrey  light_gray } # === Colours.lightgrey
+
+  # ========================================================================= #
+  # === Colours.dark_gray
+  # ========================================================================= #
+  def self.dark_gray(i)
+    "#{COLOUR_DARK_GRAY}#{i}#{REVERT}"
+  end; self.instance_eval { alias darkgray  dark_gray } # === Colours.darkgray
+       self.instance_eval { alias dark_grey dark_gray } # === Colours.dark_grey
+       self.instance_eval { alias darkgrey  dark_gray } # === Colours.darkgrey
+
+  # ========================================================================= #
+  # === Colours.grey
+  # ========================================================================= #
+  def self.grey(i)
+    "#{COLOUR_GRAY}#{i}#{REVERT}"
+  end; self.instance_eval { alias gray grey } # === Colours.gray
+
+  # ========================================================================= #
+  # === grey
+  # ========================================================================= #
+  def grey(i)
+    NAMESPACE.grey(i)
+  end; alias gray grey # === gray
+
+  # ========================================================================= #
+  # === yellow
+  # ========================================================================= #
+  def yellow(i = '')
+    NAMESPACE.yellow(i)
+  end; alias brown      yellow # === brown
+       alias yel        yellow # === yel
+       alias bold_brown yellow # === bold_brown
+
+  # ========================================================================= #
+  # === bold_yellow
+  # ========================================================================= #
+  def bold_yellow(i = '')
+    NAMESPACE.bold_yellow(i)
+  end; alias yelb bold_yellow # === yelb
+
+  # ========================================================================= #
+  # === bold_white
+  # ========================================================================= #
+  def bold_white(i)
+    NAMESPACE.bold_white(i)
+  end; alias whiteb bold_white # === whiteb
+
+  # ========================================================================= #
+  # === bold_red
+  # ========================================================================= #
+  def bold_red(i = '')
+    NAMESPACE.bold_red(i)
+  end; alias lightred bold_red # === lightred
+       alias redb     bold_red # === redb
+
+  # ========================================================================= #
+  # === light_blue
+  # ========================================================================= #
+  def light_blue(i)
+    NAMESPACE.light_blue(i)
+  end; alias lightblue light_blue # === lightblue
+       alias bold_blue light_blue # === bold_blue
+
+  # ========================================================================= #
+  # === Colours.define_colour_methods_that_can_be_included
+  #
+  # Dynamic definitions of some methods, such as teal() or red()
+  # or white() or bold_white() or lightblue(). These will be
+  # defined at include-time, meaning that they will only be
+  # available if you do "include Colours".
+  #
+  # Should come up very early in the definition, as other methods
+  # may depend on it.
+  #
+  # To test this, try:
+  #
+  #   Colours.bold_yellow('hey joe')
+  #
+  # ========================================================================= #
+  def self.define_colour_methods_that_can_be_included
+    all_colours = ::Colours.really_all_colours
+    # ======================================================================= #
+    # The above refers to an Array that looks 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]
+    #
+    # ======================================================================= #
+    all_colours.each {|entry|
+      unless defined? entry.to_sym # Must prevent re-definitions here.
+        define_method(entry.to_sym) {|i = ''| # Allow input.
+          i = i.to_s
+          _ = ''.dup
+          _ << "#{map_colour_to_constant(__method__)}"
+          _ << "#{i}#{rev}" unless i.empty?
+          return _
+        }
+      end
+    }
+  end
+
+  define_colour_methods_that_can_be_included # Invoke it at once.
+
+  # ========================================================================= #
+  # === Colours::BasicColours.white
+  # ========================================================================= #
+  def self.white(i = '')
+    "#{COLOUR_WHITE}#{i}#{REVERT}"
+  end; self.instance_eval { alias bold_white white } # === Colours::BasicColours.bold_white
+
+  # ========================================================================= #
+  # === Colours.light_green
+  # ========================================================================= #
+  def self.light_green(i)
+    "#{COLOUR_LIGHT_GREEN}#{i}#{REVERT}"
+  end; self.instance_eval { alias lightgreen light_green } # === Colours::BasicColours.lightgreen
+       self.instance_eval { alias bold_green light_green } # === Colours::BasicColours.bold_green
+
+  # ========================================================================= #
+  # === bold_green
+  # ========================================================================= #
+  def bold_green(i)
+    ::NAMESPACE.bold_green(i)
+  end; alias greenb bold_green # === greenb
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  x = Colours::BasicColours
+  # ========================================================================= #
+  # Bold variants:
+  # ========================================================================= #
+  test_this_string = '  Hello world!'
+  e
+  e x.bold_blue(test_this_string)
+  e x.bold_green(test_this_string)
+  e x.bold_red(test_this_string)
+  e x.bold_yellow(test_this_string)
+  e x.bold_white(test_this_string)
+  # ========================================================================= #
+  # Non-bold variants:
+  # ========================================================================= #
+  e
+  e 'Next, the non-bold variants:'
+  e
+  e x.yellow(test_this_string)
+  e x.green(test_this_string)
+  e x.teal(test_this_string)
+  e
+  e 'Next, we will create a class with Colours included:'
+  e
+  e '   class Foo; include Colours; def test; e bold_yellow("hi there"); end; end'
+  e
+  class Foo
+    include Colours::BasicColours
+    def test
+      e bold_yellow("hi there")
+    end
+  end
+  Foo.new.test
+end # rb basic_colours.rb

data/lib/colours/colour_methods/README.md

@@ -0,0 +1,11 @@
+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_methods/default_colour.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/default_colour.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.default_colour
+  #
+  # Invocation example:
+  #
+  #   puts Colours.default_colour('Hello world!')
+  #
+  # ========================================================================= #
+  def self.default_colour(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if make_newline
+        i = "#{i}#{N}"
+      end
+      if @use_html_colours
+        i = SupportForHTMLColours.send(@colour_table[__method__.to_sym], i)
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])  
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === edir
+  # ========================================================================= #
+  def edefault_colour(
+      i            = '',
+      make_newline = false
+    )
+    e Colours.default_colour(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === default_colour
+  # ========================================================================= #
+  def default_colour(i = '')
+    Colours.default_colour(i)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.default_colour('Hello world!')
+end #

data/lib/colours/colour_methods/sargument.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/sargument.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.sargument
+  #
+  # Invocation example:
+  #   Colours.sargument('Hello world!')
+  # ========================================================================= #
+  def self.sargument(
+      i            = '',
+      make_newline = false
+    )
+    if make_newline
+      i = "#{i}#{N}"
+    end
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(@colour_table[__method__.to_sym], i)
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end; self.instance_eval { alias argument sargument } # === Colours.argument
+       self.instance_eval { alias sarg     sargument } # === Colours.sarg
+
+  # ========================================================================= #
+  # === sargument
+  # ========================================================================= #
+  def sargument(
+      i = '',
+      make_newline = false
+    )
+    Colours.sargument(i, make_newline)
+  end; alias sarg sargument # === sarg
+  
+  # ========================================================================= #
+  # === eargument
+  # 
+  # The various simple colourize methods.
+  # ========================================================================= #
+  def eargument(
+      i            = '',
+      make_newline = false
+    )
+    e Colours.sargument(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.sargument('Hello world!')
+end

data/lib/colours/colour_methods/scomments.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/scomments.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+require 'colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.scomments
+  #
+  # Invocation example:
+  #   Colours.scomments('Hello world!')
+  # ========================================================================= #
+  def self.scomments(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(@colour_table[__method__.to_sym], i)
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end; self.instance_eval { alias comment scomments } # === Colours.comment
+
+  # ========================================================================= #
+  # === scomments
+  # ========================================================================= #
+  def scomments(i = '')
+    ::Colours.scomments(i)
+  end; alias scomment scomments # === scomment
+
+  # ========================================================================= #
+  # === Colours.ecomment
+  #
+  # This method here was added on Nov 2013.
+  #
+  # In April 2014, the ability to split at any arbitrary character was
+  # added, which can be controlled via the second argument given to
+  # that method.
+  # ========================================================================= #
+  def self.ecomment(
+      i,
+      optional_split_at_this_character = '#' # <- Specify which character to split at.
+    )
+    _ = i.to_s
+    if optional_split_at_this_character.is_a? Hash
+      if optional_split_at_this_character.has_key? :token
+        optional_split_at_this_character = optional_split_at_this_character.delete :token
+      end
+    end
+    optional_split_at_this_character = optional_split_at_this_character.to_s
+    # ======================================================================= #
+    # === If we can find a token to split at
+    # ======================================================================= #
+    if _.include? optional_split_at_this_character
+      use_this_regex = /#(.+)/ # See: http://rubular.com/r/oRUg7lw4oE
+      colour_for_comments = map_colour_to_constant(scomments?)
+      _ = _.dup if _.frozen?
+      _.gsub!(use_this_regex,
+        colour_for_comments+optional_split_at_this_character.to_s+'\\1'+rev)
+    end
+    e _
+  end
+
+  # ========================================================================= #
+  # === Colours.scomments?
+  # ========================================================================= #
+  def self.scomments?
+    colour_table?[:scomments]
+  end
+
+  # ========================================================================= #
+  # === ecomment
+  #
+  # Just a wrapper over the Colours.ecomment() functionality.
+  # ========================================================================= #
+  def ecomment(
+      i,
+      optional_split_at_this_character = '#'
+    )
+    Colours.ecomment(i, optional_split_at_this_character)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.scomments('Hello world!')
+  Colours.ecomment('Hello world! # this is the associated comment')
+end

data/lib/colours/colour_methods/sdir.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/sdir.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.sdir
+  #
+  # Invocation example:
+  #
+  #   puts Colours.sdir('Hello world!')
+  #
+  # ========================================================================= #
+  def self.sdir(
+      i            = '',
+      make_newline = false
+    )
+    if make_newline
+      i = "#{i}#{N}"
+    end
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(@colour_table[__method__.to_sym], i)
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])  
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === edir
+  # ========================================================================= #
+  def edir(
+      i            = '',
+      make_newline = false
+    )
+    e Colours.sdir(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i = '')
+    Colours.sdir(i)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.sdir('Hello world!')
+end #