environment_information 1.4.89

data/lib/environment_information/class/show_display_and_report.rb

@@ -0,0 +1,355 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/show_display_and_report.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/toplevel_methods/is_on_roebe.rb'
+  require 'environment_information/toplevel_methods/return_alias_to.rb'
+  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/toplevel_methods/url.rb'
+  rescue LoadError
+    if ::EnvironmentInformation.is_on_roebe?
+      puts 'The file rbt/toplevel_methods/url.rb is not available.'
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help?
+  # ========================================================================= #
+  def show_help?
+    @show_help
+  end
+
+  # ========================================================================= #
+  # === compare_via_gem_version
+  # ========================================================================= #
+  def compare_via_gem_version(i)
+    begin
+      Gem::Version.new(i)
+    rescue ArgumentError => error
+      e Colours.tomato(error)
+      e 'We will continue nonetheless ('+i+')'
+      return nil
+    end
+  end
+
+  require 'environment_information/toplevel_methods/e.rb'
+  # ========================================================================= #
+  # === e                                                             (e tag)
+  #
+  # The e() method is the general output-method for this class.
+  # ========================================================================= #
+  def e(i = '')
+    unless @be_silent
+      if use_one_line_to_show_the_result? # This will just use "print".
+        ::EnvironmentInformation.ee(i)
+      else
+        ::EnvironmentInformation.e(
+          i, display_everything_in_short_format: @display_everything_in_short_format
+        )
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === do_report_the_remote_urls
+  #
+  # Enable the reporting of the remote URLs, if available.
+  # ========================================================================= #
+  def do_report_the_remote_urls
+    @internal_hash[:report_the_remote_urls] = true
+  end
+
+  # ========================================================================= #
+  # === show_the_registered_components
+  # ========================================================================= #
+  def show_the_registered_components(
+      i = tracked_programs?
+    )
+    e
+    e 'The following programs will be tracked:'
+    e
+    use_one_line_to_show_the_result = use_one_line_to_show_the_result?
+    i.each_with_index {|this_program, index| index += 1
+      if use_one_line_to_show_the_result
+        padded_index = index.to_s+') '
+      else
+        padded_index = '  '+(index.to_s+') ').rjust(5)
+      end
+      colourized_and_padded_index = seagreen(padded_index)
+      e colourized_and_padded_index+
+        steelblue(this_program)
+    }
+    e
+  end
+
+  # ========================================================================= #
+  # === report_version
+  # ========================================================================= #
+  def report_version
+    require 'environment_information/toplevel_methods/menu.rb'
+    ::EnvironmentInformation.report_version
+    @do_exit_the_program = true
+  end
+
+  # ========================================================================= #
+  # === display_these_components?
+  #
+  # Note that @display_these_components is a Hash.
+  # ========================================================================= #
+  def display_these_components?
+    @array_report_these_programs
+  end; alias components?                  display_these_components? # === components?
+       alias main_dataset?                display_these_components? # === main_dataset?
+       alias main_entry?                  display_these_components? # === main_entry?
+       alias dataset?                     display_these_components? # === dataset?
+       alias result                       display_these_components? # === result
+       alias result?                      display_these_components? # === result?
+       alias display_which_components?    display_these_components? # === display_which_components?
+       alias array_obtain_these_programs? display_these_components? # === array_obtain_these_programs?
+       alias array_with_entries?          display_these_components? # === array_with_entries?
+       alias main_array?                  display_these_components? # === main_array?
+       alias programs?                    display_these_components? # === programs?
+       alias show_these_components?       display_these_components? # === show_these_components?
+
+  # ========================================================================= #
+  # === main_hash?
+  # ========================================================================= #
+  def main_hash?
+    ::EnvironmentInformation.hash?
+  end
+
+  # ========================================================================= #
+  # === register_the_available_components_and_show_them_at_once  (report tag)
+  #
+  # This method can be used to register information about the various
+  # components. It will also instantly display the component at
+  # hand, to avoid "lagging" behaviour on the commandline.
+  # ========================================================================= #
+  def register_the_available_components_and_show_them_at_once(
+      report_these_programs = @array_report_these_programs
+    )
+    if report_these_programs.empty?
+      opn; e 'There are no components that can be displayed.' # And this ends here.
+    else
+      # ===================================================================== #
+      # Always clear the main Array before proceeding here.
+      # ===================================================================== #
+      clear_missing_components
+      toplevel_hash = ::EnvironmentInformation.hash?
+      hash_use_this_for_the_query = ::EnvironmentInformation.all_the_queries
+      # ===================================================================== #
+      # Iterate over the registered programs next.
+      # ===================================================================== #
+      report_these_programs.each {|this_program|
+        # =================================================================== #
+        # First, determine the left_side and the right_side.
+        # =================================================================== #
+        left_side  = this_program.to_s.dup
+        right_side = nil
+        case this_program
+        # =================================================================== #
+        # === RAM
+        # =================================================================== #
+        when :ram,
+             /^RAM$/i
+          right_side = ram?.to_s.dup
+          right_side = right_side.dup if right_side.frozen?
+          # ================================================================= #
+          # Append 'MB RAM' in orange colour next, with some padding.
+          # This is just a small visual "enhancement" that I quite like.
+          # ================================================================= #
+          right_side << orange(' MB RAM')
+        # =================================================================== #
+        # === Rubygems installation directory
+        # =================================================================== #
+        when :rubygems_installation_directory,
+             /^rubygems( |_)?installation( |_)?directory\??$/i
+          right_side = rubygems_installation_directory?
+        # =================================================================== #
+        # === cflags
+        # =================================================================== #
+        when :cflags,
+             /^cflags$/i,
+             /^cflags(_|-| )?in(_|-| )?use$/i
+          right_side = cflags_in_use?
+        # =================================================================== #
+        # === Screen resolution
+        #
+        # This is a bit "special" in the sense that we will colourize
+        # the middle 'x', if found, and if colours are used.
+        # =================================================================== #
+        when :screen_resolution,
+             /^screen( |_)?resolution$/i
+          right_side = screen_resolution?
+          if right_side.include?('x') and use_colours?
+            splitted = right_side.split('x')
+            right_side = colourize_this_in_the_right_side_colour(splitted.first)+
+                         royalblue('x')+
+                         colourize_this_in_the_right_side_colour(splitted.last)
+          end
+        # =================================================================== #
+        # === CPU Model
+        # =================================================================== #
+        when /^cpuinfo$/i,
+             /^CPU(_|-| )?Model/
+          right_side = cpu_model?
+        # =================================================================== #
+        # === Operating system bit type
+        # =================================================================== #
+        when /^operating(_|-| )?system(_|-| )?bit(_|-| )?type$/i
+          right_side = bit_type?
+        # =================================================================== #
+        # === Operating system
+        # =================================================================== #
+        when /^Operating(_|-| )?system$/i,
+             :operating_system
+          right_side = ::EnvironmentInformation.operating_system
+        end
+        # =================================================================== #
+        # Find the corresponding entry next while including aliases:
+        # =================================================================== #
+        this_program = this_program.to_sym # These are stored as symbol.
+        this_program = ::EnvironmentInformation.return_alias_to(this_program)
+        _ = hash_use_this_for_the_query[this_program]
+        if hash_use_this_for_the_query.has_key? this_program
+          if _.to_s.start_with? 'pkg'
+            # =============================================================== #
+            # === :pkgconfig
+            #
+            # This is by far the simplest solution.
+            # =============================================================== #
+            right_side = @pkg_config_query.return_version_of(this_program)
+            add_this_to_the_toplevel_hash(left_side, right_side)
+          # ================================================================= #
+          # === :version
+          #
+          # Here we will handle simple versions, e. g. "lftp --version"
+          # entries, and similar.
+          # ================================================================= #
+          elsif _ == :version
+            right_side = @simple_version_query.return_version_of(this_program)
+            add_this_to_the_toplevel_hash(left_side, right_side)
+          else
+            # =============================================================== #
+            # Else we will pass through class ComplexVersion:
+            # =============================================================== #
+            right_side = @complex_version_query.return_version_of(this_program)
+            add_this_to_the_toplevel_hash(left_side, right_side)
+          end
+        # =================================================================== #
+        # The next clause has been written specifically to allow querying
+        # the mate-desktop components.
+        # =================================================================== #
+        elsif toplevel_hash.has_key?(this_program) and
+              toplevel_hash[this_program] # ← This is thus non-nil.
+          right_side = toplevel_hash[this_program] 
+        end
+        if right_side.nil?
+          register_unavailable_program(this_program)
+        end
+        # =================================================================== #
+        # === @internal_hash[:report_the_remote_urls]
+        #
+        # Next, honour @internal_hash[:report_the_remote_urls] if it is
+        # set to true.
+        # =================================================================== #
+        if report_the_remote_urls? and
+           is_rbt_available? and
+           RBT.respond_to?(:remote_url_for?)
+          version = ''.dup
+          _ = this_program.to_s.delete('-').downcase.strip.to_sym
+          if RBT.does_include?(_)
+            remote_url = RBT.remote_url_for?(_, :return_as_string)
+            if is_a_registered_component? _
+              if version.frozen?
+                version = version.dup
+              end
+              version << lightgreen(remote_url)
+              if right_side # We can only continue if the program is available.
+                # In theory we could show the URL anyway, but for the time
+                # being, at the least, we will not show the URL.
+                right_side = right_side.dup if right_side.frozen?
+                right_side << " #{olive('→')} #{version}"
+              end
+            end
+          end
+        end
+        # =================================================================== #
+        # The next method is defined in base.rb.
+        # =================================================================== #
+        report_left_right(
+          left_side,
+          right_side,
+          :default_colour,
+          :default_colour,
+          :default_colour,
+          !use_one_line_to_show_the_result?
+        )
+        # =================================================================== #
+        # Next compare the program versions with the local versions.
+        # =================================================================== #
+        if compare_program_versions? and
+           is_rbt_available_and_may_we_try_to_use_rbt? and
+           RBT.respond_to?(:swift_return_version_of_this_program) and
+           RBT.does_include?(left_side.to_s.strip)
+          # ================================================================= #
+          # Example:
+          #
+          #   RBT.swift_return_version_of_this_program(:gettext)
+          #
+          # ================================================================= #
+          registered_local_version = RBT.swift_return_version_of_this_program(
+            left_side.to_s.strip.to_sym
+          ).to_s
+          # ================================================================= #
+          # We ignore gtk2 when it comes to the version-check.
+          # ================================================================= #
+          next if this_program == :gtk2
+          # ================================================================= #
+          # Next use Gem::Version to compare them, but not if the version
+          # is nil.
+          # ================================================================= #
+          unless right_side.nil?
+            # =============================================================== #
+            # The .delete('v') is specifically for libuv or node.
+            # =============================================================== #
+            registered_local_version = registered_local_version.to_s.
+                                       delete('v').
+                                       tr('_','.')
+            a = compare_via_gem_version(registered_local_version)
+            b = compare_via_gem_version(right_side)
+            if a and b and (a > b)
+              e slateblue('     ^^^^^ This program could be '\
+                'upgraded, to the version ')+
+                steelblue(registered_local_version)
+            end if registered_local_version =~ /\d+/
+          end
+        end
+      }
+    end
+  end; alias display                     register_the_available_components_and_show_them_at_once # === display
+       alias report_result               register_the_available_components_and_show_them_at_once # === report_result
+       alias display_the_components      register_the_available_components_and_show_them_at_once # === display_the_components
+       alias display_the_dataset         register_the_available_components_and_show_them_at_once # === display_the_dataset
+       alias work_through_the_programs   register_the_available_components_and_show_them_at_once # === work_through_the_programs
+       alias build_up_the_main_string    register_the_available_components_and_show_them_at_once # === build_up_the_main_string
+       alias display_the_main_components register_the_available_components_and_show_them_at_once # === build_up_the_main_string
+       alias report                      register_the_available_components_and_show_them_at_once # === report
+
+end; end

data/lib/environment_information/colours/colours.rb

@@ -0,0 +1,211 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/colours/colours.rb'
+# EnvironmentInformation.colour_for_the_left_side
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/project/project.rb'
+
+  # ========================================================================= #
+  # First the code here will determine which colours are to be used. If
+  # a .yml file can be found as part of this project then it will override
+  # the default values given here; otherwise the default values will be
+  # used, consequently.
+  # ========================================================================= #
+
+  yaml_file = EnvironmentInformation.project_base_directory?+'yaml/colours.yml'
+  if File.exist? yaml_file
+    dataset = YAML.load_file(yaml_file) # These should be a Symbol.
+    @colour_for_the_left_side     = dataset['left_side'].to_sym
+    @colour_for_the_right_side    = dataset['right_side'].to_sym
+    @colour_for_program_not_found = dataset['program_not_found'].to_sym
+  else # else use default values here
+    # ========================================================================= #
+    # === @colour_for_the_left_side
+    # ========================================================================= #
+    @colour_for_the_left_side = :forestgreen
+
+    # ========================================================================= #
+    # === @colour_for_the_right_side
+    # ========================================================================= #
+    @colour_for_the_right_side = :steelblue
+
+    # ========================================================================= #
+    # === @colour_for_program_not_found
+    # ========================================================================= #
+    @colour_for_program_not_found = :lightslategrey
+  end
+
+  begin
+    require 'colours'
+    # ======================================================================= #
+    # === @use_colours
+    #
+    # By default this project will try to make use of colours. This has
+    # be protected by a rescue clause, as not every user may have the
+    # gem called "colours" installed.
+    # ======================================================================= #
+    @use_colours = true
+  rescue LoadError
+    # ======================================================================= #
+    # If the colours-gem is not available then we will not use colours.
+    # The user could still overrule this at a later time, though.
+    # ======================================================================= #
+    @use_colours = false
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.colour_for_the_left_side            (left tag)
+  #
+  # This method will return the colour 
+  #
+  # This could also be :limegreen rather than :forestgreen or vice versa.
+  # ========================================================================= #
+  def self.colour_for_the_left_side
+    @colour_for_the_left_side
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.colour_for_the_right_side          (right tag)
+  # ========================================================================= #
+  def self.colour_for_the_right_side
+    @colour_for_the_right_side
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.colour_for_program_not_found
+  # ========================================================================= #
+  def self.colour_for_program_not_found
+    @colour_for_program_not_found
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.rev
+  # ========================================================================= #
+  def self.rev
+    return ::Colours.rev if @use_colours
+    '' # Else return an empty String.
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.use_colours?
+  # ========================================================================= #
+  def self.use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.set_use_colours
+  #
+  # Determine whether the EnvironmentInformation project will use
+  # colours or whether it will not.
+  # ========================================================================= #
+  def self.set_use_colours(i = true)
+    @use_colours = i
+  end; self.instance_eval { alias use_colours= set_use_colours } # === EnvironmentInformation.use_colours=
+  
+  # ========================================================================= #
+  # === EnvironmentInformation.do_use_colours
+  # ========================================================================= #
+  def self.do_use_colours
+    @use_colours = i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.mediumpurple
+  # ========================================================================= #
+  def self.mediumpurple(i = '')
+    if @use_colours
+      return ::Colours.mediumpurple(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.lightslategrey
+  # ========================================================================= #
+  def self.lightslategrey(i = '')
+    if @use_colours
+      return ::Colours.lightslategrey(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.tomato
+  # ========================================================================= #
+  def self.tomato(
+      i = '', use_colours = @use_colours
+    )
+    return ::Colours.tomato(i) if use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.pink
+  # ========================================================================= #
+  def self.pink(
+      i = '', use_colours = @use_colours
+    )
+    return ::Colours.pink(i) if use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.forestgreen
+  # ========================================================================= #
+  def self.forestgreen(
+      i = '', use_colours = @use_colours
+    )
+    return ::Colours.forestgreen(i) if use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.lightseagreen
+  # ========================================================================= #
+  def self.lightseagreen(i = '', use_colours = @use_colours)
+    if use_colours
+      return ::Colours.lightseagreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.steelblue
+  # ========================================================================= #
+  def self.steelblue(i = '')
+    if @use_colours
+      return ::Colours.steelblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.royalblue
+  # ========================================================================= #
+  def self.royalblue(
+      i           = '',
+      use_colours = @use_colours
+    )
+    if use_colours
+      return ::Colours.royalblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.sfile
+  # ========================================================================= #
+  def self.sfile(i = '')
+    if @use_colours
+      ::Colours.sfile(i)
+    else
+      i
+    end
+  end
+
+end

data/lib/environment_information/colours/sfancy.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/colours/sfancy.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/colours/colours.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation
+  # ========================================================================= #
+  def self.sfancy(i = '')
+    return ::Colours.sfancy(i) if Object.const_defined? :Colours
+    i
+  end
+
+end

data/lib/environment_information/colours/simp.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/colours/simp.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/colours/colours.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation
+  # ========================================================================= #
+  def self.simp(i = '')
+    return ::Colours.simp(i) if Object.const_defined? :Colours
+    i
+  end
+
+end