extracter 1.2.32 → 1.3.6

data/extracter.gemspec

@@ -15,40 +15,20 @@ Gem::Specification.new { |s|
 
   DESCRIPTION = <<-EOF
 
-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.
+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.
 
-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.
+Audio can be extracted as well, via ffmpeg, if the gem called
+multimedia_paradise is installed.
 
-Usage example:
+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.
 
-    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.)
+For more information about this project have a look
+at the homepage, at
+https://rubygems.org/gems/extracter.
 
 EOF
 
@@ -106,4 +86,4 @@ EOF
   # ========================================================================= #
   s.add_dependency 'opn'
 
-}
+}

data/lib/extracter/base/base.rb

@@ -4,6 +4,8 @@
 # =========================================================================== #
 # === Extracter::Base
 #
+# This is the base class for the extracter-gem.
+#
 # Usage example:
 #
 #   Extracter::Base.new(ARGV)
@@ -15,24 +17,52 @@ module Extracter
 
 class Base # === Extracter::Base
 
+  require 'fileutils' # We always need fileutils.
+
   begin
     require 'colours/html_colours'
   rescue LoadError; end
 
+  require 'extracter/toplevel_methods/toplevel_methods.rb'
+
   # ========================================================================= #
-  # === reset
+  # === reset                                                     (reset tag)
   # ========================================================================= #
   def reset
     # ======================================================================= #
     # === @internal_hash
+    #
+    # The internal Hash must be created first.
     # ======================================================================= #
-    @internal_hash = {}
+    create_the_internal_hash
+    # ======================================================================= #
+    # === :debug
+    # ======================================================================= #
+    @internal_hash[:debug] = false
     # ======================================================================= #
-    # === :use_colours
+    # === :be_verbose
+    # ======================================================================= #
+    @internal_hash[:be_verbose] = true
+    # ======================================================================= #
+    # === :colour_to_use_for_directories
+    # ======================================================================= #
+    @internal_hash[:colour_to_use_for_directories] = 'cyan'
+    # ======================================================================= #
+    # === :use_opn
+    # ======================================================================= #
+    @internal_hash[:use_opn] = true # ← Whether to use make use of Opn by default or not.
     # ======================================================================= #
-    @internal_hash[:use_colours] = true
     # Next check whether the Colours gem is available.
+    # ======================================================================= #
     check_whether_the_colours_gem_is_available
+    do_try_to_use_colours
+  end
+
+  # ========================================================================= #
+  # === create_the_internal_hash
+  # ========================================================================= #
+  def create_the_internal_hash
+    @internal_hash = {}
   end
 
   # ========================================================================= #
@@ -45,22 +75,39 @@ class Base # === Extracter::Base
        Colours.respond_to?(:sdir) and
        Colours.respond_to?(:simp)
     else
-      @internal_hash[:use_colours] = false
+      do_not_make_use_of_colours
     end
   end
 
+  # ========================================================================= #
+  # === do_not_make_use_of_colours
+  # ========================================================================= #
+  def do_not_make_use_of_colours
+    @internal_hash[:use_colours] = false
+  end
+
+  # ========================================================================= #
+  # === change_directory
+  # ========================================================================= #
+  def change_directory(i)
+    Dir.chdir(i)
+  end; alias cd change_directory # === cd
+
   # ========================================================================= #
   # === cyan
   # ========================================================================= #
-  def cyan?
-    return Colours::CYAN if Object.const_defined?(:Colours) and use_colours?
+  def cyan?(use_colours = use_colours?)
+    return Colours::CYAN if Object.const_defined?(:Colours) and use_colours
     return ''
   end
 
   # ========================================================================= #
   # === tomato
   # ========================================================================= #
-  def tomato(i = '', use_colours = use_colours?)
+  def tomato(
+      i           = '',
+      use_colours = use_colours?
+    )
     return Colours.tomato(i) if use_colours
     return i
   end
@@ -68,30 +115,74 @@ class Base # === Extracter::Base
   # ========================================================================= #
   # === simp
   # ========================================================================= #
-  def simp(i = '')
-    return Colours.simp(i) if use_colours?
+  def simp(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return Colours.simp(i) if use_colours
     return i
   end
 
   # ========================================================================= #
   # === steelblue
   # ========================================================================= #
-  def steelblue(i = '')
-    return ::Colours.steelblue(i) if use_colours? and ::Colours.respond_to?(:steelblue)
+  def steelblue(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::Colours.steelblue(i) if use_colours and ::Colours.respond_to?(:steelblue)
     return i
   end
 
   # ========================================================================= #
   # === ewarn
   # ========================================================================= #
-  def ewarn(i = '')
-    if use_colours? and Object.const_defined?(:Colours)
+  def ewarn(
+      i           = '',
+      use_colours = use_colours?
+    )
+    if use_colours and Object.const_defined?(:Colours)
       e Colours.swarn(i)
     else
       e i
     end
   end
 
+  # ========================================================================= #
+  # === cpr
+  # ========================================================================= #
+  def cpr(a, b)
+    try_to_require_fileutils
+    FileUtils.cp_r(a, b)
+  end
+
+  # ========================================================================= #
+  # === move
+  # ========================================================================= #
+  def move(a, b)
+    try_to_require_fileutils
+    FileUtils.mv(a, b)
+  end; alias mv move # === mv
+
+  # ========================================================================= #
+  # === remove_this_directory
+  #
+  # This method can be used to remove a directory.
+  # ========================================================================= #
+  def remove_this_directory(i)
+    if File.directory? i
+      try_to_require_fileutils
+      FileUtils.rm_r(i) unless i == '/'
+    end
+  end
+
+  # ========================================================================= #
+  # === try_to_require_fileutils
+  # ========================================================================= #
+  def try_to_require_fileutils
+    require 'fileutils' unless Object.const_defined?(:FileUtils)
+  end
+
   # ========================================================================= #
   # === sfile
   # ========================================================================= #
@@ -117,62 +208,282 @@ class Base # === Extracter::Base
   end
 
   # ========================================================================= #
-  # === use_colours?
+  # === e                                                             (e tag)
+  # ========================================================================= #
+  def e(i = '')
+    puts i
+  end
+
+  # ========================================================================= #
+  # === rev                                                         (rev tag)
+  # ========================================================================= #
+  def rev
+    if use_colours?
+      ::Colours.rev
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === are_we_on_windows?
+  # ========================================================================= #
+  def are_we_on_windows?
+    ::Extracter.are_we_on_windows?
+  end
+ 
+  # ========================================================================= #
+  # === be_verbose?
   #
-  # Determine whether we will use colours in class Extracter.
+  # Getter method for whether we will be verbose or not.
   # ========================================================================= #
-  def use_colours?
-    @internal_hash[:use_colours]
-  end; alias colours? use_colours? # === colours?
+  def be_verbose?
+    @internal_hash[:be_verbose]
+  end
 
   # ========================================================================= #
-  # === e                                                             (e tag)
+  # === register_sigint
   # ========================================================================= #
-  def e(i = '')
-    puts i
+  def register_sigint(this_class_name = 'Extracter')
+    Signal.trap('SIGINT') {
+      e sfancy('Requesting a graceful exit from ')+
+        colour_to_use_for_directories?+
+        'class '+this_class_name+sfancy('. Exiting now.')
+      exit
+    }
   end
 
   # ========================================================================= #
-  # === cpr
+  # === colour_to_use_for_directories?
   # ========================================================================= #
-  def cpr(a, b)
-    require 'fileutils' unless Object.const_defined?(:FileUtils)
-    FileUtils.cp_r(a, b)
+  def colour_to_use_for_directories?
+    if use_colours?
+      return @internal_hash[:colour_to_use_for_directories]
+    else
+      return ''
+    end
   end
 
   # ========================================================================= #
-  # === move
+  # === disable_colours
+  #
+  # Use this method if you want to disable colour-support of this class.
   # ========================================================================= #
-  def move(a, b)
-    require 'fileutils' unless Object.const_defined?(:FileUtils)
-    FileUtils.mv(a, b)
-  end; alias mv move # === mv
+  def disable_colours
+    set_use_colours(false)
+    @internal_hash[:colour_to_use_for_directories] = ''.dup
+  end
 
   # ========================================================================= #
-  # === remove_this_directory
+  # === create_directory                                          (mkdir tag)
+  #
+  # Use this to create directories.
   # ========================================================================= #
-  def remove_this_directory(i)
-    if File.directory? i
-      FileUtils.rm_r(i) unless i == '/'
+  def create_directory(i)
+    FileUtils.mkdir_p(i) unless File.directory?(i)
+  end; alias mkdir create_directory # === mkdir
+
+  # ========================================================================= #
+  # === be_verbose
+  # ========================================================================= #
+  def be_verbose
+    set_be_verbose(true)
+  end
+
+  # ========================================================================= #
+  # === do_be_quiet
+  # ========================================================================= #
+  def do_be_quiet
+    set_be_verbose(false)
+  end; alias be_silent do_be_quiet # === be_silent
+       alias be_quiet  do_be_quiet # === be_quiet
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    return i.squeeze('/') if i.respond_to? :squeeze
+    return i
+  end
+
+  # ========================================================================= #
+  # === set_be_verbose
+  #
+  # This sets the verbosity level of the class. Use only this method
+  # when you wish to modify the @be_verbose instance variable.
+  # ========================================================================= #
+  def set_be_verbose(i = false)
+    @internal_hash[:be_verbose] = i
+  end; alias set_verbosity      set_be_verbose # === set_verbosity
+       alias show_commands_used set_be_verbose # === show_commands_used
+  
+  # ========================================================================= #
+  # === remove_file_extension
+  # ========================================================================= #
+  def remove_file_extension(i)
+    _ = File.basename(i)
+    return ::Extracter.remove_archive_type(_)
+  end; alias remove_extension remove_file_extension # === remove_extensions
+       alias remove_ext       remove_file_extension # === remove_ext
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === return_pwd
+  # ========================================================================= #
+  def return_pwd
+    "#{Dir.pwd}/".squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === debug?
+  # ========================================================================= #
+  def debug?
+    @internal_hash[:debug]
+  end
+
+  # ========================================================================= #
+  # === enable_debug
+  # ========================================================================= #
+  def enable_debug
+    @internal_hash[:debug] = true
+  end
+
+  # ========================================================================= #
+  # === namespace?
+  # ========================================================================= #
+  def namespace?
+    @internal_hash[:namespace]
+  end
+
+  # ========================================================================= #
+  # === enable_colours
+  # ========================================================================= #
+  def enable_colours
+    set_use_colours(true)
+    @internal_hash[:colour_to_use_for_directories] = cyan?
+  end
+
+  # ========================================================================= #
+  # === set_use_colours
+  # ========================================================================= #
+  def set_use_colours(i, main_hash = main_hash?)
+    # ======================================================================= #
+    # We must also sync this towards our main Hash, for opn(). The next
+    # line of code achieves precisely that.
+    # ======================================================================= #
+    main_hash.update(use_colours: i) if main_hash
+    @internal_hash[:try_to_use_colours] = i
+  end
+
+  # ========================================================================= #
+  # === do_try_to_use_colours
+  # ========================================================================= #
+  def do_try_to_use_colours
+    set_use_colours(true)
+  end
+
+  # ========================================================================= #
+  # === try_to_use_colours?
+  #
+  # Determine whether we will use colours for class Extracter::Base
+  # and its subclass.
+  # ========================================================================= #
+  def try_to_use_colours?
+    @internal_hash[:try_to_use_colours]
+  end; alias use_colours? try_to_use_colours? # === use_colours?
+       alias colours?     try_to_use_colours? # === colours?
+
+  # ========================================================================= #
+  # === set_use_opn
+  # ========================================================================= #
+  def set_use_opn(i = true)
+    @internal_hash[:use_opn] = i
+  end
+
+  # ========================================================================= #
+  # === use_opn?
+  # ========================================================================= #
+  def use_opn?
+    @internal_hash[:use_opn]
+  end
+
+  # ========================================================================= #
+  # === opne
+  # ========================================================================= #
+  def opne(i = '')
+    opnn; e i
+  end
+
+  # ========================================================================= #
+  # === use_this_opn_hash?
+  # ========================================================================= #
+  def use_this_opn_hash?
+    @internal_hash[:use_this_opn_hash]
+  end; alias main_hash? use_this_opn_hash? # === main_hash?
+
+  # ========================================================================= #
+  # === opnn
+  #
+  # This variant will also check whether we should show the name or not.
+  # ========================================================================= #
+  def opnn(
+      use_this_hash = use_this_opn_hash?
+    )
+    if use_opn? and Object.const_defined?(:Opn)
+      Opn.opn(use_this_hash)
     end
+  end; alias opn  opnn # === opn
+       alias copn opnn # === copn
+
+  # ========================================================================= #
+  # === is_archive?
+  #
+  # This method queries whether the given file at hand (as input to
+  # this method) is assumed to be an archive or whether it is not.
+  # ========================================================================= #
+  def is_archive?(i)
+    ARRAY_ARCHIVE_TYPES.include?(
+      File.extname(File.basename(i))
+    )
   end
 
   # ========================================================================= #
-  # === change_directory
+  # === array_archive_types?
   # ========================================================================= #
-  def change_directory(i)
-    Dir.chdir(i)
-  end; alias cd change_directory # === cd
+  def array_archive_types?
+    ARRAY_REGISTERED_ARCHIVES
+  end
 
   # ========================================================================= #
-  # === rev
+  # === orev
   # ========================================================================= #
-  def rev
-    ::Colours.rev
+  def orev(i = '')
+    opne "#{rev}#{i}"
   end
 
 end; end
 
 if __FILE__ == $PROGRAM_NAME
   Extracter::Extracter.new(ARGV)
-end # base.rb
+end # base.rb