environment_information 1.4.89

data/doc/todo/TODO_FOR_THE_ENVIRONMENT_INFORMATION_PROJECT.md

@@ -0,0 +1,48 @@
+------------------------------------------------------------------------------
+- add in envi the ability to query from another base-prefix
+  e. g. /home/Programs/.
+
+  Invocation example:
+
+    envi --work-on-programs-directory-only
+
+and then explain this too.
+
+So the idea is to first ONLY consider
+checking the programs that are registered
+and THEn to check inside of these directories,
+e. g. for pkgconfig, or for --version or whatever
+only there
+also ewe will use only those directories
+with "Current" symlink pointing to EXISTING directories.
+^^^
+THEN also
+make it available on /home/Programs/Toolchain
+
+then upload
+
+^^^ this works now with the first variant but only for
+    "bison --version" programs; need to add support
+    for pkg-config programs too, at a later time.
+
+^^^ also has to then add it onto --help to show it
+    once it works properly.
+
+------------------------------------------------------------------------------
+(7) in envi: add
+
+--scan-this-directory=/Programs
+^^^ this shall check for each directory there, if it is NOT empty,
+and then to find out what to use to determine the version 
+dynamically.
+but before we do so, perhaps add a way to query the binary
+from any path... e. g. /Programs/Htop/Current/ or so
+------------------------------------------------------------------------------
+(8)
+
+- if we rewrite the project, properly add disabling of saving
+  files AND checking permissions
+------------------------------------------------------------------------------
+test absolute prefixes again
+------------------------------------------------------------------------------
+(10) add a new log for environment information

data/environment_information.gemspec

@@ -0,0 +1,135 @@
+# =========================================================================== #
+# Gemspec for Project EnvironmentInformation.
+# =========================================================================== #
+require 'environment_information'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'environment_information'
+  s.version = EnvironmentInformation::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+The gem environment_information is able to provide information about the
+computer host system, in particular on Linux systems, if ruby is available
+on that computer. Commonly used programs will be queried for their current
+version number (and whether they exist) on the target computer. If these
+programs do happen to exist then the corresponding version will be
+displayed, on the commandline.
+
+This is somewhat similar to the "Linux from Scratch" project, which uses
+a shell script to display the version of many commonly used programs.
+As I prefer to use ruby rather than shell scripts, I wrote this somewhat
+equivalent project.
+
+This project currently tracks the version of 
+#{::EnvironmentInformation.tracked_programs?.size} 
+different programs.
+
+For more information and documentation about this project, consider
+looking at the homepage of this gem, at
+
+  https://rubygems.org/gems/environment_information
+
+and look at the documentation on the bottom right side,
+called "Documentation".
+
+  EOF
+  
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+  
+  # =============================================================== #
+  # Show this when a user installs this project.
+  # =============================================================== #
+  s.post_install_message = <<-EOF
+
+You can run this little script by issuing:
+
+    envi
+
+on the commandline. (The script envi is part of this gem and can
+be found at the subdirectory bin/envi of the gem.)
+
+Within ruby code, you can require the project and then display
+information too, via:
+
+    require 'environment_information'
+    EnvironmentInformation.run
+
+For the (documented) options, you can do either of the following:
+
+    envi --help
+    envi HELP
+
+This will feedback the options that are available.
+
+To get the full output of just about every program that is checked
+by this gem, try any of the following invocation:
+
+    envi --all
+    envi ALL
+
+(Lowercase works fine just as well. The commandline options that
+include two '-' characters are, internally, the preferred variants.)
+
+To obtain an individual entry, do something such as this:
+
+    envi gtk
+    envi pango
+    envi gcr
+
+To disable colours, do either one of these:
+
+    envi --nocolours
+    envi --no-colours
+    envi --no-colors
+    envi --nocolors
+    envi nocolours
+    envi NOCOLOURS
+
+(Both UK and US spelling is supported, so colour works just as
+well as color.)
+
+If all of this may become too tedious to type, I just use an
+alias called ALL, which stands short for "envi all" or 
+"envi show_all".
+
+Another option, both of which are synonymous to each other,
+is to compare all existing programs on a given host system
+with the version registered in the RBT project:
+
+    envi ALL REALLY_ALL
+    envi --compare_programs
+    envi compare_programs
+
+If you wish to show only the OS information, do:
+
+    envi --os?
+
+For more documentation about the project, have a look at:
+
+    #{EnvironmentInformation::URL_TO_THE_DOCUMENTATION}
+
+  EOF
+
+  s.authors    = ['Robert A. Heiler']
+  s.email      = Roebe.email?
+  s.files      = Dir['**/*']
+  s.licenses   = 'MIT'
+  s.homepage   = 'https://rubygems.org/gems/environment_information'
+  s.executables = Dir['bin/*'].map { |f| File.basename(f) }
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies of this project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  # s.add_dependency 'opn' # ← An optional dependency since as of 10.03.2020
+
+}

data/lib/environment_information/base/base.rb

@@ -0,0 +1,159 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/base/base.rb'
+# < ::EnvironmentInformation::Base
+# =========================================================================== #
+module EnvironmentInformation
+
+class Base
+
+  require 'environment_information/requires/require_the_constants.rb'
+  require 'environment_information/colours/colours.rb'
+  require 'environment_information/toplevel_methods/e.rb'
+  require 'environment_information/toplevel_methods/misc.rb'
+
+  require 'environment_information/toplevel_methods/is_on_roebe.rb'
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def esystem(i)
+    e i
+    system i
+  end
+
+  # ========================================================================= #
+  # === gold
+  # ========================================================================= #
+  def gold(i = '')
+    return ::Colours.gold(i)
+  end
+
+  # ========================================================================= #
+  # === lightblue
+  # ========================================================================= #
+  def lightblue(i = '')
+    return ::Colours.lightblue(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
+
+end; end

data/lib/environment_information/class/add.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/add.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === add                                                         (add tag)
+  #
+  # This method can be used to add individual entries to the main array
+  # called @array_report_these_programs.
+  #
+  # The format for add() contains only one component, which appears on
+  # the left side, and denotes the name of the program or component
+  # that we wish to query, such as "php" or "ruby" and so forth.
+  #
+  # Some Symbols will be used as a "pointer" towards an Array of 
+  # registered programs.
+  # 
+  # Note that (1) will be converted into a Symbol if it is a String.
+  #
+  # If the second entry (2) is nil, then the version will be inferred
+  # at "runtime" within the method display(). Otherwise display()
+  # will simply use the passed version (which should be a String in
+  # that case, then).
+  #
+  # Before we can add an entry to the main dataset, we have to check
+  # whether it is a registered entry altogether. If it is not
+  # registered, the user has to be notified about this fact.
+  # This notification will ONLY happen if the associated version is nil;
+  # if a specific version is supplied then this method will assume
+  # that the program should be displayed anyway.
+  #
+  # An Array can also be supplied to this method, if necessary.
+  # ========================================================================= #
+  def add(
+      i
+    )
+    if i.is_a?(String) and i.include?(',')
+      # ===================================================================== #
+      # Strings containing ',' will be split accordingly.
+      # ===================================================================== #
+      i = i.split(',')
+    elsif i.is_a?(String) and i.include?('-')
+      # ===================================================================== #
+      # Strings containing '-' will lose that '-'.
+      # ===================================================================== #
+      i = i.dup if i.frozen?
+      i.delete!('-')
+    end
+    [i].flatten.compact.each {|entry|
+      case entry
+      # ===================================================================== #
+      # === :everything
+      #
+      # This entry point is meant for simply adding everything.
+      # ===================================================================== #
+      when :everything
+        entry = return_every_registered_component
+      # ===================================================================== #
+      # === Rubygems installation directory
+      # ===================================================================== #
+      when :rubygems_installation_directory,
+           /^rubygems( |_)?installation( |_)?directory\??$/i
+        entry = 'rubygems_installation_directory'
+      # ===================================================================== #
+      # === cflags
+      # ===================================================================== #
+      when :cflags,
+           /^cflags$/i
+        entry = 'CFLAGS in use'
+      # ===================================================================== #
+      # === screen_resolution
+      # ===================================================================== #
+      when :screen_resolution,
+           /^screen( |_)?resolution$/i
+        entry = 'Screen Resolution'
+      # ===================================================================== #
+      # === ram
+      # ===================================================================== #
+      when :ram,
+           /^ram$/i
+        entry = 'RAM'
+      # ===================================================================== #
+      # === cpuinfo
+      # ===================================================================== #
+      when :cpuinfo,
+           /^cpuinfo$/i
+        entry = 'CPU Model'
+      # ===================================================================== #
+      # === operating_system_bit_type
+      # ===================================================================== #
+      when :operating_system_bit_type,
+           /^operating(_|-)?system(_|-)?bit(_|-)?type$/i
+        entry = 'Operating system bit type'
+      # ===================================================================== #
+      # === :operating_system
+      # ===================================================================== #
+      when :operating_system,
+           /^operating(_|-)?system$/i,
+           /^operating(_|-)?system(_|-)?in(_|-)?use$/i
+        entry = 'Operating system'
+      # ===================================================================== #
+      # === cpflags
+      # ===================================================================== #
+      when /^cflags$/i,
+           /^CFLAGS in use$/i
+        entry = 'CFLAGS in use'
+      # ===================================================================== #
+      # === :pkgconfig_entries
+      # ===================================================================== #
+      when :pkgconfig_entries
+        entry = ::EnvironmentInformation.return_pkgconfig_based_programs
+      # ===================================================================== #
+      # === :all_xorg_components
+      # ===================================================================== #
+      when :all_xorg_components
+        entry = return_all_xorg_components
+      # ===================================================================== #
+      # === envi --science
+      # ===================================================================== #
+      when :science_cluster
+        entry = ARRAY_SCIENCE_CLUSTER
+      # ===================================================================== #
+      # === envi --lfs_core_programs
+      # ===================================================================== #
+      when :lfs,
+           :lfs_core_programs
+       entry = ::EnvironmentInformation.lfs_core_programs?
+      # ===================================================================== #
+      # === :linux_kernel
+      # ===================================================================== #
+      when :linux_kernel
+        i = :linux
+      # ===================================================================== #
+      # === :RAM
+      # ===================================================================== #
+      when :RAM
+        entry = :ram # Just the "alias" to the real entry.
+      end
+      unless @array_report_these_programs.include? entry
+        @array_report_these_programs << entry
+        @array_report_these_programs.flatten!
+      end
+    }
+  end; alias update_version_for         add # === add
+       alias append                     add # === append
+       alias append_this_to_main_string add # === append_this_to_main_string
+       alias show_these_entries         add # === show_these_entries
+       alias set_additional             add # === set_additional
+
+  # ========================================================================= #
+  # === add_the_default_programs_on_a_linux_computer
+  # ========================================================================= #
+  def add_the_default_programs_on_a_linux_computer
+    # ======================================================================= #
+    # Add the default programs on a linux computer.
+    # ======================================================================= #
+    add(
+      return_default_programs_on_a_linux_computer
+    )
+  end; alias add_default_linux_programs add_the_default_programs_on_a_linux_computer # === add_default_linux_programs
+
+  # ========================================================================= #
+  # === add_ruby_and_rubygems
+  # ========================================================================= #
+  def add_ruby_and_rubygems
+    add(:ruby)
+    add(:rubygems)
+    add(:rubygems_installation_directory)
+  end
+
+  # ========================================================================= #
+  # === add_this_to_the_toplevel_hash
+  # ========================================================================= #
+  def add_this_to_the_toplevel_hash(a, b)
+    a = a.to_sym unless a.is_a? Symbol
+    ::EnvironmentInformation.hash?[a] = b
+  end; alias register_onto_the_main_hash add_this_to_the_toplevel_hash # === register_onto_the_main_hash
+
+end; end