archive-tar-external 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8262389cae7e15791e59508564874601c91d9693d1151aaac72a3a52403ce666
-  data.tar.gz: 26c49206d0cc4bbc653353c900425331b9b59ba0a448c6acd4283b43001db9f9
+  metadata.gz: 9b20d6fa4e2827a0326f31b43997f3191a1c35ac268d5de485689bb0b0ab59c0
+  data.tar.gz: 4a4938677d58c08044547d5fb3bc7a71e669d1ffe11db0c1ba47cff35aecd70a
 SHA512:
-  metadata.gz: 2ecea7018db1ab2621966fa41d514c94d92d1b0b98fb1b60b9be337b3f4c650e1c310f4c4874167cc1a0d243c3cd5be858c99699a35e9d0f15df4246e8902e8c
-  data.tar.gz: b2ca702a9caeb6a6f76c5a32bb85615ce04b3587eb75675593612f439eeb43f74a4d29746ff8fc74c76423cd341e8867ed4c8d882bf45aef0ac457a108dbe58c
+  metadata.gz: 703b000865ccddd8a1c54cbbebf47a4e2a6790964c1b9ef68663b5779dd286e8923b2dfe98d2b89a9161af457aadd588e1372a4ce9d49b7f7fa44110f094ec8e
+  data.tar.gz: 0f72ea731fd952a4474eb553a789a4a78a8d79a41f6ad6c597a2328f948981251295dab4abb6bdabeac9770a85aa1fab6466f174c311e7c330fd3391bcb73aaa

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 1.4.2 - 1-May-2021
+* Switched from test-unit to rspec.
+* Added tighter versioning for the development dependencies.
+* Tests will now try to use gtar by default, if found.
+* A fair number of rubocop suggestions were implemented, including
+  the frozen string literal pragma.
+
 ## 1.4.1 - 19-Feb-2021
 * Switched from rdoc to markdown.
 

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org' do
+  gemspec
+end

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/MANIFEST.md

@@ -1,10 +1,13 @@
 * CHANGES.md
+* LICENSE
 * MANIFEST.md
 * README.md
+* Gemfile
 * Rakefile
 * archive-tar-external.gemspec
 * certs/djberg96_pub.pem
 * doc/tar_external.md
 * lib/archive-tar-external.rb
 * lib/archive/tar_external.rb
-* test/test_archive_tar_external.rb
+* spec/archive_tar_external_spec.rb
+* spec/spec_helper.rb

data/README.md

@@ -22,9 +22,16 @@ t = Archive::Tar::External.new('test.tar', '*.rb', 'gzip')
 * At least one compression program, e.g. gzip, bzip2, zip, etc.
    
 ## Known Issues
+
+### Solaris
 The tar program that comes with Solaris will not raise an error if you
 try to expand a file from an archive that does not contain that file.
 
+### OSX
+It appears that the BSD tar that ships on Mac does not implement the -u
+option properly, and will add a file to the archive even if the timestamp
+of the file hasn't changed.
+
 If you come across any other issues, please report them on the project
 page at https://github.com/djberg96/archive-tar-external.
 

data/Rakefile

@@ -1,8 +1,8 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-CLEAN.include("**/*.gem", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
 
 namespace :gem do
   desc 'Build the archive-tar-external gem'
@@ -10,7 +10,7 @@ namespace :gem do
     require 'rubygems/package'
     spec = eval(IO.read('archive-tar-external.gemspec'))
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc 'Install the archive-tar-external library as a gem'
@@ -20,9 +20,7 @@ namespace :gem do
   end
 end
 
-Rake::TestTask.new do |t|
-  t.warning = true
-  t.verbose = true
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/archive-tar-external.gemspec

@@ -3,28 +3,28 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'archive-tar-external'
-  spec.version    = '1.4.1'
+  spec.version    = '1.4.2'
   spec.summary    = 'A simple way to create tar archives using external calls'
   spec.license    = 'Apache-2.0'
   spec.author     = 'Daniel Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/archive-tar-external'
-  spec.test_file  = 'test/test_archive_tar_external.rb'
+  spec.test_files = Dir['spec/*.rb']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
 
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/archive-tar-external',
     'bug_tracker_uri'   => 'https://github.com/djberg96/archive-tar-external/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/archive-tar-external/blob/master/CHANGES',
+    'changelog_uri'     => 'https://github.com/djberg96/archive-tar-external/blob/main/CHANGES',
     'documentation_uri' => 'https://github.com/djberg96/archive-tar-external/wiki',
     'source_code_uri'   => 'https://github.com/djberg96/archive-tar-external',
     'wiki_uri'          => 'https://github.com/djberg96/archive-tar-external/wiki'
   }
 
-  spec.add_development_dependency('test-unit')
-  spec.add_development_dependency('ptools')
   spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('ptools', '~> 1.4')
 
   spec.description = <<-EOF
     The archive-tar-external is a simple wrapper interface for creating

data/lib/archive-tar-external.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'archive/tar/external'

data/lib/archive/tar/external.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 # The Archive module serves as a namespace only.
 module Archive
-
   # The Tar class serves as a toplevel class namespace only.
   class Tar
-
     # Raised if something goes wrong during the execution of any methods
     # which use the tar command internally.
     class Error < StandardError; end
@@ -17,7 +17,7 @@ module Archive
     # This class encapsulates tar & zip operations.
     class Tar::External
       # The version of the archive-tar-external library.
-      VERSION = '1.4.1'.freeze
+      VERSION = '1.4.2'
 
       # The name of the archive file to be used, e.g. "test.tar"
       attr_accessor :archive_name
@@ -39,18 +39,13 @@ module Archive
       # If +program+ is provided, then it compresses the archive as well by
       # calling Archive::Tar::External#compress_archive internally.
       #
-      def initialize(archive_name, file_pattern=nil, program=nil)
+      def initialize(archive_name, file_pattern = nil, program = nil)
         @archive_name            = archive_name.to_s
         @compressed_archive_name = nil
         @tar_program             = 'tar'
 
-        if file_pattern
-          create_archive(file_pattern)
-        end
-
-        if program
-          compress_archive(program)
-        end
+        create_archive(file_pattern) if file_pattern
+        compress_archive(program) if program
       end
 
       # Assign a compressed archive name.  This autogenerates the archive_name
@@ -62,9 +57,9 @@ module Archive
       # that you want to uncompress, and want to have a Tar::External object
       # around.  Otherwise, use the class method Tar::External.uncompress.
       #
-      def compressed_archive_name=(name, ext=File.extname(name))
+      def compressed_archive_name=(name, ext = File.extname(name))
         if ext.downcase == '.tgz'
-          @archive_name = File.basename(name, ext.downcase) + '.tar'
+          @archive_name = File.basename(name, ext.downcase) << '.tar'
         else
           @archive_name = File.basename(name, ext)
         end
@@ -79,15 +74,15 @@ module Archive
       def create_archive(file_pattern, options = 'cf')
         cmd = "#{@tar_program} #{options} #{@archive_name} #{file_pattern}"
 
-        Open3.popen3(cmd){ |tar_in, tar_out, tar_err|
+        Open3.popen3(cmd) do |_tar_in, _tar_out, tar_err|
           err = tar_err.gets
           raise Error, err.chomp if err
-        }
+        end
 
         self
       end
 
-      alias :create :create_archive
+      alias create create_archive
 
       # Compresses the archive with +program+, or gzip if no program is
       # provided.  If you want to pass arguments to +program+, merely include
@@ -95,10 +90,10 @@ module Archive
       #
       # Any errors that occur here will raise a Tar::CompressError.
       #
-      def compress_archive(program='gzip')
+      def compress_archive(program = 'gzip')
         cmd = "#{program} #{@archive_name}"
 
-        Open3.popen3(cmd){ |prog_in, prog_out, prog_err|
+        Open3.popen3(cmd) do |_prog_in, _prog_out, prog_err|
           err = prog_err.gets
           raise CompressError, err.chomp if err
 
@@ -106,12 +101,12 @@ module Archive
           # reliable way to do this, but this should work 99% of the time.
           name = Dir["#{@archive_name}.{gz,bz2,cpio,zip}"].first
           @compressed_archive_name = name
-        }
+        end
 
         self
       end
 
-      alias :compress :compress_archive
+      alias compress compress_archive
 
       # Uncompresses the tarball using the program you pass to this method.  The
       # default is "gunzip".  Just as for +compress_archive+, you can pass
@@ -123,33 +118,31 @@ module Archive
       #
       # Any errors that occur here will raise a Tar::CompressError.
       #
-      def uncompress_archive(program="gunzip")
-        unless @compressed_archive_name
-          raise CompressError, "no compressed file found"
-        end
+      def uncompress_archive(program = 'gunzip')
+        raise CompressError, 'no compressed file found' unless @compressed_archive_name
 
         cmd = "#{program} #{@compressed_archive_name}"
 
-        Open3.popen3(cmd){ |prog_in, prog_out, prog_err|
+        Open3.popen3(cmd) do |_prog_in, _prog_out, prog_err|
           err = prog_err.gets
           raise CompressError, err.chomp if err
           @compressed_archive_name = nil
-        }
+        end
         self
       end
 
-      alias :uncompress :uncompress_archive
+      alias uncompress uncompress_archive
 
       # Uncompress an existing archive, using +program+ to uncompress it.
       # The default decompression program is gunzip.
       #
-      def self.uncompress_archive(archive, program='gunzip')
+      def self.uncompress_archive(archive, program = 'gunzip')
         cmd = "#{program} #{archive}"
 
-        Open3.popen3(cmd){ |prog_in, prog_out, prog_err|
+        Open3.popen3(cmd) do |_prog_in, _prog_out, prog_err|
           err = prog_err.gets
           raise CompressError, err.chomp if err
-        }
+        end
       end
 
       class << self
@@ -162,56 +155,54 @@ module Archive
       def archive_info
         result = []
         cmd = "#{@tar_program} tf #{@archive_name}"
-        Open3.popen3(cmd){ |ain, aout, aerr|
+
+        Open3.popen3(cmd) do |_ain, aout, aerr|
           err = aerr.gets
           raise Error, err.chomp if err
 
-          while output = aout.gets
+          while (output = aout.gets)
             result << output.chomp
           end
-        }
+        end
+
         result
       end
 
-      alias :info :archive_info
+      alias info archive_info
 
       # Adds +files+ to an already existing archive.
       #
       def add_to_archive(*files)
-        if files.empty?
-          raise Error, "there must be at least one file specified"
-        end
+        raise Error, 'there must be at least one file specified' if files.empty?
 
-        cmd = "#{@tar_program} rf #{@archive_name} #{files.join(" ")}"
+        cmd = "#{@tar_program} rf #{@archive_name} #{files.join(' ')}"
 
-        Open3.popen3(cmd){ |ain, aout, aerr|
+        Open3.popen3(cmd) do |_ain, _aout, aerr|
           err = aerr.gets
           raise Error, err.chomp if err
-        }
+        end
         self
       end
 
-      alias :add :add_to_archive
+      alias add add_to_archive
 
       # Updates the given +files+ in the archive, i.e. they are added if they
       # are not already in the archive or have been modified.
       #
       def update_archive(*files)
-        if files.empty?
-          raise Error, "there must be at least one file specified"
-        end
+        raise Error, 'there must be at least one file specified' if files.empty?
 
-        cmd = "#{@tar_program} uf #{@archive_name} #{files.join(" ")}"
+        cmd = "#{@tar_program} uf #{@archive_name} #{files.join(' ')}"
 
-        Open3.popen3(cmd){ |ain, aout, aerr|
+        Open3.popen3(cmd) do |_ain, _aout, aerr|
           err = aerr.gets
           raise Error, err.chomp if err
-        }
+        end
 
         self
       end
 
-      alias :update :update_archive
+      alias update update_archive
 
       # Expands the contents of the tarball.  It does NOT delete the tarball.
       # If +files+ are provided, then only those files are extracted.
@@ -223,22 +214,19 @@ module Archive
       #
       def extract_archive(*files)
         cmd = "#{@tar_program} xf #{@archive_name}"
+        cmd = "#{cmd} #{files.join(' ')}" unless files.empty?
 
-        unless files.empty?
-          cmd << " " << files.join(" ")
-        end
-
-        Open3.popen3(cmd){ |ain, aout, aerr|
+        Open3.popen3(cmd) do |_ain, _aout, aerr|
           err = aerr.gets
           raise Error, err.chomp if err
-        }
+        end
 
         self
       end
 
-      alias :expand_archive :extract_archive
-      alias :extract :extract_archive
-      alias :expand :extract_archive
+      alias expand_archive extract_archive
+      alias extract extract_archive
+      alias expand extract_archive
 
       # A class method that behaves identically to the equivalent instance
       # method, except that you must specifiy that tarball as the first
@@ -246,15 +234,12 @@ module Archive
       #
       def self.extract_archive(archive, *files)
         cmd = "tar xf #{archive}"
+        cmd = "#{cmd} #{files.join(' ')}" unless files.empty?
 
-        unless files.empty?
-          cmd << " " << files.join(" ")
-        end
-
-        Open3.popen3(cmd){ |ain, aout, aerr|
+        Open3.popen3(cmd) do |_ain, _aout, aerr|
           err = aerr.gets
           raise Error, err.chomp if err
-        }
+        end
 
         self
       end

data/spec/archive_tar_external_spec.rb

@@ -0,0 +1,231 @@
+###############################################################################
+# archive_tar_external_spec.rb
+#
+# Tests for the archive-tar-external library. This test case should be
+# run via the 'rake spec' Rake task.
+###############################################################################
+require 'archive/tar/external'
+require 'spec_helper'
+
+RSpec.describe Archive::Tar::External do
+  let(:tmp_file1) { 'temp1.txt' }
+  let(:tmp_file2) { 'temp2.txt' }
+  let(:tmp_file3) { 'temp3.txt' }
+
+  let(:tar_name) { 'test.tar' }
+  let(:tar_obj)  { Archive::Tar::External.new(tar_name) }
+  let(:pattern)  { '*.txt' }
+  let(:gtar)     { File.basename(File.which('gtar')) }
+
+  let(:archive_name) { 'test.tar.gz' }
+  let(:tar_program)  { gtar || 'tar' }
+
+  before do
+    tar_obj.tar_program = 'gtar' if File.which('gtar')
+    File.open(tmp_file1, 'w'){ |f| f.puts 'This is a temporary text file' }
+    File.open(tmp_file2, 'w'){ |f| f.puts 'This is a temporary text file' }
+    File.open(tmp_file3, 'w'){ |f| f.puts 'This is a temporary text file' }
+  end
+
+  example "version" do
+    expect(Archive::Tar::External::VERSION).to eq('1.4.2')
+    expect(Archive::Tar::External::VERSION).to be_frozen
+  end
+
+  context "constructor" do
+    example "with name" do
+      expect{ Archive::Tar::External.new(tar_name) }.not_to raise_error
+    end
+
+    example "with name and extension" do
+      expect{ Archive::Tar::External.new(tar_name, pattern) }.not_to raise_error
+    end
+
+    example "with compression program", :gzip => true do
+      expect{ Archive::Tar::External.new(tar_name, pattern, 'gzip') }.not_to raise_error
+    end
+
+    example "raises an error if name is not provided" do
+      expect{ Archive::Tar::External.new }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "instance methods" do
+    example "tar_program getter" do
+      expect(tar_obj).to respond_to(:tar_program)
+      expect(tar_obj.tar_program).to eq(tar_program)
+    end
+
+    example "archive_name getter" do
+      expect(tar_obj).to respond_to(:archive_name)
+      expect(tar_obj.archive_name).to eq(tar_name)
+    end
+
+    example "archive_name setter" do
+      expect(tar_obj).to respond_to(:archive_name=)
+      expect{ tar_obj.archive_name = 'foo' }.not_to raise_error
+      expect(tar_obj.archive_name).to eq('foo')
+    end
+
+    example "compressed_archive_name getter" do
+      expect(tar_obj).to respond_to(:compressed_archive_name)
+      expect(tar_obj.compressed_archive_name).to be_nil
+    end
+
+    example "compressed_archive_name setter basic functionality" do
+      expect(tar_obj).to respond_to(:compressed_archive_name=)
+      expect{ tar_obj.compressed_archive_name = archive_name }.not_to raise_error
+    end
+
+    example "setting the compressed_archive_name also sets the archive name to the expected value" do
+      tar_obj.compressed_archive_name = archive_name
+      expect(tar_obj.compressed_archive_name).to eq(archive_name)
+      expect(tar_obj.archive_name).to eq(tar_name)
+
+      tar_obj.compressed_archive_name = 'test.tgz'
+      expect(tar_obj.compressed_archive_name).to eq('test.tgz')
+      expect(tar_obj.archive_name).to eq(tar_name)
+    end
+
+    example "create_archive basic functionality" do
+      expect(tar_obj).to respond_to(:create_archive)
+      expect{ tar_obj.create_archive(pattern) }.not_to raise_error
+      expect(File.exist?(tar_name)).to be true
+    end
+
+    example "create_archive requires at least on argument" do
+      expect{ tar_obj.create_archive }.to raise_error(ArgumentError)
+    end
+
+    example "create_archive raises an error if no files match the pattern" do
+      expect{ tar_obj.create_archive('*.blah') }.to raise_error(Archive::Tar::Error)
+    end
+
+    example "create_archive accepts optional parameters" do
+      expect{ tar_obj.create_archive(pattern, 'cfj') }.not_to raise_error
+    end
+
+    example "create is an alias for create_archive" do
+      expect(tar_obj).to respond_to(:create)
+      expect(tar_obj.method(:create)).to eq(tar_obj.method(:create_archive))
+    end
+  end
+
+  context "compression" do
+    example "compress_archive basic functionality" do
+      expect(tar_obj).to respond_to(:compress_archive)
+    end
+
+    example "compress is an alias for compress_archive" do
+      expect(tar_obj).to respond_to(:compress)
+      expect(tar_obj.method(:compress)).to eq(tar_obj.method(:compress_archive))
+    end
+
+    example "compress_archive defaults to gzip", :gzip => true do
+      tar_obj.create_archive(pattern)
+      tar_obj.compress_archive
+
+      expect(tar_obj.compressed_archive_name).to eq(archive_name)
+      expect(File.exist?(archive_name)).to be true
+    end
+
+    example "compress_archive works with bzip2", :bzip2 => true do
+      expect{ tar_obj.create_archive(pattern) }.not_to raise_error
+      expect{ tar_obj.compress_archive('bzip2') }.not_to raise_error
+      expect(File.exist?('test.tar.bz2')).to be true
+    end
+  end
+
+  context "uncompression" do
+    before do
+      tar_obj.create_archive(pattern).compress_archive
+    end
+
+    example "uncompress_archive basic functionality" do
+      expect(tar_obj).to respond_to(:uncompress_archive)
+    end
+
+    example "uncompress_archive behaves as expected" do
+      expect{ tar_obj.uncompress_archive }.not_to raise_error
+      expect(File.exist?(archive_name)).to be false
+    end
+
+    example "uncompress is an alias for uncompress_archive" do
+      expect(tar_obj).to respond_to(:uncompress)
+      expect(tar_obj.method(:uncompress)).to eq (tar_obj.method(:uncompress_archive))
+    end
+
+    example "uncompress_archive singleton method" do
+      expect(Archive::Tar::External).to respond_to(:uncompress_archive)
+    end
+  end
+
+  context "archive" do
+    example "archive_info basic functionality" do
+      expect(tar_obj).to respond_to(:archive_info)
+    end
+
+    example "archive_info returns the expected value" do
+      tar_obj.create_archive(pattern)
+      expect(tar_obj.archive_info).to eq([tmp_file1, tmp_file2, tmp_file3])
+    end
+
+    example "add_to_archive basic functionality" do
+      expect(tar_obj).to respond_to(:add_to_archive)
+    end
+
+    example "add_to_archive works as expected" do
+      tar_obj = described_class.new(tar_name)
+      expect{ tar_obj.add_to_archive(tmp_file2) }.not_to raise_error
+      expect{ tar_obj.add_to_archive(tmp_file2, tmp_file3) }.not_to raise_error
+      expect(tar_obj.archive_info).to eq([tmp_file2, tmp_file2, tmp_file3])
+    end
+
+    example "update_archive basic functionality" do
+      expect(tar_obj).to respond_to(:update_archive)
+    end
+
+    example "update_archive behaves as expected", :gtar => true do
+      tar_obj.create_archive(pattern)
+      expect(tar_obj.archive_info).to eq([tmp_file1, tmp_file2, tmp_file3])
+      tar_obj.update_archive(tmp_file2)
+      expect(tar_obj.archive_info).to eq([tmp_file1, tmp_file2, tmp_file3])
+    end
+
+    example "extract_archive_basic" do
+      expect(tar_obj).to respond_to(:extract_archive)
+    end
+
+    example "extract_archive raises an error if the file isn't in the archive" do
+      tar_obj.create(pattern)
+      expect{ tar_obj.expand('blah.txt') }.to raise_error(Archive::Tar::Error)
+    end
+
+    example "extract_archive with no arguments extracts all files" do
+      tar_obj.create(pattern)
+      expect{ tar_obj.extract_archive }.not_to raise_error
+    end
+
+    example "extract_archive with a valid file argument behaves as expected" do
+      tar_obj.create(pattern)
+      expect{ tar_obj.extract_archive(tmp_file2) }.not_to raise_error
+    end
+
+    example "expand_archive, expand and extract are aliases for extract_archive" do
+      expect(tar_obj.method(:expand_archive)).to eq(tar_obj.method(:extract_archive))
+      expect(tar_obj.method(:expand)).to eq(tar_obj.method(:extract_archive))
+      expect(tar_obj.method(:extract)).to eq(tar_obj.method(:extract_archive))
+    end
+  end
+
+  after do
+    File.delete(tmp_file1) if File.exist?(tmp_file1)
+    File.delete(tmp_file2) if File.exist?(tmp_file2)
+    File.delete(tmp_file3) if File.exist?(tmp_file3)
+
+    File.delete(tar_name) if File.exist?(tar_name)
+    File.delete("#{tar_name}.gz") if File.exist?("#{tar_name}.gz")
+    File.delete("#{tar_name}.bz2") if File.exist?("#{tar_name}.bz2")
+    File.delete("#{tar_name}.zip") if File.exist?("#{tar_name}.zip")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'ptools'
+
+RSpec.configure do |config|
+  config.filter_run_excluding(:gzip) unless File.which('gzip')
+  config.filter_run_excluding(:gtar) unless File.which('gtar')
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: archive-tar-external
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,10 +35,10 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date:
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,33 +52,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ptools
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ptools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: |2
       The archive-tar-external is a simple wrapper interface for creating
       tar files using your system's tar command. You can also easily compress
@@ -89,29 +89,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Rakefile
-- certs
-- certs/djberg96_pub.pem
-- lib
-- lib/archive-tar-external.rb
-- lib/archive
-- lib/archive/tar
-- lib/archive/tar/external.rb
-- test
-- test/test_archive_tar_external.rb
 - CHANGES.md
+- Gemfile
+- LICENSE
 - MANIFEST.md
 - README.md
+- Rakefile
 - archive-tar-external.gemspec
-- doc
+- certs/djberg96_pub.pem
 - doc/archive_tar_external.md
+- lib/archive-tar-external.rb
+- lib/archive/tar/external.rb
+- spec/archive_tar_external_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/djberg96/archive-tar-external
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/archive-tar-external
   bug_tracker_uri: https://github.com/djberg96/archive-tar-external/issues
-  changelog_uri: https://github.com/djberg96/archive-tar-external/blob/master/CHANGES
+  changelog_uri: https://github.com/djberg96/archive-tar-external/blob/main/CHANGES
   documentation_uri: https://github.com/djberg96/archive-tar-external/wiki
   source_code_uri: https://github.com/djberg96/archive-tar-external
   wiki_uri: https://github.com/djberg96/archive-tar-external/wiki
@@ -130,9 +127,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A simple way to create tar archives using external calls
 test_files:
-- test/test_archive_tar_external.rb
+- spec/archive_tar_external_spec.rb
+- spec/spec_helper.rb

data/test/test_archive_tar_external.rb

@@ -1,209 +0,0 @@
-###############################################################################
-# test_archive_tar_external.rb
-#
-# Test suite for the archive-tar-external library. This test case should be
-# run via the 'rake test' Rake task.
-###############################################################################
-require 'archive/tar/external'
-require 'test-unit'
-require 'ptools'
-include Archive
-
-class TC_ArchiveTarExternal < Test::Unit::TestCase
-  def self.startup
-    Dir.chdir(File.dirname(File.expand_path(__FILE__)))
-
-    @@tmp_file1 = 'temp1.txt'
-    @@tmp_file2 = 'temp2.txt'
-    @@tmp_file3 = 'temp3.txt'
-
-    @@gtar_found  = File.which('gtar')
-    @@tar_found   = File.which('tar')
-    @@gzip_found  = File.which('gzip')
-    @@bzip2_found = File.which('bzip2')
-
-    File.open(@@tmp_file1, 'w'){ |f| f.puts 'This is a temporary text file' }
-    File.open(@@tmp_file2, 'w'){ |f| f.puts 'This is a temporary text file' }
-    File.open(@@tmp_file3, 'w'){ |f| f.puts 'This is a temporary text file' }
-  end
-
-  def setup
-    @tar      = Tar::External.new('test.tar')
-    @tar_name = 'test.tar'
-    @pattern  = '*.txt'
-    @archive  = 'temp.tar.gz'
-  end
-
-  def test_version
-    assert_equal('1.4.1', Tar::External::VERSION)
-    assert_true(Tar::External::VERSION.frozen?)
-  end
-
-  def test_constructor
-    assert_nothing_raised{ Tar::External.new(@tar_name) }
-  end
-
-  def test_constructor_with_extension
-    assert_nothing_raised{ Tar::External.new(@tar_name, '*.txt') }
-  end
-
-  def test_constructor_with_program
-    omit_unless(@@gzip_found){ 'gzip program not found - skipping' }
-    assert_nothing_raised{ Tar::External.new(@tar_name, '*.txt', 'gzip') }
-  end
-
-  def test_constructor_expected_errors
-    assert_raise(ArgumentError){ Tar::External.new }
-  end
-
-  def test_tar_program
-    assert_respond_to(@tar, :tar_program)
-    assert_equal('tar', @tar.tar_program)
-  end
-
-  def test_archive_name
-    assert_respond_to(@tar, :archive_name)
-    assert_respond_to(@tar, :archive_name=)
-
-    assert_equal('test.tar', @tar.archive_name)
-    assert_nothing_raised{ @tar.archive_name }
-    assert_nothing_raised{ @tar.archive_name = 'foo' }
-  end
-
-  def test_compressed_archive_name_get
-    assert_respond_to(@tar, :compressed_archive_name)
-    assert_nil(@tar.compressed_archive_name)
-  end
-
-  def test_compressed_archive_name_set
-    assert_respond_to(@tar, :compressed_archive_name=)
-    assert_nothing_raised{ @tar.compressed_archive_name = 'test.tar.gz' }
-    assert_equal('test.tar.gz', @tar.compressed_archive_name)
-    assert_equal('test.tar', @tar.archive_name)
-
-    assert_nothing_raised{ @tar.compressed_archive_name = 'test.tgz' }
-    assert_equal('test.tgz', @tar.compressed_archive_name)
-    assert_equal('test.tar', @tar.archive_name)
-  end
-
-  test "create_archive basic functionality" do
-    assert_respond_to(@tar, :create_archive)
-    assert_nothing_raised{ @tar.create_archive(@pattern) }
-    assert_true(File.exist?(@tar_name))
-  end
-
-  test "create_archive requires at least on argument" do
-    assert_raises(ArgumentError){ @tar.create_archive }
-  end
-
-  test "create_archive raises an error if no files match the pattern" do
-    assert_raises(Tar::Error){ @tar.create_archive('*.blah') }
-  end
-
-  test "create_archive accepts optional parameters" do
-    assert_nothing_raised{ @tar.create_archive(@pattern, 'cfj') }
-  end
-
-  def test_create_alias
-    assert_respond_to(@tar, :create)
-    assert_true(Tar::External.instance_method(:create) == Tar::External.instance_method(:create_archive))
-  end
-
-  def test_compress_archive_basic
-    assert_respond_to(@tar, :compress_archive)
-  end
-
-  def test_compress_alias
-    assert_respond_to(@tar, :compress)
-    assert_true(Tar::External.instance_method(:compress) == Tar::External.instance_method(:compress_archive))
-  end
-
-  def test_compress_archive_gzip
-    assert_nothing_raised{ @tar.create_archive('*.txt') }
-    assert_nothing_raised{ @tar.compress_archive }
-
-    assert_equal('test.tar.gz', @tar.compressed_archive_name)
-    assert_true(File.exist?('test.tar.gz'))
-  end
-
-  def test_compress_archive_bzip2
-    assert_nothing_raised{ @tar.create_archive('*.txt') }
-    assert_nothing_raised{ @tar.compress_archive('bzip2') }
-    assert_true(File.exist?('test.tar.bz2'))
-  end
-
-  def test_uncompress_archive
-    assert_respond_to(@tar, :uncompress_archive)
-    assert_nothing_raised{ @tar.create_archive('*.txt') }
-    assert_nothing_raised{ @tar.compress_archive }
-    assert_nothing_raised{ @tar.uncompress_archive }
-    assert_false(File.exist?('test.tar.gz'))
-  end
-
-  def test_uncompress_archive_class_method
-    assert_respond_to(Tar::External, :uncompress_archive)
-  end
-
-  def test_uncompress_alias
-    assert_respond_to(Tar::External, :uncompress)
-    assert_true(Tar::External.method(:uncompress) == Tar::External.method(:uncompress_archive))
-  end
-
-  def test_archive_info
-    assert_respond_to(@tar, :archive_info)
-    assert_nothing_raised{ @tar.create_archive('*.txt') }
-    assert_equal(['temp1.txt','temp2.txt','temp3.txt'], @tar.archive_info)
-  end
-
-  def test_add_to_archive
-    assert_respond_to(@tar,:add_to_archive)
-    assert_nothing_raised{ @tar.create_archive('temp1.txt') }
-    assert_nothing_raised{ @tar.add_to_archive('temp2.txt') }
-    assert_nothing_raised{ @tar.add_to_archive('temp2.txt','temp3.txt') }
-  end
-
-  def test_update_archive
-    assert_respond_to(@tar, :update_archive)
-    assert_nothing_raised{ @tar.create_archive('*.txt') }
-    assert_nothing_raised{ @tar.update_archive('temp2.txt') }
-  end
-
-  def test_extract_archive_basic
-    assert_respond_to(@tar, :extract_archive)
-  end
-
-  def test_extract_archive_aliases
-    assert_true(Tar::External.instance_method(:extract_archive) == Tar::External.instance_method(:expand_archive))
-    assert_true(Tar::External.instance_method(:extract) == Tar::External.instance_method(:expand_archive))
-    assert_true(Tar::External.instance_method(:expand) == Tar::External.instance_method(:expand_archive))
-  end
-
-  def test_extract_archive_advanced
-    omit_unless(RbConfig::CONFIG['host_os'] =~ /sunos|solaris/){
-      assert_nothing_raised{ @tar.tar_program = @@gtar }
-    }
-    assert_nothing_raised{ @tar.create('*.txt') }
-    assert_raises(Tar::Error){ @tar.expand('blah.txt') }
-
-    assert_nothing_raised{ @tar.extract_archive }
-    assert_nothing_raised{ @tar.extract_archive('temp2.txt') }
-  end
-
-  def teardown
-    @tar = nil
-    File.delete('test.tar') if File.exist?('test.tar')
-    File.delete('test.tar.gz') if File.exist?('test.tar.gz')
-    File.delete('test.tar.bz2') if File.exist?('test.tar.bz2')
-    File.delete('test.tar.zip') if File.exist?('test.tar.zip')
-  end
-
-  def self.shutdown
-    @@tar_foudn   = nil
-    @@gzip_found  = nil
-    @@bzip2_found = nil
-
-    File.delete(@@tmp_file1) if File.exist?(@@tmp_file1)
-    File.delete(@@tmp_file2) if File.exist?(@@tmp_file2)
-    File.delete(@@tmp_file3) if File.exist?(@@tmp_file3)
-  end
-end