program_information 1.1.3

data/lib/program_information/project/project_base_directory.rb

@@ -0,0 +1,22 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/project/project_base_directory.rb'
+# =========================================================================== #
+module ProgramInformation
+
+  # ========================================================================= #
+  # === ProgramInformation::PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY =
+    "#{RbConfig::CONFIG['sitelibdir']}/program_information/"
+
+  # ========================================================================= #
+  # === ProgramInformation.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    PROJECT_BASE_DIRECTORY
+  end
+
+end

data/lib/program_information/report.rb

@@ -0,0 +1,48 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ProgramInformation
+
+class ProgramInformation
+
+  # ========================================================================= #
+  # === report                                        (debug tag, report tag)
+  # ========================================================================= #
+  def report(
+      be_verbose = be_verbose?
+    )
+    case be_verbose
+    when :do_report, :be_verbose
+      be_verbose = true
+    end
+    lpad = 90
+    rpad = 49
+    if be_verbose
+      inner_ljust = 28
+      # ===================================================================== #
+      # === real short name
+      # ===================================================================== #
+      e (NAME_OF_CLASS+(' Program real short name ').ljust(inner_ljust)+'('+
+        yellow?+'@real_short_name'+rev+') is: ').ljust(lpad)+
+        (apostroph?+real_short_name?+apostroph?).
+        ljust(rpad)
+      # ===================================================================== #
+      # === short name
+      # ===================================================================== #
+      e (
+        NAME_OF_CLASS+(' Program name').ljust(inner_ljust)+'('+
+        yellow?+'@short_name'+rev+'     ) is: '
+      ).ljust(lpad)+(apostroph?+short_name?+apostroph?).
+        ljust(rpad)
+      # ===================================================================== #
+      # === program version
+      # ===================================================================== #
+      e (NAME_OF_CLASS+(' Program version ').ljust(inner_ljust)+'('+
+        yellow?+'@program_version'+rev+') is: ').ljust(lpad)+
+        (apostroph?+version?+apostroph?).
+        ljust(rpad)
+    end
+  end; alias report_result report # === report_result
+
+end; end

data/lib/program_information/reset.rb

@@ -0,0 +1,46 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/reset.rb'
+# =========================================================================== #
+module ProgramInformation
+
+class ProgramInformation # === ProgramInformation::ProgramInformation
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @short_name
+    # ======================================================================= #
+    @short_name      = nil
+    # ======================================================================= #
+    # === @real_short_name
+    # ======================================================================= #
+    @real_short_name = nil
+    # ======================================================================= #
+    # === @program_version
+    # ======================================================================= #
+    @program_version = nil
+    set_shall_we_downcase # Should become before set_input().
+    set_be_verbose
+    # ======================================================================= #
+    # === @remove_plus_and_minus
+    # ======================================================================= #
+    @remove_plus_and_minus = REMOVE_PLUS_AND_MINUS
+    # ======================================================================= #
+    # === @replace_plus_with_long_name
+    # ======================================================================= #
+    @replace_plus_with_long_name = REPLACE_PLUS_WITH_LONG_NAME
+    @remove_plus_token = REMOVE_PLUS_TOKEN
+    if @remove_plus_and_minus # Overrule always in this case.
+      @replace_plus_with_long_name = false
+    end
+    if @remove_plus_and_minus
+      @remove_plus_token = false
+    end
+  end
+
+end; end

data/lib/program_information/run.rb

@@ -0,0 +1,18 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/run.rb'
+# =========================================================================== #
+module ProgramInformation
+
+class ProgramInformation
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    determine_the_three_main_variables
+  end
+
+end; end

data/lib/program_information/toplevel_methods.rb

@@ -0,0 +1,159 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/toplevel_methods.rb'
+# =========================================================================== #
+require 'program_information/toplevel_methods/opnn.rb'
+require 'program_information/toplevel_methods/e.rb'
+require 'program_information/toplevel_methods/return_short_name.rb'
+require 'program_information/program_information.rb'
+
+module ProgramInformation
+
+  # ========================================================================= #
+  # === ProgramInformation.return_program_version
+  #
+  # This module-method will return the program version of a given input.
+  #
+  # For example, if the input to this method is
+  # 'gobject-introspection-1.52.1.tar.xz', then this method will
+  # return the String '1.52.1'. 
+  #
+  # We must also handle the case when the version passed to us is incomplete
+  # or wrong, such as "2.1.0-source". In that case, the proper program
+  # version would be 2.1.0.
+  #
+  # Usage examples, using the shorter variant instead:
+  #
+  #   ProgramInformation.return_version('/opt/ffmpeg-2.3.tar.xz')             # => "2.3"
+  #   ProgramInformation.return_version 'ophcrack-3.6.0'                      # => "3.6.0"
+  #   ProgramInformation.return_version 'gobject-introspection-1.52.1.tar.xz' # => "1.52.1"
+  #
+  # ========================================================================= #
+  def self.return_program_version(of_this_program = '')
+    if of_this_program.nil? or of_this_program.empty?
+      opnn; e 'Please provide some input to the method '\
+              'ProgramInformation.return_program_version.'
+    else
+      _ = ::ProgramInformation::ProgramInformation.new(of_this_program)
+      _.program_version?
+    end 
+  end; self.instance_eval { alias return_version    return_program_version } # === ProgramInformation.return_version
+       self.instance_eval { alias return_version_of return_program_version } # === ProgramInformation.return_version_of
+
+  # ========================================================================= #
+  # === ProgramInformation.return_real_short_name
+  #
+  # This method will return the real short name.
+  #
+  # Usage example:
+  #
+  #   ProgramInformation.return_real_short_name('iso-codes-3.50.tar.xz')
+  # 
+  # The above would return "isocodes".
+  # ========================================================================= #
+  def self.return_real_short_name(of_this_program = '')
+    if of_this_program.nil? or of_this_program.empty?
+      opnn; e 'Please provide some input to the method '\
+              'ProgramInformation.return_real_short_name.'
+    else
+      _ = ::ProgramInformation::ProgramInformation.new(of_this_program)
+      _.real_short_name?
+    end
+  end; self.instance_eval { alias real_short_name     return_real_short_name } # === ProgramInformation.real_short_name
+       self.instance_eval { alias return_real_name    return_real_short_name } # === ProgramInformation.return_real_name
+       self.instance_eval { alias return_program_name return_real_short_name } # === ProgramInformation.return_program_name
+       self.instance_eval { alias program_name?       return_real_short_name } # === ProgramInformation.program_name?
+
+  # ========================================================================= #
+  # === ProgramInformation.return_short_name_and_program_version
+  #
+  # This will return an Array with two entries - the short name,
+  # and the program version.
+  # ========================================================================= #
+  def self.return_short_name_and_program_version(
+      i,
+      replace_input = true
+    )
+    case replace_input
+    when :do_not_modify_input
+      replace_input = false
+    end
+    _ = ::ProgramInformation::ProgramInformation.new(i, :dont_run_yet)
+    _.do_not_replace_anything unless replace_input
+    _.run
+    # ======================================================================= #
+    # Assemble the Array here.
+    # ======================================================================= #
+    array = [ _.short_name?, _.program_version? ]
+    return array
+  end; self.instance_eval { alias return_short_name_and_version return_short_name_and_program_version } # === ProgramInformation.return_short_name_and__version
+
+  # ========================================================================= #
+  # === ProgramInformation.return_array_name_and_version
+  #
+  # This will return the short_name and the version, as Array.
+  #
+  # Usage example:
+  #
+  #   ProgramInformation::ProgramInformation.return_array_name_and_version(
+  #     "font-sony-misc-1.0.3") => ["font-sony-misc", "1.0.3"]
+  #
+  # ========================================================================= #
+  def self.return_array_name_and_version(i)
+    array = [
+      ::ProgramInformation.return_short_name(i),
+      ::ProgramInformation.return_program_version(i)
+    ]
+    return array
+  end; self.instance_eval { alias return_array_program_name_and_program_version return_array_name_and_version } # === ProgramInformation.return_array_program_name_and_program_version
+
+  # ========================================================================= #
+  # === ProgramInformation.return_real_short_name_and_version
+  #
+  # This method will return two results, in Array form:
+  #
+  #   The @real_short_name and
+  #   the @program_version
+  #
+  # The optional second argument can be used to downcase the program
+  # name that is returned.
+  # ========================================================================= #
+  def self.return_real_short_name_and_version(
+      i, optional_downcase = false
+    )
+    case optional_downcase
+    when :downcase
+      optional_downcase = true
+    end
+    real_short_name = ::ProgramInformation.return_real_short_name(i)
+    if optional_downcase
+      real_short_name.downcase!
+    end
+    program_version = ::ProgramInformation.return_program_version(i)
+    return [
+      real_short_name, program_version
+    ]
+  end; self.instance_eval { alias return_real_name_and_version                  return_real_short_name_and_version } # === ProgramInformation.return_real_name_and_version
+       self.instance_eval { alias return_real_short_name_and_program_version    return_real_short_name_and_version } # === ProgramInformation.return_real_short_name_and_program_version
+       self.instance_eval { alias return_name_and_version                       return_real_short_name_and_version } # === ProgramInformation.return_name_and_version
+       self.instance_eval { alias return_name_and_version_of                    return_real_short_name_and_version } # === ProgramInformation.return_name_and_version_of
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  # ========================================================================= #
+  # Some testing code follows next:
+  # ========================================================================= #
+  if ARGV.empty?
+    _ = 'gobject-introspection-1.52.1.tar.xz'
+    p ProgramInformation.return_program_version(_)
+    p ProgramInformation.return_short_name(_)
+    p ProgramInformation.return_real_short_name(_)
+  else
+    p ProgramInformation.return_program_version(ARGV.first)
+    p ProgramInformation.return_short_name(ARGV.first)
+    p ProgramInformation.return_real_short_name(ARGV.first)
+  end
+end # rb toplevel_methods.rb /Users/x/SRC/gobjectintrospection/gobject-introspection-1.52.1.tar.xz

data/lib/program_information/toplevel_methods/e.rb

@@ -0,0 +1,14 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ProgramInformation
+
+  # ========================================================================= #
+  # === ProgramInformation.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/program_information/toplevel_methods/opnn.rb

@@ -0,0 +1,27 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/toplevel_methods/opnn.rb'
+# =========================================================================== #
+require 'program_information/toplevel_methods/e.rb'
+
+module ProgramInformation
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === ProgramInformation.e
+  # ========================================================================= #
+  def self.opnn(
+      i = 'ProgramInformation'
+    )
+    if i.is_a? String
+      i = { namespace: i }
+    end
+    Opn.opn(i) if Object.const_defined? :Opn
+  end
+
+end

data/lib/program_information/toplevel_methods/remove_archive_type.rb

@@ -0,0 +1,32 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/toplevel_methods/remove_archive_type.rb'
+# =========================================================================== #
+module ProgramInformation
+
+  # ========================================================================= #
+  # === ProgramInformation.remove_archive_type
+  #
+  # This method will remove the "archive type", e. g. ".tar.xz" or
+  # ".tar.bz2" or ".tar.lz".
+  # ========================================================================= #
+  def self.remove_archive_type(i)
+    i = i.dup if i.frozen?
+    i.sub!(/\.tar\.gz$/,'')
+    i.sub!(/\.tar\.xz$/,'')
+    i.sub!(/\.tar\.bz2$/,'')
+    i.sub!(/\.run$/,'')     if i.end_with? '.run'
+    i.sub!(/\.bz2$/,'')     if i.end_with? '.bz2'
+    i.sub!(/\.tar\.lz$/,'') if i.end_with? '.tar.lz'
+    i.sub!(/\.gem$/,'')
+    i.sub!(/\.tgz$/,'')
+    i.sub!(/\.zip$/,'')
+    i.sub!(/\.jar$/,'')
+    i.sub!(/\.js$/,'')
+    i.sub!(/\.stable$/,'')
+    return i
+  end
+
+end

data/lib/program_information/toplevel_methods/return_proper_pipe_token_to_this_input.rb

@@ -0,0 +1,167 @@
+#!/System/Index/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'program_information/toplevel_methods/return_proper_pipe_token_to_this_input.rb'
+# =========================================================================== #
+require 'program_information/constants/regex.rb'
+require 'program_information/toplevel_methods/opnn.rb'
+require 'program_information/toplevel_methods/remove_archive_type.rb'
+
+module ProgramInformation
+
+  # ========================================================================= #
+  # === ProgramInformation.return_proper_pipe_token_to_this_input
+  #
+  # Most of the content of this method has to be put into a begin/require
+  # clause, as errors may happen, which could propagate downstream,
+  # leading to confusion. So we will rescue the error, and notify the
+  # user as to what has happened.
+  # ========================================================================= #
+  def self.return_proper_pipe_token_to_this_input(
+      entry
+    )
+    if entry.is_a? Array
+      entry = entry.first
+    end
+    entry = remove_archive_type(entry)
+    use_this_replacement_token = '|'
+    return if entry.to_s.empty?
+    begin
+      # ===================================================================== #
+      # === Check for input such as 'unieject-6', containing one '-' and 0 '_'
+      # ===================================================================== #
+      if (entry.count('-') == 1) and
+         (entry.count('_') == 0)
+        entry[entry.index('-'),1] = use_this_replacement_token
+      # ===================================================================== #
+      # === Check for input such as 'p7zip_16.02_src_all.tar.bz2' with
+      #     3 '_' and at the least one '.' and no '-'
+      # ===================================================================== #
+      elsif (entry.count('_') == 3) and
+            (entry.count('.') > 0) and
+            (!entry.include?('-'))
+        entry[entry.index('_'),1] = use_this_replacement_token
+      # ===================================================================== #
+      # === Input such as 'mod_python_3.3.1', with two '_' and no '-'.
+      # ===================================================================== #
+      elsif (entry.count('_') == 2) and
+            (entry.count('-') == 0)
+        entry[entry.rindex('_'),1] = use_this_replacement_token
+      # ===================================================================== #
+      # === Input such as 'unzip60' without any '-' or '_'
+      # ===================================================================== #
+      elsif (entry.count('-') == 0) and
+            (entry.count('_') == 0) and
+            (!entry.include?('.'))
+        entry[entry.index(/\d/), 0] = '|'
+      # ===================================================================== #
+      # === Check for input such as 'artemis_v16.0.11' or 'dpkg_1.18.22'
+      #     with one '_' and no '-'.
+      # ===================================================================== #
+      elsif (entry.count('_') == 1) and
+            (entry.count('-') == 0)
+        entry[entry.index('_'),1] = use_this_replacement_token
+      # ===================================================================== #
+      # === Input such as 'sendmail.8.15.2' or 'expect5.45.3', without
+      #     any '-' or '_'.
+      # ===================================================================== #
+      elsif (entry.count('-') == 0) and
+            (entry.count('_') == 0) and
+            (entry.include?('.'))
+        entry =~ REGEX_FOR_INPUT_HAVING_ONLY_DOTS
+        entry = $1.to_s.dup+use_this_replacement_token+$2.to_s.dup
+      # ===================================================================== #
+      # For input such as 'boost-1_54_0' or 'ncbi_cxx-12_0_0' or
+      # 'boost_1.56.6'. So it contains exactly one '-' character.
+      # ===================================================================== #
+      elsif ((entry.count('-') == 1) and
+            (entry.count('_') > 1) and # More than 1 '_'
+            (entry =~ REGEX_FOR_BOOST_LIKE_INPUT)) or # or the second condition.
+            ((entry.count('_') == 3) and
+            (entry.count('-') == 0) and
+            (entry =~ REGEX_FOR_BOOST_LIKE_INPUT))
+        entry =~ REGEX_FOR_BOOST_LIKE_INPUT
+        # =================================================================== #
+        # We here need only the first and the third match.
+        # =================================================================== #
+        entry = "#{$1.to_s.dup}#{use_this_replacement_token}#{$3.to_s.dup}"
+      # ===================================================================== #
+      # For input such as 'acl_2.2.47-1' or 'e_dbus-1.7.10' or
+      # 'SDL2_gfx-1.0.1' or 'domain_name-0.5.20170404.gem' or
+      # 'libatomic_ops-7.4.2' or 'icu4c-62_1'.
+      # ===================================================================== #
+      elsif (entry.count('_') == 1) and
+            (entry.count('-') == 1) and
+            (entry =~ REGEX_FOR_ACL_LIKE_INPUT)
+        regex_to_use = REGEX_FOR_ACL_LIKE_INPUT
+        entry =~ regex_to_use
+        # =================================================================== #
+        # Here we also only need to match towards the first and the third
+        # entry.
+        # =================================================================== #
+        entry = $1.to_s.dup+use_this_replacement_token+$3.to_s.dup
+      # ===================================================================== #
+      # === Input such as 'did_you_mean-1.1.2' with one '-' and two '_'
+      # ===================================================================== #
+      elsif (entry.count('-') == 1) and
+            (entry.count('_') == 2)
+        entry[entry.index('-'),1] = use_this_replacement_token
+      # ===================================================================== #
+      # === Input such as 'ntfs-3g_ntfsprogs-2017.3.23' for 2 '-' and
+      #     1 '_'.
+      # ===================================================================== #
+      elsif (entry.count('-') == 2) and
+            (entry.count('_') == 1)
+        regex_to_use = REGEX_FOR_INPUT_CONTAINING_TWO_HYPHENS_AND_ONE_UNDERSCORE
+        entry =~ regex_to_use
+        entry = $1.to_s.dup+use_this_replacement_token+$3.to_s.dup
+      # ===================================================================== #
+      # For input such as 'lynx-2.8.8-rel2' or 'subtle-0.11.3224-xi' or
+      # 'gobject-introspection-1.53.4' or 'dvd+rw-tools-7.1' or
+      # 'Archive-Zip-1.46' or 'b43-fwcutter-015' or 'wcd-6.0.1-beta3'
+      # or 'oxygen-icons5-5.37.0'. These entries have two '-' and zero
+      # '_'.
+      # ===================================================================== #
+      elsif (entry.count('-') == 2) and
+            (entry.count('_') == 0)
+        regex_to_use = REGEX_FOR_TWO_HYPHENS
+        entry =~ regex_to_use
+        entry = $1.to_s.dup+use_this_replacement_token+$2.to_s.dup
+      # ===================================================================== #
+      # For input such as 'polkit-qt-1-0.112.0' or
+      # 'font-bitstream-75dpi-1.0.3' or 'boost-build-2014-10' or
+      # 'xf86-video-i810-1.7.4' or 'gnome-internet-radio-locator-0.9.0'
+      # or 'mime-types-data-3.2016.0521' or 'polkit-kde-agent-1-5.15.2'
+      # or 'xf86-video-amd-2.7.7.7'.
+      #
+      # This input will NOT have any '_' token; and at the least 3
+      # '-' tokens.
+      # ===================================================================== #
+      elsif (!entry.include?('_')) and
+            (entry.count('-') >= 3)
+        regex_to_use = REGEX_FOR_THREE_OR_MORE_HYPHENS
+        entry =~ regex_to_use
+        entry = $1.to_s.dup+
+                use_this_replacement_token+
+                $2.to_s.dup
+      else
+        e 'ERROR in program_information.rb! This should never happen.'
+        e "The input was: #{entry}"
+      end
+    rescue Exception => error
+      opnn; e 'An error happened (line: '+__LINE__.to_s+'), for '\
+              'the entry `'+entry.to_s+'`.'
+      pp error
+      pp error.class
+      opnn; e 'The caller stack was:'
+      pp caller()
+    end
+    return entry
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ProgramInformation.return_proper_pipe_token_to_this_input(ARGV)
+end # rb return_proper*rb icu4c-61_1