environment_information 1.4.124 → 1.5.5

data/lib/environment_information/query/query.rb

@@ -0,0 +1,245 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# ============================================================================ #
+# === EnvironmentInformation::Query
+#
+# The primary purpose of this class is to provide information about
+# the computer environment ruby is running on. Obviously ruby must
+# be available on the target computer, 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.
+#
+# Usage example:
+#
+#   EnvironmentInformation::Query.new(ARGV)
+#
+# ============================================================================ #
+# 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
+#
+# Another usage example:
+#
+#   EnvironmentInformation.new('--kdeversions?')
+#
+# ============================================================================ #
+# require 'environment_information/query/query.rb'
+# ============================================================================ #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class Query < ::EnvironmentInformation::Base # === EnvironmentInformation::Query
+
+  require 'colours/autogenerated/html_colours_methods.rb'
+  require 'environment_information/commandline/commandline.rb'
+  require 'environment_information/constants/constants.rb'
+  require 'environment_information/project/project.rb'
+  require 'environment_information/version/version.rb'
+  require 'environment_information/requires/require_asciitable.rb'
+  require 'environment_information/query/constants.rb'
+  require 'environment_information/query/help.rb'
+  require 'environment_information/query/menu.rb'
+  require 'environment_information/query/misc.rb'
+  require 'environment_information/query/reset.rb'
+  require 'environment_information/query/run.rb'
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  begin
+    require 'rbt/toplevel_methods/url.rb'
+  rescue LoadError
+    if ::EnvironmentInformation.is_on_roebe?
+      puts 'The file rbt/toplevel_methods/url.rb is not available.'
+    end
+  end
+
+  begin
+    require 'rbt/requires/swift_version.rb'
+  rescue LoadError
+    if ::EnvironmentInformation.is_on_roebe?
+      puts 'The file rbt/toplevel_methods/swift_return_version_of_this_program.rb is not available.'
+    end
+  end
+
+  begin
+    require 'rbt/actions/individual_actions/information/report_mate_desktop_version.rb'
+  rescue LoadError; end
+
+  # ========================================================================== #
+  # === initialize
+  # ========================================================================== #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true,
+      &block
+    )
+    register_sigint
+    reset
+    # ======================================================================== #
+    # And set :run_already, so that menu() can overrule it lateron. This
+    # should come before we call set_commandline_arguments().
+    # ======================================================================== #
+    @internal_hash[:run_already] = run_already
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    # ======================================================================== #
+    # Next, we handle special run-mode variants.
+    # ======================================================================== #
+    case run_already?
+    when :do_not_run_yet
+      @internal_hash[:run_already] = false
+    # ======================================================================== #
+    # === do_show_everything
+    # ======================================================================== #
+    when :do_show_everything
+      do_show_everything
+      @internal_hash[:run_already] = true
+    end
+    # ======================================================================== #
+    # === Handle blocks next
+    #
+    # Next blocks will be handled. This must come after the reset() method.
+    # ======================================================================== #
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Symbol
+        case yielded # case tag
+        # ==================================================================== #
+        # === :be_quiet
+        # ==================================================================== #
+        when :be_quiet
+          set_be_verbose(:be_quiet)
+        # ==================================================================== #
+        # === :do_not_use_rbt
+        # ==================================================================== #
+        when :do_not_use_rbt
+          @internal_hash[: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,
+             :dont_run_yet
+          @internal_hash[:run_already] = false
+        end
+      # ====================================================================== #
+      # === Handle Hashes given in the block next.
+      # ====================================================================== #
+      elsif 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
+    run if run_already?
+  end
+
+  # ========================================================================== #
+  # === EnvironmentInformation::Query[]
+  # ========================================================================== #
+  def self.[](
+      i = ARGV, &block
+    )
+    new(i, &block)
+  end
+
+end
+
+# ============================================================================ #
+# === EnvironmentInformation.return_version_of_sed?
+#
+# This method will return the version of sed.
+# ============================================================================ #
+def self.return_version_of_sed?(
+    i = :sed
+  )
+  _ = ::EnvironmentInformation::Query.new(i, :do_not_run_yet) { :be_quiet }
+  _.clear_old_dataset
+  _.add_the_commandline_arguments
+  _.do_work_through_all_the_specified_components
+  return _.version?
+end; self.instance_eval { alias return_sed_version    return_version_of_sed? } # === EnvironmentInformation.return_sed_version
+     self.instance_eval { alias return_version_of_sed return_version_of_sed? } # === EnvironmentInformation.return_version_of_sed
+
+# =========================================================================== #
+# === 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::Query.new(:full_be_silent).stringified
+end
+
+# ============================================================================ #
+# === EnvironmentInformation.run
+# ============================================================================ #
+def self.run(i = ARGV, &block)
+  ::EnvironmentInformation::Query.new(i, &block)
+end; self.instance_eval { alias new                run } # === EnvironmentInformation.new
+     self.instance_eval { alias []                 run } # === EnvironmentInformation[]
+     self.instance_eval { alias run_the_main_class run } # === EnvironmentInformation.run_the_main_class
+     self.instance_eval { alias result             run } # === EnvironmentInformation.result
+     self.instance_eval { alias show               run } # === EnvironmentInformation.show
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation.run(ARGV)
+end # mainclass

data/lib/environment_information/query/reset.rb

@@ -0,0 +1,202 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# ============================================================================ #
+# require 'environment_information/query/reset.rb'
+# ============================================================================ #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class Query < ::EnvironmentInformation::Base # === EnvironmentInformation::Query
+
+  # ========================================================================== #
+  # === reset                                                      (reset tag)
+  # ========================================================================== #
+  def reset
+    super()
+    set_be_verbose
+    # ======================================================================== #
+    # === :the_primary_hash
+    #
+    # This Hash will keep track as to which programs will be displayed.
+    #
+    # The version must be registered into this primary Hash.
+    #
+    # This hash's keys will contain the components that will be reported,
+    # such as on the commandline.
+    #
+    # Take note that the order is important: the entries that appear first
+    # will be displayed earlier. In other words: first entries will be
+    # shown first as well.
+    #
+    # By default it is empty, naturally.
+    # ======================================================================== #
+    @internal_hash[:the_primary_hash] = {}
+    # ======================================================================== #
+    # === :display_the_results_at_once
+    # ======================================================================== #
+    @internal_hash[:display_the_results_at_once] = true
+    # ======================================================================== #
+    # === :display_everything_in_short_format
+    #
+    # This variable determines whether we will use a compact-display or
+    # whether there will be one-entry-per-program instead.
+    # ======================================================================== #
+    @internal_hash[:display_everything_in_short_format] = false
+    # ======================================================================== #
+    # === :may_we_try_to_use_rbt
+    #
+    # Whether we may query RBT for additional help or not. By default
+    # we will try to make use of RBT.
+    # ======================================================================== #
+    @internal_hash[:may_we_try_to_use_rbt] = true
+    # ======================================================================== #
+    # === :namespace
+    # ======================================================================== #
+    @internal_hash[:namespace] = NAMESPACE
+    # ======================================================================== #
+    # === :runmode
+    #
+    # The :runmode variable can be :commandline or :gui or :www.
+    # ======================================================================== #
+    @internal_hash[:runmode] = :commandline
+    # ======================================================================== #
+    # === :generate_a_html_file
+    #
+    # If the next instance variable is set to true then a html file will
+    # be generated. By default this will not happen, though.
+    # ======================================================================== #
+    @internal_hash[:generate_a_html_file] = false
+    # ======================================================================== #
+    # === :do_exit_the_program
+    #
+    # The following variable can determine when we exit from this class.
+    # By default we will not exist early.
+    # ======================================================================== #
+    @internal_hash[:do_exit_the_program] = false
+    # ======================================================================== #
+    # === :array_unavailable_programs
+    #
+    # Programs which could not be found can be registered into the following
+    # Array.
+    # ======================================================================== #
+    @internal_hash[:array_unavailable_programs] = []
+    # ======================================================================== #
+    # === :use_one_line_to_show_the_result
+    # ======================================================================== #
+    @internal_hash[:use_one_line_to_show_the_result] = false
+    # ======================================================================== #
+    # === :try_to_rename_the_kde_konsole_tab
+    #
+    # The following instance variable will determine as to whether we will
+    # try to make use of the KDE Konsole and rename the tab of the konsole
+    # there.
+    #
+    # Since as of October 2018 we will not use the KDE konsole by default
+    # anymore. This may change at a later moment in time, though, hence
+    # why this remains part of reset(). I tried this again in April 2024,
+    # but it is too spammy, so I will most likely no longer use it anyway.
+    # ======================================================================== #
+    @internal_hash[:try_to_rename_the_kde_konsole_tab] = false
+    # ======================================================================== #
+    # === :compare_program_versions
+    #
+    # This instance variable can be used to also compare the program
+    # versions, if the RBT project is available.
+    #
+    # By default this will not be done, though, hence the value of false.
+    # ======================================================================== #
+    @internal_hash[:compare_program_versions] = false
+    # ======================================================================== #
+    # === :store_the_results_into_local_files
+    #
+    # If the following variable is set to true then the project will
+    # generate local files too, e. g. yaml files and what not.
+    # ======================================================================== #
+    @internal_hash[:store_the_results_into_local_files] = true
+    # ======================================================================== #
+    # === @internal_hash[:run_already]
+    #
+    # This variable will be true by default.
+    # ======================================================================== #
+    @internal_hash[:run_already] = true
+    # ======================================================================== #
+    # === :sort_alphabetically
+    #
+    # Whether to sort the main Hash alphabetically or not.
+    # ======================================================================== #
+    @internal_hash[:sort_alphabetically] = false
+    # ======================================================================== #
+    # === :dataset_containing_all_tracked_programs
+    #
+    # This will always contain all tracked programs, taken from a
+    # .yml file.
+    # ======================================================================== #
+    @internal_hash[:dataset_containing_all_tracked_programs] = ::EnvironmentInformation::ARRAY_TRACKED_PROGRAMS
+    # ======================================================================== #
+    # === :table
+    #
+    # This variable keeps track over as to whether this class will make
+    # use of an ASCII table or whether it will not.
+    # ======================================================================== #
+    @internal_hash[:table] = nil
+    # ======================================================================== #
+    # === :use_ascii_table
+    #
+    # Whether to use an ASCII table or whether we will not.
+    # ======================================================================== #
+    @internal_hash[:use_ascii_table] = false
+    # ======================================================================== #
+    # === :report_the_remote_urls
+    #
+    # If this instance variable is set to true then the remote URLs will
+    # be shown as well, on the commandline.
+    # ======================================================================== #
+    @internal_hash[:report_the_remote_urls] = false
+    # ======================================================================== #
+    # === :show_everything
+    #
+    # If the following instance variable is set to true then this class
+    # will try to show every registered (and thus, available) component.
+    #
+    # By default this is not wanted, so it is disabled. The user has to
+    # specifically enable this option via the commandline, if so
+    # desired, and thus overrule this default value.
+    # ======================================================================== #
+    @internal_hash[:show_everything] = false
+    # ======================================================================== #
+    # === :show_ruby_version_and_gem_version
+    #
+    # This instance variable determines whether class EnvironmentInformation
+    # will display the ruby version and the gem version.
+    #
+    # By default we will do so, but there may be situations where this
+    # may be unwanted, or not a good idea, such as in a minimal system
+    # where no ruby is running, or if the user only wants to display
+    # very little information.
+    # ======================================================================== #
+    @internal_hash[:show_ruby_version_and_gem_version] = true
+    # ======================================================================== #
+    # === :display_result
+    #
+    # If the following instance variable is true, which is the case by
+    # default, then this class will report to the user on the commandline.
+    #
+    # If it is set to false then nothing will be displayed; this is
+    # useful when you only want to obtain the dataset, without
+    # showing anything to the user.
+    # ======================================================================== #
+    @internal_hash[:display_result] = true
+    # ======================================================================== #
+    # === :array_these_programs_not_up_to_date
+    #
+    # This Array can be used to save into a local file which programs
+    # are not up to date.
+    # ======================================================================== #
+    if is_on_roebe?
+      @internal_hash[:array_these_programs_not_up_to_date] = []
+    end
+  end
+
+end; end

data/lib/environment_information/query/run.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# ============================================================================ #
+# require 'environment_information/query/run.rb'
+# ============================================================================ #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class Query < ::EnvironmentInformation::Base # === EnvironmentInformation::Query
+
+  # ========================================================================== #
+  # === run                                                          (run tag)
+  # ========================================================================== #
+  def run
+    # ======================================================================== #
+    # Reset the toplevel-array keeping track of all missing components.
+    # ======================================================================== #
+    ::EnvironmentInformation.clear_array_missing_components
+    # ======================================================================== #
+    # Try to rename the KDE konsole first. This will happen on
+    # roebe-systems only.
+    # ======================================================================== #
+    do_rename_kde_konsole
+    # ======================================================================== #
+    # Find the appropriate version next:
+    # ======================================================================== #
+    # add(return_all_available_components)
+    # ======================================================================== #
+    # Invoke menu() to query the commandline arguments.
+    # ======================================================================== #
+    menu
+    if display_everything_in_short_format?
+      assign_components_for_the_short_format # Handle the short format here.
+    end
+    if sort_alphabetically? # ← Must come before the report-step.
+      do_sort_alphabetically
+    end
+    if insta_show?
+      # ====================================================================== #
+      # In this case we already showed every component.
+      # ====================================================================== #
+    else
+      check_this_hash_for_unavailable_programs(the_primary_hash?)
+      display_these_components
+    end
+    # ======================================================================== #
+    # === Consider generating a .html file
+    #
+    # The user may want to generate a .html file, so the following
+    # functionality allows the user to do so. This check should
+    # ideally come before other local files are generated.
+    # ======================================================================== #
+    do_generate_a_html_file if generate_a_html_file?
+    sync_the_primary_hash_onto_the_toplevel_hash
+    if commandline? and shall_we_store_the_main_hash_into_a_local_file?
+      store_this_hash_into_a_local_file(the_primary_hash?)
+      # ====================================================================== #
+      # Only store local files if the variable 
+      # @store_the_results_into_local_files is true.
+      # ====================================================================== #
+      consider_storing_which_programs_are_not_up_to_date
+    end
+  end; alias feedback_everything    run # === feedback_everything
+       alias do_feedback_everything run # === do_feedback_everything 
+       alias output                 run # === output
+       alias feedback               run # === feedback
+
+end; end

data/lib/environment_information/requires/require_the_environment_information_project.rb

@@ -5,14 +5,9 @@
 # require 'environment_information/requires/require_the_environment_information_project.rb'
 # =========================================================================== #
 require 'environment_information/requires/require_the_constants.rb'
-require 'environment_information/colours/sfancy.rb'
-require 'environment_information/colours/simp.rb'
+require 'environment_information/colours/colours.rb'
 require 'environment_information/version/version.rb'
 # =========================================================================== #
-# Next, require the individual components:
-# =========================================================================== #
-require 'environment_information/requires/require_the_individual_misc_components.rb'
-# =========================================================================== #
 # Next, require the toplevel-methods of environment_information/:
 # =========================================================================== #
 require 'environment_information/requires/require_the_toplevel_methods.rb'
@@ -20,4 +15,4 @@ require 'environment_information/requires/require_the_toplevel_methods.rb'
 # And then we will require the main class of the environment information
 # project:
 # =========================================================================== #
-require 'environment_information/class/class.rb'
+require 'environment_information/query/query.rb'

data/lib/environment_information/requires/require_the_toplevel_methods.rb

@@ -12,9 +12,7 @@ module EnvironmentInformation
   # === 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)}"
-    }
+    require 'environment_information/toplevel_methods/toplevel_methods.rb'
   end
 
   require_the_toplevel_methods # And require them at once.