totarxz 0.0.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 041d128c94b8979ede5d42c7236036a7c1746207e8259acb83a2026f958f401e
+  data.tar.gz: 06b353729028faf46806e9e999eddf1c5f558fbff65df693f2e1b641014be418
+SHA512:
+  metadata.gz: 57249625798e98c90aa9daed9ec8ad176d25e8bd6fa64be3ad688e3b8a7aab11b31f7c8b6b2d6f947b7eec98f799499ec89dd9902779ff0b1e33550286e8bc06
+  data.tar.gz: 2fc30705629fdf40c525252e36a7bc25712ad3b30a8e848432b839d57aac38f4b0b7eb7a5409cb2b80abb735a2c14761ed13e69e69fbb0aea950910fbce9e2fb

data/bin/totarxz

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'totarxz/totarxz.rb'
+
+ToTarXz.new(ARGV) { :be_silent }

data/lib/totarxz/constants.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'totarxz/constants.rb'
+# =========================================================================== #
+class ToTarXz # === Totarxz.new
+
+  # ========================================================================= #
+  # === TAR_XZ_EXTENSION
+  # ========================================================================= #
+  TAR_XZ_EXTENSION = '.tar.xz'
+
+  # ========================================================================= #
+  # === TAR_BZ2_EXTENSION
+  # ========================================================================= #
+  TAR_BZ2_EXTENSION = '.tar.bz2'
+
+  # ========================================================================= #
+  # === BE_VERBOSE
+  #
+  # Whether to be verbose by default or whether we will not be verbose.
+  # ========================================================================= #
+  BE_VERBOSE = true
+
+end

data/lib/totarxz/requires/base_requires.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fileutils'
+require 'opn'
+require 'colours'

data/lib/totarxz/totarxz.rb

@@ -0,0 +1,347 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ToTarXz
+#
+# This class will essentially just create a .tar.xz package.
+#
+# The normal command for this is on Linux is:
+#
+#   tar cfJ <archive.tar.xz> <files>
+#   tar cfJ rbt-04.09.2015.tar.xz rbt-04.09.2015/
+#
+# =========================================================================== #
+# require 'totarxz/totarxz.rb'
+# =========================================================================== #
+class ToTarXz # === Totarxz
+
+  require 'totarxz/requires/base_requires.rb'
+  require 'totarxz/version/version.rb'
+  require 'totarxz/constants.rb'
+
+  include Colours
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument is the target to become a .tar.xz archive.
+  # ========================================================================= #
+  def initialize(
+      package_this_target = nil,
+      be_verbose          = BE_VERBOSE,
+      run_already         = true,
+      &block
+    )
+    @be_verbose = be_verbose # default
+    reset # This must come after @be_verbose was set.
+    be_verbose if be_verbose # Be silent not before calling sanitize_data().
+    set_package_this_target(
+      package_this_target
+    )
+    case run_already
+    # ======================================================================= #
+    # === --help
+    # ======================================================================= #
+    when /^-?-?help$/i
+      show_help_then_exit
+    # ======================================================================= #
+    # === --date
+    # ======================================================================= #
+    when /^-?-?date$/i,
+         'TODAY','WITH_DATE'
+      @repackage_archive_to_todays_date = true
+      run_already = true
+    end
+    # ======================================================================= #
+    # === Handle blocks next
+    #
+    # Intercept blocks here. Handle :be_verbose as argument, but also
+    # certain keys in a Hash, since as of June 2020.
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      when :be_silent
+        @be_verbose = false
+      when :be_verbose
+        @be_verbose = true
+      else
+        if yielded.is_a? Hash
+          # ================================================================= #
+          # === :use_this_archive_name => "htop-2.2.0"
+          # ================================================================= #
+          if yielded.has_key? :use_this_archive_name
+            set_tar_xz_name(yielded.delete(:use_this_archive_name))
+          end
+        end
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    if @be_verbose
+      @cmd = 'tar cJvf ' # v stands for verbosity here.
+    else
+      @cmd = 'tar cJf '  # v stands for verbosity here.
+    end
+    # ======================================================================= #
+    # === @cmd
+    # ======================================================================= #
+    @cmd = @cmd.dup
+    # ======================================================================= #
+    # === @archive_type
+    # ======================================================================= #
+    @archive_type = '.tar.xz'
+    # ======================================================================= #
+    # === @repackage_archive_to_todays_date
+    # ======================================================================= #
+    @repackage_archive_to_todays_date = false
+    # ======================================================================= #
+    # === @orig_stdout
+    # ======================================================================= #
+    @orig_stdout = nil
+  end
+
+  # ========================================================================= #
+  # === be_silent?
+  # ========================================================================= #
+  def be_silent?
+    !@be_verbose
+  end
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @be_verbose
+  end
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help
+    e 'To package up with the date, use DATE or TODAY.'
+  end
+
+  # ========================================================================= #
+  # === show_help_then_exit
+  # ========================================================================= #
+  def show_help_then_exit
+    show_help
+    exit
+  end
+
+  # ========================================================================= #
+  # === abort_then_exit
+  # ========================================================================= #
+  def abort_then_exit
+    abort "class ToTarXz: No file was provided or could be found. Please \n"\
+          "supply a valid argument (an existing file) and try again."
+    exit
+  end
+
+  # ========================================================================= #
+  # === set_package_this_target
+  #
+  # This method will be called from within initialize().
+  # ========================================================================= #
+  def set_package_this_target(
+      i = nil
+    )
+    if i.is_a? Array and !i.empty?
+      i = i.join(' ').strip
+    end
+    if i and i.end_with?('*')
+      # In this case continue.
+    elsif i.nil? or !File.exist?(i.to_s)
+      abort_then_exit
+    end
+    case i
+    # ======================================================================= #
+    # === --help
+    # ======================================================================= #
+    when /^-?-?help$/i
+      show_help_then_exit
+    end 
+    i = i.to_s.dup
+    unless i.end_with? '*'
+      i << '/' unless i.end_with? '/'
+    end
+    i.delete_suffix!('.tar.xz')  if i.include?('.tar.xz')
+    i.delete_suffix!('.tar.bz2') if i.include?('.tar.bz2')
+    @package_this_target = i
+    # ======================================================================= #
+    # Now we can determine the .tar.xz name.
+    # ======================================================================= #
+    determine_tar_xz_name
+  end; alias set_archive_filename       set_package_this_target # === set_archive_filename
+       alias directory=                 set_package_this_target # === directory=
+       alias extract_to_this_directory= set_package_this_target # === extract_to_this_directory=
+  
+  # ========================================================================= #
+  # === silence
+  # ========================================================================= #
+  def silence
+    @be_verbose = false
+    @orig_stdout = $stdout # Be silent.
+    $stdout = File.new('/dev/null', 'w')
+  end
+
+  # ========================================================================= #
+  # === extract_to_this_directory?
+  # ========================================================================= #
+  def extract_to_this_directory?
+    @tar_xz_name
+  end; alias directory?        extract_to_this_directory? # === directory?
+       alias dir?              extract_to_this_directory? # === dir?
+       alias tar_xz_name?      extract_to_this_directory? # === tar_xz_name?
+       alias archive_location? extract_to_this_directory? # === archive_location?
+       alias result?           extract_to_this_directory? # === result?
+
+  # ========================================================================= #
+  # === location?
+  # ========================================================================= #
+  def location?
+    determine_tar_xz_name # Yes, we will determine anew.
+  end
+  
+  # ========================================================================= #
+  # === package_this_target?
+  # ========================================================================= #
+  def package_this_target?
+    @package_this_target
+  end; alias input?            package_this_target? # === input?
+       alias archive_filename? package_this_target? # === archive_filename?
+       alias archive?          package_this_target? # === archive?
+
+  # ========================================================================= #
+  # === mv
+  # ========================================================================= #
+  def mv(old, new)
+    FileUtils.mv(old, new)
+  end
+
+  # ========================================================================= #
+  # === today?
+  # ========================================================================= #
+  def today?
+    Time.now.strftime '%d.%m.%Y'
+  end
+
+  # ========================================================================= #
+  # === set_cmd
+  # ========================================================================= #
+  def set_cmd(i)
+    unless i.end_with? ' '
+      i = i.dup if i.frozen?
+      i << ' '
+    end
+    @cmd = i
+  end
+
+  # ========================================================================= #
+  # === run_cmd
+  # ========================================================================= #
+  def run_cmd
+    e @cmd
+    system @cmd
+    # ======================================================================= #
+    # Next, we will apply a mv-action if we repackage to another name.
+    # ======================================================================= #
+    if rename?
+      new_name = File.basename(archive?).sub(/\.tar\.xz$/, '')+
+                 '-'+
+                 today?+
+                 @archive_type
+      opn; e 'Next renaming the archive to `'+sfancy(new_name)+'`.'
+      mv(archive?, new_name)
+    end
+    if @orig_stdout
+      $stdout = @orig_stdout unless be_verbose? # Restore stdout again.
+    end
+  end; alias create_tarxz_package run_cmd # === create_tarxz
+
+  # ========================================================================= #
+  # === create_tarxz_package
+  # ========================================================================= #
+  def create_tarxz_package
+    build_cmd_string
+    run_cmd
+  end
+
+  # ========================================================================= #
+  # === rename?
+  #
+  # Whether we will rename our archive or whether we will not.
+  # ========================================================================= #
+  def rename?
+    @repackage_archive_to_todays_date
+  end
+
+  # ========================================================================= #
+  # === determine_tar_xz_name
+  #
+  # Note that this method will always append .tar.xz to the name. This
+  # is fine for .tar.xz archives but not for .tar.bz2 archives.
+  # ========================================================================= #
+  def determine_tar_xz_name(
+      i = input?.delete('/')+
+          TAR_XZ_EXTENSION
+    )
+    @tar_xz_name = i
+  end; alias determine_the_name_of_the_archive determine_tar_xz_name # === determine_the_name_of_the_archive
+
+  # ========================================================================= #
+  # === set_tar_xz_name
+  # ========================================================================= #
+  def set_tar_xz_name(i)
+    if i.frozen?
+      i = i.dup
+    end
+    i << TAR_XZ_EXTENSION unless i.end_with? TAR_XZ_EXTENSION
+    @tar_xz_name = i
+  end
+
+  # ========================================================================= #
+  # === build_cmd_string
+  # ========================================================================= #
+  def build_cmd_string
+    @cmd << @tar_xz_name << ' ' << input? # Simply append.
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    create_tarxz_package
+  end
+
+  # ========================================================================= #
+  # === ToTarXz[]
+  # ========================================================================= #
+  def self.[](i)
+    new(i)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'opn'
+  require 'colours/colours_e_autoinclude.rb'
+  if ARGV[1]
+    if ARGV[1].include?('TODAY') or ARGV[1].include?('DATE') # Handle TODAY and DATE differently.
+      ToTarXz.new(ARGV.first, ARGV[1])
+    end
+  else
+    ARGV.each {|entry|
+      _ = ToTarXz.new(entry) { :be_silent }
+      Opn.opn(namespace: ToTarXz.to_s)
+      puts 'You can now find everything at: '+simp(_.archive_location?)
+    }
+  end
+end # tottarxz GEAS TODAY

data/lib/totarxz/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'totarxz/version/version.rb'
+# =========================================================================== #
+class ToTarXz
+
+  # ========================================================================= #
+  # === ToTarXz
+  # ========================================================================= #
+  VERSION = '0.0.21'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '16.03.2024'
+
+end

data/lib/totarxz.rb

@@ -0,0 +1 @@
+require 'totarxz/totarxz.rb'

data/test/testing_totarxz.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'fileutils'
+require 'cliner'
+require 'totarxz'
+require 'colours/colours_e_autoinclude.rb'
+require 'extracter'
+
+e "Now testing #{sfancy('class ToTarXz')}."
+htop = '/Users/x/SRC/htop/htop-1.0.3.tar.xz'
+target_dir = '/Depot/jjjj/'
+FileUtils.cp(htop, target_dir)
+Dir.chdir(target_dir)
+target = target_dir+File.basename(htop)
+e 'First extracting '+target+'.'
+_ = Extracter.new target, Dir.pwd
+pp Dir['*']
+cliner
+e sfancy(_.extracted_to?)
+File.delete(target) # Kill the old archive.
+e 'Now packaging up this here:'
+e '  '+sfancy(target)
+location = ToTarXz[target].location?
+e 'It can now be found here:'
+e
+e '  '+sfancy(location)
+e

data/totarxz.gemspec

@@ -0,0 +1,46 @@
+# =========================================================================== #
+# Gemspec for Project Totarxz.
+# =========================================================================== #
+require 'totarxz/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name        = 'totarxz'
+  s.version     = ToTarXz::VERSION
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  
+  s.summary = <<-EOF
+
+  This library is called totarxz. It will create a .tar.xz
+  file from the given input at hand.
+
+  EOF
+
+  s.description = <<-EOF
+
+  This library is called totarxz. It will create a .tar.xz
+  file from the given input at hand.
+
+  EOF
+
+  s.extra_rdoc_files = %w()
+
+  s.authors     = ['Robert A. Heiler']
+  s.email       = Roebe.email?
+  s.files       = Dir['**/*']
+  s.license     = 'GPL-2.0-only'
+  s.executables = Dir['bin/*'].map { |f| File.basename(f) }
+  s.homepage    = 'https://rubygems.org/gems/totarxz'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+
+}

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: totarxz
+version: !ruby/object:Gem::Version
+  version: 0.0.21
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-16 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'
+description: |2+
+
+    This library is called totarxz. It will create a .tar.xz
+    file from the given input at hand.
+
+email: shevy@inbox.lt
+executables:
+- totarxz
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/totarxz
+- lib/totarxz.rb
+- lib/totarxz/constants.rb
+- lib/totarxz/requires/base_requires.rb
+- lib/totarxz/totarxz.rb
+- lib/totarxz/version/version.rb
+- test/testing_totarxz.rb
+- totarxz.gemspec
+homepage: https://rubygems.org/gems/totarxz
+licenses:
+- GPL-2.0-only
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.5.6
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: This library is called totarxz. It will create a .tar.xz file from the given
+  input at hand.
+test_files: []
+...