extracter 1.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3938254f958b3362154eb6638e11061ed06f1e539f05a7bc37217e12409f4834
+  data.tar.gz: e30edc461a2c1ca5b193364992d290560d01a24f5450698f662fe910da27aa40
+SHA512:
+  metadata.gz: 82d93ea69e4d00dbd0969c36a408d19c27fe9a6cc4896e2710cc19e45cc278df597efb8841ebfa798cd22d7fd1086702077795ef0bf9377047eb70a8d308be2f
+  data.tar.gz: ecb7cb4f5bae3cca4513c203774caf8a1510bc421dc1d1a221580063b76319f08dc9d18f1df5ed69b7058354cdadcc5dbc50dd7595234c7dadc460151317b10c

data/README.md

@@ -0,0 +1,86 @@
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/extracter.svg)](https://badge.fury.io/rb/extracter)
+	
+# Extracter
+
+## Scope of Extracter
+
+The scope (and goals) for **class Extracter** are really simple: throw any archive
+format at it, and the class will try to **extract** it.
+
+It can be used on the commandline as well.
+
+## How to find out whether a given file is a valid archive
+
+You can find out whether given input xyz is a valid archive by issuing
+the following toplevel-method:
+
+    Extracter.is_this_a_valid_archive?(path)
+
+This will return either true or false.
+
+## How to extract an archive through class Extracter, in pure ruby
+
+You can use the following method to extract an archive, into a specific
+target location:
+
+    Extracter.extract_what_to('foo-1.0.tar.xz', '/tmp')
+
+The first argument is the local path to an archive. The second
+argument specifies the **target**, usually the target directory.
+
+## Colour support
+
+If the **Colours** gem (**gem install colours**) is available then colour
+support is possible for **class Extracter**. For the class, the instance
+variable **@use_colours** determines this. If you do not want to have
+colours then you can disable this, e. g. through the method call
+**.disable_colours** to give one example for doing so.
+
+## class Extracter::ExtractIt
+
+class Extracter::ExtractIt was a standalone .gem (named **extract_it**), 
+but since as of September 2020 it is now part of "module Extracter".
+
+Basically this class is is a wrapper over the class Extracter,
+which will extract archives in general. The extraction step
+will go into the current working directory.
+
+## What archives and files can be extracted?
+
+**class Extracter** can extract .tar.xz, .tar.bz, .tar.gz, tar.Z,
+.zip and numerous other file formats. This requires that tools
+such as **tar** or **gzip** or **xz** are installed and available
+on the target computer-machine, as we will simply use ruby to
+shell out to these other programs.
+
+This class can also **extract audio-files** if ffmpeg is installed and
+the multimedia_paradise project is available (**gem install
+multimedia_paradise**), as well as squashfs files (typically 
+.img files). In the latter case, such an .img file will be mounted 
+in the current directory.
+
+Support for extracting .jar files has been added in **May 2020**.
+
+Support for 'extracting' .pdf files has been added in **January 2021**.
+This depends on **poppler**, and it is not really an extraction; we
+simply convert the file to a .txt (text) file. For this functionality
+the **pdf_paradise** project has to be available.
+
+
+## Contact information
+
+If your creative mind has ideas and specific suggestions to make this
+gem more useful in general, feel free to drop me an email at any
+time, via:
+
+    shevegen@gmail.com
+
+(Do keep in mind that responding to emails may take some time, depending
+on the amount of work I may have at that moment, due to reallife. I will,
+however had, read feedback. Patches and code changes are welcome too
+of course, as long as they are in the spirit of the project at
+hand, e. g. fitting to the general theme.)
+
+Thank you.

data/USAGE.md

@@ -0,0 +1,22 @@
+= Usage of Library
+
+== Requiring it
+
+  require 'extracter'
+
+== Using it in a project
+
+  _ = Extracter.extract_what_to('foobar-1.0.tar.bz2', '/tmp/')
+  
+  # You can also use the .new variant, which goes
+  # like so::
+
+  _ = Extracter.new('foo.gz', '/tmp', false) # Yes, you can extract .gz files.
+  _.run
+  
+  # The argument false means "do not yet run". You have to
+  # invoke the .run method in that case.
+  
+  # The second argument to the above method is the target
+  # location, the directory where we will extract our
+  # archive to.

data/bin/extract

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'extracter'
+
+Extracter.what_to(ARGV, Dir.pwd)

data/bin/extract_it

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

data/doc/README.gen

@@ -0,0 +1,69 @@
+ADD_RUBY_BADGE
+	
+# Extracter
+
+## Scope of Extracter
+
+The scope (and goals) for **class Extracter** are really simple: throw any archive
+format at it, and the class will try to **extract** it.
+
+It can be used on the commandline as well.
+
+## How to find out whether a given file is a valid archive
+
+You can find out whether given input xyz is a valid archive by issuing
+the following toplevel-method:
+
+    Extracter.is_this_a_valid_archive?(path)
+
+This will return either true or false.
+
+## How to extract an archive through class Extracter, in pure ruby
+
+You can use the following method to extract an archive, into a specific
+target location:
+
+    Extracter.extract_what_to('foo-1.0.tar.xz', '/tmp')
+
+The first argument is the local path to an archive. The second
+argument specifies the **target**, usually the target directory.
+
+## Colour support
+
+If the **Colours** gem (**gem install colours**) is available then colour
+support is possible for **class Extracter**. For the class, the instance
+variable **@use_colours** determines this. If you do not want to have
+colours then you can disable this, e. g. through the method call
+**.disable_colours** to give one example for doing so.
+
+## class Extracter::ExtractIt
+
+class Extracter::ExtractIt was a standalone .gem (named **extract_it**), 
+but since as of September 2020 it is now part of "module Extracter".
+
+Basically this class is is a wrapper over the class Extracter,
+which will extract archives in general. The extraction step
+will go into the current working directory.
+
+## What archives and files can be extracted?
+
+**class Extracter** can extract .tar.xz, .tar.bz, .tar.gz, tar.Z,
+.zip and numerous other file formats. This requires that tools
+such as **tar** or **gzip** or **xz** are installed and available
+on the target computer-machine, as we will simply use ruby to
+shell out to these other programs.
+
+This class can also **extract audio-files** if ffmpeg is installed and
+the multimedia_paradise project is available (**gem install
+multimedia_paradise**), as well as squashfs files (typically 
+.img files). In the latter case, such an .img file will be mounted 
+in the current directory.
+
+Support for extracting .jar files has been added in **May 2020**.
+
+Support for 'extracting' .pdf files has been added in **January 2021**.
+This depends on **poppler**, and it is not really an extraction; we
+simply convert the file to a .txt (text) file. For this functionality
+the **pdf_paradise** project has to be available.
+
+ADD_CONTACT_INFORMATION

data/extracter.gemspec

@@ -0,0 +1,111 @@
+# =========================================================================== #
+# Gemspec for Project Extracter.
+# =========================================================================== #
+require 'extracter/version/version.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'extracter'
+  s.version = Extracter::Extracter::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This fairly small class/library 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. The
+latter is - and should be - optional though.
+
+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 we should extract to, 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.)
+
+If you have a specific suggestion to make this gem more useful
+for others, please drop me an email at:
+
+    shevegen@gmail.com
+
+Thank you.
+
+EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.authors     = ['Robert A. Heiler']
+  s.email       = 'shevegen@gmail.com'
+  s.files       = Dir['**/*']
+  s.files      << 'USAGE.md' 
+  s.licenses    = 'GPL-2.0'
+  s.homepage    = 'http://rubygems.org/gems/extracter'
+
+  # ========================================================================= #
+  # Show this when a user installs the DiamondShell.
+  # ========================================================================= #
+  s.post_install_message = <<-EOF
+
+  class Extracter can be used to extract archives, such as .tar.gz or
+  .zip.
+
+  If you need some help, you can invoke bin/extract via:
+
+      extract --help
+
+  In general, the syntax for extract is kept simple. Just pass in the
+  archive that has to be extracted as the first argument to 
+  extract ( bin/extract) , and class Extracter will try to extract
+  it, if it is a registered archive format.
+
+  In ruby code, you may be able to use class Extracter in this manner:
+
+      require 'extracter'
+      Extracter[file_path_here]
+
+  or
+
+      require 'extracter'
+      Extracter.new(file_path_here)
+
+  Specific example:
+
+      require 'extracter'
+      Extracter.new('htop-2.2.0.tar.xz')
+
+  See the --help option.
+
+  EOF
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Specify the dependencies for this gem:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+  s.add_dependency 'remove_file_suffix'
+
+}

data/lib/extracter/class_methods.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Extracter
+
+class Extracter
+
+  # ========================================================================= #
+  # === Extracter::Extracter.is_this_a_valid_archive?
+  #
+  # Query whether the input is a valid archive.
+  #
+  # The registered formats are stored in the constant
+  # ARRAY_REGISTERED_ARCHIVES.
+  # ========================================================================= #
+  def self.is_this_a_valid_archive?(
+      i,
+      array_registered_archives = ARRAY_REGISTERED_ARCHIVES
+    )
+    return_value = false
+    array_registered_archives.each {|entry|
+      return_value = true if i =~ /#{entry}$/
+    }
+    return return_value
+  end; self.instance_eval { alias is_archive? is_this_a_valid_archive? } # === Extracter::Extracter.is_archive?
+
+  # ========================================================================= #
+  # === Extracter.extract_what_to
+  #
+  # This method provides a convenient API to extract something to a 
+  # specified directory, as a class method. It defaults to the
+  # current working directory, as that is by far the most convenient
+  # way to extract a source tarball/archive.
+  #
+  # Useage example goes like this:
+  #
+  #   Extracter.extract_what_to('foo-1.0.tar.xz', '/tmp')
+  #
+  # ========================================================================= #
+  def self.extract_what_to(
+      what,
+      to                 = Dir.pwd, # <- This can also be a Hash.
+      optional_be_silent = false
+    )
+    _ = Extracter.new(what, to, :do_not_run_yet)
+    if to.is_a? Hash
+      # ===================================================================== #
+      # === :prepend_this_namespace
+      # ===================================================================== #
+      if to.has_key? :prepend_this_namespace
+        prefix_with_this = to.delete(:prepend_this_namespace) # Get rid of it from the Hash as well.
+        _.prefix_namespace_with(
+          prefix_with_this
+        )
+      end
+      # ===================================================================== #
+      # === :to
+      # ===================================================================== #
+      if to.has_key? :to
+        to = to.delete(:to)
+      end
+      # ===================================================================== #
+      # === :verbosity
+      #
+      # Handle how verbose we shall be.
+      # ===================================================================== #
+      if to.has_key? :verbosity
+        _.set_verbosity(
+          to.delete(:verbosity)
+        )
+      end
+      # ===================================================================== #
+      # === :use_colours
+      # ===================================================================== #
+      if to.has_key? :use_colours
+        _.set_use_colours(to[:use_colours])
+      end
+      # ===================================================================== #
+      # === :pad_opn_with_n_tokens
+      # ===================================================================== #
+      if to.has_key? :pad_opn_with_n_tokens
+        _.set_pad_opn_with_n_tokens(to[:pad_opn_with_n_tokens])
+      end
+      # ===================================================================== #
+      # === :use_opn
+      # ===================================================================== #
+      if to.has_key? :use_opn
+        _.set_use_opn(to[:use_opn])
+      end
+    end
+    if optional_be_silent
+      _.be_silent
+    else
+      _.be_verbose
+    end
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      when :show_the_full_name_of_the_archive
+        _.do_show_the_full_name_of_the_archive
+      end
+    end
+    _.run
+  end; self.instance_eval { alias extract_this extract_what_to } # === Extracter.extract_this
+       self.instance_eval { alias what_to      extract_what_to } # === Extracter.what_to
+       self.instance_eval { alias extract      extract_what_to } # === Extracter.extract
+
+  # ========================================================================= #
+  # === Extracter::Extracter[]
+  # ========================================================================= #
+  def self.[](i, where_to = Dir.pwd)
+    new(i, where_to)
+  end
+
+end
+
+# =========================================================================== #
+# === Extracter.is_this_a_valid_archive?
+#
+# Determine whether the Extracter project can deal with the given archive
+# or whether it can not.
+# =========================================================================== #
+def self.is_this_a_valid_archive?(i)
+  ::Extracter::Extracter.is_this_a_valid_archive?(i)
+end; self.instance_eval { alias is_archive? is_this_a_valid_archive? } # === Extracter.is_archive?
+
+# =========================================================================== #
+# === Extracter.extract_what_to
+# =========================================================================== #
+def self.extract_what_to(
+    what = 'foo-1.0.tar.xz',
+    to   = '/tmp/', # This target directory defaults to Linux/UNIX-like systems.
+    optional_be_silent = false
+  )
+  ::Extracter::Extracter.extract_what_to(what, to, optional_be_silent)
+end; self.instance_eval { alias what_to extract_what_to } # === Extracter.what_to
+
+# =========================================================================== #
+# === Extracter[]
+# =========================================================================== #
+def self.[](i, where_to = Dir.pwd)
+  ::Extracter::Extracter.new(i, where_to)
+end
+
+end

data/lib/extracter/colours.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Extracter
+
+class Extracter
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === use_colours?
+  #
+  # Determine whether we will use colours in class Extracter.
+  # ========================================================================= #
+  def use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === set_use_colours
+  # ========================================================================= #
+  def set_use_colours(i)
+    # ======================================================================= #
+    # We must also sync this towards our main Hash, for opn(). The next
+    # line of code achieves precisely that.
+    # ======================================================================= #
+    @use_this_opn_hash.update(use_colours: i)
+    @use_colours = i
+  end
+
+  # ========================================================================= #
+  # === disable_colours
+  #
+  # Use this method if you want to disable colour-support of this class.
+  # ========================================================================= #
+  def disable_colours
+    @use_colours = false
+    @colour_to_use_for_directories = ''.dup
+  end
+
+  # ========================================================================= #
+  # === enable_colours
+  # ========================================================================= #
+  def enable_colours
+    @use_colours = true
+    @colour_to_use_for_directories = cyan?
+  end
+
+  # ========================================================================= #
+  # === set_colour_for_directories
+  #
+  # Set the colour for directories to use.
+  # ========================================================================= #
+  def set_colour_for_directories(i)
+    @colour_to_use_for_directories = Colours.beautify(i)
+  end
+
+  # ========================================================================= #
+  # === colour_to_use_for_directories?
+  # ========================================================================= #
+  def colour_to_use_for_directories?
+    if @use_colours
+      @colour_to_use_for_directories
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === cyan
+  # ========================================================================= #
+  def cyan?
+    if @use_colours
+      Colours::CYAN
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === ewarn
+  # ========================================================================= #
+  def ewarn(i = '')
+    if use_colours?
+      e Colours.swarn(i)
+    else
+      e i
+    end
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i = '')
+    return Colours.simp(i) if @use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    return Colours.sfancy(i) if @use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    return Colours.sfancy(i) if @use_colours
+    return i
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i = '')
+    return Colours.sdir(i) if @use_colours
+    return i
+  end
+
+end; end

data/lib/extracter/constants/constants.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Extracter
+
+class Extracter
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === 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 = '14 Apr 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
+
+  # ========================================================================= #
+  # === SHOW_ONLY_THE_SHORT_NAME_OF_THE_ARCHIVE
+  #
+  # If this constant is set to true then we will only show the shortened
+  # name of the archive in question by default.
+  # ========================================================================= #
+  SHOW_ONLY_THE_SHORT_NAME_OF_THE_ARCHIVE = true
+
+  # ========================================================================= #
+  # === 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'
+
+  # ========================================================================= #
+  # === 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
+    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
+  )
+
+end; end