extracter 1.2.32 → 1.3.6

data/lib/extracter/constants/constants.rb

@@ -16,7 +16,7 @@ module Extracter
   #
   # Archives that can be extracted, have to be registered in this Array.
   #
-  # Sort alphabetically.
+  # This Array has to be sorted alphabetically.
   #
   # The libreoffice format .odt is just like .zip.
   # ========================================================================= #
@@ -53,22 +53,13 @@ module Extracter
     zst
   )
 
-  # ========================================================================= #
-  # === LAST_UPDATED
-  #
-  # When this class was last updated/releasted. This is not a hugely
-  # important constat, so do not worry too much if this may be heavily 
-  # outdated eventually.
-  # ========================================================================= #
-  LAST_UPDATED = '08.10.2021'
-
   # ========================================================================= #
   # === TEMP_DIR
   #
   # Set the temp dir here.
   # ========================================================================= #
   if ENV['MY_TEMP']
-    TEMP_DIR = ENV['MY_TEMP'].to_s+'/'
+    TEMP_DIR = "#{ENV['MY_TEMP']}/"
   else
     # ======================================================================= #
     # If this environment variable is unavailable then use a conservative
@@ -77,21 +68,20 @@ module Extracter
     TEMP_DIR = '/tmp/'
   end
 
-  # ========================================================================= #
-  # === GEM_UNPACK_COMMAND
-  #
-  # The command to use to unpack ruby .gems.
-  # We can pass the ---target=DIR syntax to extract to a specific location.
-  # ========================================================================= #
-  GEM_UNPACK_COMMAND = 'gem unpack'
-
   # ========================================================================= #
   # === UNPACK_COMMAND_TO_USE_ON_WINDOWS
   #
-  # The full commandline will look like this:
+  # The full commandline when on windows will look like this:
+  #
+  #   7z x -so C:\home\x\src\htop\htop-3.0.5.tar.xz | 7z x -si -ttar
   #
-  #   7z x -so C:\home\x\src\htop\htop-3.0.5.tar.xz | 6z x -si -ttar
+  # This was used in the RBT project, in the past, e. g. via code
+  # such as:
   #
+  #   cmd = '7z x "'.dup
+  #   cmd << i
+  #   cmd << '" -so | 7z x -aoa -si -ttar -o"'+program_name_and_program_version?.to_s+'"'
+  #        
   # ========================================================================= #
   UNPACK_COMMAND_TO_USE_ON_WINDOWS = '7z x -so '
 
@@ -100,23 +90,6 @@ module Extracter
   # ========================================================================= #
   SECOND_UNPACK_COMMAND_TO_USE_ON_WINDOWS = '7z x -si -ttar'
 
-  # ========================================================================= #
-  # === COMMAND_TO_EXTRACT_BSDTAR_ARCHIVES
-  #
-  # This command is to specifically extract rpm-archives.
-  # ========================================================================= #
-  COMMAND_TO_EXTRACT_BSDTAR_ARCHIVES = 'bsdtar xfv'
-
-  # ========================================================================= #
-  # === COMMAND_TO_EXTRACT_TAR_BZ2_FILES
-  # ========================================================================= #
-  COMMAND_TO_EXTRACT_TAR_BZ2_FILES = 'tar -xjvf'
-
-  # ========================================================================= #
-  # === COMMAND_TO_EXTRACT_JAR_ARCHIVES
-  # ========================================================================= #
-  COMMAND_TO_EXTRACT_JAR_ARCHIVES = 'jar xvf'
-
   # ========================================================================= #
   # === COMMAND_TO_EXTRACT_TGZ_FILES
   #
@@ -154,4 +127,30 @@ module Extracter
   # ========================================================================= #
   COMMAND_TO_EXTRACT_TAR_FILES = 'tar -xvf'
 
-end
+  # ========================================================================= #
+  # === GEM_UNPACK_COMMAND
+  #
+  # The command to use to unpack ruby .gems.
+  #
+  # We can pass the ---target=DIR syntax to extract to a specific location.
+  # ========================================================================= #
+  GEM_UNPACK_COMMAND = 'gem unpack'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_BSDTAR_ARCHIVES
+  #
+  # This command is to specifically extract rpm-archives.
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_BSDTAR_ARCHIVES = 'bsdtar xfv'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_TAR_BZ2_FILES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_TAR_BZ2_FILES = 'tar -xjvf'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_JAR_ARCHIVES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_JAR_ARCHIVES = 'jar xvf'
+
+end

data/lib/extracter/requires/require_the_extracter_project.rb

@@ -5,4 +5,4 @@
 # require 'extracter/requires/require_the_extracter_project.rb'
 # =========================================================================== #
 require 'extracter/class/extracter.rb'
-require 'extracter/extract_it/extract_it.rb'
+require 'extracter/requires/require_the_toplevel_methods.rb'

data/lib/extracter/requires/require_the_toplevel_methods.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'extracter/requires/require_the_toplevel_methods.rb'
+# =========================================================================== #
+require 'extracter/toplevel_methods/toplevel_methods.rb'

data/lib/extracter/toplevel_methods/toplevel_methods.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'extracter/toplevel_methods/is_this_a_valid_archive.rb'
+# Extracter.is_this_a_valid_archive?
+# =========================================================================== #
+module Extracter
+
+  require 'extracter/constants/constants.rb'
+
+  # ========================================================================= #
+  # === Extracter.return_pwd
+  # ========================================================================= #
+  def self.return_pwd
+    "#{Dir.pwd}/".squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === Extracter.are_we_on_windows?
+  #
+  # This method can be used to determine whether we are on windows (as
+  # our primary platform) or whether we are not.
+  # ========================================================================= #
+  def self.are_we_on_windows?
+    RUBY_PLATFORM.include?('win') or
+    RUBY_PLATFORM.include?('mingw')
+  end
+
+  # ========================================================================= #
+  # === Extracter.are_we_on_windows?
+  # ========================================================================= #
+  def self.this_on_windows(i)
+    _ = UNPACK_COMMAND_TO_USE_ON_WINDOWS+' '+
+        File.absolute_path(i)+
+        ' | '+
+        SECOND_UNPACK_COMMAND_TO_USE_ON_WINDOWS
+    esystem _
+  end
+
+  # ========================================================================= #
+  # === Extracter.esystem
+  # ========================================================================= #
+  def self.esystem(i)
+    puts i
+    system(i)
+  end
+
+  # ========================================================================= #
+  # === Extracter.remove_archive_type
+  #
+  # This method will remove suffix-types from a given input String.
+  # ========================================================================= #
+  def self.remove_archive_type(i)
+    return i.delete_suffix('.xz').
+             delete_suffix('.tgz').
+             delete_suffix('.bz2').
+             delete_suffix('.gz').
+             delete_suffix('.tar').
+             delete_suffix('.zip').
+             delete_suffix('.gem')
+  end; self.instance_eval { alias remove_file_suffix remove_archive_type } # === Extracter.remove_file_suffix
+
+  # ========================================================================= #
+  # === Extracter.is_this_a_valid_archive?
+  #
+  # Query whether the input given to this method is a valid archive.
+  #
+  # This allows us to determine whether the Extracter project can
+  # deal with the given archive at hand or whether it can not.
+  #
+  # The registered formats are stored in the constant
+  # ARRAY_REGISTERED_ARCHIVES.
+  # ========================================================================= #
+  def self.is_this_a_valid_archive?(
+      i, # The given input, such as "foobar.zip".
+      array_registered_archives = ARRAY_REGISTERED_ARCHIVES
+    )
+    if i.is_a? Array
+      i = i.first
+    end
+    return_value = false
+    array_registered_archives.each {|entry|
+      return_value = true if i =~ /#{entry}$/i
+    }
+    return return_value
+  end; self.instance_eval { alias is_archive?              is_this_a_valid_archive? } # === Extracter.is_archive?
+       self.instance_eval { alias is_this_a_valid_archive? is_this_a_valid_archive? } # === Extracter.is_this_a_valid_archive?
+
+end; Extract = Extracter # And keep a pseudo-alias here.
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e
+  e 'Are we on windows? '+Extracter.are_we_on_windows?.to_s
+  e
+  pp Extracter.is_this_a_valid_archive?(ARGV)
+  e
+end

data/lib/extracter/version/version.rb

@@ -11,11 +11,11 @@ module Extracter
   #
   # Which specific version to use for class Extracter.
   # ========================================================================= #
-  VERSION = '1.2.32'
+  VERSION = '1.3.6'
 
   # ========================================================================= #
   # === LAST_UPDATE
   # ========================================================================= #
-  LAST_UPATE = '19.03.2024'
+  LAST_UPATE = '26.03.2024'
 
 end

data/test/testing_are_we_on_windows.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+if __FILE__ == $PROGRAM_NAME
+  require 'fileutils'
+  require 'extracter'
+  require 'colours/colours_e_autoinclude.rb'
+  e 'Are we on windows? '+Extracter.are_we_on_windows?.to_s
+end # 

data/test/testing_class_extracter.rb

@@ -13,7 +13,8 @@ if __FILE__ == $PROGRAM_NAME
   e
   e Extracter.is_this_a_valid_archive? 'foo.php'
   # Extracter.new(ARGV)
-  FileUtils.cp('/home/x/src/recode/recode-3.7.1.tar.xz','/Depot/j')
+  what = '/home/x/src/recode/recode-3.7.1.tar.xz'
+  FileUtils.cp(what,'/Depot/j/') # Copy it there.
   Extracter.what_to '/Depot/j/recode-3.7.1.tar.xzg', '/Depot/jj' # This line is deliberately wrong.
   Extracter.what_to '/Depot/j/recode-3.7.1.tar.xz',  '/Depot/jj'
   Extracter.what_to '/Depot/j/recode-3.7.1.gzip',  '/Depot/jj'
@@ -22,4 +23,4 @@ if __FILE__ == $PROGRAM_NAME
   e Colours.orange("3) Next testing "+sfancy("Extracter['/home/x/src/libzip/']"))
   Extracter['/home/x/src/libzip/', to: extract_to]
   # Test the strip-components part next:
-end # testextracter
+end # testextracter

data/test/testing_class_method_extract_what_to.rb

@@ -6,4 +6,7 @@
 # =========================================================================== #
 require 'extracter/class/extracter.rb'
 
-Extracter.extract_what_to('/home/x/src/php/php-8.1.5.tar.xz', '/home/Temp/')
+what = '/home/x/src/php/php-8.3.4.tar.xz'
+to = '/home/x/Temp/'
+
+Extracter.extract_what_to(what, to)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extracter
 version: !ruby/object:Gem::Version
-  version: 1.2.32
+  version: 1.3.6
 platform: ruby
 authors:
 - Robert A. Heiler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opn
@@ -24,19 +24,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\nThis fairly small project can be used to extract different\narchive
-  formats such as .tar.bz2 or .tbz - archives such\nas .gem and .lzma will also work.\n\nYou
-  can also extract audio, by making use of class ExtractAudio\n(part of the multimedia_paradise
-  gem. The latter is - and should\nbe - optional, though. If you have no such use
-  case then you \nwon't need to install the multimedia_paradise gem.\n\nUsage example:\n\n
-  \   require 'extracter'\n\n    Extracter.new('/foo/bla-1.0.tar.bz2')\n\nThe second
-  argument that can be passed to the method new()\nspecifies where this should be
-  extract to.\n\nFor example:\n\n    Extracter.new('/foo/bla-1.0.tar.bz2', '/opt')\n\nThis
-  would extract to the /opt directory.\n\nYou can query whether input is an archive
-  or not via:\n\n  Extracter.is_archive? 'foo.tar.xz'\n\nAs of April 2014 we also
-  provide a bin/extract file, so that\nyou can simply extract something from the commandline.\n\nSince
-  as of November 2018, class Extracter can also \"extract\"\n.iso files. (The .iso
-  will be mounted to a directory that\nwill be created, actually.)\n\n"
+description: |2+
+
+  This fairly small gem can be used to extract different
+  archive formats, such as .tar.bz2, .tar.gz, .tbz,
+  .zip, .gem, .lzma and various more.
+
+  Audio can be extracted as well, via ffmpeg, if the gem called
+  multimedia_paradise is installed.
+
+  This project, however had, depends on external tools,
+  such as tar (on Linux) or 7z / 7zip (on Windows), so
+  these have to be installed first.
+
+  For more information about this project have a look
+  at the homepage, at
+  https://rubygems.org/gems/extracter.
+
 email: shevy@inbox.lt
 executables: []
 extensions: []
@@ -44,19 +48,17 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/extract
-- bin/extract_it
 - doc/README.gen
 - extracter.gemspec
 - lib/extracter.rb
 - lib/extracter/base/base.rb
-- lib/extracter/class/extract_this_archive.rb
 - lib/extracter/class/extracter.rb
 - lib/extracter/constants/constants.rb
-- lib/extracter/extract_it/extract_it.rb
 - lib/extracter/requires/require_the_extracter_project.rb
-- lib/extracter/toplevel_methods/is_this_a_valid_archive.rb
-- lib/extracter/toplevel_methods/misc.rb
+- lib/extracter/requires/require_the_toplevel_methods.rb
+- lib/extracter/toplevel_methods/toplevel_methods.rb
 - lib/extracter/version/version.rb
+- test/testing_are_we_on_windows.rb
 - test/testing_class_extracter.rb
 - test/testing_class_method_extract_what_to.rb
 homepage: https://rubygems.org/gems/extracter
@@ -85,22 +87,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.5.6
+      version: 3.5.3
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: 'This fairly small project can be used to extract different archive formats
-  such as .tar.bz2 or .tbz - archives such as .gem and .lzma will also work.  You
-  can also extract audio, by making use of class ExtractAudio (part of the multimedia_paradise
-  gem. The latter is - and should be - optional, though. If you have no such use case
-  then you  won''t need to install the multimedia_paradise gem.  Usage example:  require
-  ''extracter''  Extracter.new(''/foo/bla-1.0.tar.bz2'')  The second argument that
-  can be passed to the method new() specifies where this should be extract to.  For
-  example:  Extracter.new(''/foo/bla-1.0.tar.bz2'', ''/opt'')  This would extract
-  to the /opt directory.  You can query whether input is an archive or not via:  Extracter.is_archive?
-  ''foo.tar.xz''  As of April 2014 we also provide a bin/extract file, so that you
-  can simply extract something from the commandline.  Since as of November 2018, class
-  Extracter can also "extract" .iso files. (The .iso will be mounted to a directory
-  that will be created, actually.)'
+summary: This fairly small gem can be used to extract different archive formats, such
+  as .tar.bz2, .tar.gz, .tbz, .zip, .gem, .lzma and various more.  Audio can be extracted
+  as well, via ffmpeg, if the gem called multimedia_paradise is installed.  This project,
+  however had, depends on external tools, such as tar (on Linux) or 7z / 7zip (on
+  Windows), so these have to be installed first.  For more information about this
+  project have a look at the homepage, at https://rubygems.org/gems/extracter.
 test_files: []
+...

data/bin/extract_it

@@ -1,13 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-require 'extracter/requires/require_the_extracter_project.rb'
-
-_ = Extracter.extract_it(ARGV, false)
-if ARGV[1]
-  _.show_commands_used
-else 
-  _.be_silent
-end
-_.run # extractit