environment_information 1.4.29

data/lib/environment_information/toplevel_methods/return_version_of_this_program.rb

@@ -0,0 +1,186 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/return_version_of_this_program.rb'
+# EnvironmentInformation.return_version_of_this_program
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'yaml'
+  require 'environment_information/colours/colours.rb'
+  require 'environment_information/constants/array_tracked_components.rb'
+  require 'environment_information/constants/error_line.rb'
+  require 'environment_information/constants/misc.rb'
+  require 'environment_information/constants/newline.rb'
+  require 'environment_information/toplevel_methods/e.rb'
+  require 'environment_information/toplevel_methods/prefix_to_use.rb'
+  require 'environment_information/requires/require_the_individual_misc_components.rb'
+  require 'environment_information/queries/pkg_config.rb'
+  require 'environment_information/queries/simple_version.rb'
+  require 'environment_information/queries/complex_version.rb'
+
+  begin
+    require 'rbt/utility_scripts/report_mate_desktop_version.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === @debug
+  #
+  # This variable can be used to control whether we debug the project
+  # or not. It should be false by default (and upon re-destribution of
+  # the project to other users).
+  # ========================================================================= #
+  @debug = false
+
+  # ========================================================================= #
+  # === @query_to_use_for_the_individual_components
+  #
+  # Initialize our dataset here.
+  # ========================================================================= #
+  @query_to_use_for_the_individual_components = YAML.load_file(
+    FILE_QUERY_TO_USE_FOR_THE_INDIVIDUAL_COMPONENTS
+  )
+
+  # ========================================================================= #
+  # === EnvironmentInformation.return_version_of_this_program
+  #
+  # This is the general method that will return the version of a particular
+  # program at hand.
+  #
+  # The method must be able to deal with using pkg-config, but also
+  # querying some program's version via --version, via the commandline,
+  # Furthermore, some programs may require an ad-hoc fix.
+  # ========================================================================= #
+  def self.return_version_of_this_program(
+      this_program,
+      prefix_to_use = @prefix_to_use
+    )
+    prefix_to_use = prefix_to_use.dup if prefix_to_use
+    version = nil # ← This is the default.
+    if this_program.is_a? Array
+      this_program = this_program.flatten.first
+    end
+    # ======================================================================= #
+    # Next define a few aliases.
+    # ======================================================================= #
+    case this_program.to_s
+    when 'diff'
+      this_program = 'diffutils'
+    when 'yacc'
+      this_program = 'bison'
+    end
+    if ARRAY_TRACKED_NON_PROGRAMS.include? this_program
+      return ::EnvironmentInformation.send(this_program)
+    elsif @query_to_use_for_the_individual_components.has_key? this_program.to_sym
+      use_this_command = @query_to_use_for_the_individual_components[this_program.to_sym]
+      case use_this_command
+      # ===================================================================== #
+      # === :mate_desktop
+      #
+      # This entry is special.
+      # ===================================================================== #
+      when :mate_desktop
+        return RBT.return_mate_desktop_version_array
+      # ===================================================================== #
+      # === :pkgconfig
+      #
+      # An invocation example for this would be:
+      #
+      #   x = EnvironmentInformation.return_version_of_this_program(:check) # => "0.15.2"
+      #
+      # ===================================================================== #
+      when :pkgconfig
+        version = ::EnvironmentInformation::Queries::PkgConfig.new(this_program).version?
+      # ===================================================================== #
+      # === :custom_gtk2
+      # ===================================================================== #
+      when :custom_gtk2
+        version = ::EnvironmentInformation::Queries::PkgConfig.new('gtk+-2.0').version?
+      # ===================================================================== #
+      # === :custom_mpc
+      #
+      # We rely on the header called mpc.h.
+      # ===================================================================== #
+      when :custom_mpc
+        version = ::EnvironmentInformation.return_version_of_mpc
+      # ===================================================================== #
+      # === :custom_boost
+      # ===================================================================== #
+      when :custom_boost
+        version = ::EnvironmentInformation.return_version_of_boost
+        if version.nil?
+          register_this_component_is_missing(:boost)
+        end
+      # ===================================================================== #
+      # === :version                                            (version tag)
+      #
+      # This entry point is typically for "program_name --version"
+      # entries. Some of them require custom modifications.
+      # ===================================================================== #
+      when :version
+        # =================================================================== #
+        # Next enable support for AppDir layout, where programs will
+        # ultimately reside in the same directory.
+        # =================================================================== #
+        unless prefix_to_use.empty?
+          prefix_to_use << "#{this_program.to_s.capitalize}/Current/bin/"
+        end
+        cmd = "#{prefix_to_use}#{this_program} --version #{ERROR_LINE}"
+        if @debug
+          e Colours.crimson('DEBUG for the prefix-value in use: ')+
+            Colours.steelblue(cmd)
+        end
+        version = ::EnvironmentInformation::Queries::SimpleVersion.new(this_program) {{
+          prefix_to_use: prefix_to_use
+        }}.version?
+      # ===================================================================== #
+      # Next we will handle special programs, such as "swig -v" and similar.
+      # This is done by class ComplexVersion since as of 29.08.2020.
+      # ===================================================================== #
+      else # else tag
+        if use_this_command.start_with?('pkg-config')
+          version = ::EnvironmentInformation::Queries::PkgConfig.new(this_program).version?
+        else
+          cmd = "#{@prefix_to_use}#{use_this_command} #{ERROR_LINE}"
+          version = ::EnvironmentInformation::Queries::ComplexVersion.new(this_program) {{
+            prefix_to_use: prefix_to_use
+          }}.version?
+        end
+      end
+    else
+      e 'Not registered any key for the program: '+this_program.to_s
+      e 'This is currently not allowed - please add this missing information.'
+      exit
+    end
+    result = version
+    if result
+      unless result.include? COMMAND_NOT_FOUND
+        result = result.dup if result.frozen?
+        result.strip!
+      end
+    end
+    if result and (result == 'found' or result == 'foud')
+      register_this_component_is_missing(this_program)
+    elsif result and result.include?(COMMAND_NOT_FOUND)
+      register_this_component_is_missing(this_program)
+    # ======================================================================= #
+    # Check whether pkg-config is available or not.
+    # ======================================================================= #
+    elsif result and (
+            result.include?(PKGCONFIG_COMMAND_NOT_FOUND) or
+            result.include?(NO_SUCH_FILE_OR_DIRECTORY)
+          )
+      register_this_component_is_missing(this_program)
+    elsif result.nil?
+      register_this_component_is_missing(this_program)
+    end
+    return result
+  end; self.instance_eval { alias version_for? return_version_of_this_program } # === EnvironmentInformation,version_for?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts EnvironmentInformation.return_version_of_this_program(ARGV)
+end # envireturnversionofthisprogram ruby
+    # envireturnversionofthisprogram ethtools

data/lib/environment_information/toplevel_methods/show_all_available_components.rb

@@ -0,0 +1,192 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/show_all_available_components.rb'
+# EnvironmentInformation.show_all_available_components
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # The next require also pulls in the misc/ components.
+  # ========================================================================= #
+  require 'environment_information/toplevel_methods/return_version_of_this_program.rb'
+  require 'environment_information/constants/array_tracked_components.rb'
+  require 'environment_information/constants/regex.rb'
+  require 'environment_information/toplevel_methods/hash.rb'
+  require 'environment_information/toplevel_methods/autogenerate_all_relevant_methods.rb'
+  require 'environment_information/toplevel_methods/misc.rb'
+  require 'environment_information/toplevel_methods/replay_from_the_stored_file.rb'
+
+  begin
+    require 'rbt/requires/swift_version.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # Add colours-support next:
+  # ========================================================================= #
+  require 'environment_information/colours/colours.rb'
+  require 'environment_information/queries/pkg_config.rb'
+  require 'environment_information/toplevel_methods/e.rb'
+  require 'environment_information/toplevel_methods/is_on_roebe.rb'
+  require 'environment_information/toplevel_methods/register_this_component_is_missing.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.show_all_available_components
+  #
+  # This method will quickly and easily show all available (registered)
+  # components. If you need more fine-tuning when you wish to display
+  # the main dataset at hand, then you should use other methods that
+  # are also a bit more complex. This method here is really just a
+  # fast version-display overview.
+  #
+  # The second argument to this method contains the programs that we
+  # wish to display through this method.
+  # ========================================================================= #
+  def self.show_all_available_components(
+      n_ljust               = 18,
+      show_these_components = ARRAY_DEFAULT_PROGRAMS_ON_LINUX+
+                              ARRAY_TRACKED_PROGRAMS,
+      use_colours           = use_colours?
+    )
+    clear_main_hash
+    if show_these_components.is_a? Array
+      show_these_components.flatten!
+    end
+    # ======================================================================= #
+    # The next variable determines whether we will also compare the
+    # program versions.
+    # ======================================================================= #
+    compare_program_versions = false
+    default_nljust_value = 30 # ← Detemine default padding.
+    if n_ljust.is_a?(Array) and n_ljust.empty?
+      n_ljust = default_nljust_value # Use the default value in this case.
+    end
+    # ======================================================================= #
+    # First we will treat n_ljust as a commandline-flag if it is a String
+    # and additionally begins with "--".
+    # ======================================================================= #
+    if n_ljust.is_a?(Array) and n_ljust.first.start_with?('--')
+      _ = n_ljust.first
+      case _
+      # ===================================================================== #
+      # === --compare-to-program-versions
+      #
+      # To invoke this, try:
+      #
+      #   show_components --compare
+      #   envi --compare-version
+      #
+      # ===================================================================== #
+      when *ARRAY_COMPARE_PROGRAM_VERSIONS
+        compare_program_versions = true
+        n_ljust = default_nljust_value
+      # ===================================================================== #
+      # === --xorg
+      # ===================================================================== #
+      when /^-?-?xorg$/i
+        show_these_components = ::EnvironmentInformation.xorg_components?
+        n_ljust = default_nljust_value
+      # ===================================================================== #
+      # === --help
+      #
+      # Invocation example:
+      #
+      #   showcomponents --help
+      #
+      # ===================================================================== #
+      when /^-?-?help$/i
+        e 'The following options are available for bin/fast_envi (fenvi):'
+        e
+        e '   --xorg                        # show only the xorg-components'
+        e '   --compare-to-program-versions # also compare the program versions'
+        e
+        exit
+      end
+    end
+    e
+    uniq = show_these_components.uniq
+    uniq.sort.each {|this_program|
+      use_this_name_for_send = "return_version_of_#{this_program}"
+      # ===================================================================== #
+      # Next, add the name of the program at hand, onto the left hand side:
+      # ===================================================================== #
+      result = this_program.to_s.ljust(n_ljust)
+      if use_colours
+        result = ::EnvironmentInformation.colourize_and_pad_the_left_side(result)
+      end
+      # ===================================================================== #
+      # Some components may not be installed on the user's computer system,
+      # which we have to keep in mind in the following code. This is
+      # why we will first apply the .send(), before checking whether
+      # the program at hand is actually missing or not.
+      # ===================================================================== #
+      result_of_send = send(use_this_name_for_send)
+      if result_of_send
+        result_of_send = result_of_send.dup if result_of_send.frozen?
+        result_of_send.strip!
+      end
+      @hash_available_programs[this_program.to_sym] = result_of_send.to_s
+      right_component = ''.dup
+      if @array_this_component_is_missing.include?(this_program.to_sym)
+        right_component << "not installed (or otherwise not found)".ljust(12)
+      else
+        right_component << result_of_send.ljust(12) if result_of_send
+      end
+      if use_colours
+        # =================================================================== #
+        # We will distinguish between components that have been found and
+        # components that have not been found.
+        # =================================================================== #
+        if right_component.include?('not installed')
+          right_component = ::Colours.send(:mediumslateblue, right_component)
+        else
+          right_component = ::Colours.send(colour_for_the_right_side, right_component)
+        end
+      end
+      result = result.dup if result.frozen?
+      result << right_component
+      if compare_program_versions
+        if is_this_program_included?(this_program)
+          registered_local_version = RBT.swift_return_version_of_this_program(this_program.to_sym).to_s.dup
+          if registered_local_version.include? 'v'
+            # =============================================================== #
+            # Modify entries such as 'v12.15.0' into '12.15.0'.
+            # =============================================================== #
+            registered_local_version.delete!('v')
+          end
+          case this_program.to_s
+          when 'gtk2'
+            registered_local_version = query_pkgconfig_version_for(:gtk2)
+          else
+            if result_of_send.nil?
+              # ^^^ This is missing, then, so it will be ignored.
+            elsif registered_local_version <= result_of_send 
+              # This is ok.
+            else
+              result << 
+                royalblue(
+                  "\n    "\
+                  "^^^ This could be updated; the version in "\
+                  "RBT is: #{mediumpurple(registered_local_version)}"
+                )
+            end
+          end
+        end
+      end
+      # ===================================================================== #
+      # Finally display our findings to the end user.
+      # ===================================================================== #
+      e result
+    }
+    e
+    if is_on_roebe? # And store it on my home system too.
+      ::EnvironmentInformation.store_relevant_files
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation.show_all_available_components(ARGV)
+end # showcomponents --compare

data/lib/environment_information/toplevel_methods/write_what_into.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/toplevel_methods/write_what_into.rb'
+# EnvironmentInformation.write_what_into
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.write_what_into
+  # ========================================================================= #
+  def self.write_what_into(what, into)
+    what = what.join("\n") if what.is_a? Array
+    File.open(into, 'w+') {|entry| entry.write(what) }
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation.write_what_into(ARGV, 'test_this.md')
+end

data/lib/environment_information/version/version.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/version/version.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation::VERSION
+  # ========================================================================= #
+  VERSION = '1.4.29'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '26.11.2020'
+
+  # ========================================================================= #
+  # === EnvironmentInformation::URL_TO_THE_DOCUMENTATION
+  # ========================================================================= #
+  URL_TO_THE_DOCUMENTATION =
+    "https://www.rubydoc.info/gems/#{self.to_s.split(/(?=[A-Z])/).join('_').downcase}/#{VERSION}"
+
+end

data/lib/environment_information/www/sinatra_interface.rb

@@ -0,0 +1,213 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === EnvironmentInformation::Sinatra
+# =========================================================================== #
+# require 'environment_information/www/sinatra_interface.rb'
+# =========================================================================== #
+require 'sinatra/base.rb'
+require 'beautiful_url'
+require 'environment_information/requires/require_the_environment_information_project.rb'
+
+module EnvironmentInformation
+
+class Sinatra < Sinatra::Base
+
+  include Colours
+  include Colours::E
+  begin
+    require 'html_tags'
+    include HtmlTags::BaseModule
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === USE_THIS_PORT
+  # ========================================================================= #
+  USE_THIS_PORT = '4567'
+
+  set :port, USE_THIS_PORT
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    super()
+    reset
+    if ::EnvironmentInformation.is_on_roebe?
+      require 'open_in_browser'
+      # ===================================================================== #
+      # Tell us which port will be used:
+      # ===================================================================== #
+      target = "http://localhost:#{USE_THIS_PORT}/"
+      e sfancy(target)
+      Thread.new {
+        sleep 1.0
+        OpenInBrowser[target]
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === html_end
+  # ========================================================================= #
+  def html_end
+    '<idv></body></html>'
+  end
+
+  # ========================================================================= #
+  # === return_html_start
+  #
+  # This method will include all parts up to the first main <div>
+  # element of the webpage.
+  # ========================================================================= #
+  def return_html_start
+    "<html><head><title>\n"\
+    "Sinatra-Interface of the EnvironmentInformation project\n"\
+    "</title></head><body>"\
+    "<div style=\"padding:2px; margin-left:0.5em\">"
+  end
+
+  # ========================================================================= #
+  # === / Entry point
+  #
+  # This is the root of our web-application.
+  # ========================================================================= #
+  get('/') {
+    # ======================================================================= #
+    # We will initialize the main Hash next, that is kept in
+    # EnvironmentInformation.
+    # ======================================================================= #
+    ::EnvironmentInformation.build_up_and_return_the_main_hash
+    inner_content = 
+      h2('Displaying information about the local computersystem')+
+      uniform_p_tag('Operating system in use:',
+        ::EnvironmentInformation.operating_system?)+
+      uniform_p_tag('OS Bit type (architecture):', 
+        ::EnvironmentInformation.bit_type?)+
+      uniform_p_tag('CPU Model:', 
+        ::EnvironmentInformation.cpu_model?)+
+      uniform_p_tag('CFLAGS in use:', 
+        ::EnvironmentInformation.cflags_in_use?)+
+      uniform_p_tag('RAM (in MB):', 
+        ::EnvironmentInformation.ram?)+
+      uniform_p_tag('Screen resolution:',
+        ::EnvironmentInformation.screen_resolution?.to_s)
+    inner_content = inner_content.dup
+    # ======================================================================= #
+    # Next, add the individual components:
+    # ======================================================================= #
+    %i(
+      gcc
+      glibc
+      linux_kernel
+      binutils
+      awk
+      ruby
+      rubygems
+      coreutils
+      diffutils
+      bison
+      boost
+      cmake
+      file
+      flex
+      intltool
+      gettext
+      grep
+      gnupg
+    ).each {|this_component|
+      inner_content << sinatra_paragraph_showing_this_component(this_component).to_s
+    }
+    return_html_start+
+    div(css_style: 'font-size: normal; margin-top:1px; margin-bottom: 1px;') {
+      inner_content
+    }+
+    html_end
+  }
+
+  # ========================================================================= #
+  # === uniform_p_tag
+  # ========================================================================= #
+  def uniform_p_tag(i, content)
+    i = i.to_s
+    unless i.end_with? ':'
+      i = i.dup if i.frozen?
+      i << ':'
+    end
+    p(
+      "#{i}<br><b style=\"color: darkblue; margin-left:1.5em\">#{content}"\
+      "</b>",
+      css_style: 'margin-left: 2.5em;
+                  margin: 4px;
+                  padding: 5px;
+                  padding-top: 0.2em'
+    )
+  end
+
+  # ========================================================================= #
+  # === sinatra_paragraph_showing_this_component
+  #
+  # This method was added primarily so that we can use a unified (and
+  # consistent) style for display.
+  # ========================================================================= #
+  def sinatra_paragraph_showing_this_component(
+      i = :gcc
+    )
+    content = "return_version_of_#{i}".to_s
+    content = ::EnvironmentInformation.send(content)
+    # ======================================================================= #
+    # Next, we grab it from the main Hash.
+    # ======================================================================= #
+    case i
+    when :awk,
+         :bison,
+         :boost,
+         :coreutils,
+         :binutils,
+         :cmake,
+         :diffutils,
+         :findutils,
+         :file,
+         :flex,
+         :gcc,
+         :gettext,
+         :glibc,
+         :grep,
+         :gnupg,
+         :intltool,
+         :ruby,
+         :rubygems
+      i = i.to_s.capitalize+' Version'
+    when :linux_kernel
+      i = 'Linux Kernel'
+    end
+    # ======================================================================= #
+    # Finally return the proper <p> tag:
+    # ======================================================================= #
+    uniform_p_tag(i, content)
+  end
+
+end
+
+# =========================================================================== #
+# === EnvironmentInformation.start_sinatra_interface
+#
+# This method can be used to start the sinatra interface.
+# =========================================================================== #
+def self.start_sinatra_interface
+  puts 'Trying to start the sinatra-interface of EnvironmentInformation next.'
+  ::EnvironmentInformation::Sinatra.run!
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation.start_sinatra_interface
+end # envi --sinatra

data/lib/environment_information/www/webobject_interface.cgi

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This small .cgi file just demonstrates how to use the information
+# from the EnvironmentInformation project in a .cgi page.
+# =========================================================================== #
+# http://localhost/DATA/PROGRAMMING_LANGUAGES/RUBY/src/environment_information/lib/environment_information/www/webobject_interface.cgi
+# =========================================================================== #
+require 'web_object/autoinclude'
+
+use_this_title = 'WebObject interface to EnvironmentInformation'
+
+english {
+title use_this_title
+fav 'PC/RUBY/RUBY_FAVICON.png'
+body_css_class 's4px padt2px marpad2px VERDANAs'
+body_css_style 'background-color: #d3d2d1;'
+font_size 'def'
+
+doc('mar0px') {
+  h1 sg(:buero_klammer, '','drag_buero_klammer')+
+     use_this_title
+  # ========================================================================= #
+  # Tap into showing the information from the EnvironmentInformation project.
+  # This is actually built into WebObject since as of February 2020.
+  # ========================================================================= #
+  WebObject.display_information_about_the_environment
+}}}

data/lib/environment_information/yaml/array_default_programs_on_linux.yml

@@ -0,0 +1,14 @@
+# =========================================================================== #
+# x = YAML.load_file('array_default_programs_on_linux.yml')
+# =========================================================================== #
+
+- !ruby/symbol operating_system
+- !ruby/symbol operating_system_bit_type
+- !ruby/symbol cpuinfo
+- !ruby/symbol ram
+- !ruby/symbol screen_resolution
+- !ruby/symbol cflags
+- !ruby/symbol gcc
+- !ruby/symbol glibc
+- !ruby/symbol linux
+- !ruby/symbol binutils