environment_information 1.4.124 → 1.5.5

data/lib/environment_information/colours/colours.rb

@@ -9,86 +9,91 @@ module EnvironmentInformation
 
   require 'environment_information/project/project.rb'
 
+  begin # This block should come early on.
+    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.use_colours?
   # ========================================================================= #
+  def self.use_colours?
+    @use_colours
+  end
+
+  # ========================================================================== #
+  # === Support for yaml/colours.yml
+  #
   # 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'
+  # ========================================================================== #
+  yaml_file = "#{EnvironmentInformation.project_base_directory?}yaml/colours.yml"
   if File.exist? yaml_file
+    # ======================================================================== #
+    # The .yml file exists, so we can use the colours defined in that
+    # .yml 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
   #
@@ -109,8 +114,11 @@ module EnvironmentInformation
   # ========================================================================= #
   # === EnvironmentInformation.mediumpurple
   # ========================================================================= #
-  def self.mediumpurple(i = '')
-    if @use_colours
+  def self.mediumpurple(
+      i           = '',
+      use_colours = @use_colours
+    )
+    if use_colours
       return ::Colours.mediumpurple(i)
     end
     return i
@@ -119,10 +127,10 @@ module EnvironmentInformation
   # ========================================================================= #
   # === EnvironmentInformation.lightslategrey
   # ========================================================================= #
-  def self.lightslategrey(i = '')
-    if @use_colours
-      return ::Colours.lightslategrey(i)
-    end
+  def self.lightslategrey(
+      i = '', use_colours = @use_colours
+    )
+    return ::Colours.lightslategrey(i) if use_colours
     return i
   end
 
@@ -130,7 +138,8 @@ module EnvironmentInformation
   # === EnvironmentInformation.tomato
   # ========================================================================= #
   def self.tomato(
-      i = '', use_colours = @use_colours
+      i           = '',
+      use_colours = @use_colours
     )
     return ::Colours.tomato(i) if use_colours
     return i
@@ -140,7 +149,8 @@ module EnvironmentInformation
   # === EnvironmentInformation.pink
   # ========================================================================= #
   def self.pink(
-      i = '', use_colours = @use_colours
+      i           = '',
+      use_colours = @use_colours
     )
     return ::Colours.pink(i) if use_colours
     return i
@@ -150,7 +160,8 @@ module EnvironmentInformation
   # === EnvironmentInformation.forestgreen
   # ========================================================================= #
   def self.forestgreen(
-      i = '', use_colours = @use_colours
+      i           = '',
+      use_colours = @use_colours
     )
     return ::Colours.forestgreen(i) if use_colours
     return i
@@ -159,7 +170,10 @@ module EnvironmentInformation
   # ========================================================================= #
   # === EnvironmentInformation.lightseagreen
   # ========================================================================= #
-  def self.lightseagreen(i = '', use_colours = @use_colours)
+  def self.lightseagreen(
+      i           = '',
+      use_colours = @use_colours
+    )
     if use_colours
       return ::Colours.lightseagreen(i)
     end
@@ -183,9 +197,7 @@ module EnvironmentInformation
       i           = '',
       use_colours = @use_colours
     )
-    if use_colours
-      return ::Colours.royalblue(i)
-    end
+    return ::Colours.royalblue(i) if use_colours
     return i
   end
 
@@ -196,29 +208,43 @@ module EnvironmentInformation
       i           = '',
       use_colours = @use_colours
     )
-    if use_colours
-      return ::Colours.mediumaquamarine(i)
-    end
+    return ::Colours.mediumaquamarine(i) if use_colours
     return i
   end
 
   # ========================================================================= #
   # === EnvironmentInformation.sfile
   # ========================================================================= #
-  def self.sfile(i = '')
-    if @use_colours
-      ::Colours.sfile(i)
-    else
-      i
-    end
+  def self.sfile(
+      i           = '',
+      use_colours = @use_colours
+    )
+    return ::Colours.sfile(i) if use_colours
+    return i
   end
 
   # ========================================================================= #
   # === EnvironmentInformation.rev                                  (rev tag)
   # ========================================================================= #
-  def self.rev
-    return ::Colours.rev if @use_colours
-    '' # Else return an empty String.
+  def self.rev(use_colours = @use_colours)
+    return ::Colours.rev if use_colours
+    return '' # Else return an empty String.
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.simp
+  # ========================================================================= #
+  def self.simp(i = '')
+    return ::Colours.simp(i) if Object.const_defined? :Colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation
+  # ========================================================================= #
+  def self.sfancy(i = '')
+    return ::Colours.sfancy(i) if Object.const_defined? :Colours
+    return i
   end
 
-end
+end

data/lib/environment_information/commandline/commandline.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# ============================================================================ #
+# === EnvironmentInformation::Commandline
+#
+# Usage example:
+#
+#   EnvironmentInformation::Commandline.new(ARGV)
+#
+# ============================================================================ #
+# require 'environment_information/commandline/commandline.rb'
+# ============================================================================ #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class Commandline < ::EnvironmentInformation::Base # === EnvironmentInformation::Commandline
+
+  require 'environment_information/version/version.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+  end
+
+  # ========================================================================= #
+  # === menu
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ====================================================================== #
+      # === envi --gui
+      # ====================================================================== #
+      when /^-?-?gui$/i,
+           /^-?-?gtk$/i,
+           /^-?-?start(-|_)?gtk$/i
+        start_gtk_component
+      # ====================================================================== #
+      # === envi --compare
+      # ====================================================================== #
+      when *ARRAY_COMPARE_PROGRAM_VERSIONS
+        ::EnvironmentInformation.show_all_available_components(
+          ['--compare-program-versions']
+        )
+      # ====================================================================== #
+      # === envi --version?
+      # ====================================================================== #
+      when *ARRAY_VERSION
+        report_version
+      # ====================================================================== #
+      # === envi --replay
+      #
+      # The replay-functionality can be used to display information
+      # quickly, by reading the dataset from a local file.
+      # ====================================================================== #
+      when /^-?-?replay$/i
+        replay_from_the_stored_file
+      else
+        EnvironmentInformation.test
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    menu
+  end
+
+  # ========================================================================= #
+  # === report_version
+  # ========================================================================= #
+  def report_version
+    ::EnvironmentInformation.report_version
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::Commandline[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end
+
+# ============================================================================ #
+# === EnvironmentInformation.menu
+# ============================================================================ #
+def self.menu(i = ARGV)
+  EnvironmentInformation::Commandline.new(i)
+end
+
+# ============================================================================ #
+# === EnvironmentInformation.report_version
+# ============================================================================ #
+def self.report_version
+  e "#{rev}The version of the EnvironmentInformation project "\
+    "in use is: #{simp(VERSION)}#{rev}"
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation::Commandline.new(ARGV)
+end # commandline.rb