extracter 1.1.0

data/lib/extracter/opn.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class Extracter
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === custom_opn
+  #
+  # This is like opn(), except that we also check whether
+  # we should show the name or not.
+  # ========================================================================= #
+  def custom_opn
+    opnn unless @do_not_show_name
+  end; alias copn custom_opn # === copn
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    if @use_opn and Object.const_defined?(:Opn)
+      Opn.opn(@use_this_opn_hash)
+    end
+  end
+
+  # ========================================================================= #
+  # === set_use_opn
+  # ========================================================================= #
+  def set_use_opn(i = true)
+    @use_opn = i
+  end
+
+  # ========================================================================= #
+  # === pad_opn_with_n_tokens
+  # ========================================================================= #
+  def pad_opn_with_n_tokens(n_tokens)
+    determine_default_opn_hash # Update this, just in case.
+    @use_this_opn_hash.update(padding: n_tokens)
+  end; alias set_pad_opn_with_n_tokens pad_opn_with_n_tokens # === set_pad_opn_with_n_tokens
+
+end

data/lib/extracter/reset.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class Extracter
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  #
+  # Reset our main instance variables here.
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @namespace
+    #
+    # Specify the main namespace to be used. This setting can be modified
+    # at "runtime".
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @debug
+    # ======================================================================= #
+    @debug = false
+    # ======================================================================= #
+    # === Extract to this location
+    #
+    # Next specify where to extract the archive in question, defaulting to
+    # the TEMP_DIR constant.
+    # ======================================================================= #
+    @extract_to_this_location = TEMP_DIR
+    # ======================================================================= #
+    # === @did_we_extract_already
+    #
+    # We will keep track of whether we already extracted or not.
+    # ======================================================================= #
+    @did_we_extract_already = false
+    # ======================================================================= #
+    # === @do_not_show_name
+    # ======================================================================= #
+    @do_not_show_name = false
+    # ======================================================================= #
+    # === @use_opn
+    # ======================================================================= #
+    @use_opn = true # ← Whether to use Opn by default or not.
+    # ======================================================================= #
+    # === @show_only_the_short_name_of_the_archive
+    # ======================================================================= #
+    @show_only_the_short_name_of_the_archive = SHOW_ONLY_THE_SHORT_NAME_OF_THE_ARCHIVE
+    # ======================================================================= #
+    # === @skip_extracting
+    # ======================================================================= #
+    @skip_extracting = false
+    # ======================================================================= #
+    # === @run_simulation
+    # ======================================================================= #
+    @run_simulation = false # ← Whether to run in simulation, or for "real".
+    set_extract_to_this_location
+    do_show_name # We will show the name usually.
+    enable_colours
+    determine_default_opn_hash
+    set_be_verbose(false)
+  end
+
+end

data/lib/extracter/version/version.rb

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

data/test/testing_class_extracter.rb

@@ -0,0 +1,24 @@
+#!/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 = '/Depot/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('/Users/x/SRC/recode/recode-3.7.tar.xz','/Depot/j')
+  Extracter.what_to '/Depot/j/recode-3.7.tar.xzg', '/Depot/jj' # This line is deliberately wrong.
+  Extracter.what_to '/Depot/j/recode-3.7.tar.xz',  '/Depot/jj'
+  Extracter.what_to '/Depot/j/recode-3.7.gzip',  '/Depot/jj'
+  e Colours.orange("2) Next testing "+sfancy("Extracter['/Users/x/SRC/htop/']"))
+  Extracter['/Users/x/SRC/htop/']
+  e Colours.orange("3) Next testing "+sfancy("Extracter['/Users/x/SRC/libzip/']"))
+  Extracter['/Users/x/SRC/libzip/', to: extract_to]
+end # testextracter

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: extracter
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: remove_file_suffix
+  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: |2+
+
+  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.
+
+email: shevegen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- USAGE.md
+- bin/extract
+- doc/README.gen
+- extracter.gemspec
+- lib/extracter.rb
+- lib/extracter/class_methods.rb
+- lib/extracter/colours.rb
+- lib/extracter/constants/constants.rb
+- lib/extracter/do_extract_what_to.rb
+- lib/extracter/extracter.rb
+- lib/extracter/help.rb
+- lib/extracter/initialize.rb
+- lib/extracter/misc.rb
+- lib/extracter/opn.rb
+- lib/extracter/reset.rb
+- lib/extracter/version/version.rb
+- test/testing_class_extracter.rb
+homepage: http://rubygems.org/gems/extracter
+licenses:
+- GPL-2.0
+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.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.4
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: '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.'
+test_files: []
+...