environment_information 1.4.124 → 1.5.5

data/lib/environment_information/constants/constants.rb

@@ -2,16 +2,377 @@
 # 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'
+module EnvironmentInformation
+
+  require 'yaml'
+  require 'environment_information/project/project.rb'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::N
+  #
+  # A newline constant to simplify our life.
+  # ========================================================================== #
+  N = "\n"
+
+  # ========================================================================== #
+  # === NAMESPACE
+  # ========================================================================== #
+  NAMESPACE = inspect
+
+  # ========================================================================== #
+  # === ARRAY_DEFAULT_PROGRAMS_ON_LINUX
+  # ========================================================================== #
+  ARRAY_DEFAULT_PROGRAMS_ON_LINUX = %i(
+    bash
+    gcc
+    binutils
+    bison
+    busybox
+    bzip2
+    coreutils
+    diffutils
+    findutils
+    flex
+    gawk
+    grep
+    gzip
+    linux
+    perl
+    xz
+  )
+
+  # ========================================================================== #
+  # === EnvironmentInformation::ARRAY_VERSION
+  # ========================================================================== #
+  ARRAY_VERSION = [
+    /^-?-?version\??$/i
+  ]
+
+  # ========================================================================== #
+  # === EnvironmentInformation::NOT_FOUND
+  #
+  # This constant is used to denote that a component was not found.
+  # ========================================================================== #
+  NOT_FOUND = '[Not available, installed or found.]'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::NOT_FOUND
+  #
+  # This was the old variant.
+  # ========================================================================== #
+  # NOT_FOUND = 'not found'
+  
+  # ========================================================================== #
+  # === EnvironmentInformation::TEMP_DIRECTORY
+  #
+  # This constant denotes into which directory files should be stored,
+  # e. g. autogenerated files from the EnvironmentInformation project.
+  #
+  # This constant MUST have a trailing '/' character.
+  #
+  # The environment variable called MY_TEMP_DIR can overrule all
+  # other guesses made here, but it is not always available,
+  # e. g. in a .cgi file such an environment variable may not
+  # be available.
+  # ========================================================================== #
+  if ENV.has_key? 'MY_TEMP_DIR'
+    TEMP_DIRECTORY = ENV['MY_TEMP_DIR'].to_s
+  elsif File.directory? '/home/x/Temp/' # ← My main directory.
+    TEMP_DIRECTORY = '/home/x/Temp/'
+  elsif File.directory? '/Depot/Temp/'
+    TEMP_DIRECTORY = '/Depot/Temp/'
+  else
+    TEMP_DIRECTORY = '/tmp/' # ← "Rescue" for most other users on linux.
+  end
+
+  # ========================================================================== #
+  # === @temp_directory
+  # ========================================================================== #
+  @temp_directory = TEMP_DIRECTORY
+
+  # ========================================================================== #
+  # === EnvironmentInformation.temp_directory?
+  #
+  # This method will refer to the temp-directory in use for this project.
+  #
+  # It is advised to make use of the method, rather than the
+  # TEMP_DIRECTORY constant, as that is more convenient in the
+  # long run.
+  # ========================================================================== #
+  def self.temp_directory?(
+      i = @temp_directory
+    )
+    i.squeeze('/').dup
+  end; self.instance_eval { alias temp_dir? temp_directory? } # === EnvironmentInformation.temp_dir?
+
+  # ========================================================================== #
+  # === EnvironmentInformation::ARRAY_COMPARE_PROGRAM_VERSIONS
+  # ========================================================================== #
+  ARRAY_COMPARE_PROGRAM_VERSIONS = [
+    /^-?-?compare(-|_)?to(-|_)?program(-|_)?versions$/i,
+    /^-?-?compare(-|_)?program(-|_)?versions$/i,
+    /^-?-?compare(-|_)?programs$/i,
+    /^-?-?compare$/i,
+    /^-?-?compare(-|_)?version$/i
+  ]
+
+  # ========================================================================== #
+  # === EnvironmentInformation::NOT_INSTALLED_OR_NOT_FOUND
+  # ========================================================================== #
+  NOT_INSTALLED_OR_NOT_FOUND = '[Not installed or not found.]'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::COMMAND_NOT_FOUND
+  # ========================================================================== #
+  COMMAND_NOT_FOUND = 'command not found'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::VERSION_STRING
+  # ========================================================================== #
+  VERSION_STRING = 'version'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::NOT_FOUND_IN_PKG_CONFIG_SEARCH_PATH
+  #
+  # This constant is specifically for missing (or not found) .pc
+  # files.
+  # ========================================================================== #
+  NOT_FOUND_IN_PKG_CONFIG_SEARCH_PATH =
+    'as not found in the pkg-config search path'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::THE_PROGRAM_WAS_NOT_FOUND
+  # ========================================================================== #
+  THE_PROGRAM_WAS_NOT_FOUND =
+    '[The program was not found.]'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::PKGCONFIG_COMMAND_NOT_FOUND
+  #
+  # The constant that follows next is used to determine whether
+  # pkg-config could find a corresponding .pc file. If not then
+  # pkg-config will typically report a line such as this:
+  #
+  #   Package libdr was not found in the pkg-config search path.
+  #
+  # We will include the last part of this string, as a generic
+  # message that can be used to indicate "this package could
+  # not be found on the given computer system at hand".
+  # ========================================================================== #
+  PKGCONFIG_COMMAND_NOT_FOUND =
+    ' was not found in the pkg-config search path.'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::NO_SUCH_FILE_OR_DIRECTORY
+  # ========================================================================== #
+  NO_SUCH_FILE_OR_DIRECTORY =
+    'No such file or directory'
+
+  # ========================================================================== #
+  # === TRY_TO_MAKE_USE_OF_THE_OPN_GEM_IF_IT_IS_AVAILABLE
+  #
+  # This gem is closely connected to the NAMESPACE constant, so it
+  # will also reside in this file here.
+  # ========================================================================== #
+  TRY_TO_MAKE_USE_OF_THE_OPN_GEM_IF_IT_IS_AVAILABLE = true
+
+  # ========================================================================== #
+  # === ERROR_LINE
+  #
+  # The error line is the one that can be appended to system-related
+  # queries (e. g. via system()).
+  # ========================================================================== #
+  ERROR_LINE = '2>&1'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::SAVE_FILE
+  #
+  # Where to save stuff to. This depends on a proper setting of the
+  # toplevel variable called @temp_directory.
+  # ========================================================================== #
+  SAVE_FILE =
+    "#{@temp_directory}EnvironmentInformation.md"
+
+  # ========================================================================== #
+  # === EnvironmentInformation::UTF_ENCODING
+  #
+  # UTF-8 is the default encoding for the EnvironmentInformation namespace.
+  # ========================================================================== #
+  UTF_ENCODING = 'UTF-8'
+
+  # ========================================================================== #
+  # === EnvironmentInformation::MAIN_ENCODING
+  # ========================================================================== #
+  MAIN_ENCODING = UTF_ENCODING
+
+  # ========================================================================= #
+  # === ARRAY_TRACKED_PROGRAMS
+  # ========================================================================= #
+  this_file = EnvironmentInformation.project_base_directory?+
+             'yaml/track_these_components.yml'
+  if File.exist? this_file 
+    ARRAY_TRACKED_PROGRAMS = YAML.load_file(this_file)
+  else
+    ARRAY_TRACKED_PROGRAMS = []
+  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'
+
+  # ========================================================================= #
+  # === EnvironmentInformation::ARRAY_TRACKED_XORG_COMPONENTS      (xorg tag)
+  # ========================================================================= #
+  ARRAY_TRACKED_XORG_COMPONENTS = %w(
+    libevdev
+    libinput
+    libx11
+    libxaw3d
+    libxau
+    libxcb
+    libxcm
+    libxcursor
+    libxdamage
+    libxi
+    libxkbfile
+    libxmu
+    libxpm
+    libxpresent
+    libxtst
+    libxt
+    libxv
+    libxvmc
+    randrproto
+    xextproto
+    xkbcomp
+    xrandr
+    xstdcmap
+    xf86bigfontproto
+    xf86dgaproto
+    xf86driproto
+  )
+
+  # ========================================================================== #
+  # === EnvironmentInformation.tracked_xorg_components?
+  # ========================================================================== #
+  def self.tracked_xorg_components?
+    ARRAY_TRACKED_XORG_COMPONENTS
+  end; self.instance_eval { alias return_all_xorg_components_as_array tracked_xorg_components? } # === EnvironmentInformation.return_all_xorg_components_as_array
+       self.instance_eval { alias xorg_components?                    tracked_xorg_components? } # === EnvironmentInformation.xorg_components?
+
+  # ========================================================================== #
+  # === 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_all_components.yml"
+  end
+
+  # ========================================================================== #
+  # === EnvironmentInformation::ARRAY_TRACKED_NON_PROGRAMS
+  # ========================================================================== #
+  ARRAY_TRACKED_NON_PROGRAMS = %w(
+    cpuinfo
+    operating_system
+    operating_system_bit_type
+    cflags
+    ram
+    rubygems_installation_directory
+    screen_resolution
+  )
+
+  # ========================================================================== #
+  # === EnvironmentInformation.tracked_components?
+  # ========================================================================== #
+  def self.tracked_components?
+    [
+      ARRAY_TRACKED_PROGRAMS+
+      ARRAY_TRACKED_NON_PROGRAMS
+    ].flatten
+  end
+
+  # ========================================================================= #
+  # === 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::ARRAY_SCIENCE_CLUSTER
+  #
+  # This is currently hardcoded here.
+  # ========================================================================== #
+  ARRAY_SCIENCE_CLUSTER = %w(
+    hmmer pbbam relion samtools viennarna
+  )
+
+  # ========================================================================== #
+  # === EnvironmentInformation.science_cluster?
+  # ========================================================================== #
+  def self.science_cluster?
+    ARRAY_SCIENCE_CLUSTER
+  end
+
+  # ========================================================================= #
+  # === 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
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp EnvironmentInformation.lfs_core_programs?
+end

data/lib/environment_information/project/project.rb

@@ -24,4 +24,4 @@ module EnvironmentInformation
     PROJECT_BASE_DIRECTORY
   end; self.instance_eval { alias project_base_dir? project_base_directory? } # === EnvironmentInformation.project_base_dir? 
 
-end
+end

data/lib/environment_information/query/constants.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# ============================================================================ #
+# require 'environment_information/query/constants.rb'
+# ============================================================================ #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class Query < ::EnvironmentInformation::Base # === EnvironmentInformation::Query
+
+  # ========================================================================== #
+  # === EnvironmentInformation::EnvironmentInformation::THIS_FILE
+  #
+  # THIS_FILE = __FILE__
+  #
+  # We hardcode this since it is only relevant on my home system, anyway.
+  # ========================================================================== #
+  THIS_FILE  =
+    '/home/x/programming/ruby/src/'\
+    'environment_information/lib/environment_information/query/'\
+    'query.rb'
+
+  # ========================================================================== #
+  # === N_LEFT_PAD
+  # ========================================================================== #
+  N_LEFT_PAD = 35
+
+  # ========================================================================== #
+  # === FILE_COLOURS
+  # ========================================================================== #
+  FILE_COLOURS = "#{::EnvironmentInformation.project_base_dir?}"\
+                 "yaml/colours.yml"
+
+  # ========================================================================== #
+  # === NAMESPACE
+  # ========================================================================== #
+  NAMESPACE = inspect
+
+  # ========================================================================== #
+  # === QUERY_TO_USE_FOR_ALL_COMPONENTS
+  # ========================================================================== #
+  QUERY_TO_USE_FOR_ALL_COMPONENTS = ::EnvironmentInformation.query_to_use_for_all_components?
+
+end; end

data/lib/environment_information/query/help.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# ============================================================================ #
+# require 'environment_information/query/help.rb'
+# ============================================================================ #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class Query < ::EnvironmentInformation::Base # === EnvironmentInformation::Query
+
+  # ========================================================================== #
+  # === do_show_help                                               (help tag)
+  #
+  # Show the commandline-usage through this method here.
+  #
+  # To invoke this, try:
+  #
+  #   envi --help
+  #
+  # ========================================================================== #
+  def do_show_help
+    e
+    lpad = "#{col1}    "
+    e "#{rev}The following options are available for "\
+      "#{simp('class EnvironmentInformation:')}#{rev}#{N}#{N}"
+    if ASCIITABLE_IS_AVAILABLE
+      e col1+'    asciitable        '+rev+'# Print in Ascii Table format'
+    end
+    e lpad+'html              '+rev+'# Save the environment information '\
+      'into a .html file'
+    e lpad+'gui               '+"#{rev}# Start the GTK gui bindings; some "\
+      "aliases are possible such as --GUI"
+    e lpad+'nocolours         '+"#{rev}# Disable colours "\
+      "(--disable-colours also works)"
+    e lpad+'noruby            '+rev+'# dont show ruby-related environment '\
+      'information'
+    e lpad+'help              '+rev+'# show some help'
+    e lpad+'xorg              '+rev+'# show some xorg-specific '\
+      'components (also --xorg-components)'
+    e lpad+'OS                '+rev+'# show the OS then exit'
+    e lpad+'full              '+rev+'# show full information, including '\
+      'GTK, Glib, Atk and Pango Version'
+    e '                      # ^^^ This is probably the most useful usage.'
+    e lpad+'openssl           '+"#{rev}# display openssl option"
+    e lpad+'REALLY_ALL        '+"#{rev}# also compare the program_versions "\
+      "(--really-everything is an alias to this)"
+    e lpad+'save              '+"#{rev}# display the result, then "\
+      "save it into a file"
+    e lpad+'sinatra           '+"#{rev}# start the sinatra-interface "\
+      "of the environment_information project"
+    e lpad+'version           '+rev+'# show the version of '\
+      'EnvironmentInformation in use'
+    e lpad+'--show-remote-url '+rev+'# show the remote URLs '\
+      'of a program (requires the RBT project)'
+    e lpad+'padding=value     '+"#{rev}# set to another padding value"
+    e lpad+'--one-liner       '+"#{rev}# show everything compacted, without a newline"
+    e lpad+'--nentries?       '+"#{rev}# feedback how many entries are tracked in total"
+    e rev+N+'The above commands should be commandline arguments, '\
+      'such as: "'+teal('envi full')+rev+'".'
+    e
+    e "#{rev}Do note that you can prefix the above commands via "\
+      "a leading --, of course."
+    e
+    # ======================================================================== #
+    # Show a simple usage example next:
+    # ======================================================================== #
+    e 'Usage example:'
+    e
+    e steelblue(
+        '    envi --version'
+      )
+    e
+    e "#{rev}If you wish to show only some programs, you could "\
+      "use the following:"
+    e
+    e steelblue(
+        '    envi --use-these-programs=bash,binutils,bison,yacc,bzip2,coreutils,diff,find,gawk,gcc'
+      )
+    e steelblue(
+        '    envi --use-these-programs=:lfs'
+      )
+    e true_rev # Reset via Colours.rev here.
+    do_exit_the_program
+  end; alias show_help do_show_help # === show_help
+
+end; end