environment_information 1.4.29

data/lib/environment_information/class/opn.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/opn.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/class/colours.rb'
+  require 'environment_information/constants/namespace.rb'
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    if TRY_TO_MAKE_USE_OF_THE_OPN_GEM_IF_IT_IS_AVAILABLE and
+       Object.const_defined?(:Opn)
+      Opn.opn({
+        namespace:   NAMESPACE,
+        use_colours: use_colours?
+      })
+    end
+  end; alias opn opnn # === opn
+
+end; end

data/lib/environment_information/class/register_sigint.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/register_sigint.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === register_sigint
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') { e; exit }
+  end
+
+end; end

data/lib/environment_information/class/reset.rb

@@ -0,0 +1,213 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/reset.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @pkg_config_query
+    # ======================================================================= #
+    @pkg_config_query = ::EnvironmentInformation::Queries::PkgConfig.new
+    # ======================================================================= #
+    # === @simple_version_query
+    # ======================================================================= #
+    @simple_version_query = ::EnvironmentInformation::Queries::SimpleVersion.new
+    # ======================================================================= #
+    # === @complex_version_query
+    # ======================================================================= #
+    @complex_version_query = ::EnvironmentInformation::Queries::ComplexVersion.new
+    # ======================================================================= #
+    # === @array_report_these_programs
+    #
+    # This Array denotes which programs are to be reported.
+    #
+    # By default it is empty.
+    # ======================================================================= #
+    @array_report_these_programs = []
+    # ======================================================================= #
+    # === @array_unavailable_programs
+    #
+    # Programs which could not be found can be registered into the following
+    # Array.
+    # ======================================================================= #
+    @array_unavailable_programs = []
+    # ======================================================================= #
+    # === @runmode
+    #
+    # The @runmode variable can be :commandline or :gui or :www.
+    # ======================================================================= #
+    @runmode = :commandline
+    # ======================================================================= #
+    # === @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.
+    # ======================================================================= #
+    @show_everything = false
+    # ======================================================================= #
+    # === @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.
+    # ======================================================================= #
+    @display_result = true
+    # ======================================================================= #
+    # === @be_silent
+    #
+    # By default, this class is not silent, meaning that it will display
+    # information to the user.
+    # ======================================================================= #
+    @be_silent = 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.
+    # ======================================================================= #
+    @may_we_try_to_use_rbt = true
+    # ======================================================================= #
+    # === @array_show_this_to_the_user
+    #
+    # The following Array can be used to show messages to the user.
+    # ======================================================================= #
+    @array_show_this_to_the_user = []
+    # ======================================================================= #
+    # === @array_display_these_components
+    #
+    # This Array will display the components 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.
+    # ======================================================================= #
+    @array_display_these_components = []
+    # ======================================================================= #
+    # === @sort_alphabetically
+    #
+    # Whether to sort the main Hash alphabetically or not.
+    # ======================================================================= #
+    @sort_alphabetically = 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.
+    # ======================================================================= #
+    @show_ruby_version_and_gem_version = 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.
+    # ======================================================================= #
+    @display_everything_in_short_format = false
+    # ======================================================================= #
+    # === @run_already
+    #
+    # This variable will be true by default.
+    # ======================================================================= #
+    @run_already = true
+    # ======================================================================= #
+    # === @show_help
+    #
+    # If this variable is set to true, then we will only show help, then
+    # exit the program.
+    # ======================================================================= #
+    @show_help = false
+    # ======================================================================= #
+    # === @do_exit_the_program
+    #
+    # The following variable can determine when we exit from this class.
+    # By default we will not exist early.
+    # ======================================================================= #
+    @do_exit_the_program = false
+    # ======================================================================= #
+    # === @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?
+      @array_these_programs_not_up_to_date = []
+    end
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :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
+    # ======================================================================= #
+    # === @internal_hash[: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.
+    # ======================================================================= #
+    @internal_hash[:try_to_rename_the_kde_konsole_tab] = false
+    # ======================================================================= #
+    # === @internal_hash[: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
+    # ======================================================================= #
+    # === @internal_hash[: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[:use_ascii_table]
+    #
+    # Whether to use an ASCII table or whether we will not:
+    # ======================================================================= #
+    @internal_hash[:use_ascii_table] = false
+    # ======================================================================= #
+    # === @internal_hash[:table]
+    # ======================================================================= #
+    @internal_hash[:table] = nil # The ascii table.
+    # ======================================================================= #
+    # === @internal_hash[: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.
+    # ======================================================================= #
+    @internal_hash[:compare_program_versions] = false
+  end
+
+end; end

data/lib/environment_information/class/ruby.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/ruby.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === dont_show_ruby_stuff
+  #
+  # Disable showing ruby + gem information.
+  # ========================================================================= #
+  def dont_show_ruby_stuff # Dont show ruby stuff.
+    @show_ruby_version_and_gem_version = false
+  end; alias show_no_ruby dont_show_ruby_stuff # === show_no_ruby
+
+  # ========================================================================= #
+  # === return_all_ruby_components
+  #
+  # Combine three calls into one here - all related to ruby.
+  # ========================================================================= #
+  def return_all_ruby_components
+    %i(
+      ruby
+      rubygems
+      rubygems_installation_directory
+    )
+  end
+
+  # ========================================================================= #
+  # === consider_adding_the_ruby_components
+  #
+  # This method can be used to consider adding the ruby-components,
+  # which means "ruby" itself, rubygems "gem", and the rubygems
+  # installation directory.
+  # ========================================================================= #
+  def consider_adding_the_ruby_components
+    if @show_ruby_version_and_gem_version
+      add(
+        return_all_ruby_components # Combine three calls into one here - all related to ruby.
+      )
+    end
+  end
+
+  # ========================================================================= #
+  # === do_not_show_the_ruby_components
+  # ========================================================================= #
+  def do_not_show_the_ruby_components
+    @show_ruby_version_and_gem_version = false
+  end; alias do_not_display_the_ruby_components do_not_show_the_ruby_components # === do_not_display_the_ruby_components
+
+  # ========================================================================= #
+  # === return_version_of_rubygems?
+  # ========================================================================= #
+  def return_version_of_rubygems?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_rubygems return_version_of_rubygems? # == return_version_of_rubygems
+
+  # ========================================================================= #
+  # === return_version_of_ruby?
+  # ========================================================================= #
+  def return_version_of_ruby?
+    ::EnvironmentInformation.send(__method__)
+  end; alias return_version_of_ruby return_version_of_ruby? # == return_version_of_ruby
+
+  require 'environment_information/misc_components/rubygems_installation_directory.rb'
+  # ========================================================================= #
+  # === rubygems_installation_directory?
+  # ========================================================================= #
+  def rubygems_installation_directory?
+    ::EnvironmentInformation.rubygems_installation_directory?
+  end
+
+end; end

data/lib/environment_information/class/run.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/run.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    # ======================================================================= #
+    # Try to rename the KDE konsole first. This will happen on
+    # roebe-systems only.
+    # ======================================================================= #
+    do_rename_kde_konsole
+    # ======================================================================= #
+    # ^^^ This check happens here again because menu() is allowed to
+    # toggle this variable.
+    # ======================================================================= #
+    if @display_everything_in_short_format
+      assign_components_for_the_short_format # Handle the short format here.
+    end
+    do_sort_alphabetically if @sort_alphabetically # ← Must come before the report-step.
+    unless @do_exit_the_program
+      # ===================================================================== #
+      # === Report step
+      #
+      # We may only display the components if @display_result is true.
+      # ===================================================================== #
+      if @display_result
+        register_the_available_components_and_show_them_at_once
+      end
+    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 @internal_hash[:generate_a_html_file]
+    if commandline? and store_the_results_into_local_files?
+      # ===================================================================== #
+      # Only store local files if the variable 
+      # @store_the_results_into_local_files is true.
+      # ===================================================================== #
+      consider_storing_the_components_that_were_displayed
+      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