archive-tar-external 1.2.3 → 1.3.0

data/CHANGES

@@ -1,87 +1,94 @@
-== 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
-* 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.
-* Several gemspec updates, including an updated description, the addition
-  of a license and development dependencies and refactored platform handling.
-* Added test-unit and ptools as development dependencies for the test suite.
-* Some refactoring of the test suite to take advantage of some of the features
-  in test-unit 2.x.
-* Renamed the test file to test_archive_tar_external.rb.
-
-== 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
-* Project renamed 'archive-tar-external'.
-* The 'Tar' class is now Tar::External.
-* The RAA project name is now tar-external.
-* Added the Tar::External.uncompress_archive class method for archives
-  that already exist.
-* Added the Tar::External.extract_archive class method for tarballs
-  that already exist.
-* Added the Tar::External#compressed_archive_name= method.
-
-== 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
-* 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
-* Moved project to RubyForge.
-* Modified the constructor to accept a file pattern.  If present, becomes
-  a shortcut for Tar.new + Tar#create_archive.
-* Constructor merely calls .to_s on the archive name, rather than validating
-  that it's a String argument.
-* You can now specify the tar program you wish to use, e.g. "tar", "gtar", etc.
-* Fixed a bug in Tar#uncompress_archive where it wasn't finding the appropriate
-  compressed archive name.
-* Added aliases for most methods whereby you can omit the word "archive" in
-  the method name now, e.g. Tar#compress is an alias for Tar#compress_archive.
-* Now more polite about closing open handles from Open3.
-* The (rdoc) documentation is now inlined.
-* Removed the tarsimple.rd and tarsimple.html files.
-* Made most documentation rdoc friendly.
-* Updated the README and MANIFEST files.
-* Removed the INSTALL file.  The installation instructions are now included
-  in the README file.
-* Test suite updates.
-* Added a gemspec.
-
-== 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
-  either method name.
-* The extract_archive() method now accepts a list of file names as
-  an argument.  If present, then only those file names are extracted.
-  If not, then the entire archive is extracted.
-* Added corresponding tests and documentation updates.
-
-== 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
-  "CompressError", respectively.
-* Moved rd documentation into its own file under the 'doc' directory.
-* Added unit tests and updated the docs.
-* Removed the html file.  You can generate that on your own if you
-  wish using the rd2 tool.
-* Added warranty information.
-
-== 0.1.0 - 24-Jan-2003
-* Initial Release
+== 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
+* 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
+* 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.
+* Several gemspec updates, including an updated description, the addition
+  of a license and development dependencies and refactored platform handling.
+* Added test-unit and ptools as development dependencies for the test suite.
+* Some refactoring of the test suite to take advantage of some of the features
+  in test-unit 2.x.
+* Renamed the test file to test_archive_tar_external.rb.
+
+== 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
+* Project renamed 'archive-tar-external'.
+* The 'Tar' class is now Tar::External.
+* The RAA project name is now tar-external.
+* Added the Tar::External.uncompress_archive class method for archives
+  that already exist.
+* Added the Tar::External.extract_archive class method for tarballs
+  that already exist.
+* Added the Tar::External#compressed_archive_name= method.
+
+== 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
+* 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
+* Moved project to RubyForge.
+* Modified the constructor to accept a file pattern.  If present, becomes
+  a shortcut for Tar.new + Tar#create_archive.
+* Constructor merely calls .to_s on the archive name, rather than validating
+  that it's a String argument.
+* You can now specify the tar program you wish to use, e.g. "tar", "gtar", etc.
+* Fixed a bug in Tar#uncompress_archive where it wasn't finding the appropriate
+  compressed archive name.
+* Added aliases for most methods whereby you can omit the word "archive" in
+  the method name now, e.g. Tar#compress is an alias for Tar#compress_archive.
+* Now more polite about closing open handles from Open3.
+* The (rdoc) documentation is now inlined.
+* Removed the tarsimple.rd and tarsimple.html files.
+* Made most documentation rdoc friendly.
+* Updated the README and MANIFEST files.
+* Removed the INSTALL file.  The installation instructions are now included
+  in the README file.
+* Test suite updates.
+* Added a gemspec.
+
+== 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
+  either method name.
+* The extract_archive() method now accepts a list of file names as
+  an argument.  If present, then only those file names are extracted.
+  If not, then the entire archive is extracted.
+* Added corresponding tests and documentation updates.
+
+== 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
+  "CompressError", respectively.
+* Moved rd documentation into its own file under the 'doc' directory.
+* Added unit tests and updated the docs.
+* Removed the html file.  You can generate that on your own if you
+  wish using the rd2 tool.
+* Added warranty information.
+
+== 0.1.0 - 24-Jan-2003
+* Initial Release

data/MANIFEST

@@ -1,8 +1,8 @@
-* MANIFEST
-* CHANGES
-* INSTALL
-* Rakefile
-* archive-tar-external.gemspec
-* doc/tar_external.txt
-* lib/archive/tar_external.rb
+* MANIFEST
+* CHANGES
+* INSTALL
+* Rakefile
+* archive-tar-external.gemspec
+* doc/tar_external.txt
+* lib/archive/tar_external.rb
 * test/test_archive_tar_external.rb

data/README

@@ -1,29 +1,47 @@
-== Description
-   A very simple tar/compress package that uses calls to external programs
-   to do the work.
-   
-== 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
-   Ruby 1.8.0 or later.
-   The win32-open3 package (MS Windows only).
-   The "tar" command line program.
-   At least one compression program, e.g. gzip, bzip2, zip, etc.
-   
-== Installation
-   rake test (optional)
-   rake install (non-gem) or rake install_gem (gem)
-   
-== Notes
-   For further documentation and information, see the tar_external.txt file
-   in the 'doc' directory.
+== 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 win32-open3 library (MS Windows only).
+  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 http://www.rubyforge.org/projects/shards.
+
+== Future Plans
+  Anything folks are looking for?
+
+== License
+  Artistic 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 - 2010 Daniel J. Berger
+  All Rights Reserved
+
+== Author
+  Daniel J. Berger

data/Rakefile

@@ -1,26 +1,26 @@
-require 'rake'
-require 'rake/testtask'
-
-desc "Install the archive-tar-external library (non-gem)"
-task :install do
-   dest = File.join(Config::CONFIG['sitelibdir'], 'archive')
-   Dir.mkdir(dest) unless File.exists? dest
-   cp 'lib/archive/tar_external.rb', dest, :verbose => true
-end
-
-desc 'Build the archive-tar-external gem'
-task :gem do
-   spec = eval(IO.read('archive-tar-external.gemspec'))
-   Gem::Builder.new(spec).build
-end
-
-desc 'Install the archive-tar-external library as a gem'
-task :install_gem => [:gem] do
-   file = Dir["*.gem"].first
-   sh "gem install #{file}"
-end
-
-Rake::TestTask.new do |t|
-   t.warning = true
-   t.verbose = true
-end
+require 'rake'
+require 'rake/testtask'
+
+desc "Install the archive-tar-external library (non-gem)"
+task :install do
+   dest = File.join(Config::CONFIG['sitelibdir'], 'archive')
+   Dir.mkdir(dest) unless File.exists? dest
+   cp 'lib/archive/tar_external.rb', dest, :verbose => true
+end
+
+desc 'Build the archive-tar-external gem'
+task :gem do
+   spec = eval(IO.read('archive-tar-external.gemspec'))
+   Gem::Builder.new(spec).build
+end
+
+desc 'Install the archive-tar-external library as a gem'
+task :install_gem => [:gem] do
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+Rake::TestTask.new do |t|
+   t.warning = true
+   t.verbose = true
+end

data/archive-tar-external.gemspec

@@ -1,40 +1,40 @@
-require 'rubygems'
-require 'rbconfig'
-
- Gem::Specification.new do |s|
-   s.name      = 'archive-tar-external'
-   s.version   = '1.2.3'
-   s.summary   = 'A simple way to create tar archives using external calls'
-   s.license   = 'Artistic 2.0'
-   s.author    = 'Daniel Berger'
-   s.email     = 'djberg96@gmail.com'
-   s.homepage  = 'http://www.rubyforge.org/shards'
-   s.test_file = 'test/test_archive_tar_external.rb'
-   s.has_rdoc  = true
-   s.files     = Dir['**/*'].reject{ |f| f.include?('CVS') }
-
-   s.rubyforge_project = 'shards'
-
-   s.extra_rdoc_files = [
-      'README',
-      'CHANGES',
-      'MANIFEST',
-      'doc/tar_external.txt'
-   ]
-
-   s.description = <<-EOF
-      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.
-   EOF
-
-   s.add_development_dependency('test-unit', '>= 2.0.3')
-   s.add_development_dependency('ptools', '>= 1.1.7')
-
-   if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw|win32/i
-      if RUBY_VERSION.to_f < 1.9 && RUBY_PLATFORM !~ /java/i
-         s.add_dependency('win32-open3', '>= 0.3.1')
-      end
-   end
-end
+require 'rubygems'
+require 'rbconfig'
+
+Gem::Specification.new do |spec|
+  spec.name      = 'archive-tar-external'
+  spec.version   = '1.3.0'
+  spec.summary   = 'A simple way to create tar archives using external calls'
+  spec.license   = 'Artistic 2.0'
+  spec.author    = 'Daniel Berger'
+  spec.email     = 'djberg96@gmail.com'
+  spec.homepage  = 'http://www.rubyforge.org/shards'
+  spec.test_file = 'test/test_archive_tar_external.rb'
+  spec.has_rdoc  = true
+  spec.files     = Dir['**/*'].reject{ |f| f.include?('git') }
+
+  spec.rubyforge_project = 'shards'
+
+  spec.extra_rdoc_files = [
+    'README',
+    'CHANGES',
+    'MANIFEST',
+    'doc/tar_external.txt'
+  ]
+
+  spec.description = <<-EOF
+    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.
+  EOF
+
+  spec.add_development_dependency('test-unit', '>= 2.0.3')
+  spec.add_development_dependency('ptools', '>= 1.1.7')
+
+  if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw|win32/i
+    if RUBY_VERSION.to_f < 1.9 && RUBY_PLATFORM !~ /java/i
+      spec.add_dependency('win32-open3', '>= 0.3.1')
+    end
+  end
+end

data/doc/tar_external.txt

@@ -1,136 +1,109 @@
-== 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)
-   Creates a new tarball, including those files which match 'file_pattern'.
-
-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.
-
-== 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 http://www.rubyforge.org/projects/shards.
-
-== Future Plans
-   Anything folks are looking for?
-
-== License
-   Artistic 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 - 2009 Daniel J. Berger
-   All Rights Reserved
-
-== Author
-   Daniel J. Berger
-   djberg96 at gmail dot com
-   imperator on IRC (freenode)
+== 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)
+   Creates a new tarball, including those files which match 'file_pattern'.
+
+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.