environment_information 1.4.124 → 1.5.5

data/lib/environment_information/base/base.rb

@@ -10,157 +10,541 @@ module EnvironmentInformation
 class Base
 
   require 'environment_information/requires/require_the_constants.rb'
+  require 'environment_information/toplevel_methods/toplevel_methods.rb'
   require 'environment_information/colours/colours.rb'
-  require 'environment_information/toplevel_methods/e.rb'
-  require 'environment_information/toplevel_methods/misc.rb'
+  require 'environment_information/project/project.rb'
 
-  require 'environment_information/toplevel_methods/is_on_roebe.rb'
-  # ========================================================================= #
+  # ========================================================================== #
+  # === TRY_TO_USE_HTML_COLOURS
+  #
+  # If true then we will try to use the konsole-colours, when possible.
+  #
+  # These are part of the colours gem, so this adds a dependency on the
+  # colours gem.
+  # ========================================================================== #
+  TRY_TO_USE_HTML_COLOURS = true
+
+  # ========================================================================== #
+  # === reset
+  # ========================================================================== #
+  def reset
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :use_colours
+    # ======================================================================= #
+    set_use_colours(TRY_TO_USE_HTML_COLOURS)
+    # ======================================================================= #
+    # === :be_verbose
+    # ======================================================================= #
+    set_be_verbose
+  end
+
+  # ========================================================================== #
+  # === set_be_verbose
+  # ========================================================================== #
+  def set_be_verbose(
+      i = true
+    )
+    case i
+    # ======================================================================== #
+    # === :be_quiet
+    # ======================================================================== #
+    when :be_quiet
+      i = false
+    end
+    @internal_hash[:be_verbose] = i
+  end
+
+  # ========================================================================== #
   # === is_on_roebe?
-  # ========================================================================= #
+  # ========================================================================== #
   def is_on_roebe?
     ::EnvironmentInformation.is_on_roebe?
   end
 
-  # ========================================================================= #
-  # === e
-  # ========================================================================= #
-  def e(i = '')
-    ::EnvironmentInformation.e(i)
-  end
-
-  # ========================================================================= #
+  # ========================================================================== #
   # === set_commandline_arguments
-  # ========================================================================= #
+  # ========================================================================== #
   def set_commandline_arguments(i = '')
     i = [i].flatten.compact
     @commandline_arguments = i
   end
 
-  # ========================================================================= #
+  # ========================================================================== #
   # === commandline_arguments?
-  # ========================================================================= #
+  # ========================================================================== #
   def commandline_arguments?
     @commandline_arguments
   end
 
-  # ========================================================================= #
+  # ========================================================================== #
   # === first_argument?
-  # ========================================================================= #
+  # ========================================================================== #
   def first_argument?
     @commandline_arguments.first
   end; alias first? first_argument? # === first?
 
-  # ========================================================================= #
+  # ========================================================================== #
   # === is_rbt_available?                                           (rbt tag)
   #
   # Query whether the user has the necessary code from the RBT project
   # installed.
-  # ========================================================================= #
+  # ========================================================================== #
   def is_rbt_available?
     Object.const_defined? :RBT
   end
 
-  # ========================================================================= #
-  # === log_dir?
-  # ========================================================================= #
-  def log_dir?
-    ::EnvironmentInformation.temp_directory?
-  end; alias log_directory? log_dir? # === log_directory?
-
-  require 'environment_information/toplevel_methods/cd.rb'
-  # ========================================================================= #
+  # ========================================================================== #
   # === cd                                                           (cd tag)
   #
   # A shorter variant for the change-directory action.
-  # ========================================================================= #
+  # ========================================================================== #
   def cd(i)
     ::EnvironmentInformation.cd(i)
   end
 
-  # ========================================================================= #
+  # ========================================================================== #
+  # === e
+  # ========================================================================== #
+  # def e(i = '')
+  #   ::EnvironmentInformation.e(i)
+  # end
+
+  # ========================================================================== #
+  # === e                                                             (e tag)
+  # ========================================================================== #
+  def e(i = '')
+    puts i
+  end
+
+  # ========================================================================== #
   # === esystem
-  # ========================================================================= #
+  # ========================================================================== #
   def esystem(i)
     e i
     system i
   end
 
-  # ========================================================================= #
+  # ========================================================================== #
+  # === return_very_silent_system_output_from                      (query tag)
+  # ========================================================================== #
+  def return_very_silent_system_output_from(
+      use_this_query
+    )
+    return ::EnvironmentInformation.return_very_silent_system_output_from(
+      use_this_query
+    )
+  end; alias default_query      return_very_silent_system_output_from # === default_query
+       alias silent_sys_command return_very_silent_system_output_from # === silent_sys_command
+       alias silent_query       return_very_silent_system_output_from # === silent_query
+       alias swift_query        return_very_silent_system_output_from # === swift_query
+
+  # ========================================================================== #
+  # === sanitize_this_version_string
+  # ========================================================================== #
+  def sanitize_this_version_string(
+      i
+    )
+    return ::EnvironmentInformation.sanitize_this_version_string(i)
+  end
+
+  # ========================================================================== #
+  # === sfile
+  # ========================================================================== #
+  def sfile(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::EnvironmentInformation.sfile(i, use_colours) if use_colours
+    return i
+  end
+
+  # ========================================================================== #
+  # === use_colours?
+  # ========================================================================== #
+  def use_colours?
+    @use_colours
+  end
+
+  # ========================================================================== #
+  # === tomato
+  # ========================================================================== #
+  def tomato(i = '')
+    return ::Colours::HtmlColoursMethods.tomato(i)
+  end
+
+  # ========================================================================== #
   # === gold
-  # ========================================================================= #
+  # ========================================================================== #
   def gold(i = '')
-    return ::Colours.gold(i)
+    return ::Colours::HtmlColoursMethods.gold(i)
   end
 
-  # ========================================================================= #
-  # === report_left_right
-  # ========================================================================= #
-  def report_left_right(
-      left  = program_name?,
-      right = program_version?,
-      colour_for_the_left_side     = ::EnvironmentInformation.colour_for_the_left_side,
-      colour_for_the_right_side    = ::EnvironmentInformation.colour_for_the_right_side,
-      colour_for_program_not_found = ::EnvironmentInformation.colour_for_program_not_found,
-      use_padding = true
-    )
-    case colour_for_the_left_side
-    # ======================================================================= #
-    # === :default_colour
-    # ======================================================================= #
-    when :default_colour
-      colour_for_the_left_side = ::EnvironmentInformation.colour_for_the_left_side
-    end
-    case colour_for_the_right_side
-    # ======================================================================= #
-    # === :default_colour
-    # ======================================================================= #
-    when :default_colour
-      colour_for_the_right_side = ::EnvironmentInformation.colour_for_the_right_side
-    end
-    case colour_for_program_not_found
-    # ======================================================================= #
-    # === :default_colour
-    # ======================================================================= #
-    when :default_colour
-      colour_for_program_not_found = ::EnvironmentInformation.colour_for_program_not_found
-    end
-    case right
-    when nil
-      right = NOT_INSTALLED_OR_NOT_FOUND
-    end
-    right = right.dup if right.frozen?
-    right.strip!
-    if right.include? 'not found'
-      right = ::EnvironmentInformation.send(
-        colour_for_program_not_found, right
-      )
-    end
-    colourized_right_side = ::EnvironmentInformation.send(
-      colour_for_the_right_side,
-      right
-    ) 
-    modified_left = "#{left}:"
-    modified_left = modified_left.ljust(32) if use_padding
-    e ::EnvironmentInformation.send(
-        colour_for_the_left_side,
-        modified_left
-      )+
-      " #{colourized_right_side}"
-  end
-
-  # ========================================================================= #
+  # ========================================================================== #
+  # === mediumaquamarine
+  # ========================================================================== #
+  def mediumaquamarine(i = '')
+    return ::Colours::HtmlColoursMethods.mediumaquamarine(i)
+  end
+
+  # ========================================================================== #
   # === lightblue
-  # ========================================================================= #
+  # ========================================================================== #
   def lightblue(i = '')
-    return ::Colours.lightblue(i)
+    return ::Colours::HtmlColoursMethods.lightblue(i)
   end
 
-  # ========================================================================= #
-  # === mediumaquamarine
-  # ========================================================================= #
-  def mediumaquamarine(i = '')
-    return ::EnvironmentInformation.mediumaquamarine(i)
+  # ========================================================================== #
+  # === cyan
+  # ========================================================================== #
+  def cyan(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.cyan(i) if use_colours and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === true_rev
+  # ========================================================================== #
+  def true_rev
+    return Colours.rev if use_colours?
+    return ''
+  end
+
+  # ========================================================================== #
+  # === simp
+  # ========================================================================== #
+  def simp(
+      i,
+      use_colours = use_colours?
+    )
+    return ::Colours.simp(i) if use_colours
+    return i
+  end
+
+  # ========================================================================== #
+  # === register_sigint
+  # ========================================================================== #
+  def register_sigint
+    Signal.trap('SIGINT') { e; exit }
   end
 
+  # ========================================================================== #
+  # === tracked_programs?
+  # ========================================================================== #
+  def tracked_programs?
+    ARRAY_TRACKED_PROGRAMS
+  end
+
+  # ========================================================================== #
+  # === set_use_colours
+  # ========================================================================== #
+  def set_use_colours(i = true)
+    @use_colours = i
+  end
+
+  # ========================================================================== #
+  # === enable_colours
+  # ========================================================================== #
+  def enable_colours
+    set_use_colours(true)
+  end
+
+  # ========================================================================== #
+  # === disable_colours
+  # ========================================================================== #
+  def disable_colours
+    set_use_colours(false)
+  end; alias no_colours disable_colours # === no_colours()
+
+  # ========================================================================== #
+  # === rev                                                         (rev tag)
+  # ========================================================================== #
+  def rev(
+      use_colours = use_colours?
+    )
+    return ::EnvironmentInformation.rev(use_colours)
+  end
+
+  # ========================================================================== #
+  # === lightseagreen
+  # ========================================================================== #
+  def lightseagreen(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.lightseagreen(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === seagreen
+  # ========================================================================== #
+  def seagreen(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.seagreen(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === blue
+  # ========================================================================== #
+  def blue(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.blue(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === crimson
+  # ========================================================================== #
+  def crimson(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.crimson(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === mediumpurple
+  # ========================================================================== #
+  def mediumpurple(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.mediumpurple(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === teal
+  # ========================================================================== #
+  def teal(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.teal(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === orange
+  # ========================================================================== #
+  def orange(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.orange(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === lightgreen
+  # ========================================================================== #
+  def lightgreen(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.lightgreen(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === darkolivegreen
+  # ========================================================================== #
+  def darkolivegreen(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.darkolivegreen(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === limegreen
+  # ========================================================================== #
+  def limegreen(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.limegreen(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === olive
+  # ========================================================================== #
+  def olive(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.olive(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === olivedrab
+  # ========================================================================== #
+  def olivedrab(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.olivedrab(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === steelblue
+  # ========================================================================== #
+  def steelblue(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.steelblue(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === slateblue
+  # ========================================================================== #
+  def slateblue(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.slateblue(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === royalblue
+  # ========================================================================== #
+  def royalblue(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.royalblue(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === dimgray
+  # ========================================================================== #
+  def dimgray(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.dimgray(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === darkgreen
+  # ========================================================================== #
+  def darkgreen(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours::HtmlColoursMethods.darkgreen(i) if use_colours? and TRY_TO_USE_HTML_COLOURS
+    return i
+  end
+
+  # ========================================================================== #
+  # === col1
+  #
+  # The "first" colour to be used.
+  # ========================================================================== #
+  def col1
+    return Colours::BOLD_BLUE if use_colours?
+    return ''
+  end
+
+  # ========================================================================== #
+  # === sfancy
+  # ========================================================================== #
+  def sfancy(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours.sfancy(i) if use_colours
+    return i
+  end
+
+  # ========================================================================== #
+  # === write_what_into
+  # ========================================================================== #
+  def write_what_into(what, into)
+    ::EnvironmentInformation.write_what_into(what, into)
+  end
+
+  # ========================================================================== #
+  # === be_verbose?
+  # ========================================================================== #
+  def be_verbose?
+    @internal_hash[:be_verbose]
+  end
+
+  # ========================================================================== #
+  # === be_silent
+  # ========================================================================== #
+  def be_silent
+    @internal_hash[:be_verbose] = false
+  end; alias be_quiet be_silent # === be_quiet
+
+  # ========================================================================== #
+  # === set_be_silent
+  # ========================================================================== #
+  def set_be_silent(i = true)
+    @internal_hash[:be_verbose] = !i
+  end
+
+  # ========================================================================== #
+  # === be_silent?
+  # ========================================================================== #
+  def be_silent?
+    !be_verbose?
+  end
+
+  # ========================================================================== #
+  # === opne
+  # ========================================================================== #
+  def opne(i = '')
+    opnn; e i
+  end; alias opnne opne # === opnne
+
+  # ========================================================================== #
+  # === log_dir?
+  # ========================================================================== #
+  def log_dir?
+    ::EnvironmentInformation.temp_directory?
+  end; alias log_directory?  log_dir? # === log_directory?
+       alias temp_dir?       log_dir? # === temp_dir?
+       alias temp_directory? log_dir? # === temp_directory?
+
+  # ========================================================================== #
+  # === load_dataset_from_this_file
+  #
+  # This method can be used to read which programs will be displayed
+  # from a local file, rather than rely on the pre-set default.
+  # ========================================================================== #
+  def load_dataset_from_this_file(i)
+    if File.exist? i
+      File.readlines(i).map {|entry|
+        entry.delete('-').strip # ← Clean up the input a little bit.
+      }
+    else
+      opne "No file exists at `#{sfile(i)}`."
+    end
+  end; alias try_to_load_dataset_from_this_file load_dataset_from_this_file # === try_to_load_dataset_from_this_file
+       alias try_to_read_content_from_this_file load_dataset_from_this_file # === try_to_read_content_from_this_file
+
 end; end