archive-tar-external 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e57f18722a9e513fc516a16e98dd6afbff23ebac953c8b2e100ae3525e8857f3
-  data.tar.gz: a6d6c232c28e1fecaeba4c96ba8ccc93aa9c25f1449f9f8707a6e9ece1526d0e
+  metadata.gz: 8262389cae7e15791e59508564874601c91d9693d1151aaac72a3a52403ce666
+  data.tar.gz: 26c49206d0cc4bbc653353c900425331b9b59ba0a448c6acd4283b43001db9f9
 SHA512:
-  metadata.gz: 0d4b25808000f06553d1fd57bd3b612dc4ed673434480b1f11d8871772b68d163851740f434a6a6c120a9e2a07becd4632d40dbfc6e154cbd9d717dff3aedfea
-  data.tar.gz: e2292e0e11919e725f2ebccc8cf16e76a82a8bc99befe58e63a06e99edfc9539defcb5f796d624e7fdf3d144bfa1ca2cc494f26130c96cd2a03aa0f8774e958e
+  metadata.gz: 2ecea7018db1ab2621966fa41d514c94d92d1b0b98fb1b60b9be337b3f4c650e1c310f4c4874167cc1a0d243c3cd5be858c99699a35e9d0f15df4246e8902e8c
+  data.tar.gz: b2ca702a9caeb6a6f76c5a32bb85615ce04b3587eb75675593612f439eeb43f74a4d29746ff8fc74c76423cd341e8867ed4c8d882bf45aef0ac457a108dbe58c

data/{CHANGES → CHANGES.md}

@@ -1,40 +1,43 @@
-== 1.4.0 - 23-Jan-2019
+## 1.4.1 - 19-Feb-2021
+* Switched from rdoc to markdown.
+
+## 1.4.0 - 23-Jan-2019
 * Changed license to Apache-2.0.
 * The VERSION constant is now frozen.
 * Added some metadata to the gemspec.
 * Cert updated, should be good for about 10 years.
 
-== 1.3.3 - 16-Jan-2016
+## 1.3.3 - 16-Jan-2016
 * This gem is now signed.
 * Fixed some deprecation warnings in the test suite.
 * Added an archive-tar-external.rb file for convenience.
 * Updates to the Rakefile.
 
-== 1.3.2 - 14-Mar-2014
+## 1.3.2 - 14-Mar-2014
 * The create_archive method now accepts an optional second argument that
   specifies options to the tar command. The default is 'cf' (create file).
 * The gem:create task was updated for Rubygems 2.x.
 * Added rake as a development dependency.
 * Ruby 1.8.x support has been dropped. This only matters for MS Windows.
 
-== 1.3.1 - 20-Sep-2011
+## 1.3.1 - 20-Sep-2011
 * Refactored the Rakefile a bit.
 
-== 1.3.0 - 16-Jan-2010
+## 1.3.0 - 16-Jan-2010
 * Altered the source code layout, which requires a change in your require
   line. It's now require 'archive/tar/external'.
 * Moved some content from the .txt file to the README.
 * Updated one test to use a skip as needed.
 * Moved source code to github.
 
-== 1.2.3 - 25-Sep-2009
+## 1.2.3 - 25-Sep-2009
 * Fixed a packaging bug.
 * Added cygwin and mingw to Windows checks.
 * Now requires open3 properly for Ruby 1.9 on Windows.
 * Minor modifications to the gemspec.
 * Added the 'gem' rake task.
 
-== 1.2.2 - 28-Jul-2009
+## 1.2.2 - 28-Jul-2009
 * Compatibility fixes for Ruby 1.9.x and JRuby.
 * Singleton methods that were previously synonyms are now true aliases.
 * License changed to Artistic 2.0.
@@ -45,13 +48,13 @@
   in test-unit 2.x.
 * Renamed the test file to test_archive_tar_external.rb.
 
-== 1.2.1 - 30-Jul-2007
+## 1.2.1 - 30-Jul-2007
 * The TarError class is now Tar::Error.
 * Added a Rakefile with tasks for installation and testing.
 * Removed the install.rb file. Installation is now handled by the Rakefile.
 * Documentation updates.
 
-== 1.2.0 - 7-Apr-2006
+## 1.2.0 - 7-Apr-2006
 * Project renamed 'archive-tar-external'.
 * The 'Tar' class is now Tar::External.
 * The RAA project name is now tar-external.
@@ -61,16 +64,16 @@
   that already exist.
 * Added the Tar::External#compressed_archive_name= method.
 
-== 1.1.1 - 1-Mar-2006
+## 1.1.1 - 1-Mar-2006
 * Replaced PLATFORM with RUBY_PLATFORM since the former is deprecated
   for Ruby 1.9/2.0.
 
-== 1.1.0 - 10-Feb-2006
+## 1.1.0 - 10-Feb-2006
 * Internal refactoring changes - now uses block form of Open3.popen3.
 * Most methods now return self instead of true (better for chaining).
 * Corresponding test suite changes.
 
-== 1.0.0 - 1-Sep-2005
+## 1.0.0 - 1-Sep-2005
 * Moved project to RubyForge.
 * Modified the constructor to accept a file pattern.  If present, becomes
   a shortcut for Tar.new + Tar#create_archive.
@@ -91,7 +94,7 @@
 * Test suite updates.
 * Added a gemspec.
 
-== 0.3.0 - 10-Aug-2004
+## 0.3.0 - 10-Aug-2004
 * Added the update_archive() method.
 * The expand_archive() method has been renamed to extract_archive().
   For backward's compatability, an alias remains so you may use
@@ -101,7 +104,7 @@
   If not, then the entire archive is extracted.
 * Added corresponding tests and documentation updates.
 
-== 0.2.0 - 9-Aug-2004
+## 0.2.0 - 9-Aug-2004
 * Added the add_to_archive() method.
 * Removed the VERSION() class method. Use the constant instead.
 * Changed "TarException" and "CompressionException" to "TarError" and
@@ -112,5 +115,5 @@
   wish using the rd2 tool.
 * Added warranty information.
 
-== 0.1.0 - 24-Jan-2003
+## 0.1.0 - 24-Jan-2003
 * Initial Release

data/{MANIFEST → MANIFEST.md}

@@ -1,10 +1,10 @@
-* MANIFEST
-* CHANGES
-* INSTALL
+* CHANGES.md
+* MANIFEST.md
+* README.md
 * Rakefile
 * archive-tar-external.gemspec
 * certs/djberg96_pub.pem
-* doc/tar_external.txt
+* doc/tar_external.md
 * lib/archive-tar-external.rb
 * lib/archive/tar_external.rb
 * test/test_archive_tar_external.rb

data/README.md

@@ -0,0 +1,49 @@
+## Description
+A simple tar & compress library that nicely wraps external system calls.
+
+## Installation
+`gem install archive-tar-external`
+   
+## Synopsis
+```ruby
+require 'archive/tar/external' # or 'archive-tar-external'
+   
+# Create an archive of all files with an ".rb" extension, the long way.
+t = Archive::Tar::External.new('test.tar')
+t.create_archive('*.rb')
+t.compress_archive('gzip')
+   
+# Same, but the short way.
+t = Archive::Tar::External.new('test.tar', '*.rb', 'gzip')
+```
+
+## Prerequisites
+* The 'tar' command line program.
+* At least one compression program, e.g. gzip, bzip2, zip, etc.
+   
+## Known Issues
+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.
+
+If you come across any other issues, please report them on the project
+page at https://github.com/djberg96/archive-tar-external.
+
+## History
+This project was originally named "archive-tarsimple", but was renamed
+on April 7, 2006. Versions of this gem prior to that date are no longer
+available.
+
+## License
+Apache-2.0
+
+## Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+## Copyright
+(C) 2003 - 2021 Daniel J. Berger
+All Rights Reserved
+
+## Author
+Daniel J. Berger

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.0'
+  spec.version    = '1.4.1'
   spec.summary    = 'A simple way to create tar archives using external calls'
   spec.license    = 'Apache-2.0'
   spec.author     = 'Daniel Berger'
@@ -13,13 +13,6 @@ Gem::Specification.new do |spec|
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files = [
-    'README',
-    'CHANGES',
-    'MANIFEST',
-    'doc/tar_external.txt'
-  ]
-
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/archive-tar-external',
     'bug_tracker_uri'   => 'https://github.com/djberg96/archive-tar-external/issues',

data/doc/archive_tar_external.md

@@ -0,0 +1,134 @@
+## Description
+A simple tar interface using external system calls.
+
+## Synopsis
+```ruby
+# Assuming we have three .txt files, t1.txt, t2.txt, t3.txt ...
+require 'archive/tar/external'
+include Archive
+
+t = Tar::External.new("myfile.tar")
+ 
+t.create_archive("*.txt")
+t.compress_archive("bzip2") # 'myfile.tar.bz2' now exists
+
+t.uncompress_archive("bunzip2")
+
+t.archive_name # "myfile.tar"
+t.archive_info # ["t1.txt","t2.txt","t3.txt"]
+
+t.add_to_archive("t4.txt","t5.txt")
+t.expand_archive
+```
+
+## Constants
+`VERSION`- The current version number of this library. This is a string.
+
+## Singleton Methods
+`.new(archive_name, pattern=nil, program=nil)`
+
+Creates an instance of 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.
+   
+If `pattern` is provided, then the `create_archive` method is called internally.
+   
+If `program` is provided, then the `compress_archive` method is called internally.
+
+Note that `archive_name` name must be a string, or a `TypeError` is raised.
+
+`.expand_archive(archive_name, file1 [, file2, ...])`
+
+Identical to the instance method of the same name, except that you must
+specify the `archive_name`, and the tar program is hard coded to `tar xf`.
+
+`.uncompress_archive(archive_name, program='gunzip')`
+
+Identical to the instance method of the same name, except that you must
+specify the +archive_name+ as the first argument.
+
+## Instance Methods
+```
+#add(file1 [, file2, ...])
+#add_to_archive(file1 [, file2, ...])
+```
+
+Adds a list of files to the current archive. At least one file must be
+provided or an `Archive::Tar::Error` is raised.
+
+```
+#archive_info
+#info
+```
+
+Returns an array of file names that are included within the tarball.
+
+`#archive_name`
+
+Returns the current archive name.
+
+`#archive_name=`
+
+Sets the current archive name.
+
+```
+#compress(program="gzip")
+#compress_archive(program="gzip")
+```
+
+Compresses the tarball using the program you pass to this method. The default is "gzip".
+
+Note that any arguments you want to be passed along with the program can simply
+be included as part of the program, e.g. "gzip -f".
+
+```
+#create(file_pattern)
+#create_archive(file_pattern, options = 'cf')
+```
+
+Creates a new tarball, including those files which match `file_pattern`
+using `options`, which are set to 'cf' (create file) by default.
+
+```
+#expand_archive(files=nil)
+#extract_archive(files=nil)
+```
+
+Expands the contents of the tarball. Note that this method does NOT delete the tarball.
+
+If file names are provided, then only those files are extracted.
+
+`#tar_program`
+
+Returns the name of the tar program used. The default is "tar".
+
+`#tar_program=(program_name)`
+
+Sets the name of the tar program to be used.
+
+```
+#uncompress(program="gunzip")
+#uncompress_archive(program="gunzip")
+```
+
+Uncompresses the tarball using the program you pass to this method. The default is "gunzip".
+
+Like the `compress_archive` method, you can pass arguments along as part of the method call.
+
+```
+#update(files)
+#update_archive(files)
+```
+
+Updates the given `files` in the archive, i.e they are added if they
+are not already in the archive or have been modified.
+
+## Exceptions
+`Archive::Tar::Error`
+
+Raised if something goes wrong during the execution of any methods that
+use the tar command internally.
+
+`Archive::Tar::CompressError`
+
+Raised if something goes wrong during the `compress_archive` or `uncompress_archive` methods.

data/lib/archive/tar/external.rb

@@ -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.0'.freeze
+      VERSION = '1.4.1'.freeze
 
       # The name of the archive file to be used, e.g. "test.tar"
       attr_accessor :archive_name

data/test/test_archive_tar_external.rb

@@ -35,7 +35,7 @@ class TC_ArchiveTarExternal < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('1.4.0', Tar::External::VERSION)
+    assert_equal('1.4.1', Tar::External::VERSION)
     assert_true(Tar::External::VERSION.frozen?)
   end
 

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: archive-tar-external
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Daniel Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+date:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -87,28 +87,24 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
-- doc/tar_external.txt
+extra_rdoc_files: []
 files:
-- CHANGES
-- test
-- test/test_archive_tar_external.rb
-- archive-tar-external.gemspec
-- doc
-- doc/tar_external.txt
-- README
 - Rakefile
-- MANIFEST
+- certs
+- certs/djberg96_pub.pem
 - lib
+- lib/archive-tar-external.rb
 - lib/archive
 - lib/archive/tar
 - lib/archive/tar/external.rb
-- lib/archive-tar-external.rb
-- certs
-- certs/djberg96_pub.pem
+- test
+- test/test_archive_tar_external.rb
+- CHANGES.md
+- MANIFEST.md
+- README.md
+- archive-tar-external.gemspec
+- doc
+- doc/archive_tar_external.md
 homepage: http://github.com/djberg96/archive-tar-external
 licenses:
 - Apache-2.0
@@ -119,7 +115,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +130,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A simple way to create tar archives using external calls
 test_files:

data/README

@@ -1,48 +0,0 @@
-== Description
-  A simple tar & compress library that nicely wraps external system calls.
-
-== Installation
-  gem install archive-tar-external
-   
-== Synopsis
-  require 'archive/tar/external'
-  include Archive
-   
-  # The long way
-  t = Tar::External.new('test.tar')
-  t.create_archive('*.rb')
-  t.compress_archive('gzip')
-   
-  # The short way
-  t = Tar::External.new('test.tar', '*.rb', 'gzip')
-
-== Prerequisites
-  The 'tar' command line program.
-  At least one compression program, e.g. gzip, bzip2, zip, etc.
-   
-== Known Issues
-  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.
-
-  If you come across any other issues, please report them on the project
-  page at https://github.com/djberg96/archive-tar-external.
-
-== History
-  This project was originally named "archive-tarsimple", but was renamed
-  on April 7, 2006. Versions of this gem prior to that date are no longer
-  available.
-
-== License
-  Apache-2.0
-
-== Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-
-== Copyright
-  (C) 2003 - 2019 Daniel J. Berger
-  All Rights Reserved
-
-== Author
-  Daniel J. Berger

data/doc/tar_external.txt

@@ -1,110 +0,0 @@
-== Description
-  A simple tar interface using external system calls.
-
-== Synopsis
-  # Assuming we have three .txt files, t1.txt, t2.txt, t3.txt ...
-  require 'archive/tar/external'
-  include Archive
-
-  t = Tar::External.new("myfile.tar")
- 
-  t.create_archive("*.txt")
-  t.compress_archive("bzip2") # 'myfile.tar.bz2' now exists
-
-  t.uncompress_archive("bunzip2")
-
-  t.archive_name # "myfile.tar"
-  t.archive_info # ["t1.txt","t2.txt","t3.txt"]
-
-  t.add_to_archive("t4.txt","t5.txt")
-  t.expand_archive
-
-== Constants
-VERSION
-  Current version number of this library. This is a string.
-
-== Class Methods
-Archive::Tar::External.new(archive_name, pattern=nil, program=nil)
-   Creates an instance of 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.
-   
-   If +pattern+ is provided, then the Archive#create_archive method is called
-   internally.
-   
-   If +program+ is provided, then the Archive#compress_archive method is
-   called internally.
-
-   Note that +archive_name+ name must be a String, or a TypeError is raised.
-
-Archive::Tar::External.expand_archive(archive_name, *files)
-   Identical to the instance method of the same name, except that you must
-   specify the +archive_name+, and the tar program is hard coded to 'tar xf'.
-
-Archive::Tar::External.uncompress_archive(archive_name, program='gunzip')
-   Identical to the instance method of the same name, except that you must
-   specify the +archive_name+ as the first argument.
-
-== Instance Methods
-Archive;:Tar#add(file1 [, file2, ...])
-Archive::Tar::External#add_to_archive(file1 [, file2, ...])
-   Adds a list of files to the current archive.  At least one file must be
-   provided or a Tar::Error is raised.
-
-Archive::Tar::External#archive_info
-Archive::Tar::External#info
-   Returns an array of file names that are included within the tarball.
-
-Archive::Tar::External#archive_name
-   Returns the current archive name.
-
-Archive::Tar::External#archive_name=
-   Sets the current archive name.
-
-Archive::Tar::External#compress(program="gzip")
-Archive::Tar::External#compress_archive(program="gzip")
-   Compresses the tarball using the program you pass to this method. The
-   default is "gzip".
-
-   Note that any arguments you want to be passed along with the program can
-   simply be included as part of the program, e.g. "gzip -f".
-
-Archive::Tar::External#create(file_pattern)
-Archive::Tar::External#create_archive(file_pattern, options = 'cf')
-   Creates a new tarball, including those files which match 'file_pattern'
-   using 'options', which are set to 'cf' (create file) by default.
-
-Archive::Tar::External#expand_archive(files=nil)
-Archive::Tar::External#extract_archive(files=nil)
-   Expands the contents of the tarball. Note that this method does NOT delete
-   the tarball.
-
-   If file names are provided, then only those files are extracted.
-
-Archive::Tar::External#tar_program
-   Returns the name of the tar program used.  The default is "tar".
-
-Archive::Tar::External#tar_program=(program_name)
-   Sets the name of the tar program to be used.
-
-Archive::Tar::External#uncompress(program="gunzip")
-Archive::Tar::External#uncompress_archive(program="gunzip")
-   Uncompresses the tarball using the program you pass to this method.  The
-   default is "gunzip".
-
-   As for compress_archive(), you can pass arguments along as part of the
-   argument.
-
-Archive::Tar::External#update(files)
-Archive::Tar::External#update_archive(files)
-   Updates the given +files+ in the archive, i.e they are added if they
-   are not already in the archive or have been modified.
-
-== Exceptions
-Tar::Error
-   Raised if something goes wrong during the execution of any methods that
-   use the tar command internally.
-
-Tar::CompressError
-   Raised if something goes wrong during the Tar#compress_archive or
-   Tar#uncompress_archive methods.