environment_information 1.4.29

data/lib/environment_information/requires/require_the_toplevel_methods.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/requires/require_the_toplevel_methods.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/project/project.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.require_the_toplevel_methods
+  # ========================================================================= #
+  def self.require_the_toplevel_methods
+    Dir["#{PROJECT_BASE_DIRECTORY}toplevel_methods/*.rb"].each {|this_file|
+      require "environment_information/toplevel_methods/#{File.basename(this_file)}"
+    }
+  end
+
+  require_the_toplevel_methods # And require them at once.
+
+end

data/lib/environment_information/toplevel_methods/autogenerate_all_relevant_methods.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Code in this file is tasked to autogenerate the relevant methods for use
+# in the toplevel EnvironmentInformation namespace.
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/autogenerate_all_relevant_methods.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/constants/array_tracked_components.rb'
+  require 'environment_information/toplevel_methods/return_version_of_this_program.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.autogenerate_all_relevant_methods
+  #
+  # By default this method will scan for all tracked programs, and
+  # for the xorg-components.
+  # ========================================================================= #
+  def self.autogenerate_all_relevant_methods(
+      i = ARRAY_TRACKED_PROGRAMS+
+          ARRAY_XORG_COMPONENTS
+    )
+    i.flatten!
+    # ======================================================================= #
+    # Add some aliases which will be defined next.
+    # ======================================================================= #
+    hash_aliases = {
+      atk:   :libatk,   # === EnvironmentInformation.return_version_of_libatk
+      pcre2: :libpcre2, # === EnvironmentInformation.return_version_of_libpcre2
+      pcre:  :libpcre,  # === EnvironmentInformation.return_version_of_libpcre
+      zlib:  :libzlib   # === EnvironmentInformation.return_version_of_libzlib
+    }
+    # ======================================================================= #
+    # Iterate over our Array next:
+    # ======================================================================= #
+    i.each {|this_program|
+      case this_program
+      when :kde
+        this_program = :kde_frameworks
+      end
+      self.class.instance_eval {
+        # =================================================================== #
+        # To test this method, try to do:
+        #
+        #   EnvironmentInformation.return_version_of_valgrind # => "3.15.0"
+        #
+        # =================================================================== #
+        this_method = "return_version_of_#{this_program}"
+        define_method(this_method) {
+          return_version_of_this_program(this_program)
+        }
+        if hash_aliases.has_key?(this_program)
+          # ================================================================= #
+          # To test this, try:
+          #
+          #   EnvironmentInformation.return_version_of_libzlib
+          #
+          # ================================================================= #
+          use_this_as_the_alias_target = "return_version_of_#{hash_aliases[this_program]}"
+          define_method(use_this_as_the_alias_target) {
+            return_version_of_this_program(this_program)
+          }
+        end
+      }
+    }
+  end
+
+  autogenerate_all_relevant_methods # ← And call it at once.
+
+  # ========================================================================= #
+  # And add a few more aliases.
+  # ========================================================================= #
+  self.instance_eval { alias add_xz_information                                         return_version_of_xz }             # === EnvironmentInformation.add_xz_information
+  self.instance_eval { alias append_xz_version                                          return_version_of_xz }             # === EnvironmentInformation.append_xz_version
+  self.instance_eval { alias return_sed_version                                         return_version_of_sed }            # === EnvironmentInformation.return_sed_version
+  self.instance_eval { alias return_version_of_makeinfo                                 return_version_of_texinfo }        # === EnvironmentInformation.return_version_of_makeinfo
+  self.instance_eval { alias xfsprogs?                                                  return_version_of_xfsprogs }       # === EnvironmentInformation.xfsprogs?
+  self.instance_eval { alias add_xfsprogs_information                                   return_version_of_xfsprogs }       # === EnvironmentInformation.add_xfsprogs_information
+  self.instance_eval { alias return_version_of_lftp?                                    return_version_of_lftp }           # === EnvironmentInformation.return_version_of_lftp?
+  self.instance_eval { alias add_llvm_information                                       return_version_of_llvm }           # === EnvironmentInformation.add_llvm_information
+  self.instance_eval { alias append_llvm_version                                        return_version_of_llvm }           # === EnvironmentInformation.append_llvm_version
+  self.instance_eval { alias add_mpc_information                                        return_version_of_mpc }            # === EnvironmentInformation.add_mpc_information
+  self.instance_eval { alias append_mpc_version                                         return_version_of_mpc }            # === EnvironmentInformation.append_mpc_version
+  self.instance_eval { alias try_to_show_re2c_version                                   return_version_of_re2c }           # === EnvironmentInformation.try_to_show_re2c_version
+  self.instance_eval { alias append_re2c_version                                        return_version_of_re2c }           # === EnvironmentInformation.append_nasm_version
+  self.instance_eval { alias return_version_of_pkg_config                               return_version_of_pkgconfig }      # === EnvironmentInformation.return_version_of_pkg_config
+  self.instance_eval { alias add_readline_information                                   return_version_of_readline }       # === EnvironmentInformation.add_readline_information
+  self.instance_eval { alias append_readline_version                                    return_version_of_readline }       # === EnvironmentInformation.add_readline_information
+  self.instance_eval { alias return_version_of_liblibtasn1                              return_version_of_libtasn1 }       # === EnvironmentInformation.return_version_of_liblibtasn1
+  self.instance_eval { alias return_version_of_liblibtasn                               return_version_of_libtasn1 }       # === EnvironmentInformation.return_version_of_liblibtasn
+  self.instance_eval { alias return_version_of_grep?                                    return_version_of_grep }           # === EnvironmentInformation.return_version_of_grep?
+  self.instance_eval { alias return_version_of_intltool?                                return_version_of_intltool }       # === EnvironmentInformation.return_version_of_intltool?
+  self.instance_eval { alias glib?                                                      return_version_of_glib }           # === EnvironmentInformation.glib?
+  self.instance_eval { alias add_gmp_information                                        return_version_of_gmp }            # === EnvironmentInformation.add_gmp_information
+  self.instance_eval { alias append_gmp_version                                         return_version_of_gmp }            # === EnvironmentInformation.append_gmp_version
+  self.instance_eval { alias kernel                                                     return_version_of_linux }          # === EnvironmentInformation.kernel
+  self.instance_eval { alias linux_kernel                                               return_version_of_linux }          # === EnvironmentInformation.linux_kernel
+  self.instance_eval { alias linux_kernel?                                              return_version_of_linux }          # === EnvironmentInformation.linux_kernel?
+  self.instance_eval { alias return_information_about_the_component_called_linux_kernel return_version_of_linux }          # === EnvironmentInformation.return_information_about_the_component_called_linux_kernel
+  self.instance_eval { alias append_kernel_version                                      return_version_of_linux }          # === EnvironmentInformation.append_kernel_version
+  self.instance_eval { alias add_kernel_information                                     return_version_of_linux }          # === EnvironmentInformation.add_kernel_information
+  self.instance_eval { alias return_version_of_linux_kernel                             return_version_of_linux }          # === EnvironmentInformation.return_version_of_linux_kernel
+  self.instance_eval { alias return_version_of_linux_kernel?                            return_version_of_linux }          # === EnvironmentInformation.return_version_of_linux_kernel?
+  self.instance_eval { alias boost?                                                     return_version_of_boost }          # === EnvironmentInformation.boost?
+  self.instance_eval { alias return_version_of_boost?                                   return_version_of_boost }          # === EnvironmentInformation.return_version_of_boost?
+  self.instance_eval { alias return_version_of_find                                     return_version_of_findutils }      # === EnvironmentInformation.return_version_of_find
+  self.instance_eval { alias findutils?                                                 return_version_of_findutils }      # === EnvironmentInformation.findutils?
+  self.instance_eval { alias awk?                                                       return_version_of_gawk }           # === EnvironmentInformation.awk?
+  self.instance_eval { alias gawk?                                                      return_version_of_gawk }           # === EnvironmentInformation.gawk?
+  self.instance_eval { alias return_information_about_the_component_called_awk          return_version_of_gawk }           # === EnvironmentInformation.return_information_about_the_component_called_awk
+  self.instance_eval { alias return_version_of_awk?                                     return_version_of_gawk }           # === EnvironmentInformation.return_version_of_awk?
+  self.instance_eval { alias return_version_of_awk                                      return_version_of_gawk }           # === EnvironmentInformation.return_version_of_awk
+  self.instance_eval { alias append_gdkpixbuf_version                                   return_version_of_gdkpixbuf }      # === EnvironmentInformation.append_gdkpixbuf_version
+  self.instance_eval { alias glibc?                                                     return_version_of_glibc }          # === EnvironmentInformation.glibc?
+  self.instance_eval { alias glibc_version?                                             return_version_of_glibc }          # === EnvironmentInformation.glibc_version?
+  self.instance_eval { alias return_version_of_glibc?                                   return_version_of_glibc }          # === EnvironmentInformation.return_version_of_glibc?
+  self.instance_eval { alias ruby?                                                      return_version_of_ruby }           # === EnvironmentInformation.ruby?
+  self.instance_eval { alias return_information_about_the_component_called_ruby         return_version_of_ruby }           # === EnvironmentInformation.return_information_about_the_component_called_ruby
+  self.instance_eval { alias return_version_of_ruby?                                    return_version_of_ruby }           # === EnvironmentInformation.return_version_of_ruby?
+  self.instance_eval { alias binutils?                                                  return_version_of_binutils }       # === EnvironmentInformation.binutils?
+  self.instance_eval { alias return_version_of_binutils?                                return_version_of_binutils }       # === EnvironmentInformation.return_version_of_binutils?
+  self.instance_eval { alias bison?                                                     return_version_of_bison }          # === EnvironmentInformation.bison?
+  self.instance_eval { alias return_version_of_bison?                                   return_version_of_bison }          # === EnvironmentInformation.return_version_of_bison?
+  self.instance_eval { alias return_version_of_flex?                                    return_version_of_flex }           # === EnvironmentInformation.return_version_of_flex?
+  self.instance_eval { alias return_version_of_freetype2                                return_version_of_freetype }       # === EnvironmentInformation.return_version_of_freetype2
+  self.instance_eval { alias evince?                                                    return_version_of_evince }         # === EnvironmentInformation.evince?
+  self.instance_eval { alias return_version_of_evince?                                  return_version_of_evince }         # === EnvironmentInformation.return_version_of_evince?
+  self.instance_eval { alias gcc?                                                       return_version_of_gcc }            # === EnvironmentInformation.gcc?
+  self.instance_eval { alias return_information_about_the_component_called_gcc          return_version_of_gcc }            # === EnvironmentInformation.return_information_about_the_component_called_gcc
+  self.instance_eval { alias return_version_of_gcc?                                     return_version_of_gcc }            # === EnvironmentInformation.return_version_of_gcc?
+  self.instance_eval { alias return_version_of_R                                        return_version_of_r }              # === EnvironmentInformation.return_version_of_R
+  self.instance_eval { alias coreutils?                                                 return_version_of_coreutils }      # === EnvironmentInformation.coreutils?
+  self.instance_eval { alias return_version_of_coreutils?                               return_version_of_coreutils }      # === EnvironmentInformation.return_version_of_coreutils
+  self.instance_eval { alias return_version_of_diffutils?                               return_version_of_diffutils }      # === EnvironmentInformation.return_version_of_diffutils?
+  self.instance_eval { alias return_version_of_libexempi                                return_version_of_exempi }         # === EnvironmentInformation.return_version_of_libexempi
+  self.instance_eval { alias return_version_of_gpg                                      return_version_of_gnupg }          # === EnvironmentInformation.return_version_of_gpg
+  self.instance_eval { alias return_version_of_gnupg?                                   return_version_of_gnupg }          # === EnvironmentInformation.return_version_of_gnupg?
+  self.instance_eval { alias return_version_of_bzip                                     return_version_of_bzip2 }          # === EnvironmentInformation.return_version_of_bzip
+  self.instance_eval { alias return_version_of_llvm                                     return_version_of_clang }          # === EnvironmentInformation.return_version_of_llvm
+  self.instance_eval { alias return_clang_version                                       return_version_of_clang }          # === EnvironmentInformation.return_clang_version
+  self.instance_eval { alias kde5?                                                      return_version_of_kde_frameworks } # === EnvironmentInformation.kde5?
+  self.instance_eval { alias add_kde5_information                                       return_version_of_kde_frameworks } # === EnvironmentInformation.add_kde5_information
+  self.instance_eval { alias add_kde_information                                        return_version_of_kde_frameworks } # === EnvironmentInformation.add_kde_information
+  self.instance_eval { alias return_information_about_the_component_called_rubygems     return_version_of_rubygems }       # === EnvironmentInformation.return_information_about_the_component_called_rubygems
+  self.instance_eval { alias rubygems?                                                  return_version_of_rubygems }       # === EnvironmentInformation.rubygems?
+  self.instance_eval { alias return_version_of_rubygems?                                return_version_of_rubygems }       # === EnvironmentInformation.return_version_of_rubygems?
+  self.instance_eval { alias gtk3?                                                      return_version_of_gtk3 }           # === EnvironmentInformation.gtk3?
+  self.instance_eval { alias gtk2?                                                      return_version_of_gtk2 }           # === EnvironmentInformation.gtk2?
+
+end

data/lib/environment_information/toplevel_methods/cd.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/cd.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation.cd                                    (cd tag)
+  # ========================================================================= #
+  def self.cd(i)
+    Dir.chdir(i) if File.directory? i
+  end
+
+end

data/lib/environment_information/toplevel_methods/e.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/e.rb'
+# EnvironmentInformation.e
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation.e
+  # ========================================================================= #
+  def self.e(i = '', hash = {})
+    if hash and
+       hash.has_key?(:display_everything_in_short_format) and
+       hash[:display_everything_in_short_format]
+      # ===================================================================== #
+      # Display the results in a single line in this case.
+      # ===================================================================== #
+      print "#{i}, "
+    else
+      puts i
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation.e('Hello world!')
+end

data/lib/environment_information/toplevel_methods/hash.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/hash.rb'
+# EnvironmentInformation.hash?
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/toplevel_methods/register_this_component_is_missing.rb'
+
+  # ========================================================================= #
+  # === @hash_available_programs
+  #
+  # This hash stores the available programs.
+  #
+  # We need to use a Hash, rather than an Array, because we may save
+  # the result into a file, such as a yaml file. It is then more
+  # convenient to have the names of the program appear on the left
+  # side directoy, and the version on the right side.
+  #
+  # This Hash will hold the program name on the left side, and the
+  # program version on the right side. A nil value on the right
+  # side indicates that this program is NOT installed - which
+  # makes this the default value.
+  # ========================================================================= #
+  @hash_available_programs = {}
+
+  # ========================================================================= #
+  # === EnvironmentInformation.hash?
+  #
+  # This method will return the Hash of all available programs.
+  # ========================================================================= #
+  def self.hash?
+    @hash_available_programs
+  end; self.instance_eval { alias hash     hash? } # === EnvironmentInformation.hash
+       self.instance_eval { alias dataset? hash? } # === EnvironmentInformation.dataset?
+
+  # ========================================================================= #
+  # === EnvironmentInformation.add_to_hash
+  # ========================================================================= #
+  def self.add_to_hash(a, b)
+    b.strip! if b.is_a? String
+    if b.nil?
+      ::EnvironmentInformation.register_this_component_is_missing(a)
+    end
+    @hash_available_programs[a] = b
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.clear_hash
+  #
+  # This method can be used to clear the main (toplevel) Hash.
+  # ========================================================================= #
+  def self.clear_hash
+    @hash_available_programs.clear
+  end; self.instance_eval { alias clear_toplevel_hash clear_hash } # === EnvironmentInformation.clear_toplevel_hash
+       self.instance_eval { alias clear_main_hash     clear_hash } # === EnvironmentInformation.clear_main_hash
+
+end

data/lib/environment_information/toplevel_methods/internet_is_available.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/internet_is_available.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation.internet_is_available?
+  # ========================================================================= #
+  def self.internet_is_available?
+    require 'resolv'
+    dns_resolver = Resolv::DNS.new
+    begin
+      # ===================================================================== #
+      # The first domain name ever. Will probably not be removed.
+      # ===================================================================== #
+      dns_resolver.getaddress('symbolics.com')
+      return true
+    rescue Resolv::ResolvError => _error
+      return false
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts EnvironmentInformation.internet_is_available?
+end

data/lib/environment_information/toplevel_methods/is_on_roebe.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/is_on_roebe.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_i == 1
+  end
+
+end

data/lib/environment_information/toplevel_methods/menu.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/menu.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/toplevel_methods/e.rb'
+  require 'environment_information/version/version.rb'
+  require 'environment_information/colours/colours.rb'
+  require 'environment_information/colours/simp.rb'
+  require 'environment_information/constants/regex.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.menu
+  # ========================================================================= #
+  def self.menu(
+      i = ARGV
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === envi --replay
+      #
+      # The replay-functionality can be used to display information
+      # quickly, by reading the dataset from a local file.
+      # ===================================================================== #
+      when /^-?-?replay$/i
+        require 'environment_information/toplevel_methods/replay_from_the_stored_file.rb'
+        replay_from_the_stored_file
+      # ===================================================================== #
+      # === envi --version?
+      # ===================================================================== #
+      when *ARRAY_VERSION
+        report_version
+      # ===================================================================== #
+      # === envi --compare
+      # ===================================================================== #
+      when *ARRAY_COMPARE_PROGRAM_VERSIONS
+        require 'environment_information/toplevel_methods/show_all_available_components.rb'
+        ::EnvironmentInformation.show_all_available_components(
+          ['--compare-program-versions']
+        )
+      # ===================================================================== #
+      # === envi --gui
+      # ===================================================================== #
+      when /^-?-?gui$/i,
+           /^-?-?gtk$/i,
+           /^-?-?start(-|_)?gtk$/i
+        start_gtk_component
+      else
+        require 'environment_information/toplevel_methods/misc.rb'
+        EnvironmentInformation.test
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.report_version
+  # ========================================================================= #
+  def self.report_version
+    e "#{rev}The version of the EnvironmentInformation project "\
+      "in use is: #{simp(VERSION)}#{rev}"
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.start_gtk_component
+  #
+  # We have to rescue the code so to notify the user what exactly
+  # may have failed.
+  # ========================================================================= #
+  def self.start_gtk_component
+    begin
+      this_file = 'environment_information/gui/gtk/bindings.rb'
+      require this_file
+    rescue LoadError => error
+      e "An error happened - file #{sfile(this_file)} could not be found."
+      pp error
+    end
+    ::EnvironmentInformation.run_gtk
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation.menu(ARGV)
+end # rb menu.rb --version