archive-tar-external 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b20d6fa4e2827a0326f31b43997f3191a1c35ac268d5de485689bb0b0ab59c0
-  data.tar.gz: 4a4938677d58c08044547d5fb3bc7a71e669d1ffe11db0c1ba47cff35aecd70a
+  metadata.gz: 990b9b955f7f127b7e2cc3b74fc35116af8ea287fa24113a94c4027c76d859ba
+  data.tar.gz: 92b196efe6a52ddbc04dc5602cf0c1318cf5d1d0ac081e9701aa470046825e0b
 SHA512:
-  metadata.gz: 703b000865ccddd8a1c54cbbebf47a4e2a6790964c1b9ef68663b5779dd286e8923b2dfe98d2b89a9161af457aadd588e1372a4ce9d49b7f7fa44110f094ec8e
-  data.tar.gz: 0f72ea731fd952a4474eb553a789a4a78a8d79a41f6ad6c597a2328f948981251295dab4abb6bdabeac9770a85aa1fab6466f174c311e7c330fd3391bcb73aaa
+  metadata.gz: 804c66f9312a14ff9a413eecef0ad30adb77f0400c63667747c6a4e9a9a3ddaf99efc9381a5f72e44d34df89a2f95f6565605debfea1ea400f1e8976f1945f73
+  data.tar.gz: b2930a7e498792a701a81991475707642d228acab91a6faeb74ea1104c0a2bcbaf23625c9dd5c5ab7b0e56e2678e242e574b4e665b89cad586f8acb59a127ac2

data/CHANGES.md

@@ -1,4 +1,8 @@
-## 1.4.2 - 1-May-2021
+## 1.5.0 - 1-May-2021
+* A fourth option was added to the constructor. This allows you to set the
+  archive format. By default this is now set to 'pax'.
+
+## 1.4.2 - 30-Apr-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.

data/README.md

@@ -29,8 +29,11 @@ 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.
+option properly by default, and will add a file to the archive even if
+the timestamp of the file hasn't changed.
+
+The OSX issue was effectively addressed in version 1.5.0, where the default
+archive format was added and set to 'pax'.
 
 If you come across any other issues, please report them on the project
 page at https://github.com/djberg96/archive-tar-external.

data/archive-tar-external.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'archive-tar-external'
-  spec.version    = '1.4.2'
+  spec.version    = '1.5.0'
   spec.summary    = 'A simple way to create tar archives using external calls'
   spec.license    = 'Apache-2.0'
   spec.author     = 'Daniel Berger'

data/lib/archive/tar/external.rb

@@ -17,32 +17,40 @@ module Archive
     # This class encapsulates tar & zip operations.
     class Tar::External
       # The version of the archive-tar-external library.
-      VERSION = '1.4.2'
+      VERSION = '1.5.0'
 
       # The name of the archive file to be used, e.g. "test.tar"
       attr_accessor :archive_name
 
-      # The name of the tar program you wish to use.  The default is "tar".
+      # The name of the tar program you wish to use. The default is "tar".
       attr_accessor :tar_program
 
       # The name of the archive file after compression, e.g. "test.tar.gz"
       attr_reader :compressed_archive_name
 
-      # Returns an Archive::Tar::External object.  The +archive_name+ is the
-      # name of the tarball.  While a .tar extension is recommended based on
+      # The format of the archive file. The default is "pax".
+      attr_reader :format
+
+      # Returns an Archive::Tar::External object. The +archive_name+ is the
+      # name of the tarball. While a .tar extension is recommended based on
       # years of convention, it is not enforced.
       #
       # Note that this does not actually create the archive unless you
-      # pass a value to +file_pattern+.  This then becomes a shortcut for
+      # pass a value to +file_pattern+. This then becomes a shortcut for
       # Archive::Tar::External.new + Archive::Tar::External#create_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)
+      # You may also specify an archive format. As of version 1.5, the
+      # default is 'pax'. Previous versions used whatever your tar program
+      # used by default.
+      #
+      def initialize(archive_name, file_pattern = nil, program = nil, format = 'pax')
         @archive_name            = archive_name.to_s
         @compressed_archive_name = nil
         @tar_program             = 'tar'
+        @format                  = 'pax'
 
         create_archive(file_pattern) if file_pattern
         compress_archive(program) if program
@@ -67,12 +75,13 @@ module Archive
       end
 
       # Creates the archive using +file_pattern+ using +options+ or 'cf'
-      # (create file) by default.
+      # (create file) by default. The 'f' option should always be present
+      # and always be last.
       #
       # Raises an Archive::Tar::Error if a failure occurs.
       #
       def create_archive(file_pattern, options = 'cf')
-        cmd = "#{@tar_program} #{options} #{@archive_name} #{file_pattern}"
+        cmd = "#{@tar_program} --format #{@format} -#{options} #{@archive_name} #{file_pattern}"
 
         Open3.popen3(cmd) do |_tar_in, _tar_out, tar_err|
           err = tar_err.gets

data/spec/archive_tar_external_spec.rb

@@ -15,20 +15,18 @@ RSpec.describe Archive::Tar::External do
   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' }
+  let(:tar_program)  { '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 eq('1.5.0')
     expect(Archive::Tar::External::VERSION).to be_frozen
   end
 
@@ -102,13 +100,18 @@ RSpec.describe Archive::Tar::External do
     end
 
     example "create_archive accepts optional parameters" do
-      expect{ tar_obj.create_archive(pattern, 'cfj') }.not_to raise_error
+      expect{ tar_obj.create_archive(pattern, 'jcf') }.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
+
+    example "format getter" do
+      expect(tar_obj).to respond_to(:format)
+      expect(tar_obj.format).to eq('pax')
+    end
   end
 
   context "compression" do
@@ -185,7 +188,7 @@ RSpec.describe Archive::Tar::External do
       expect(tar_obj).to respond_to(:update_archive)
     end
 
-    example "update_archive behaves as expected", :gtar => true do
+    example "update_archive behaves as expected" 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)

data/spec/spec_helper.rb

@@ -3,5 +3,4 @@ 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.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -132,5 +132,5 @@ signing_key:
 specification_version: 4
 summary: A simple way to create tar archives using external calls
 test_files:
-- spec/archive_tar_external_spec.rb
 - spec/spec_helper.rb
+- spec/archive_tar_external_spec.rb