environment_information 1.4.124

data/lib/environment_information/class/colours.rb

@@ -0,0 +1,282 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/colours.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === colourize_this_in_the_right_side_colour
+  # ========================================================================= #
+  def colourize_this_in_the_right_side_colour(i)
+    if use_colours?
+      ::Colours.send(::EnvironmentInformation.colour_for_the_right_side, i)
+    else
+      i
+    end
+  end
+
+  # ========================================================================= #
+  # === cyan
+  # ========================================================================= #
+  def cyan(
+      i = '', use_colours = use_colours?
+    )
+    if i.empty?
+      Colours::CYAN
+    end if use_colours
+  end
+
+  # ========================================================================= #
+  # === blue
+  # ========================================================================= #
+  def blue(i = '')
+    if i.empty?
+      ::Colours::BLUE
+    end if use_colours?
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i, use_colours = use_colours?)
+    return ::Colours.simp(i) if use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === set_use_colours
+  # ========================================================================= #
+  def set_use_colours(i = '')
+    ::EnvironmentInformation.set_use_colours(true)
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    ::EnvironmentInformation.use_colours?
+  end
+
+  # ========================================================================= #
+  # === enable_colours
+  # ========================================================================= #
+  def enable_colours
+    ::EnvironmentInformation.use_colours = true
+  end
+
+  # ========================================================================= #
+  # === disable_colours
+  #
+  # Call this method when you wish to disable the colours. Note that
+  # this will disable colours on the toplevel.
+  # ========================================================================= #
+  def disable_colours
+    ::EnvironmentInformation.use_colours = false
+  end; alias no_colours disable_colours # === no_colours()
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    if use_colours?
+      Colours::GREEN
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === true_rev
+  # ========================================================================= #
+  def true_rev
+    if use_colours?
+      Colours::REV
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === col1
+  #
+  # The "first" colour to be used.
+  # ========================================================================= #
+  def col1
+    if use_colours?
+      Colours::BOLD_BLUE
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i)
+    return ::Colours.sfile(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    return ::Colours.sfancy(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === crimson
+  # ========================================================================= #
+  def crimson(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.crimson(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === darkgreen
+  # ========================================================================= #
+  def darkgreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.darkgreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === dimgray
+  # ========================================================================= #
+  def dimgray(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.dimgray(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.royalblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === slateblue
+  # ========================================================================= #
+  def slateblue(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.slateblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.steelblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === seagreen
+  # ========================================================================= #
+  def seagreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.seagreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === olivedrab
+  #
+  # This one will be used for the right-hand side.
+  # ========================================================================= #
+  def olivedrab(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.olivedrab(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === olive
+  # ========================================================================= #
+  def olive(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.olive(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === limegreen
+  # ========================================================================= #
+  def limegreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.limegreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === darkolivegreen
+  # ========================================================================= #
+  def darkolivegreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.darkolivegreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === lightgreen
+  # ========================================================================= #
+  def lightgreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.lightgreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === mediumpurple
+  # ========================================================================= #
+  def mediumpurple(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.mediumpurple(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === teal
+  # ========================================================================= #
+  def teal(i = '')
+    return ::Colours.teal(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === orange
+  # ========================================================================= #
+  def orange(i = '')
+    return ::Colours.orange(i) if use_colours?
+    return i
+  end
+
+end; end

data/lib/environment_information/colours/colours.rb

@@ -0,0 +1,224 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/colours/colours.rb'
+# EnvironmentInformation.colour_for_the_left_side
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/project/project.rb'
+
+  # ========================================================================= #
+  # First the code here will determine which colours are to be used. If
+  # a .yml file can be found as part of this project then it will override
+  # the default values given here; otherwise the default values will be
+  # used, consequently.
+  # ========================================================================= #
+
+  yaml_file = EnvironmentInformation.project_base_directory?+'yaml/colours.yml'
+  if File.exist? yaml_file
+    dataset = YAML.load_file(yaml_file) # These should be a Symbol.
+    @colour_for_the_left_side     = dataset['left_side'].to_sym
+    @colour_for_the_right_side    = dataset['right_side'].to_sym
+    @colour_for_program_not_found = dataset['program_not_found'].to_sym
+  else # else use default values here
+    # ========================================================================= #
+    # === @colour_for_the_left_side
+    # ========================================================================= #
+    @colour_for_the_left_side = :forestgreen
+
+    # ========================================================================= #
+    # === @colour_for_the_right_side
+    # ========================================================================= #
+    @colour_for_the_right_side = :steelblue
+
+    # ========================================================================= #
+    # === @colour_for_program_not_found
+    # ========================================================================= #
+    @colour_for_program_not_found = :lightslategrey
+  end
+
+  begin
+    require 'colours/html_colours'
+    # ======================================================================= #
+    # === @use_colours
+    #
+    # By default this project will try to make use of colours. This has
+    # be protected by a rescue clause, as not every user may have the
+    # gem called "colours" installed.
+    # ======================================================================= #
+    @use_colours = true
+  rescue LoadError
+    # ======================================================================= #
+    # If the colours-gem is not available then we will not use colours.
+    # The user could still overrule this at a later time, though.
+    # ======================================================================= #
+    @use_colours = false
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.colour_for_the_left_side            (left tag)
+  #
+  # This method will return the colour 
+  #
+  # This could also be :limegreen rather than :forestgreen or vice versa.
+  # ========================================================================= #
+  def self.colour_for_the_left_side
+    @colour_for_the_left_side
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.colour_for_the_right_side          (right tag)
+  # ========================================================================= #
+  def self.colour_for_the_right_side
+    @colour_for_the_right_side
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.colour_for_program_not_found
+  # ========================================================================= #
+  def self.colour_for_program_not_found
+    @colour_for_program_not_found
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.use_colours?
+  # ========================================================================= #
+  def self.use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.set_use_colours
+  #
+  # Determine whether the EnvironmentInformation project will use
+  # colours or whether it will not.
+  # ========================================================================= #
+  def self.set_use_colours(i = true)
+    @use_colours = i
+  end; self.instance_eval { alias use_colours= set_use_colours } # === EnvironmentInformation.use_colours=
+  
+  # ========================================================================= #
+  # === EnvironmentInformation.do_use_colours
+  # ========================================================================= #
+  def self.do_use_colours
+    @use_colours = i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.mediumpurple
+  # ========================================================================= #
+  def self.mediumpurple(i = '')
+    if @use_colours
+      return ::Colours.mediumpurple(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.lightslategrey
+  # ========================================================================= #
+  def self.lightslategrey(i = '')
+    if @use_colours
+      return ::Colours.lightslategrey(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.tomato
+  # ========================================================================= #
+  def self.tomato(
+      i = '', use_colours = @use_colours
+    )
+    return ::Colours.tomato(i) if use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.pink
+  # ========================================================================= #
+  def self.pink(
+      i = '', use_colours = @use_colours
+    )
+    return ::Colours.pink(i) if use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.forestgreen
+  # ========================================================================= #
+  def self.forestgreen(
+      i = '', use_colours = @use_colours
+    )
+    return ::Colours.forestgreen(i) if use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.lightseagreen
+  # ========================================================================= #
+  def self.lightseagreen(i = '', use_colours = @use_colours)
+    if use_colours
+      return ::Colours.lightseagreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.steelblue
+  # ========================================================================= #
+  def self.steelblue(i = '')
+    if @use_colours
+      return ::Colours.steelblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.royalblue
+  # ========================================================================= #
+  def self.royalblue(
+      i           = '',
+      use_colours = @use_colours
+    )
+    if use_colours
+      return ::Colours.royalblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.mediumaquamarine
+  # ========================================================================= #
+  def self.mediumaquamarine(
+      i           = '',
+      use_colours = @use_colours
+    )
+    if use_colours
+      return ::Colours.mediumaquamarine(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.sfile
+  # ========================================================================= #
+  def self.sfile(i = '')
+    if @use_colours
+      ::Colours.sfile(i)
+    else
+      i
+    end
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.rev                                  (rev tag)
+  # ========================================================================= #
+  def self.rev
+    return ::Colours.rev if @use_colours
+    '' # Else return an empty String.
+  end
+
+end

data/lib/environment_information/colours/sfancy.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/colours/sfancy.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/colours/colours.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation
+  # ========================================================================= #
+  def self.sfancy(i = '')
+    return ::Colours.sfancy(i) if Object.const_defined? :Colours
+    i
+  end
+
+end

data/lib/environment_information/colours/simp.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/colours/simp.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/colours/colours.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation
+  # ========================================================================= #
+  def self.simp(i = '')
+    return ::Colours.simp(i) if Object.const_defined? :Colours
+    i
+  end
+
+end