program_information 1.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14ca5c3339db035de0d87f6efc1282913ab514e0ae7f81593b52fc424299e1fe
+  data.tar.gz: 677986be5e47d80b4b2fa843a67e59aac01dd2fd14853a85393b0e82c8accff2
+SHA512:
+  metadata.gz: f148044607a65bf6dd71fec34321f284a5e053b049b03a3fe95e1f1087493a6f8aeedaa431222d96dd57942d8d15f2aa5ea68f739d0b0be9bd334bbab0c14d32
+  data.tar.gz: 3c96e83e6c3225bd50979cd44a0572dba50397a1f83ef245ba71388c72a7c644b0e68a8456e0da3ae8a6f6ce1988db55cf7e6a45df9b61f6c13ed4cd0ed0c0a9

data/README.md

@@ -0,0 +1,80 @@
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+
+## Welcome to the ProgramInformation gem
+
+<img src="https://i.imgur.com/q4VfoHv.png">
+
+This is really a tiny gem. <b>Do one thing well.</b>
+
+## The two methods .first and .last
+
+You can obtain the name of the program at hand, and the associated
+version, like so:
+
+    require 'program_information'
+
+    x = ProgramInformation.new('ruby-2.5.0')
+    puts x.first
+    puts x.last
+
+Note that other toplevel variants exist such as:
+
+    ProgramInformation.return_name()
+    ProgramInformation.return_version()
+
+The idea here is to be as flexible as possible, so
+that you can cherry-pick what you prefer.
+
+## Tests
+
+The tests are stored mostly in the file
+<b>array_test_with_this_as_input.rb</b>.
+
+Not all tests may work perfectly well, but for the
+most likely input it should work fine. So like
+98% of all use cases the gem should do well.
+
+
+## Contact information and mandatory 2FA coming up in 2022
+
+If your creative mind has ideas and specific suggestions to make this gem
+more useful in general, feel free to drop me an email at any time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail, for various reasons. In order to limit the
+explanation here, allow me to just briefly state that I do not feel as if I
+want to promote any Google service anymore when the user becomes the 
+product (such as via data collection by upstream services). I feel this is
+a hugely flawed business model.
+
+Do keep in mind that responding to emails may take some time, depending on
+the amount of work I may have at that moment.
+
+In <b>2022</b> rubygems.org, or rather the corporate overlords who control the
+rubygems.org infrastructure these days, decided to make 2FA mandatory for every
+gem owner eventually: see
+https://blog.rubygems.org/2022/06/13/making-packages-more-secure.html
+
+Mandatory 2FA will eventually be extended to all rubygems.org developers and
+maintainers. As I can not use 2FA, for reasons I will skip explaining here,
+this means that my projects will eventually be taken over by shopify (or,
+correspondingly, whoever effectively controls the rubygems.org ecosystem).
+At that point, I no longer have any control what is done to my projects
+since shopify (respectively those controlling the gems ecosystem) took away
+control here. Not sure at which point ruby became corporate-controlled -
+that was not the case several years ago.
+
+Ruby also only allows 2FA users to participate on the issue tracker these
+days:
+
+  https://bugs.ruby-lang.org/issues/18800
+
+(Note that this was changed a few months ago, so the last part is no
+longer valid - it is possible to register again without mandating 
+2FA. I will retain the above notice for a bit longer, though, as I feel
+we should not restrict communication via mandatory authentification
+in general. Fighting spam is a noble goal, but when it also means you
+lock out real human people then this is definitely NOT good.)
+

data/bin/program_information

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'program_information'
+
+if ARGV.first
+  ProgramInformation::ProgramInformation.new(ARGV).report(:be_verbose)
+else # "Normal" tests here.
+  _ = ProgramInformation.parse 'http://downloads.sourceforge.net/boost/boost_1_54_0.tar.bz2'
+  p ProgramInformation.parse('http://downloads.sourceforge.net/boost/boost_1_54_0.tar.bz2', false)
+end
+# p _.original_program_name
+# pii

data/doc/CONVENTIONS.md

@@ -0,0 +1,22 @@
+Any given input can have three components:
+
+   (1) real_short_name
+   (2) short_name
+   (3) program_version
+
+real_short_name depends on short_name. It simply is short_name with all
+instances of the '_' character removed. It is thus a dependent variable.
+
+The three numbers above also correspond to respective @instance_variables,
+so in other words we have @real_short_name, @short_name and
+@program_version.
+
+The input passed to the main class may be "unclean". The class will try
+# to get the "best" result out of any given input that was supplied, no
+matter how unclean this input was.
+
+It is recommended to use this class when wanting to determine the
+short_name and the program version of any given program.
+
+Note that short_name is allowed to include '-' characters whereas
+real_short_name will strip '-' characters.

data/doc/README.gen

@@ -0,0 +1,37 @@
+GOBOLINUX_IS_AWESOME
+
+## Welcome to the ProgramInformation gem
+
+<img src="https://i.imgur.com/q4VfoHv.png">
+
+This is really a tiny gem. <b>Do one thing well.</b>
+
+## The two methods .first and .last
+
+You can obtain the name of the program at hand, and the associated
+version, like so:
+
+    require 'program_information'
+
+    x = ProgramInformation.new('ruby-2.5.0')
+    puts x.first
+    puts x.last
+
+Note that other toplevel variants exist such as:
+
+    ProgramInformation.return_name()
+    ProgramInformation.return_version()
+
+The idea here is to be as flexible as possible, so
+that you can cherry-pick what you prefer.
+
+## Tests
+
+The tests are stored mostly in the file
+<b>array_test_with_this_as_input.rb</b>.
+
+Not all tests may work perfectly well, but for the
+most likely input it should work fine. So like
+98% of all use cases the gem should do well.
+
+ADD_MY_EMAIL

data/lib/program_information/constants/array_test_with_this_as_input.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This is the input that can be used by the testing file.
+# =========================================================================== #
+# require 'program_information/constants/array_test_with_this_as_input.rb'
+# =========================================================================== #
+module ProgramInformation
+
+  require 'program_information/constants/regex.rb'
+  require 'program_information/toplevel_methods/return_proper_pipe_token_to_this_input.rb'
+
+  # ========================================================================= #
+  # === ProgramInformation::ARRAY_TEST_THIS_AS_INPUT
+  #
+  # The character '|' is not allowed to be part of any program name,
+  # so we wil use this as special token.
+  #
+  # We will insert it at the boundary level.
+  # ========================================================================= #
+  ARRAY_TEST_THIS_AS_INPUT = %w(
+    unieject-6
+    acl_2.2.47-1
+    ncbi_cxx-12_0_0
+    lynx-2.8.8-rel2
+    subtle-0.11.3224-xi
+    font-bitstream-75dpi-1.0.3
+    xf86-input-elographics-1.4.1
+    zope.interface-4.2.0
+    CrownCutlass-Alpha1.4
+    gobject-introspection-1.53.4
+    dvd+rw-tools-7.1
+    font-xfree86-type1-1.0.4
+    lshw-B.02.08.01
+    e_dbus-1.7.10
+    xf86-video-omap-0.4.2
+    at-spi2-core-2.19.2
+    xfce4-dev-tools-4.8.0
+    WebKit-r174650
+    akonadi-calendar-tools-17.08.1
+    Archive-Zip-1.46
+    did_you_mean-1.1.2
+    artemis_v16.0.11
+    chunky_png-1.3.8
+    libedit-20170329-3.1
+    font-adobe-utopia-type1-1.0.4
+    wpa_supplicant-2.6
+    dpkg_1.18.22
+    ncbi-blast-2.6.0+
+    ntfs-3g_ntfsprogs-2017.3.23
+    b43-fwcutter-015
+    wcd-6.0.1-beta3
+    xf86-video-i810-1.7.4
+    gnome-internet-radio-locator-0.9.0
+    SDL2_gfx-1.0.1
+    boost-1_54_0
+    boost_1_65_1.tar.bz2
+    boost_1_65_1
+    oxygen-icons5-5.37.0
+    artemis_v16.0.11.jar
+    mod_python_3.3.1
+    xfce4-statusnotifier-plugin-0.2.0
+    p7zip_16.02_src_all.tar.bz2
+    mime-types-data-3.2016.0521.gem
+    domain_name-0.5.20170404.gem
+    ftp://ftp.alsa-project.org/pub/plugins/alsa-plugins-1.0.29.tar.bz2
+    alsa-plugins-1.0.29.tar.bz2
+    alsa-plugins-1.0.29
+    libquvi-scripts-0.9.20131130
+    btrfs-progs-v4.13.2.tar.xz
+    btrfs-progs-v4.13.2
+    ImageMagick-7.0.7-7
+    Archive-Zip-1.46
+    loop-AES-v3.7d
+    boost-build-2014-10
+    openobex-1.7.1-Source
+    /Users/x/SRC/zope.interface/zope.interface-4.4.2.tar.gz
+    libatomic_ops-7.4.2.tar.gz
+    mod_python-11.10.2017
+    expect5.45.3
+    http://search.cpan.org/CPAN/authors/id/M/MA/MARKOV/XML-LibXML-Simple-0.98.tar.gz
+    https://rubygems.org/downloads/mini_portile2-2.3.0.gem
+    kismet-2016-07-R1.tar.xz
+    nana%201.5.4.zip
+    http://download.icu-project.org/files/icu4c/61.1/icu4c-61_1-src.tgz
+    XML-NamespaceSupport-1.09.tar.xz
+    XML-NamespaceSupport-1.09
+    icu4c-62_1
+    polkit-kde-agent-1-5.15.2
+    polkit-kde-agent-1-5.10.95
+    polkit-qt-1-0.112.0
+    xf86-video-amd-2.7.7.7
+    NVIDIA-Linux-x86-352.63.run
+    xf86-video-s3virge-1.11.0
+    youtube-dl-2019.06.27
+    dvd+rw-tools-7.1
+    SDL_Pango-0.1.2.tar.xz
+  )
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/autoinclude'
+  # ========================================================================= #
+  # This is colourized in more detail because it makes it easier to
+  # visualize what is going on, on the commandline.
+  # ========================================================================= #
+  ProgramInformation::ARRAY_TEST_THIS_AS_INPUT.each {|entry|
+    original_entry = entry.dup
+    entry = File.basename(entry)
+    entry = ProgramInformation.return_proper_pipe_token_to_this_input(entry)
+    use_sfancy_colour = Colours.colour_methods_to_specific_colour?[:sfancy]
+    e "#{simp(original_entry.ljust(38))}"\
+      "  →  "\
+      "#{sfancy(
+        entry.sub(/\|/, Colours.orange('|')+
+        Colours.send(use_sfancy_colour))
+      )}"
+  }
+end

data/lib/program_information/constants/colours.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ProgramInformation
+
+class ProgramInformation
+
+  begin
+    require 'colours'
+  rescue LoadErrors; end
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    Colours.rev
+  end
+
+  # ========================================================================= #
+  # === COLOUR_FOR_REVERT
+  # ========================================================================= #
+  COLOUR_FOR_REVERT = Colours::WHITE # WHITE is defined in the colours project.
+
+  # ========================================================================= #
+  # === APOSTROPH
+  # ========================================================================= #
+  APOSTROPH = Colours::TEAL+'`'+COLOUR_FOR_REVERT # +Colours.rev
+
+  # ========================================================================= #
+  # === NAME_OF_CLASS
+  # ========================================================================= #
+  NAME_OF_CLASS = Colours::CGREY+'ProgramInformation:'+COLOUR_FOR_REVERT
+
+  # ========================================================================= #
+  # === yellow?
+  # ========================================================================= #
+  def yellow?
+    Colours::BOLD_YELLOW
+  end
+
+end; end

data/lib/program_information/constants/constants.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/constants/constants.rb'
+# =========================================================================== #
+require 'program_information/constants/regex.rb'
+require 'program_information/constants/colours.rb'
+
+module ProgramInformation
+
+class ProgramInformation
+
+  # ========================================================================= #
+  # === SHALL_WE_DOWNCASE
+  #
+  # So that input such as "Libgnome" can become "libgnome".
+  # ========================================================================= #
+  SHALL_WE_DOWNCASE = false
+
+  # ========================================================================= #
+  # === REMOVE_PLUS_AND_MINUS
+  #
+  # If true then we will remove plus '+' and minus '-' from the program name.
+  # ========================================================================= #
+  REMOVE_PLUS_AND_MINUS = false
+
+  # ========================================================================= #
+  # === REPLACE_PLUS_WITH_LONG_NAME
+  #
+  # If this constant is true then we will replace all '+' with the
+  # string 'plus' as part of the issued name. Note that remove-actions
+  # are stronger, so if the constant REMOVE_PLUS_AND_MINUS was also
+  # set to true, then the constant here will not be honoured at all.
+  # ========================================================================= #
+  REPLACE_PLUS_WITH_LONG_NAME = false
+
+  # ========================================================================= #
+  # === REMOVE_PLUS_TOKEN
+  #
+  # If this constant is true then we will eliminate '+' in the input.
+  #
+  # This overrules the replace-constant called REPLACE_PLUS_WITH_LONG_NAME.
+  #
+  # Also note that if the constant REMOVE_PLUS_AND_MINUS is set to true
+  # then this setting here will always be set to false.
+  # ========================================================================= #
+  REMOVE_PLUS_TOKEN = false
+
+  # ========================================================================= #
+  # === BE_VERBOSE
+  # ========================================================================= #
+  BE_VERBOSE = false
+
+end; end

data/lib/program_information/constants/regex.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/constants/regex.rb'
+# =========================================================================== #
+module ProgramInformation
+
+  # ========================================================================= #
+  # === REGEX_FOR_TWO_HYPHENS
+  #
+  # This is valid for input such as 'lynx-2.8.8-rel2' or
+  # 'gobject-introspection-1.53.4' or 'subtle-0.11.3224-xi' or
+  # 'dvd+rw-tools-7.1' or 'Archive-Zip-1.46' or 'btrfs-progs-v4.12.1'
+  # or 'color-tools-1.3.0' or 'libedit-20170329-3.1' or
+  # 'ncbi-blast-2.6.0+' or 'b43-fwcutter-015' or 'wcd-6.0.1-beta3'
+  # or 'oxygen-icons5-5.37.0' or 'btrfs-progs-v4.13.2' or
+  # 'Archive-Zip-1.46' or 'wcd-6.0.1-beta3' or 'openobex-1.7.1-Source'
+  # or 'youtube-dl-2019.06.27'.
+  #
+  # See:
+  #
+  #   https://rubular.com/r/u9Yy3qcxrlp5uG
+  #
+  # ========================================================================= #
+  REGEX_FOR_TWO_HYPHENS = 
+    /([A-Za-z+]{0,12}-?[a-z0-9]{0,9}-?[A-Za-z]{0,14}\d{0,4}-?[A-Za-z0-9]{0,12})-(\d{0,2}\.?[a-z]{0,1}\d{0,2}\.?[a-z]{0,1}\d{0,4}[.|-]?\d{0,8}[A-Za-z]{0,9}\d?\+?)$/
+
+  # ========================================================================= #
+  # === REGEX_FOR_THREE_OR_MORE_HYPHENS
+  #
+  # This is for input such as 'akonadi-calendar-tools-17.08.1' or
+  # 'boost-build-2014-10' or 'xf86-video-i810-1.7.4' or
+  # or 'xfce4-statusnotifier-plugin-0.2.0' or 'mime-types-data-3.2016.0521'
+  # or 'XML-LibXML-Simple-0.98' or 'kismet-2016-07-R1.tar.xz' or
+  # 'polkit-kde-agent-1-5.15.2' or 'xf86-video-amd-2.7.7.7'
+  # or 'xf86-video-s3virge-1.11.0'.
+  #
+  # See: https://rubular.com/r/lCrdU01HE7MRV4
+  # ========================================================================= #
+  REGEX_FOR_THREE_OR_MORE_HYPHENS =
+    /^([A-Za-z]{0,9}\d{0,2}-?[A-Za-z]{0,12}\d{0,2}-?[a-z]{0,9}\d{0,1}-?[A-Za-z]{0,8}-?1?\d{0,3}[a-z]{0,3})-(\d{0,4}\.?\d{0,4}\.?-?[A-Z]{0,1}\d{0,4}\.?\d{0,4})$/
+
+  # ========================================================================= #
+  # === REGEX_FOR_INPUT_HAVING_ONLY_DOTS
+  #
+  # This is valid for strange input such as 'expect5.45.3' or
+  # 'sendmail.8.15.2'. These have no '-' and no '_'.
+  #
+  # See: https://rubular.com/r/KVePR7ShX3
+  # ========================================================================= #
+  REGEX_FOR_INPUT_HAVING_ONLY_DOTS =
+    /([a-z]{1,10})\.?(\d+\.?\d{1,2}\.?\d{0,2})/
+
+  # ========================================================================= #
+  # === REGEX_FOR_BOOST_LIKE_INPUT
+  #
+  # Valid input should be 'ncbi_cxx-12_0_0' or 'icu4c-61_1'.
+  #
+  # See: https://rubular.com/r/CyNqJbCMR2
+  # ========================================================================= #
+  REGEX_FOR_BOOST_LIKE_INPUT =
+    /([a-z]{0,3}\d{0,1}[a-z]{0,5}_?[a-z]{0,3})([-|_]{1})(\d{1,2}_\d{1,2}_?\d*)/
+
+  # ========================================================================= #
+  # === REGEX_FOR_ACL_LIKE_INPUT
+  #
+  # Valid input should be 'acl_2.2.47-1' or 'e_dbus-1.7.10' or
+  # 'wpa_supplicant-2.6' or 'SDL2_gfx-1.0.1' or 'libatomic_ops-7.4.2'
+  # or 'mod_python-11.10.2017' or 'mini_portile2-2.3.0.gem'.
+  #
+  # See: https://rubular.com/r/gLysRUCwPNGAe1
+  # ========================================================================= #
+  REGEX_FOR_ACL_LIKE_INPUT =
+    /([A-Za-z]{0,10}[0-9]{0,1}_?[0-9]{0,1}[A-Za-z]{1,12}[0-9]{0,1})(_|-)([0-9]{0,2}\.?[0-9]{0,2}\.?[0-9]{0,2}-?[0-9]{0,2}_?[0-9]{0,4})/
+
+  # ========================================================================= #
+  # === REGEX_FOR_INPUT_CONTAINING_TWO_HYPHENS_AND_ONE_UNDERSCORE
+  #
+  # This is input for programs such as 'ntfs-3g_ntfsprogs-2017.3.23'.
+  #
+  # See: https://rubular.com/r/15pAuHKxt5
+  # ========================================================================= #
+  REGEX_FOR_INPUT_CONTAINING_TWO_HYPHENS_AND_ONE_UNDERSCORE =
+    /([a-z]{1}.+)(-)(\d{1,4}\.\d\.\d{1,2})/
+
+end

data/lib/program_information/initialize.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ProgramInformation
+
+class ProgramInformation # === ProgramInformation::ProgramInformation
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # Specific usage example:
+  #
+  #   ProgramInformation::ProgramInformation.new('util-linux-ng-2.15')
+  #
+  # ========================================================================= #
+  def initialize(
+      i                   = ARGV,
+      run_already         = true,
+      optional_be_verbose = false
+    )
+    reset
+    set_input(i)
+    if optional_be_verbose
+      set_be_verbose(optional_be_verbose)
+    end
+    case run_already
+    # ======================================================================= #
+    # === :do_run_already
+    # ======================================================================= #
+    when :do_run_already
+      run_already = true
+    # ======================================================================= #
+    # === :dont_run_already
+    # ======================================================================= #
+    when :dont_run_already,
+         :do_not_run_already
+      run_already = false
+    end
+    run if run_already
+  end
+
+end; end

data/lib/program_information/menu.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/menu.rb'
+# =========================================================================== #
+module ProgramInformation
+
+class ProgramInformation # === ProgramInformation::ProgramInformation
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(i)
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === help
+      # ===================================================================== #
+      when /-?-?help$/i
+        show_help
+        exit
+      end
+    end
+  end
+
+end; end