environment_information 1.4.124 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5861f5556bed23f9d9dae0bd306f83eaa0ac8dfdbce64ac08d44d6fbf59b96
-  data.tar.gz: ea3cf9fe183273cebd487de66f3650036d9b2da1dbf1ad04c25b2e84ffef0ed6
+  metadata.gz: 0a8bf0346d36d12f3c11c33bce38d7c832830de80c9567b4eb884560c14abdb7
+  data.tar.gz: 41e3be2709db623d4b4bfd58caa2043695c0457598f36eff641d91becbeaa050
 SHA512:
-  metadata.gz: b94ff7fdd1a6551a5fc092d5ff4e94ae92505e8b5bd25a4b2fbffc8be0a068f9036059c6039209c97b443e4be696f355e1efcc0f8c083c3f08a73250d96ff139
-  data.tar.gz: e78aa12517ef57116ed79809c12274830629e96b1e21a93e0236f2b895a985dacb7168cc82b421d3a179400dda3cf437a87bb50ddd47fb687d694e6f8c2514b3
+  metadata.gz: 369716812e9c94c49a9a46c2a0cbfc721da9a4e453f4b8a6395e68d7585d0857f5474329eedf594afab916261eecca32089178864b85c9a576c7b3d07c1de3d3
+  data.tar.gz: 63c18de3c21023d5996867436f1e2c9083798759c6fee393a37cbcb7a75f8204ec8d71f6bc9036439863c90ef30872de89ff4bdc9d556de71ecc4a01086090bc

data/README.md

@@ -2,14 +2,14 @@
 [![forthebadge](https://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
 [![Gem Version](https://badge.fury.io/rb/environment_information.svg)](https://badge.fury.io/rb/environment_information)
 
-This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">27.03.2024</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">19:39:48</span> o'clock.
+This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">11.04.2024</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">15:40:51</span> o'clock.
 
 ## About the environment_information gem
 
 This project is called **EnvironmentInformation** (**environment information**).
 
-Its primary goal is **to gather information about the environment that ruby is
-presently running on** - in other words, **the host system** and its
+Its primary goal is <b>to gather information about the environment that ruby is
+presently running on</b> - in other words, **the host system** and its
 capabilities.
 
 This gathered information can then be shown to the user on the commandline,
@@ -20,10 +20,9 @@ quickly show all versions of different programs on the target computer
 system.
 
 To provide a short overview how this may look, taken on the **KDE konsole**
-and **bash**, have a look at the following image on a black background:
+and <b>bash</b>, have a look at the following image on a black background:
 
-![alt text][screenshot1]
-[screenshot1]: https://i.imgur.com/KiXIIVV.png
+<img src="https://i.imgur.com/KiXIIVV.png" style="margin-left: 1em">
 
 Invocation example:
 
@@ -58,7 +57,7 @@ main executable called **envi** (**bin/envi**) via:
 
 What is meant with the term **environment**?
 
-**Definition**:
+<b>Definition</b>:
 
 The term **environment**, within the context of the **environment_information gem**,
 is **the (software) environment** that can be discovered by the ruby version
@@ -83,7 +82,7 @@ in a **standalone .html file**, if you so desire to. This .html file
 could then be used for static display of the information (but may
 become quickly outdated, so keep this in mind as well).
 
-The **Environment information** project may include any of the
+The <b>Environment information</b> project may include any of the
 following as its output:
 
 - The **GCC Version** in use on the given computer host system.
@@ -91,9 +90,9 @@ following as its output:
 - Which Ruby Version is used.
 - Which Rubygem version is used.
 - The path to the rubygem directory.
-- What the Host CPU Model is (on Linux at the least).
-- What is the the **GTK*+, **GLIB*+ and **gdk-pixbuf** version, respectively.
-- Which **dhcpcd version** is available.
+- What the <b>Host CPU Model</b> is (on Linux at the least).
+- What is the the <b>GTK</b>, <b>GLIB</b> and <b>gdk-pixbuf</b> version, respectively.
+- Which <b>dhcpcd version</b> is available.
 - What Xorg components are available, such as libX11, libxcm, libxp,
 libxau.
 
@@ -219,7 +218,7 @@ of GTK, Glib, Atk and Pango, by passing in "f" or "full" or "--full"
 on the commandline, without the quotation marks.
 
 See the help section to this this script, which can be invoked by
-passing "help" or "--help" as argument to envi.
+passing "<b>help</b>" or "--help" as argument to envi.
 
 You can also pass this information through a block (as a Hash inside
 of that block), if you would like to:
@@ -360,7 +359,6 @@ but imagine if you work on Linux runlevel 3, without
 a GUI. In this case this can be convenient to have
 in one terminal as you work.
 
-
 ## fenvi
 
 There is an executable at **bin/fast_envi**, as part of this gem, which
@@ -434,7 +432,7 @@ avoid using a shell script, such as this one:
 
 http://www.linuxfromscratch.org/lfs/view/development/chapter02/hostreqs.html
 
-The name **fake-symbol** is given because via the commandline
+The name <b>fake-symbol</b> is given because via the commandline
 you can only pass e. g. a String, not a Symbol, as bash does
 not know what a Symbol is. So if a string has a leading :
 then the EnvironmentInformation project will assume that the
@@ -492,7 +490,7 @@ would like to, through this:
 
 ## Sinatra interface
 
-Since as of **May 2019** there is now a small sinatra "interface"
+Since as of <b>May 2019</b> there is now a small sinatra "interface"
 available.
 
 To start it, try:
@@ -705,6 +703,13 @@ This listing can be seen in the **file**:
 
 These are the following programs:
 
+    cpuinfo
+    operating_system
+    operating_system_bit_type
+    cflags
+    ram
+    rubygems_installation_directory
+    screen_resolution
     adwaitaicontheme
     atk
     automake
@@ -725,6 +730,7 @@ These are the following programs:
     cmake
     colord
     coreutils
+    cryptsetup
     curl
     dbus
     dhcpcd
@@ -783,6 +789,7 @@ These are the following programs:
     gsl
     gstreamer
     gstpluginsbase
+    gstpluginsgood
     gtk2
     gtk3
     guile
@@ -921,7 +928,46 @@ These are the following programs:
     xterm
     xvid
     xz
+    zenity
     zlib
+    hmmer
+    pbbam
+    relion
+    samtools
+    viennarna
+    libevdev
+    libinput
+    libx11
+    libxaw3d
+    libxau
+    libxcb
+    libxcm
+    libxcursor
+    libxdamage
+    libxi
+    libxkbfile
+    libxmu
+    libxpm
+    libxpresent
+    libxtst
+    libxt
+    libxv
+    libxvmc
+    randrproto
+    xextproto
+    xkbcomp
+    xrandr
+    xstdcmap
+    xf86bigfontproto
+    xf86dgaproto
+    xf86driproto
+    cpuinfo
+    operating_system
+    operating_system_bit_type
+    cflags
+    ram
+    rubygems_installation_directory
+    screen_resolution
 
 
 You can also display these programs dynamically, such as through the
@@ -1276,6 +1322,36 @@ to have a collection of different widget sets that all work
 on as many different operating systems as possible. Stay
 tuned for more updates in this regard in the future.
 
+## Generating a .html file
+
+You can pass the flag <b>--generate-html-file</b> to the main class,
+in order to generate a standalone .html file. Note that the
+commandline output will still be shown, so it may be a bit
+spammy. I use this to mostly find out which versions
+are available, and to additionally generate a .html file in
+case this has to be uploaded or shown to someone else
+via the browser.
+
+## The method .add() in class EnvironmentInformation::Query
+
+The method <b>.add()</b> in that class is used to add the particular
+components that you wish to display. By default all components
+will be added, but you can override this behaviour via
+various commandline flags.
+
+## Disabling individual components
+
+If you want to NOT show certain components, for whatever the
+reason, you can use this commandline flag:
+
+    --disable=htop,awk
+
+This would NOT show <b>htop</b> and <b>awk</b>.
+
+If you input an unregistered name then class Query will
+not notify you about this and simply ignore it - at the
+least this is the current behaviour.
+
 
 ## Contact information and mandatory 2FA (no longer) coming up in 2022 / 2023
 

data/doc/README.gen

@@ -4,8 +4,8 @@ DEFAULT_HEADER
 
 This project is called **EnvironmentInformation** (**environment information**).
 
-Its primary goal is **to gather information about the environment that ruby is
-presently running on** - in other words, **the host system** and its
+Its primary goal is <b>to gather information about the environment that ruby is
+presently running on</b> - in other words, **the host system** and its
 capabilities.
 
 This gathered information can then be shown to the user on the commandline,
@@ -16,10 +16,9 @@ quickly show all versions of different programs on the target computer
 system.
 
 To provide a short overview how this may look, taken on the **KDE konsole**
-and **bash**, have a look at the following image on a black background:
+and <b>bash</b>, have a look at the following image on a black background:
 
-![alt text][screenshot1]
-[screenshot1]: https://i.imgur.com/KiXIIVV.png
+<img src="https://i.imgur.com/KiXIIVV.png" style="margin-left: 1em">
 
 Invocation example:
 
@@ -54,7 +53,7 @@ main executable called **envi** (**bin/envi**) via:
 
 What is meant with the term **environment**?
 
-**Definition**:
+<b>Definition</b>:
 
 The term **environment**, within the context of the **environment_information gem**,
 is **the (software) environment** that can be discovered by the ruby version
@@ -79,7 +78,7 @@ in a **standalone .html file**, if you so desire to. This .html file
 could then be used for static display of the information (but may
 become quickly outdated, so keep this in mind as well).
 
-The **Environment information** project may include any of the
+The <b>Environment information</b> project may include any of the
 following as its output:
 
 - The **GCC Version** in use on the given computer host system.
@@ -87,9 +86,9 @@ following as its output:
 - Which Ruby Version is used.
 - Which Rubygem version is used.
 - The path to the rubygem directory.
-- What the Host CPU Model is (on Linux at the least).
-- What is the the **GTK*+, **GLIB*+ and **gdk-pixbuf** version, respectively.
-- Which **dhcpcd version** is available.
+- What the <b>Host CPU Model</b> is (on Linux at the least).
+- What is the the <b>GTK</b>, <b>GLIB</b> and <b>gdk-pixbuf</b> version, respectively.
+- Which <b>dhcpcd version</b> is available.
 - What Xorg components are available, such as libX11, libxcm, libxp,
 libxau.
 
@@ -215,7 +214,7 @@ of GTK, Glib, Atk and Pango, by passing in "f" or "full" or "--full"
 on the commandline, without the quotation marks.
 
 See the help section to this this script, which can be invoked by
-passing "help" or "--help" as argument to envi.
+passing "<b>help</b>" or "--help" as argument to envi.
 
 You can also pass this information through a block (as a Hash inside
 of that block), if you would like to:
@@ -356,7 +355,6 @@ but imagine if you work on Linux runlevel 3, without
 a GUI. In this case this can be convenient to have
 in one terminal as you work.
 
-
 ## fenvi
 
 There is an executable at **bin/fast_envi**, as part of this gem, which
@@ -430,7 +428,7 @@ avoid using a shell script, such as this one:
 
 http://www.linuxfromscratch.org/lfs/view/development/chapter02/hostreqs.html
 
-The name **fake-symbol** is given because via the commandline
+The name <b>fake-symbol</b> is given because via the commandline
 you can only pass e. g. a String, not a Symbol, as bash does
 not know what a Symbol is. So if a string has a leading :
 then the EnvironmentInformation project will assume that the
@@ -488,7 +486,7 @@ would like to, through this:
 
 ## Sinatra interface
 
-Since as of **May 2019** there is now a small sinatra "interface"
+Since as of <b>May 2019</b> there is now a small sinatra "interface"
 available.
 
 To start it, try:
@@ -1055,4 +1053,34 @@ to have a collection of different widget sets that all work
 on as many different operating systems as possible. Stay
 tuned for more updates in this regard in the future.
 
+## Generating a .html file
+
+You can pass the flag <b>--generate-html-file</b> to the main class,
+in order to generate a standalone .html file. Note that the
+commandline output will still be shown, so it may be a bit
+spammy. I use this to mostly find out which versions
+are available, and to additionally generate a .html file in
+case this has to be uploaded or shown to someone else
+via the browser.
+
+## The method .add() in class EnvironmentInformation::Query
+
+The method <b>.add()</b> in that class is used to add the particular
+components that you wish to display. By default all components
+will be added, but you can override this behaviour via
+various commandline flags.
+
+## Disabling individual components
+
+If you want to NOT show certain components, for whatever the
+reason, you can use this commandline flag:
+
+    --disable=htop,awk
+
+This would NOT show <b>htop</b> and <b>awk</b>.
+
+If you input an unregistered name then class Query will
+not notify you about this and simply ignore it - at the
+least this is the current behaviour.
+
 ADD_CONTACT_INFORMATION

data/doc/todo/TODO_FOR_THE_ENVIRONMENT_INFORMATION_PROJECT.md

@@ -1,3 +1,19 @@
+------------------------------------------------------------------------------
+(1)
+
+- if we rewrite the project, properly add:
+
+- disabling of saving files, AND
+- checking permissions
+  ^^^^^^^^
+------------------------------------------------------------------------
+(2) About the environment_information gem
+^^^^ add jruby bindings to it; 
+for now in jruby/
+^^^^^^^^^
+
+^^^ at the least test it via jruby.
+
 ------------------------------------------------------------------------------
 - add in envi the ability to query from another base-prefix
   e. g. /home/Programs/.
@@ -38,18 +54,6 @@ dynamically.
 but before we do so, perhaps add a way to query the binary
 from any path... e. g. /Programs/Htop/Current/ or so
 ------------------------------------------------------------------------------
-(8)
-
-- if we rewrite the project, properly add disabling of saving
-  files AND checking permissions
-------------------------------------------------------------------------------
 test absolute prefixes again
 ------------------------------------------------------------------------------
 (10) add a new log for environment information
-
-
-------------------------------------------------------------------------
-About the environment_information gem
-^^^^ add jruby bindings to it; 
-for now in jruby/
-^^^^^^^^^