environment_information 1.4.99

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'
+    # ======================================================================= #
+    # === @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.rev
+  # ========================================================================= #
+  def self.rev
+    return ::Colours.rev if @use_colours
+    '' # Else return an empty String.
+  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
+
+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

data/lib/environment_information/constants/array_tracked_components.rb

@@ -0,0 +1,210 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/constants/array_tracked_components.rb'
+# EnvironmentInformation.is_this_program_included?
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # The following constant will also pull in yaml-support.
+  # ========================================================================= #
+  require 'environment_information/constants/file_constants.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_LFS_CORE_PROGRAMS
+  #
+  # All the LFS core programs are registered here in this Array.
+  # ========================================================================= #
+  ARRAY_LFS_CORE_PROGRAMS =
+    YAML.load_file(FILE_ARRAY_LFS_CORE_PROGRAMS)
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_XORG_COMPONENTS              (xorg tag)
+  #
+  # All xorg-components will be collected here. Sort alphabetically, please,
+  # and keep the entries downcased.
+  #
+  # xf86dga is an xorg-component, but since as of October 2018 it has
+  # been removed and will no longer be checked - it seems to have been
+  # abandoned, more or less.
+  # ========================================================================= #
+  ARRAY_XORG_COMPONENTS = YAML.load_file(FILE_ARRAY_TRACKED_XORG_COMPONENTS)
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_TRACKED_PROGRAMS
+  #
+  # This Array keeps track of which programs are tracked by the
+  # EnvironmentInformation project. That listing will include ALL
+  # registered entries, with a corresponding entry under the
+  # directory individual_components/.
+  #
+  # All entries of this Array should be downcased.
+  #
+  # Keep this Array alphabetically sorted, please, even though this is
+  # not an absolute necessity; it just simplifies adding and removing
+  # entries in the long run.
+  #
+  # Since as of February 2020 this is maintained in a yaml file.
+  # ========================================================================= #
+  if File.exist? FILE_ARRAY_TRACKED_PROGRAMS
+    ARRAY_TRACKED_PROGRAMS = YAML.load_file(FILE_ARRAY_TRACKED_PROGRAMS)
+  else
+    puts 'No file could be found at '+FILE_ARRAY_TRACKED_PROGRAMS+'.'
+    ARRAY_TRACKED_PROGRAMS = [] # Default in this case.
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.array_tracked_programs
+  #
+  # This method will return all the programs that are currently
+  # tracked by the EnvironmentInformation project.
+  # ========================================================================= #
+  def self.array_tracked_programs
+    ARRAY_TRACKED_PROGRAMS
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_DEFAULT_PROGRAMS_ON_LINUX
+  #
+  # This Array keeps track of the default programs on a linux computer.
+  # ========================================================================= #
+  ARRAY_DEFAULT_PROGRAMS_ON_LINUX =
+    YAML.load_file(FILE_ARRAY_DEFAULT_PROGRAMS_ON_LINUX)
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_TRACKED_NON_PROGRAMS
+  #
+  # The entry rubygems_installation_directory depends on the executable
+  # called "gem", which is part of ruby.
+  #
+  # This Array has also been called "registered extra functionality" in
+  # the past. The entries here are special in one way or another.
+  # Usually these entries are NOT standalone-programs, which is
+  # why they are tracked separately.
+  # ========================================================================= #
+  ARRAY_TRACKED_NON_PROGRAMS =
+    load_file_array_tracked_non_programs
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_SCIENCE_CLUSTER           (science tag)
+  #
+  # Science-specific applications are gathered in this array.
+  # ========================================================================= #
+  ARRAY_SCIENCE_CLUSTER = 
+    YAML.load_file(FILE_ARRAY_SCIENCE_CLUSTER)
+
+  # ========================================================================= #
+  # === EnvironmentInformation.science_cluster?
+  # ========================================================================= #
+  def self.science_cluster?
+    ARRAY_SCIENCE_CLUSTER
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_LFS_TEMPORARY_PROGRAMS
+  #
+  # All programs that are temporary, e. g. for enabling the bootstrapping
+  # of the compiler, are stored in the following Array.
+  # ========================================================================= #
+  ARRAY_LFS_TEMPORARY_PROGRAMS = %i(
+    binutils
+    gcc
+    linux_API_headers
+    glibc
+    libstdc++
+    binutils
+    tcl
+    expect
+    dejagnu
+    m4
+    ncurse
+    bash
+    bison
+    bzip2
+    coreutils
+    diffutils
+    file
+    findutils
+    gawk
+    gettext
+    grep
+    gzip
+    make
+    patch
+    perl
+    python
+    sed
+    tar
+    texinfo
+    xz
+  )
+
+  # ========================================================================= #
+  # === EnvironmentInformation.tracked_programs?
+  #
+  # Simpler toplevel-method to find out which programs are registered
+  # within the EnvironmentInformation project.
+  # ========================================================================= #
+  def self.tracked_programs?
+    ARRAY_TRACKED_PROGRAMS
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.xorg_components?
+  # ========================================================================= #
+  def self.xorg_components?
+    ARRAY_XORG_COMPONENTS
+  end; self.instance_eval { alias return_all_xorg_components_as_array xorg_components? } # === EnvironmentInformation.return_all_xorg_components_as_array
+       self.instance_eval { alias return_all_xorg_components_as_array xorg_components? } # === EnvironmentInformation.return_all_xorg_components_as_array
+
+  # ========================================================================= #
+  # === EnvironmentInformation.tracked_non_programs?
+  #
+  # Simpler toplevel-method to find out which non-programs are registered
+  # within the EnvironmentInformation project.
+  # ========================================================================= #
+  def self.tracked_non_programs?
+    ARRAY_TRACKED_NON_PROGRAMS
+  end; self.instance_eval { alias registered_extra_functionality tracked_non_programs? } # === EnvironmentInformation.registered_extra_functionality
+
+  # ========================================================================= #
+  # === EnvironmentInformation.lfs_core_programs?
+  # ========================================================================= #
+  def self.lfs_core_programs?
+    ARRAY_LFS_CORE_PROGRAMS
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.is_this_program_included?
+  #
+  # This will include the two Arrays ARRAY_TRACKED_PROGRAMS and
+  # ARRAY_XORG_COMPONENTS, but it will NOT include ARRAY_TRACKED_NON_PROGRAMS.
+  # ========================================================================= #
+  def self.is_this_program_included?(i)
+    (
+      ARRAY_TRACKED_PROGRAMS +
+      ARRAY_XORG_COMPONENTS
+    ).flatten.include? i.to_sym # Need a symbol.
+  end; self.instance_eval { alias is_this_a_registered_program? is_this_program_included? } # === ::EnvironmentInformation.is_this_a_registered_program?
+
+  # ========================================================================= #
+  # === EnvironmentInformation.is_this_component_included?
+  #
+  # This is a more extensive check than .is_this_program_included?()
+  # ========================================================================= #
+  def self.is_this_component_included?(i)
+    array = (
+              ARRAY_TRACKED_PROGRAMS +
+              ARRAY_XORG_COMPONENTS  +
+              ARRAY_TRACKED_NON_PROGRAMS
+            )
+    array.flatten.include? i.to_sym # Need a Symbol as input.
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp EnvironmentInformation.lfs_core_programs?
+end

data/lib/environment_information/constants/constants.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will require the other .rb files in the environment/constants/
+# subdirectory.
+# =========================================================================== #
+# require 'environment_information/constants/constants.rb'
+# =========================================================================== #
+require 'environment_information/constants/array_tracked_components.rb'
+require 'environment_information/constants/encoding.rb'
+require 'environment_information/constants/error_line.rb'
+require 'environment_information/constants/file_constants.rb'
+require 'environment_information/constants/misc.rb'
+require 'environment_information/constants/namespace.rb'
+require 'environment_information/constants/newline.rb'
+require 'environment_information/constants/temp_directory.rb'

data/lib/environment_information/constants/encoding.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/constants/encoding.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation::UTF_ENCODING
+  #
+  # UTF-8 is the default encoding for the EnvironmentInformation namespace.
+  # ========================================================================= #
+  UTF_ENCODING = 'UTF-8'
+
+  # ========================================================================= #
+  # === EnvironmentInformation::MAIN_ENCODING
+  # ========================================================================= #
+  MAIN_ENCODING = UTF_ENCODING
+
+end

data/lib/environment_information/constants/error_line.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/constants/error_line.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === ERROR_LINE
+  #
+  # The error line is the one that can be appended to system-related
+  # queries (e. g. via system()).
+  # ========================================================================= #
+  ERROR_LINE = '2>&1'
+
+end

data/lib/environment_information/constants/file_constants.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/constants/file_constants.rb'
+# EnvironmentInformation.file_query_to_use_for_the_individual_components
+# EnvironmentInformation.query_to_use_for_the_individual_components?
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'yaml'
+  require 'environment_information/project/project.rb'
+
+  # ========================================================================= #
+  # === @query_to_use_for_the_individual_components
+  # ========================================================================= #
+  @query_to_use_for_the_individual_components = nil
+
+  # ========================================================================= #
+  # === EnvironmentInformation::FILE_ARRAY_TRACKED_PROGRAMS
+  # ========================================================================= #
+  FILE_ARRAY_TRACKED_PROGRAMS =
+    "#{PROJECT_BASE_DIRECTORY}yaml/array_tracked_programs.yml"
+
+  # ========================================================================= #
+  # === EnvironmentInformation::FILE_ARRAY_DEFAULT_PROGRAMS_ON_LINUX
+  # ========================================================================= #
+  FILE_ARRAY_DEFAULT_PROGRAMS_ON_LINUX =
+    "#{PROJECT_BASE_DIRECTORY}yaml/array_default_programs_on_linux.yml"
+
+  # ========================================================================= #
+  # === EnvironmentInformation::FILE_ARRAY_TRACKED_NON_PROGRAMS
+  # ========================================================================= #
+  FILE_ARRAY_TRACKED_NON_PROGRAMS =
+    "#{PROJECT_BASE_DIRECTORY}yaml/array_tracked_non_programs.yml"
+
+  # ========================================================================= #
+  # === EnvironmentInformation.load_file_array_tracked_non_programs
+  # ========================================================================= #
+  def self.load_file_array_tracked_non_programs(
+      i = FILE_ARRAY_TRACKED_NON_PROGRAMS
+    )
+    YAML.load_file(i)
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::FILE_ARRAY_TRACKED_XORG_COMPONENTS
+  # ========================================================================= #
+  FILE_ARRAY_TRACKED_XORG_COMPONENTS =
+    "#{PROJECT_BASE_DIRECTORY}yaml/array_tracked_xorg_components.yml"
+
+  # ========================================================================= #
+  # === EnvironmentInformation::FILE_ARRAY_LFS_CORE_PROGRAMS
+  # ========================================================================= #
+  FILE_ARRAY_LFS_CORE_PROGRAMS =
+    "#{PROJECT_BASE_DIRECTORY}yaml/array_lfs_core_programs.yml"
+
+  # ========================================================================= #
+  # === EnvironmentInformation::FILE_ARRAY_SCIENCE_CLUSTER
+  # ========================================================================= #
+  FILE_ARRAY_SCIENCE_CLUSTER =
+    "#{PROJECT_BASE_DIRECTORY}yaml/array_science_cluster.yml"
+
+  # ========================================================================= #
+  # === EnvironmentInformation::FILE_QUERY_TO_USE_FOR_THE_INDIVIDUAL_COMPONENTS
+  # ========================================================================= #
+  FILE_QUERY_TO_USE_FOR_THE_INDIVIDUAL_COMPONENTS = 
+    "#{PROJECT_BASE_DIRECTORY}yaml/query_to_use_for_the_individual_components.yml"
+
+  # ========================================================================= #
+  # === EnvironmentInformation.file_query_to_use_for_the_individual_components
+  # ========================================================================= #
+  def self.file_query_to_use_for_the_individual_components
+    "#{PROJECT_BASE_DIRECTORY}yaml/query_to_use_for_the_individual_components.yml"
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.load_file_query_to_use_for_the_individual_components
+  # ========================================================================= #
+  def self.load_file_query_to_use_for_the_individual_components(
+      i = FILE_QUERY_TO_USE_FOR_THE_INDIVIDUAL_COMPONENTS
+    )
+    @query_to_use_for_the_individual_components = YAML.load_file(i)
+    return @query_to_use_for_the_individual_components
+  end; self.instance_eval { alias all_the_queries load_file_query_to_use_for_the_individual_components } # === EnvironmentInformation.all_the_queries
+
+  # ========================================================================= #
+  # === EnvironmentInformation.query_to_use_for_the_individual_components?
+  # ========================================================================= #
+  def self.query_to_use_for_the_individual_components?
+    @query_to_use_for_the_individual_components
+  end
+
+  # ========================================================================= #
+  # === FILE_THESE_PROGRAMS_CAN_BE_UPGRADED
+  #
+  # We may store which programs could be upgraded into a local file.
+  # ========================================================================= #
+  FILE_THESE_PROGRAMS_CAN_BE_UPGRADED =
+    'these_programs_can_be_upgraded.yml'
+
+end