archive-tar-external 1.3.1 → 1.4.2

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,102 +1,136 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: archive-tar-external
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
-  segments: 
-  - 1
-  - 3
-  - 1
-  version: 1.3.1
+version: !ruby/object:Gem::Version
+  version: 1.4.2
 platform: ruby
-authors: 
+authors:
 - Daniel Berger
-autorequire: 
+autorequire:
 bindir: bin
-cert_chain: []
-
-date: 2011-09-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: test-unit
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+  -----END CERTIFICATE-----
+date: 2021-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ptools
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :development
-  version_requirements: *id002
-description: "    The archive-tar-external is a simple wrapper interface for creating\n    tar files using your system's tar command. You can also easily compress\n    your tar files with your system's compression programs such as zip, gzip,\n    or bzip2.\n"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
+      your tar files with your system's compression programs such as zip, gzip,
+      or bzip2.
 email: djberg96@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-- CHANGES
-- MANIFEST
-- doc/tar_external.txt
-files: 
+extra_rdoc_files: []
+files:
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
+- Rakefile
 - archive-tar-external.gemspec
-- CHANGES
-- doc/tar_external.txt
+- certs/djberg96_pub.pem
+- doc/archive_tar_external.md
+- lib/archive-tar-external.rb
 - lib/archive/tar/external.rb
-- MANIFEST
-- Rakefile
-- README
-- test/test_archive_tar_external.rb
-homepage: http://www.rubyforge.org/shards
-licenses: 
-- Artistic 2.0
-post_install_message: 
+- 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/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
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: shards
-rubygems_version: 1.8.10
-signing_key: 
-specification_version: 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
+test_files:
+- spec/archive_tar_external_spec.rb
+- spec/spec_helper.rb