extracter 1.2.32 → 1.3.6

data/lib/extracter/class/extract_this_archive.rb

@@ -1,289 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'extracter/class/extract_this_archive.rb'
-# =========================================================================== #
-require 'extracter/base/base.rb'
-
-module Extracter
-
-class Extracter < ::Extracter::Base # === Extracter::Extracter
-
-  # ========================================================================= #
-  # === consider_verbosity_for
-  # ========================================================================= #
-  def consider_verbosity_for(i)
-    i = i.dup
-    unless be_verbose?
-      case i
-      # "tar -xvf" must become "tar -xvf" here.
-      when COMMAND_TO_EXTRACT_TAR_XZ_FILES
-        i.delete!('v')
-      end
-    end
-    return i
-  end
-
-  # ========================================================================= #
-  # === extract_this_archive                                    (extract tag)
-  # ========================================================================= #
-  def extract_this_archive(
-      i, extract_to = extract_to?
-    )
-    i = File.absolute_path(i)
-    # ======================================================================= #
-    # Next handle the situation when we are on Windows:
-    # ======================================================================= #
-    if ::Extracter.are_we_on_windows?
-      # ===================================================================== #
-      # On windows we will overrule this completely, for now.
-      # ===================================================================== #
-      _ = UNPACK_COMMAND_TO_USE_ON_WINDOWS+' '+
-          File.absolute_path(i)+
-          ' | '+
-          SECOND_UNPACK_COMMAND_TO_USE_ON_WINDOWS
-      esystem _
-      return
-    end
-    # ======================================================================= #
-    # First determine whether we can extract the archive or whether we can
-    # not:
-    # ======================================================================= #
-    if ::Extracter.is_this_a_valid_archive?(i) or i.end_with?('.pdf')
-      if be_verbose?
-        if show_only_the_short_name_of_the_archive?
-          name_of_the_archive = File.basename(i)
-          copn; e "#{rev}Extracting `#{sfancy(name_of_the_archive)}#{rev}` "\
-                  "to `#{sdir(extract_to)}#{rev}`."
-        else
-          copn; e "#{rev}Extracting `#{sfancy(i)}` to "\
-                  "`#{sdir(extract_to)}#{rev}`."
-        end
-      end
-      unless File.writable? extract_to
-        copn; ewarn 'You do not have sufficient permissions to'
-        copn; ewarn "modify #{sdir(extract_to)}#{swarn('.')}"
-        return
-      end
-      # ===================================================================== #
-      # Next, pad it if it includes a ' ' character or (). This was
-      # disabled as of July 2022.
-      # ===================================================================== #
-      # i = pad(i) if i.include?(' ') or i.include?(')')
-      case i # case tag; those listed on top are more important.
-      # ===================================================================== #
-      # === .rpm
-      #
-      # This entry point will handle .rpm files.
-      # ===================================================================== #
-      when /\.rpm$/i
-        name_of_the_directory = i.delete_suffix('.rpm')
-        mkdir(name_of_the_directory)
-        set_extract_to(File.absolute_path(name_of_the_directory))
-        cd(name_of_the_directory)
-        esystem 'rpm2cpio ../'+File.basename(i)+' | cpio -idmv'
-        return # Early return.
-      # ===================================================================== #
-      # === .tar.xz
-      #
-      # Note that .txz is just .tar.xz. Support for .txz was added here
-      # in January of 2012.
-      # ===================================================================== #
-      when /\.tar\.xz$/i,
-           /\.txz$/i,
-           /\.xz$/i
-        esystem consider_verbosity_for(COMMAND_TO_EXTRACT_TAR_XZ_FILES)+' '+i+padded_extract_to?
-      # ===================================================================== #
-      # === .tar
-      #
-      # This entry point is for simple .tar files.
-      # ===================================================================== #
-      when /\.tar$/i
-        esystem COMMAND_TO_EXTRACT_TAR_FILES+' '+i+padded_extract_to?
-      # ===================================================================== #
-      # === zip
-      # ===================================================================== #
-      when /.zip$/i,
-           /.xpi$/i,
-           /.docx$/i,
-           /.odt$/i, # .docx and .odt format types can be unpacked with zip too.
-           /.apkg$/
-        # =================================================================== #
-        # 'ar -jxf' # unzip #{what} <-- this should work as well.
-        # =================================================================== #
-        i = pad(i) if i.include?(' ') or i.include?(')')
-        esystem "unzip #{i}"
-      # ===================================================================== #
-      # === tgz
-      #
-      # This entry point will also handle ".tar.Z" files.
-      # ===================================================================== #
-      when /\.?tgz$/i,
-           /\.?tar.Z$/i,
-           /\.?taz$/i
-        esystem COMMAND_TO_EXTRACT_TGZ_FILES+' '+i+padded_extract_to?
-      # ===================================================================== #
-      # === 7z
-      # ===================================================================== #
-      when '.7z' # 7z does not accept the -C commandline.
-        # _ << '7za e' # <- Deprecated this variant as of 05.06.2020.
-        esystem "7z x #{i}"
-      # ===================================================================== #
-      # === .tar.bz2
-      # ===================================================================== #
-      when /\.tar\.bz2$/i,
-           /\.tbz$/i
-        esystem COMMAND_TO_EXTRACT_TAR_BZ2_FILES+' '+i+padded_extract_to?
-      # ===================================================================== #
-      # === gz
-      # ===================================================================== #
-      when /\.?gz$/i,
-           /\.?apk$/i
-        if i.include? '.tar' # Handle .tar.gz here.
-          esystem 'tar -zxvf '+i+padded_extract_to?
-        else
-          esystem 'gunzip '+i
-        end
-      # ===================================================================== #
-      # === .bz2
-      # ===================================================================== #
-      when /\.?bz2$/,
-           /\.?tbz2$/
-        if i.include? '.tar' # Treat it as a .tar file.
-          esystem 'tar -vjxf '+i
-        else
-          esystem 'bunzip2 '+i
-        end
-      # ===================================================================== #
-      # === rar
-      # ===================================================================== #
-      when '.rar'
-        check_whether_rar_is_available
-        esystem 'unrar e '+i
-      # ===================================================================== #
-      # === .zst
-      #
-      # This entry point is for e. g. "pymol-2.3.0-3-x86_64.pkg.tar.zst".
-      # ===================================================================== #
-      when '.zst','.tar.zst'
-        esystem COMMAND_TO_EXTRACT_ZST_ARCHIVES+' '+i
-      # ===================================================================== #
-      # === deb
-      #
-      # We could use dpkg-deb too, such as via "dpkg-deb". But using "ar"
-      # seems to be the better choice.
-      # ===================================================================== #
-      when /\.?deb$/i
-        esystem COMMAND_TO_EXTRACT_DEB_FILES+' '+i
-      # ===================================================================== #
-      # === gem
-      #
-      # The gem commands needs a specific --target=DIRECTORY option.
-      # ===================================================================== #
-      when /\.?gem$/i
-        esystem GEM_UNPACK_COMMAND+' '+i+" --target=#{extract_to}"
-      # ===================================================================== #
-      # === lzma
-      # ===================================================================== #
-      when '.lzma'
-        esystem "#{COMMAND_TO_EXTRACT_LZMA_FILES} #{i}"
-      # ===================================================================== #
-      # === bin
-      #
-      # This entry point allows the user to handle .bin files. In this
-      # context, "handling" means to simply run that file as-is.
-      # ===================================================================== #
-      when /\.?bin$/i 
-        esystem("./#{i}")
-      # ===================================================================== #
-      # === iso
-      # ===================================================================== #
-      when /\.?iso$/i
-        try_to_extract_this_iso_file(i)
-        return
-      # ===================================================================== #
-      # === img
-      #
-      # Note that .img in this context refers to squafhs .img files.
-      # ===================================================================== #
-      when /\.?img$/i,
-           /\.?squashfs$/i
-        try_to_extract_this_img_file(i)
-        return # Must return early in this case.
-      # ===================================================================== #
-      # === lz
-      #
-      # This entry point requires lzip to be installed.
-      # ===================================================================== #
-      when /\.?lz$/i,
-           /\.?tar\.?lz$/i
-        esystem("#{COMMAND_TO_EXTRACT_LZ_FILES} #{i}#{padded_extract_to?}")
-      # ===================================================================== #
-      # === mp4
-      #
-      # If it is a .mp4 file, we delegate to MultimediaParadise.extract_audio.
-      #
-      # Usage example:
-      #
-      #   rubyextract foobar.mp4
-      #
-      # ===================================================================== #
-      when /\.?mp4$/i
-        begin
-          require 'multimedia_paradise/audio/extract_audio/extract_audio.rb'
-        rescue LoadError; end
-        if Object.const_defined? :MultimediaParadise
-          MultimediaParadise.extract_audio(i)
-        end
-      # ===================================================================== #
-      # === ps
-      # ===================================================================== #
-      when/\.?ps$/i
-        esystem 'ps2ascii '+i+padded_extract_to?
-      # ===================================================================== #
-      # === .jar
-      # ===================================================================== #
-      when /\.?jar$/i
-        esystem COMMAND_TO_EXTRACT_JAR_ARCHIVES+' '+i
-      # ===================================================================== #
-      # === rpm
-      # ===================================================================== #
-      when '.rpm'
-        esystem "#{COMMAND_TO_EXTRACT_BSDTAR_ARCHIVES} #{i}"
-      # ===================================================================== #
-      # === sxz
-      # ===================================================================== #
-      when '.sxz'
-        esystem "unsquashfs #{i}"
-      # ===================================================================== #
-      # === pdf
-      #
-      # For pdf-files we will tap into the pdf_paradise project, if it
-      # is available.
-      # ===================================================================== #
-      when /\.?pdf$/
-        begin
-          require 'pdf_paradise/utility_scripts/convert_pdf_to_text.rb'
-          _ = PdfParadise::ConvertPdfToText.new(i)
-          e _.output_file?
-        rescue LoadError => error
-          e 'No, not there.'
-          pp error # Show the error to the user here.
-        end
-        return # Must return early in this case.
-      else # else tag. We did not find the extension type.
-        notify_the_user_that_this_extension_has_not_been_registered_yet(i)
-      end
-    else
-      if File.exist? i
-        notify_the_user_that_this_extension_has_not_been_registered_yet(i)
-      else
-        opnn; e "No file exists at `#{sfile(i)}`."
-      end
-    end
-  end; alias do_extract_to      extract_this_archive # === do_extract_to
-       alias do_extract_what_to extract_this_archive # === do_extract_what_to
-       alias start              extract_this_archive # === start
-
-end; end

data/lib/extracter/extract_it/extract_it.rb

@@ -1,241 +0,0 @@
-#!/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 "#{rev}No result could be found for the given input, "\
-             "thus using #{sfancy(i)} #{rev}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 "#{rev}Finished extracting "\
-                 "#{sfile(_)}#{rev} to `#{sdir(to_this_dir)}#{rev}`."
-        else
-          opn; e "#{rev}No file called `#{sfile(name_of_the_extracted_archive)}"\
-                 "#{rev}` 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/toplevel_methods/is_this_a_valid_archive.rb

@@ -1,41 +0,0 @@
-#!/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

@@ -1,34 +0,0 @@
-#!/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