environment_information 1.4.89

data/lib/environment_information/class/initialize.rb

@@ -0,0 +1,177 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === EnvironmentInformation::EnvironmentInformation
+#
+# The primary purpose of this class is to provide information about
+# the computer environment ruby is running on. Obviously ruby must
+# be available in order for this class (this program) to work.
+#
+# By default, class EnvironmentInformation will run in
+# "commandline mode", that is, it will output information
+# onto the console/terminal.
+#
+# The dataset is of course also available internally, though, so you
+# can query this information and display it e. g. in a traditional
+# GUI or WWW setting, like for a webpage.
+# =========================================================================== #
+# A complete usage example for the main class follows next:
+#
+#   require 'environment_information'
+#
+#   _ = EnvironmentInformation::EnvironmentInformation.new(:do_not_run_yet)
+#   _.disable_colours
+#   _.be_silent
+#   _.run
+#   _.string
+#
+# =========================================================================== #
+# require 'environment_information/class/initialize.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/class/run.rb'
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    register_sigint
+    reset
+    # ======================================================================= #
+    # Next, we handle special run-mode variants.
+    # ======================================================================= #
+    case run_already
+    when :do_show_everything
+      do_show_everything
+      run_already = true
+    end
+    # ======================================================================= #
+    # And set @run_already, so that menu() can overrule it lateron.
+    # ======================================================================= #
+    @run_already = run_already
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    # ======================================================================= #
+    # === Handle blocks
+    #
+    # Next blocks will be handled. This must come after the reset() method.
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded # case tag
+      # ===================================================================== #
+      # === :do_not_use_rbt
+      # ===================================================================== #
+      when :do_not_use_rbt
+        @may_we_try_to_use_rbt = false
+      # ===================================================================== #
+      # === :disable_colours
+      # ===================================================================== #
+      when :disable_colours
+        disable_colours
+      # ===================================================================== #
+      # === :disable_colours_and_do_not_store_into_a_local_file
+      # ===================================================================== #
+      when :disable_colours_and_do_not_store_into_a_local_file
+        disable_colours
+        do_not_save_anything
+      # ===================================================================== #
+      # === :do_not_run_yet
+      # ===================================================================== #
+      when :do_not_run_yet
+        @run_already = false
+      else
+        # =================================================================== #
+        # Handle Hashes given in the block.
+        # =================================================================== #
+        if yielded.is_a? Hash
+          # ================================================================= #
+          # === :use_n_tokens
+          # ================================================================= #
+          if yielded.has_key? :use_n_tokens
+            set_use_n_tokens(yielded.delete(:use_n_tokens))
+          # ================================================================= #
+          # === :n_tokens
+          # ================================================================= #
+          elsif yielded.has_key? :n_tokens
+            set_use_n_tokens(yielded.delete(:n_tokens))
+          end
+          # ================================================================= #
+          # === :use_colours
+          # ================================================================= #
+          if yielded.has_key? :use_colours
+            set_use_colours(yielded.delete(:use_colours))
+          end
+          # ================================================================= #
+          # === :be_silent
+          # ================================================================= #
+          if yielded.has_key? :be_silent
+            set_be_silent(yielded.delete(:be_silent))
+          end
+          # ================================================================= #
+          # === :show_ruby_stuff
+          # ================================================================= #
+          if yielded.has_key? :show_ruby_stuff
+            if yielded.delete(:show_ruby_stuff) == false
+              dont_show_ruby_stuff
+            end
+          end
+        end
+      end
+    end
+    # ======================================================================= #
+    # First, we will add the default programs on a linux computer. The
+    # later invocation to menu() can change this, but we also want to
+    # provide "useful defaults" for users to benefit from this gem.
+    # ======================================================================= #
+    add_the_default_programs_on_a_linux_computer
+    # ======================================================================= #
+    # Add the ruby components next. This must come before menu().
+    # ======================================================================= #
+    consider_adding_the_ruby_components 
+    # ======================================================================= #
+    # Invoke menu() to query and honour the commandline arguments.
+    # ======================================================================= #
+    menu
+    run if @run_already
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::EnvironmentInformation[]
+  # ========================================================================= #
+  def self.[](i = ARGV, &block)
+    new(i, &block)
+  end
+
+end
+
+# =========================================================================== #
+# === EnvironmentInformation.run_the_main_class
+# =========================================================================== #
+def self.run_the_main_class(i = ARGV, &block)
+  ::EnvironmentInformation::EnvironmentInformation.new(i, &block)
+end; self.instance_eval { alias result run_the_main_class } # === EnvironmentInformation.result
+     self.instance_eval { alias show   run_the_main_class } # === EnvironmentInformation.show
+     self.instance_eval { alias new    run_the_main_class } # === EnvironmentInformation.new
+     self.instance_eval { alias []     run_the_main_class } # === EnvironmentInformation[]
+
+# =========================================================================== #
+# === EnvironmentInformation.environment_information?
+#
+# This method will return a very long string containing all
+# information about the locally installed/available programs.
+# =========================================================================== #
+def self.environment_information?
+  ::EnvironmentInformation::EnvironmentInformation.new(:full_be_silent).stringified
+end
+
+end

data/lib/environment_information/class/menu.rb

@@ -0,0 +1,465 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/menu.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/class/help.rb'
+  require 'environment_information/class/html.rb'
+  require 'environment_information/class/misc.rb'
+  require 'environment_information/class/ruby.rb'
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  #
+  # This method constitutes the "menu" interface for class
+  # EnvironmentInformation. It usually deals with the
+  # commandline-given arguments stored in ARGV.
+  # ========================================================================= #
+  def menu(
+      i = @commandline_arguments
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === envi --one-liner
+      #
+      # A more complex usage example may be this:
+      #
+      #   envi --rall --oneliner
+      #
+      # ===================================================================== #
+      when /^-?-?one(-|_)?liner$/i # === envi --oneliner
+        @internal_hash[:use_one_line_to_show_the_result] = true # This is different to the short-format.
+      # ===================================================================== #
+      # === envi --short
+      # ===================================================================== #
+      when /^-?-?short$/i,
+           /^-?-?display(-|_)?short(-|_)?format$/i,
+           /^-?-?do(-|_)?display(-|_)?in(-|_)?a(-|_)?short(-|_)?format$/i
+        do_display_in_a_short_format
+      # ===================================================================== #
+      # === envi --sort-alphabetically
+      #
+      # This entry point can also be combined, such as in:
+      #
+      #   envi --show-everything --sort-alphabetically
+      #
+      # ===================================================================== #
+      when /^-?-?sort(-|_)?alphabetically$/i,
+           /^-?-?sort$/i,
+           /^-?-?alphabetically$/i,
+           /^-?-?alphabet$/i
+        enable_sort_alphabetically
+      # ===================================================================== #
+      # === envi --use-colours?
+      # ===================================================================== #
+      when /^-?-?use(-|_)?colou?rs\??$/i
+        e 'Will colours be used? '+
+          ::EnvironmentInformation.verbose_truth(
+            ::EnvironmentInformation.use_colours?.to_s
+          )
+        do_not_run
+        @do_exit_the_program = true
+      # ===================================================================== #
+      # === :do_show_everything
+      #
+      # An alternative way to make use of this entry point is via:
+      #
+      #   envi --do-show-everything
+      #   envi --show-everything
+      #
+      # ===================================================================== #
+      when :do_show_everything,
+           :show_really_everything,
+           /^-?-?do(_|-)?show(_|-)?everything$/i,
+           /^-?-?show(-|_)?everything$/i,
+           /^-?-?show(-|_)?full(-|_)?information$/i,
+           /^-?-?everything$/i,
+           /^-?-?rall$/i,
+           'ALL'
+        do_show_everything
+        @run_already = true
+      # ===================================================================== #
+      # === envi --kdeversions?
+      #
+      # Note that this variant depends on another gem, called "rbt", and
+      # the associated RBT namespace.
+      # ===================================================================== #
+      when /^-?-?kde(_|-)?versions\??$/i,
+           /^-?-?kde\??$/i
+        report_the_installed_KDE_software_suite
+      # ===================================================================== #
+      # === envi --registered-components?
+      # ===================================================================== #
+      when /^-?-?registered(_|-)?components\??$/i,
+           /^-?-?available\??$/i
+        do_not_run_already
+        show_the_registered_components
+        @do_exit_the_program = true
+      # ===================================================================== #
+      # === envi --additional=php
+      #
+      # This entry point allows us to show additional programs.
+      #
+      # Another usage example:
+      #
+      #   envi --additional=php,python,perl
+      #
+      # ===================================================================== #
+      when /^-?-?additional=(.+)$/i,
+           /^-?-?add=(.+)$/i
+        _ = $1.to_s.dup
+        add(_)
+      # ===================================================================== #
+      # === envi --n_entries?
+      # ===================================================================== #
+      when /^-?-?n(_|-)?entries\??$/i,
+           /^-?-?n(_|-)?programs\??$/i # envi --nprograms?
+        show_n_registered_entries # === envi --n_entries
+        @do_exit_the_program = true
+      # ===================================================================== #
+      # === envi --use-these-programs=bash,binutils,bison,yacc,bzip2,coreutils,diff,find,gawk,gcc,grep,gzip,linux,make,m4,patch,perl,python,sed,tar,makeinfo,xz
+      # === envi --use-these-programs=:lfs
+      #
+      # This entry point can be used to display a certain subset of
+      # programs, at the user's discretion.
+      # ===================================================================== #
+      when /^-?-?use(-|_)?these(-|_)?programs=(.+)$/i # === $3
+        # =================================================================== #
+        # First clear (aka reset) the main dataset.
+        # =================================================================== #
+        clear_old_dataset
+        match = $3.to_s.dup
+        add(match)
+      # ===================================================================== #
+      # === envi --show-remote-url
+      #
+      # This entry point will also show the remote URL to the
+      # program at hand.
+      # ===================================================================== #
+      when /^-?-?show(_|-)?remote(_|-)?url$/i
+        do_report_the_remote_urls
+      # ===================================================================== #
+      # === envi --help
+      #
+      # This entry point will always show help-related information.
+      # ===================================================================== #
+      when /^-?-?help$/i
+        do_show_help
+      # ===================================================================== #
+      # === envi --really-all
+      #
+      # This entry point is for really showing everything.
+      # ===================================================================== #
+      when /^-?-?REALLY(_|-)?ALL$/i,
+           /^-?-?compare(_|-)?program(_|-)?version$/i,
+           /^-?-?compare(_|-)?to(_|-)?program(_|-)?versions$/i,
+           /^-?-?do(_|-)?compare(_|-)?program(_|-)?version$/i,
+           /^-?-?really(_|-)?everything$/i
+        clear_old_dataset
+        add_default_linux_programs
+        add_ruby_and_rubygems
+        do_show_almost_everything_excluding_the_default_linux_programs
+        do_compare_the_program_version
+      # ===================================================================== #
+      # === envi --no-save
+      #
+      # Skip saving into a local file through this entry point.
+      #
+      # Invocation example:
+      #
+      #   envi --lfs --no-save
+      #
+      # ===================================================================== #
+      when /^-?-?no(_|-)?save$/i
+        do_not_save_anything
+      # ===================================================================== #
+      # === envi --os?
+      # ===================================================================== #
+      when /^-?-?OS\??$/i,
+           /^-?-?show(-|_)?only(-|_)?the(-|_)?operating(-|_)?system$/i
+        do_show_only_the_operating_system
+        show_no_ruby
+      # ===================================================================== #
+      # === envi --help
+      # ===================================================================== #
+      when /help/i
+        @show_help = true
+      # ===================================================================== #
+      # === envi --clear
+      #
+      # This entry point will simply clear the old dataset.
+      #
+      # This can be used to only display a few components, such as:
+      #
+      #   envi --clear --python --ruby --perl
+      #
+      # ===================================================================== #
+      when /^-?-?clear$/i,
+           /^-?-?clear(_|-)?old(_|-)?dataset$/i
+        clear_old_dataset
+      # ===================================================================== #
+      # === envi --sinatra
+      # ===================================================================== #
+      when /^-?-?sinatra$/i,
+           /^-?-?www$/i
+        start_the_sinatra_interface
+      # ===================================================================== #
+      # === envi --open
+      # ===================================================================== #
+      when /^-?-?open$/i,
+           /^-?-?edit$/i
+        open_this_file_in_editor
+      # ===================================================================== #
+      # === envi --lfs
+      # ===================================================================== #
+      when /^-?-?lfs$/i,
+           /^-?-?lfs(_|-)?core(_|-)?programs$/i
+        clear_old_dataset
+        add(:lfs_core_programs)
+      # ===================================================================== #
+      # === envi openssl
+      # ===================================================================== #
+      when /^-?-?openssl$/,
+           'ssl'
+        add(:openssl)
+      # ===================================================================== #
+      # === envi --science
+      # ===================================================================== #
+      when /^-?-?science$/
+        clear_old_dataset
+        add(:science_cluster)
+      # ===================================================================== #
+      # === envi --nocolours
+      #
+      # This entry point can be used to disable usage of colours.
+      # ===================================================================== #
+      when /^-?-?nocolours/,'2',
+           /^-?-?no(-|_)?colou?rs$/i,
+           /^-?-?nocol$/i,
+           /^-?-?disable(-|_)?colou?rs$/i, # === envi --really-all --disable-colours
+           :disable_colours
+        disable_colours
+      # ===================================================================== #
+      # === envi --version
+      # ===================================================================== #
+      when *ARRAY_VERSION
+        report_version
+      # ===================================================================== #
+      # === envi --gui
+      # ===================================================================== #
+      when /^-?-?gui$/i,
+           /^-?-?gtk$/i,
+           /^-?-?start(-|_)?gtk$/i
+        start_gtk_component
+      # ===================================================================== #
+      # === envi --replay
+      # ===================================================================== #
+      when /^-?-?replay$/i
+        require 'environment_information/toplevel_methods/replay_from_the_stored_file.rb'
+        ::EnvironmentInformation.replay_from_the_stored_file
+      # ===================================================================== #
+      # === envi --be_silent_no_colours
+      #
+      # Not sure why the following entry point exists, but I will retain it
+      # for the time being.
+      # ===================================================================== #
+      when /^-?-?be(_|-)?silent(_|-)?no(_|-)?colours$/
+        disable_colours
+        do_not_display_the_result
+        do_show_everything
+      # ===================================================================== #
+      # This entry point is mostly for internal use, e. g. to pass
+      # in Symbols to menu().
+      # ===================================================================== #
+      when :be_silent_no_colours_everything,
+           :be_silent_and_no_colours,
+           :be_silent_no_colours,
+           :full_be_silent
+        disable_colours
+        do_show_everything
+        do_not_display_the_result
+      # ===================================================================== #
+      # === envi --be_silent
+      # ===================================================================== #
+      when /^-?-?be(_|-)?silent$/i # === envi --be-silent
+        do_not_display_the_result
+        do_show_everything
+      # ===================================================================== #
+      # === envi --work-on-programs-directory-only
+      # ===================================================================== #
+      when /^-?-?work(-|_)?on(-|_)?programs(-|_)?directory(-|_)?only$/i,
+           /^-?-?work(-|_)?on(-|_)?the(-|_)?programs(-|_)?directory(-|_)?only$/i
+        work_on_the_programs_directory_only
+      # ===================================================================== #
+      # === envi --do-save
+      # ===================================================================== #
+      when /^save$/i,
+           /^-?-?do(_|-)?save$/i
+        @store_the_results_into_local_files = true
+      # ===================================================================== #
+      # === envi --asciitable
+      # ===================================================================== #
+      when /^-?-?asciitable$/i,
+           'table','1'
+        use_ascii_table if ASCIITABLE_IS_AVAILABLE
+      # ===================================================================== #
+      # === envi --read-from-this-file=/Depot/j/display_these_programs.md
+      # === envi --file=/Depot/j/display_these_programs.md
+      # === envi --input-from=/Depot/j/display_these_programs.md
+      # ===================================================================== #
+      when /^-?-?read(-|_)?from(-|_)?this(-|_)?file=(.+)$/i, # <- And this has $4
+           /^-?-?file=(.+)$/i, # <- This has only $1
+           /^-?-?input(-|_)?from=(.+)$/i # <- This has $2
+        _ = $1.to_s.dup
+        _ = $2.to_s.dup if $2
+        _ = $4.to_s.dup if $4
+        clear_old_dataset
+        set_use_this_as_main_input(
+          load_dataset_from_this_file(_)
+        )
+      # ===================================================================== #
+      # === envi --no-yaml-file
+      # ===================================================================== #
+      when /^-?-?no(-|_)?yaml(-|_)?file$/i,
+           /^-?-?no(-|_)?local(-|_)?file$/i
+        @store_the_results_into_local_files = false
+      # ===================================================================== #
+      # === envi noruby
+      # ===================================================================== #
+      when /^-?-?noruby$/i,
+           'show_no_ruby',
+           'classic',
+           'naked',
+           '3',
+           'minimal'
+        show_no_ruby
+      # ===================================================================== #
+      # === envi --show-all
+      # ===================================================================== #
+      when /^-?-?show(-|_)?all$/i,
+           /^-?-?all$/i,
+           /^-?-?full$/i,
+           /^-?-?everything$/i,    # === envi --everything
+           /^-?-?information$/i,
+           'f',
+           '4'
+        do_show_everything # <- Just to be sure.
+      # ===================================================================== #
+      # === :be_silent
+      # ===================================================================== #
+      when /^-?-?be(_|-)?silent$/i,
+           :be_silent # We will be silent, but we will still show everything.
+        do_not_display_the_result
+        do_show_everything
+      # ===================================================================== #
+      # === envi --compare_programs
+      #
+      # This entry point allows us to compare the program versions with
+      # the one registered in RBT.
+      # ===================================================================== #
+      when *ARRAY_COMPARE_PROGRAM_VERSIONS
+        do_compare_the_program_version
+      # ===================================================================== #
+      # === envi --generate-html-file
+      #
+      # This entry point can be used to generate a local .html file.
+      # ===================================================================== #
+      when /^-?-?generate(-|_)?html(-|_)?file$/i,
+           /^-?-?html$/i # envi --HTML
+        @internal_hash[:generate_a_html_file] = true
+        set_runmode_html # Set it here again, just in case.
+        do_show_everything
+      # ===================================================================== #
+      # === envi --show-components?
+      # ===================================================================== #
+      when /^-?-?show(-|_)?components\??$/i
+        e "#{true_rev}The following components will be shown on a default run:"
+        e
+        show_these_components?.each {|this_component|
+          if this_component.is_a? Array
+            this_component = this_component.first
+          end
+          e "  - #{steelblue(this_component)}#{true_rev}"
+        }
+        e
+        exit
+      # ===================================================================== #
+      # === :do_not_run_yet
+      #
+      # Invocation example:
+      #
+      #   envi --do-not-run-yet
+      #
+      # ===================================================================== #
+      when /^-?-?-do(-|_)?not(-|_)?run(-|_)?yet$/i, # === envi --do-not-run-yet
+           :do_not_run_yet,
+           :dont_run_yet,
+           :default # This is the default variant.
+        @run_already = false
+      # ===================================================================== #
+      # === envi --pkgconfig
+      #
+      # Show all pkgconfig entries - but only these.
+      # ===================================================================== #
+      when /^-?-?pkg(-|_)?config$/i
+        clear_old_dataset
+        add(:pkgconfig_entries)
+      # ===================================================================== #
+      # === envi --xorg-components
+      #
+      # This entry point is for when the user only wants to show the
+      # xorg-components on the local computer system.
+      # ===================================================================== #
+      when /^-?-?xorg(_|-)?components$/i,
+           /^-?-?xorg$/i,
+           /^-?-?show(_|-)?xorg(_|-)?components$/i
+        do_show_only_the_xorg_components
+      else # else tag
+        # =================================================================== #
+        # It is better to report that the given commandline-input as
+        # not found, so this will be reported. Before we can do so, we
+        # will first check whether the user wanted to pass some
+        # existing/registered component nonetheless.
+        #
+        # This clause can be checked via something like this:
+        #
+        #   envi --bash
+        #   envi --brotli
+        #
+        # =================================================================== #
+        if is_a_registered_component?(i.delete('-'))
+          # ================================================================= #
+          # The next line has been added in August 2022. Not sure if we
+          # retain it or not - either way the future will show.
+          # ================================================================= #
+          @array_report_these_programs.clear # Clear the old result first.
+          do_not_store_anything
+          add(
+            i.delete('-')
+          )
+        else
+          # ================================================================= #
+          # Only enter the report-section if we do NOT want to exit early.
+          # ================================================================= #
+          do_show_help if show_help?
+          # Or:
+          # e 'Unhandled command input (in file environment_information/class/menu.rb): '
+          # e
+          # e "  #{sfancy(i)}"
+          # e
+        end
+      end
+    end
+  end
+
+end; end