environment_information 1.4.99

data/lib/environment_information/gui/shared_code/environment_information_module.rb

@@ -0,0 +1,409 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === EnvironmentInformation::GUI::Gtk::EnvironmentInformationModule
+# =========================================================================== #
+# require 'environment_information/gui/shared_code/environment_information_module.rb'
+# include ::EnvironmentInformation::EnvironmentInformation::GUI::Gtk::BindingModule
+# =========================================================================== #
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base
+
+module GUI
+
+module Gtk
+
+module EnvironmentInformationModule
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  begin
+    require 'colours'
+    include Colours::E
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Environment Information'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH  = '98%'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '80%'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      optional_file = nil,
+      run_already   = true
+    )
+    super(:vertical)
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, NAMESPACE]
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    set_title(TITLE)
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    set_width(WIDTH)
+    set_height(HEIGHT)
+    # ======================================================================= #
+    # === @data
+    # ======================================================================= #
+    assign_the_environment_information_dataset_to_the_data_variable
+    # ======================================================================= #
+    # === @display_information_on_the_commandline
+    #
+    # If the next variable is set to true then information will be
+    # displayed on the commandline.
+    # ======================================================================= #
+    @display_information_on_the_commandline = true
+    # ======================================================================= #
+    # === @list_store
+    # ======================================================================= #
+    @list_store = ::Gtk::ListStore.new(String, String)
+    increase_font_size
+    use_gtk_paradise_css_file
+    infer_the_size_automatically
+  end
+
+  # ========================================================================= #
+  # === connect_skeleton
+  # ========================================================================= #
+  def connect_skeleton
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    0
+  end
+
+  # ========================================================================= #
+  # === create_skeleton
+  # ========================================================================= #
+  def create_skeleton
+    create_toolbar
+    create_gtk_tree_view
+    @renderer = gtk_cell_renderer_text
+  end
+
+  # ========================================================================= #
+  # === create_toolbar
+  #
+  # This will create the toolbar on top of the widget.
+  # ========================================================================= #
+  def create_toolbar
+    @toolbar = gtk_toolbar
+    @toolbar.append_space if ::Gtk.use_gtk2?
+    # ======================================================================= #
+    # (1) Add the refresh-button next.
+    # ======================================================================= #
+    button_refresh = gtk_button(:refresh)
+    button_refresh.no_relief
+    button_refresh.on_clicked {
+      do_update_the_main_content_of_the_widget
+    }
+    button_refresh.hint = '<b>Click</b> on this button in order to '\
+                          'refresh the information shown below.'
+    @toolbar << button_refresh
+    # ======================================================================= #
+    # (2) Add a pin-emoji next, to assign to the xorg-buffer upon clicking
+    #     on it.
+    # ======================================================================= #
+    pin_emoji = emoji(:pin)
+    event_box_for_the_pin_emoji = event_box(pin_emoji)
+    event_box_for_the_pin_emoji.on_clicked {
+      do_assign_the_current_selection_to_the_xorg_buffer
+    }
+    pin_emoji.hint = '<b>Click</b> on this button to assign the '\
+                     'current selection to the xorg-buffer.'
+    @toolbar << event_box_for_the_pin_emoji
+    # ======================================================================= #
+    # (2) This belongs to the pin-emoji actually; the functionality should
+    #     be regarded as a "cohesive unit".
+    # ======================================================================= #
+    @button_assign_to_the_xorg_buffer = button_xorg_buffer(label: 'Xorg')
+    @button_assign_to_the_xorg_buffer.no_relief
+    @button_assign_to_the_xorg_buffer.on_clicked {
+      do_assign_the_current_selection_to_the_xorg_buffer
+    }
+    @toolbar << @button_assign_to_the_xorg_buffer
+  end
+
+  # ========================================================================= #
+  # === currently_selected
+  #
+  # Will show both key and version.
+  # ========================================================================= #
+  def currently_selected
+    _ = ''.dup
+    if @tree_view and @tree_view.selection
+      @tree_view.selection.selected_each {|list_store, tree_path, tree_iter|
+        if tree_iter[0]
+          name_of_the_program = tree_iter[0].strip
+        else
+          name_of_the_program = 'unknown'
+        end
+        version_of_the_program = tree_iter[1]
+        _ << "#{name_of_the_program} #{version_of_the_program}"
+      }
+    end
+    return _
+  end; alias return_the_current_selection_of_the_treeview_widget currently_selected # === return_the_current_selection_of_the_treeview_widget 
+
+  # ========================================================================= #
+  # === do_assign_the_current_selection_to_the_xorg_buffer
+  # ========================================================================= #
+  def do_assign_the_current_selection_to_the_xorg_buffer(
+      i = return_the_current_selection_of_the_treeview_widget
+    )
+    @button_assign_to_the_xorg_buffer.attach(i)
+  end
+
+  # ========================================================================= #
+  # === assign_the_environment_information_dataset_to_the_data_variable
+  # ========================================================================= #
+  def assign_the_environment_information_dataset_to_the_data_variable
+    @data = ::EnvironmentInformation.initialize_hash
+  end
+
+  # ========================================================================= #
+  # === do_update_the_main_content_of_the_widget
+  # ========================================================================= #
+  def do_update_the_main_content_of_the_widget
+    assign_the_environment_information_dataset_to_the_data_variable
+    @list_store.clear
+    @data.each {|line|
+      name, version = *line # Decompose line.
+      iter = @list_store.append
+      if version.nil? or version.to_s.empty?
+        version = '[Not installed.]'
+      end
+      iter.set_value(0, name)
+      iter.set_value(1, version)
+    }
+  end
+
+  # ========================================================================= #
+  # === add_status_icon
+  # ========================================================================= #
+  def add_status_icon
+    _ = gtk_status_icon(:dialog_info)
+    # ======================================================================= #
+    # Add a menu and a quit-button too.
+    # ======================================================================= #
+    menu = gtk_menu
+    quit = gtk_image_menu_item(::Gtk::Stock::QUIT)
+    quit.on_activate { ::Gtk.main_quit }
+    menu.append(quit)
+    menu.show_all
+    _.signal_connect(:popup_menu) { |icon, button, time|
+      menu.popup(nil, nil, button, time)
+    }
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    2
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::EnvironmentInformation::GUI::Gtk::EnvironmentInformation.width
+  # ========================================================================= #
+  def self.width
+    WIDTH
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::EnvironmentInformation::GUI::Gtk::EnvironmentInformation.height
+  # ========================================================================= #
+  def self.height
+    HEIGHT
+  end
+
+  # ========================================================================= #
+  # === favicon?
+  # ========================================================================= #
+  def favicon?
+    :tabble
+  end
+
+  # ========================================================================= #
+  # === create_gtk_tree_view
+  #
+  # The TreeView widget is the main widget which allows the user to
+  # display environment-related information about installed
+  # programs.
+  # ========================================================================= #
+  def create_gtk_tree_view
+    @tree_view = ::Gtk::TreeView.new(@list_store) # rf ruby gtk_TreeView
+    @tree_view.do_select_multiple # Allow multiple selections.
+    @tree_view.use_clickable_headers
+    # ======================================================================= #
+    # === ruby-gtk2
+    # ======================================================================= #
+    if ::Gtk.use_gtk2?
+      @tree_view.enable_model_drag_source(
+        Gdk::Window::BUTTON1_MASK,
+        [ ['GTK_TREE_MODEL_ROW', 0, 0] ],
+        Gdk::DragContext::ACTION_COPY|Gdk::DragContext::ACTION_MOVE
+      )
+      @tree_view.enable_model_drag_dest([
+        ['GTK_TREE_MODEL_ROW', 0, 0] ],
+        Gdk::DragContext::ACTION_COPY|Gdk::DragContext::ACTION_MOVE
+      )
+    else
+    # ======================================================================= #
+    # ruby-gtk3
+    # ======================================================================= #
+      @tree_view.enable_model_drag_source(
+        :button1_mask,
+        [ ['GTK_TREE_MODEL_ROW', 0, 0] ],
+        Gdk::DragAction::COPY|Gdk::DragAction::MOVE
+      )
+      @tree_view.enable_model_drag_dest([
+        ['GTK_TREE_MODEL_ROW', 0, 0] ],
+        Gdk::DragAction::COPY|Gdk::DragAction::MOVE
+      )
+    end
+    @tree_view.signal_connect(:row_activated) {
+      # puts "hello"
+    } 
+    # ========================================================================= #
+    # Respond to mouse-button press events. This is currently not in use 
+    # really.
+    # ========================================================================= #
+    @tree_view.on_button_press_event { |widget, event|
+      if mouse_button_double_click?(event)
+        # e 'MouseButton: double click event.'
+        # ^^^ Currently we do not handle this event.
+      elsif left_mouse_button_clicked?(event)
+        # e 'MouseButton: left-click event (once).'
+      elsif right_mouse_button_clicked?(event)
+        # e 'MouseButton: right-click event (once).'
+      end
+    }
+    @tree_view.selection.set_mode(::Gtk::SelectionMode::MULTIPLE)
+    @tree_view.selection.signal_connect(:changed) {|entry|
+      entry.each {|model, path, inner_array|
+        if @display_information_on_the_commandline
+          if inner_array[0]
+            name_of_the_program  = inner_array[0].strip
+          else
+            name_of_the_program  = '(unknown'
+          end
+          version_of_the_program = inner_array[1]
+          result = Colours.steelblue(
+            name_of_the_program.ljust(25)
+          ).dup
+          if ::EnvironmentInformation.is_this_a_registered_program?(name_of_the_program)
+            result << 'Version: '
+          end
+          result << Colours.lightgreen(version_of_the_program.to_s)
+          e result
+        end
+      }
+    }
+    @tree_view.resizable_headers
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton
+    # ======================================================================= #
+    # Append the information contained in our @data variable to the
+    # ListStore object next. This will yield an Array.
+    # ======================================================================= #
+    do_update_the_main_content_of_the_widget
+    @tree_view.append('Name',    @renderer, text: 0)
+    @tree_view.append('Version', @renderer, text: 1)
+    @tree_view.the_headers_are_clickable
+    @tree_view.is_sortable
+    @tree_view.on_key_press_event { |w, event|
+      case Gdk::Keyval.to_name(event.keyval)
+      when 'Return','KP_Enter'
+        e currently_selected
+      end
+    }
+    vbox = gtk_vbox
+    vbox.add(@toolbar)
+    @scrolled_window = gtk_scrolled_window(@tree_view)
+    @scrolled_window.set_size_request(600, 600)
+    vbox.maximal(@scrolled_window, 2)
+    maximal(vbox)
+    add_status_icon
+    show_all
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation::GUI::Gtk::EnvironmentInformationModule.run
+  # ========================================================================= #
+  def self.run
+    require 'gtk_paradise/run'
+    r = ::Gtk.run
+    r << ::EnvironmentInformation::GUI::Gtk::EnvironmentInformation.new
+    r.enable_quick_exit
+    r.top_left_then_run
+  end
+
+end; end; end; end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.gtk_bindings
+  # ========================================================================= #
+  def self.gtk_bindings
+     ::EnvironmentInformation::EnvironmentInformation::GUI::Gtk::EnvironmentInformation.new
+  end
+
+  # ========================================================================= #
+  # === EnvironmentInformation.run_gtk
+  #
+  # Use this method if you wish to run the gtk-component of the
+  # EnvironmentInformation project.
+  # ========================================================================= #
+  def self.run_gtk
+    require 'gtk_paradise/run'
+    _ = ::EnvironmentInformation.gtk_bindings
+    r = ::Gtk.run
+    r << _ # ← Add the widget here.
+    r.add_shortcut(1, 'focus(:left)', :alt)
+    r.modify_background(:normal, :white)
+    r.automatic_title
+    r.top_left_then_run
+  end
+
+end

data/lib/environment_information/misc_components/README.md

@@ -0,0 +1,3 @@
+Ruby files in this directory relate to components that are not really 
+programs, such as CFLAGS, or the number of processors, or the amount 
+of RAM on a given computer system.

data/lib/environment_information/misc_components/cflags.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/misc_components/cflags.rb'
+# EnvironmentInformation.cflags_in_use?
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation.cflags?                           (cflags tag)
+  #
+  # The following is equivalent to the value stored in the variable
+  # $CFLAGS, which on unix-like systems may be obtained by issuing
+  # the following command:
+  #
+  #     echo $CFLAGS
+  #
+  # The output may be like this:
+  #
+  #   -O2 -fPIC -fno-strict-overflow -Wno-error
+  #
+  # ========================================================================= #
+  def self.cflags?
+    version = ENV['CFLAGS'].to_s.strip
+    version = '<none>' if version.empty? # Display special status if it is empty.
+    version
+  end; self.instance_eval { alias cflags_in_use?           cflags? } # === EnvironmentInformation.cflags_in_use?
+       self.instance_eval { alias return_version_of_cflags cflags? } # === EnvironmentInformation.return_version_of_cflags
+       self.instance_eval { alias cflags                   cflags? } # === EnvironmentInformation.cflags
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts EnvironmentInformation.cflags?
+end

data/lib/environment_information/misc_components/cpuinfo.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/misc_components/cpuinfo.rb'
+# EnvironmentInformation.cpuinfo?
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/constants/newline.rb'
+  require 'environment_information/constants/error_line.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.cpuinfo?                         (cpuinfo tag)
+  #
+  # This method currently relies on /proc/cpuinfo, thus favouring
+  # Linux-based systems.
+  #
+  # The output will be similar to this:
+  #
+  #   AMD A8-7600 Radeon R7, 10 Compute Cores 4C+6G, 4 cores
+  #
+  # It will become the display part of "CPU Model".
+  # ========================================================================= #
+  def self.cpuinfo?
+    result = '/proc/cpuinfo'
+    if File.exist? result
+      readlines = File.readlines(result)
+      _ = readlines.grep(/model name/).first.chomp
+      splitted = _.split(':')
+      _ = splitted[1].strip # => "model name\t: AMD Sempron(tm) 145 Processor"
+      # ===================================================================== #
+      # Next, add the amount of cores. We use "nproc" for this but "lscpu"
+      # also contains this information. The following regex could be used
+      # for lscpu:
+      #
+      #   Core\(s\) per socket:    (.+)
+      #
+      # Ok, we use lscpu for now.
+      # ===================================================================== #
+      n_cores = `nproc --all`.strip
+      case n_cores.to_s
+      when '1'
+        n_cores << ' core'  # Singular.
+      else
+        n_cores << ' cores' # Plural then.
+      end
+      _ << ", #{n_cores}" unless n_cores.empty?
+      result = _
+    else
+      result = nil
+    end
+    result
+  end; self.instance_eval { alias append_operating_system_cpuinfo cpuinfo? } # === EnvironmentInformation.append_operating_system_cpuinfo
+       self.instance_eval { alias cpu_model                       cpuinfo? } # === EnvironmentInformation.cpu_model
+       self.instance_eval { alias cpu_model?                      cpuinfo? } # === EnvironmentInformation.cpu_model?
+       self.instance_eval { alias return_version_of_cpuinfo       cpuinfo? } # === EnvironmentInformation.return_version_of_cpuinfo
+       self.instance_eval { alias cpuinfo                         cpuinfo? } # === EnvironmentInformation.cpuinfo
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts EnvironmentInformation.cpuinfo?
+end

data/lib/environment_information/misc_components/operating_system.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/misc_components/operating_system.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/constants/newline.rb'
+  require 'environment_information/constants/error_line.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.operating_system                      (os tag)
+  #
+  # This method is also known as "bit type".
+  #
+  # The return value of this method may be a String such as this one here:
+  #
+  #   "GNU/Linux"
+  #
+  # This is then further modified a bit to drop the "GNU/" part
+  # specifically.
+  #
+  # ========================================================================= #
+  def self.operating_system
+    cmd = 'uname -mo'
+    result = `#{cmd}`.chomp
+    if result.start_with? 'GNU'
+      # ===================================================================== #
+      # The next part removes 'GNU/' specifically. It is a simpler name
+      # than "GNU Linux" and variants, just as "BSD" is simpler than
+      # e. g. "FreeBSD". You can reason that it may be "less accurate",
+      # but it makes the notification-part of this gem simpler.
+      # ===================================================================== #
+      result.sub!(/^GNU\//,'') # Experimental as of Sep 2019.
+    end
+    if result.include? ' '
+      result = result.split(' ').last
+    end
+    result
+  end; self.instance_eval { alias operating_system?                         operating_system } # === EnvironmentInformation.operating_system?
+       self.instance_eval { alias operating_system_information?             operating_system } # === EnvironmentInformation.operating_system_information
+       self.instance_eval { alias add_operating_system_information          operating_system } # === EnvironmentInformation.add_operating_system_information
+       self.instance_eval { alias append_operating_system_in_use            operating_system } # === EnvironmentInformation.append_operating_system_in_use
+       self.instance_eval { alias add_os_information                        operating_system } # === EnvironmentInformation.add_os_information
+       self.instance_eval { alias operating_system_in_use?                  operating_system } # === EnvironmentInformation.operating_system_in_use?
+       self.instance_eval { alias return_version_of_operating_system        operating_system } # === EnvironmentInformation.return_version_of_operating_system
+       self.instance_eval { alias return_version_of_operating_system_in_use operating_system } # === EnvironmentInformation.return_version_of_operating_system_in_use
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts EnvironmentInformation.operating_system
+end # envi_operating_system

data/lib/environment_information/misc_components/operating_system_bit_type.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/misc_components/operating_system.rb'
+# =========================================================================== #
+module EnvironmentInformation
+
+  require 'environment_information/constants/newline.rb'
+  require 'environment_information/constants/error_line.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation.operating_system_bit_type_information (bit tag, bit type tag)
+  #
+  # This method will return the bit type in use, as a String,
+  # such as "x86_64" or "x86_64 (64 bit)" specifically. The
+  # reason why this method appends ' (64 bit)' is mostly so
+  # that the user can quickly see whether a computer is on
+  # 32 bit or on 64 bit.
+  # ========================================================================= #
+  def self.operating_system_bit_type_information
+    cmd = 'uname -m'
+    result = `#{cmd}`.chomp
+    result = result.split(' ')[-1] if result.include?(' ')
+    result = result.dup if result.frozen?
+    case result
+    when 'x86_64'
+      result << ' (64 bit)'
+    end
+    result
+  end; self.instance_eval { alias add_bit_type_information                    operating_system_bit_type_information } # === EnvironmentInformation.add_bit_type_information
+       self.instance_eval { alias add_operating_system_bit_type               operating_system_bit_type_information } # === EnvironmentInformation.add_operating_system_bit_type
+       self.instance_eval { alias bit_type?                                   operating_system_bit_type_information } # === EnvironmentInformation.bit_type?
+       self.instance_eval { alias return_version_of_operating_system_bit_type operating_system_bit_type_information } # === EnvironmentInformation.return_version_of_operating_system_bit_type
+       self.instance_eval { alias operating_system_bit_type?                  operating_system_bit_type_information } # === EnvironmentInformation.operating_system_bit_type?
+       self.instance_eval { alias operating_system_bit_type                   operating_system_bit_type_information } # === EnvironmentInformation.operating_system_bit_type
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts EnvironmentInformation.operating_system_bit_type_information
+end

data/lib/environment_information/misc_components/ram.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/misc_components/ram.rb'
+# ::EnvironmentInformation.ram?
+# =========================================================================== #
+module EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation.ram?                                 (ram tag)
+  #
+  # This method will determine how much RAM the given computer host has.
+  #
+  # The result will be given in n MB.
+  # ========================================================================= #
+  def self.ram?
+    result_in_n_mb = `free -m 2>&1`.split("\n")[1]
+    if result_in_n_mb and result_in_n_mb.include?(' ')
+      result_in_n_mb = result_in_n_mb.split(' ')[1]
+    end
+    result_in_n_mb
+  end; self.instance_eval { alias return_version_of_ram ram? } # === EnvironmentInformation.return_version_of_ram
+       self.instance_eval { alias ram                   ram? } # === EnvironmentInformation.ram
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts EnvironmentInformation.ram?
+end