extracter 1.2.21

data/lib/extracter/constants/constants.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'extracter/constants/constants.rb'
+# =========================================================================== #
+module Extracter
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === Extracter::ARRAY_REGISTERED_ARCHIVES
+  #
+  # Archives that can be extracted, have to be registered in this Array.
+  #
+  # Sort alphabetically.
+  #
+  # The libreoffice format .odt is just like .zip.
+  # ========================================================================= #
+  ARRAY_REGISTERED_ARCHIVES = %w(
+    7z
+    apk
+    apkg
+    bin
+    bz2
+    deb
+    gem
+    gz
+    img
+    iso
+    jar
+    lz
+    lzma
+    odt
+    mp4
+    pdf
+    rar
+    rpm
+    squashfs
+    sxz
+    tar
+    taz
+    tbz
+    tgz
+    txz
+    xpi
+    xz
+    zip
+    Z
+    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+'/'
+  else
+    # ======================================================================= #
+    # If this environment variable is unavailable then use a conservative
+    # default value.
+    # ======================================================================= #
+    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:
+  #
+  #   7z x -so C:\home\x\src\htop\htop-3.0.5.tar.xz | 6z x -si -ttar
+  #
+  # ========================================================================= #
+  UNPACK_COMMAND_TO_USE_ON_WINDOWS = '7z x -so '
+
+  # ========================================================================= #
+  # === SECOND_UNPACK_COMMAND_TO_USE_ON_WINDOWS
+  # ========================================================================= #
+  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
+  #
+  # This is specifically for .tgz files.
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_TGZ_FILES = 'tar zxvf'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_LZ_FILES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_LZ_FILES = 'tar --lzip -xvf'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_TAR_XZ_FILES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_TAR_XZ_FILES = 'tar -xvf'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_LZMA_FILES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_LZMA_FILES = 'unlzma'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_DEB_FILES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_DEB_FILES = 'ar -x'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_ZST_ARCHIVES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_ZST_ARCHIVES = 'tar -I zstd -xvf'
+
+  # ========================================================================= #
+  # === COMMAND_TO_EXTRACT_TAR_FILES
+  # ========================================================================= #
+  COMMAND_TO_EXTRACT_TAR_FILES = 'tar -xvf'
+
+end

data/lib/extracter/extract_it/extract_it.rb

@@ -0,0 +1,240 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Extracter::ExtractIt
+#
+# If no input was provided to this class, but a .zip file exists in
+# the current working directory, then that .zip file will be used.
+#
+# Usage example:
+#
+#   Extracter::ExtractIt.new(ARGV)
+#
+# =========================================================================== #
+# require 'extracter/extract_it/extract_it.rb'
+# =========================================================================== #
+require 'extracter/base/base.rb'
+
+module Extracter
+
+class ExtractIt < ::Extracter::Base # === Extracter::ExtractIt
+
+  require 'extracter/class/extracter.rb' # This file will pull in some other .rb files.
+  require 'extracter/constants/constants.rb'
+  require 'extracter/toplevel_methods/misc.rb' 
+
+  # ========================================================================= #
+  # === ExtractIt::NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === ExtractIt::ARRAY_ARCHIVE_TYPES
+  #
+  # Register the available (and handled) archive types here.
+  # ========================================================================= #
+  ARRAY_ARCHIVE_TYPES = ::Extracter::ARRAY_REGISTERED_ARCHIVES
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      optional_set_input = nil,
+      run_already        = true
+    )
+    reset
+    set_input(optional_set_input)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ======================================================================= #
+    # === @debug
+    # ======================================================================= #
+    @debug = false
+  end
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help
+    e 'We will show a little bit help, then exit.'
+    e
+    e 'To extract .tar.xz, do:'
+    e
+    efancy '  → tar -xJf *.tar.xz'
+  end
+
+  # ========================================================================= #
+  # === set_input
+  #
+  # We will work on an Array as value to @input, at the end of this
+  # method.
+  # ========================================================================= #
+  def set_input(i = N)
+    case i
+    # ======================================================================= #
+    # === extract_it --help
+    # ======================================================================= #
+    when /-?-?help$/i # Show some help stuff here.
+      show_help
+      exit
+    end
+    i = [i] if i.is_a? String # Need an Array.
+    if @debug
+      opn; e 'The input given to us is: `'+sfile(i)+'`'
+    end
+    if i.is_a?(Array) and i.empty?
+      # ===================================================================== #
+      # In this case, try to see if the current directory has a .zip
+      # file. We will use this in that case.
+      # ===================================================================== #
+      is_there_a_zip_file = Dir['*.zip']
+      unless is_there_a_zip_file.empty?
+        use_this_zip_file = is_there_a_zip_file.first
+        notify_the_user_that_no_input_was_given_but_this_file_was_found(use_this_zip_file)
+        i << use_this_zip_file
+      end
+      is_there_at_the_least_one_tar_xz_file = Dir['*.tar.xz']
+      unless is_there_at_the_least_one_tar_xz_file.empty?
+        i << is_there_at_the_least_one_tar_xz_file.first
+      end
+    end
+    @input = i # Should be an array, always.
+  end
+
+  # ========================================================================= #
+  # === be_silent
+  # ========================================================================= #
+  def be_silent
+    @be_silent = true
+  end
+
+  # ========================================================================= #
+  # === be_verbose
+  # ========================================================================= #
+  def be_verbose
+    @be_silent = false
+  end; alias show_commands_used be_verbose # === show_commands_used
+
+  # ========================================================================= #
+  # === notify_the_user_that_no_input_was_given_but_this_file_was_found
+  # ========================================================================= #
+  def notify_the_user_that_no_input_was_given_but_this_file_was_found(
+      this_file
+    )
+    opn; e "No input was given to #{sfancy(NAMESPACE)} but a "\
+           ".zip file was"
+    opn; e 'found in this directory ('+sdir(Dir.pwd)+'): '+
+            sfancy(this_file)
+    opn; e 'We will use this zip file.'
+  end
+
+  # ========================================================================= #
+  # === try_to_glob_on
+  # ========================================================================= #
+  def try_to_glob_on(i)
+    result = Dir["#{i}*"]
+    # ======================================================================= #
+    # Next, sort this result to put archives on the beginning of the Array.
+    # ======================================================================= #
+    result = result.partition {|entry| is_archive?(entry) }
+    result.flatten!
+    unless result.empty?
+      # ===================================================================== #
+      # Ok, we grab the first entry next.
+      # ===================================================================== #
+      i = result.first
+      opn; e "No result could be found for the given input, thus "\
+             "using #{sfancy(i)} instead."
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === extract_input
+  # ========================================================================= #
+  def extract_input
+    pp @input if @debug
+    @input.each {|entry|
+      to_this_dir = Dir.pwd
+      to_this_dir << '/' unless to_this_dir.end_with? '/'
+      unless File.exist? entry
+        entry = try_to_glob_on(entry)
+      end
+      # ===================================================================== #
+      # Delegate to class Extracter next.
+      # ===================================================================== #
+      Extracter.extract_what_to(
+        entry,
+        to_this_dir
+      ) {{ be_verbose: @be_silent }}
+      _ = ::Extracter.remove_file_suffix(entry)
+      if File.exist? entry
+        # =================================================================== #
+        # Must also check whether the extracted directory exists.
+        # =================================================================== #
+        name_of_the_extracted_archive = to_this_dir+_
+        ARRAY_ARCHIVE_TYPES.each {|extension_name|
+          if name_of_the_extracted_archive.include? extension_name
+            quoted = Regexp.quote(extension_name)
+            name_of_the_extracted_archive.sub!(/#{quoted}$/,'')
+          end
+        }
+        if File.exist?(name_of_the_extracted_archive) and
+          # ================================================================= #
+          # The following check ensures that we really have another name
+          # for the extracted directory.
+          # ================================================================= #
+          !(entry == name_of_the_extracted_archive)
+          opn; e "Finished extracting #{sfile(_)} to `#{sdir(to_this_dir)}`."
+        else
+          opn; e "No file called `#{sfile(name_of_the_extracted_archive)}"\
+                 "` appears to exist."
+        end
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === is_archive?
+  # ========================================================================= #
+  def is_archive?(i)
+    ARRAY_ARCHIVE_TYPES.include?(
+      File.extname(File.basename(i))
+    )
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    extract_input
+  end
+
+  # ========================================================================= #
+  # === Extracter::ExtractIt[]
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === Extracter.extract_it
+# =========================================================================== #
+def self.extract_it(i = ARGV, run_already = true)
+  ::Extracter::ExtractIt.new(i, run_already)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Extracter::ExtractIt.new(ARGV)
+end # extractitrb

data/lib/extracter/requires/require_the_extracter_project.rb

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

data/lib/extracter/toplevel_methods/is_this_a_valid_archive.rb

@@ -0,0 +1,41 @@
+#!/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.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
+
+if __FILE__ == $PROGRAM_NAME
+  pp Extracter.is_this_a_valid_archive?(ARGV)
+end

data/lib/extracter/toplevel_methods/misc.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === require 'extracter/toplevel_methods/misc.rb'
+# =========================================================================== #
+module Extracter
+
+  # ========================================================================= #
+  # === Extracter.remove_archive_type
+  # ========================================================================= #
+  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.are_we_on_windows?
+  # ========================================================================= #
+  def self.are_we_on_windows?
+    RUBY_PLATFORM.include?('win') or
+    RUBY_PLATFORM.include?('mingw')
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Extracter.are_we_on_windows?
+end

data/lib/extracter/version/version.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'extracter/version/version.rb'
+# =========================================================================== #
+module Extracter
+
+  # ========================================================================= #
+  # === VERSION
+  #
+  # Which specific version to use for class Extracter.
+  # ========================================================================= #
+  VERSION = '1.2.21'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPATE = '22.09.2022'
+
+end

data/lib/extracter.rb

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

data/test/testing_class_extracter.rb

@@ -0,0 +1,25 @@
+#!/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'
+  extract_to = '/home/Temp/'
+  e 'Now testing class Extracter - some will fail, do not worry:'
+  e
+  e Colours.orange('1) Testing Extracter.is_this_a_valid_archive?() functionality:')
+  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')
+  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'
+  e Colours.orange("2) Next testing "+sfancy("Extracter['/home/x/src/htop/']"))
+  Extracter['/home/x/src/htop/']
+  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

data/test/testing_class_method_extract_what_to.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will only test Extracter.extract_what_to().
+# =========================================================================== #
+require 'extracter/class/extracter.rb'
+
+Extracter.extract_what_to('/home/x/src/php/php-8.1.5.tar.xz', '/home/Temp/')

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: extracter
+version: !ruby/object:Gem::Version
+  version: 1.2.21
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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"
+email: shevy@inbox.lt
+executables: []
+extensions: []
+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/version/version.rb
+- test/testing_class_extracter.rb
+- test/testing_class_method_extract_what_to.rb
+homepage: https://rubygems.org/gems/extracter
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n  class Extracter can be used to extract archives, such as
+  .tar.gz or\n  .zip.\n\n  If you need some help, you can invoke bin/extract via:\n\n
+  \     extract --help\n\n  In general, the syntax for extract is kept simple. Just
+  pass in the\n  archive that has to be extracted as the first argument to \n  extract
+  ( bin/extract) , and class Extracter will try to extract\n  it, if it is a registered
+  archive format.\n\n  In ruby code, you may be able to use class Extracter in this
+  manner:\n\n      require 'extracter'\n      Extracter[file_path_here]\n\n  or\n\n
+  \     require 'extracter'\n      Extracter.new(file_path_here)\n\n  Specific example:\n\n
+  \     require 'extracter'\n      Extracter.new('htop-2.2.0.tar.xz')\n\n  See the
+  --help option.\n\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.3.22
+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.)'
+test_files: []