archive-tar-external 1.2.0

data/CHANGES

@@ -0,0 +1,63 @@
+== 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/README

@@ -0,0 +1,34 @@
+== 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 (Windows only).
+   The "tar" command line program.
+   At least one compression program, e.g. gzip, bzip2, zip, etc.
+   
+== Installation
+=== Standard Installation
+   ruby test/tc_archive.rb (optional)
+   ruby install.rb
+
+=== Gem Installation
+   ruby archive-tar-external.gemspec
+   gem install archive-tar-external-XXX.gem
+   
+== Notes
+   For further documentation and information, see the tar_external.txt file
+   in the 'doc' directory.

data/doc/tar_external.txt

@@ -0,0 +1,136 @@
+== 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 package.  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 TarError 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
+TarError
+   Raised if something goes wrong during the execution of any methods that
+   use the tar command internally.
+
+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
+   Ruby's
+
+== 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 - 2006 Daniel J. Berger
+   All Rights Reserved
+
+== Author
+   Daniel J. Berger
+   djberg96 at gmail dot com
+   imperator on IRC (freenode)

data/lib/archive/tar_external.rb

@@ -0,0 +1,277 @@
+if RUBY_PLATFORM.match("mswin")
+   require "win32/open3"
+else
+   require "open3"
+end
+
+module Archive
+
+   class TarError < StandardError; end
+   class CompressError < StandardError; end
+   class Tar; end # Dummy, so our nesting/scoping works properly.
+
+   class Tar::External
+      VERSION = '1.2.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".
+      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
+      # 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
+      # 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)
+         @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
+      end
+
+      # Assign a compressed archive name.  This autogenerates the archive_name
+      # based on the extension of the name provided, unless you provide the
+      # extension yourself.  If the extension is '.tgz', then the base of the
+      # name + '.tar' will be the new archive name.
+      #
+      # This should only be used if you have a pre-existing, compressed 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))
+         if ext == '.tgz' || ext == '.TGZ'
+            @archive_name = File.basename(name, ext.downcase) + '.tar'
+         else
+            @archive_name = File.basename(name, ext)
+         end
+         @compressed_archive_name = name
+      end
+
+      # Creates the archive using +file_pattern+.  Any errors that occur
+      # here will raise a TarError.
+      #
+      def create_archive(file_pattern)
+         cmd = "#{@tar_program} cf #{@archive_name} #{file_pattern}"
+         Open3.popen3(cmd){ |tar_in, tar_out, tar_err|
+            err = tar_err.gets
+            if err
+               raise TarError, err.chomp
+            end
+         }
+         self
+      end
+      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
+      # them as part of the program name, e.g. "gzip -f".
+      #
+      # Any errors that occur here will raise a CompressError.
+      #
+      def compress_archive(program="gzip")
+         cmd = "#{program} #{@archive_name}"
+         Open3.popen3(cmd){ |prog_in, prog_out, prog_err|
+            err = prog_err.gets 
+            if err
+               raise CompressError, err.chomp
+            end
+
+            # Find the new file name with the extension.  There's probably a more
+            # 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
+         }
+         self
+      end
+      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
+      # arguments along as part of the argument.
+      #
+      # Note that this is only for use with archives that have been zipped up
+      # with gunzip, or whatever.  If you want to *extract* the files from the
+      # tarball, use Tar::External#extract instead.
+      #
+      # Any errors that occur here will raise a CompressError.
+      #
+      def uncompress_archive(program="gunzip")
+         unless @compressed_archive_name
+            raise CompressError, "no compressed file found"
+         end
+            
+         cmd = "#{program} #{@compressed_archive_name}"
+
+         Open3.popen3(cmd){ |prog_in, prog_out, prog_err|
+            err = prog_err.gets
+            if err
+               raise CompressError, err.chomp
+            end
+            @compressed_archive_name = nil
+         }
+         self
+      end
+      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')
+         cmd = "#{program} #{archive}"
+
+         Open3.popen3(cmd){ |prog_in, prog_out, prog_err|
+            err = prog_err.gets
+            if err
+               raise CompressError, err.chomp
+            end
+         }
+      end
+
+      # An alias for Tar::External.uncompress_archive.
+      #
+      def self.uncompress(file, program='gunzip')
+         self.uncompress_archive(file, program)
+      end
+
+      # Returns an array of file names that are included within the tarball.
+      # This method does not extract the archive.
+      #
+      def archive_info
+         result = []
+         cmd = "#{@tar_program} tf #{@archive_name}"
+         Open3.popen3(cmd){ |ain, aout, aerr|
+            err = aerr.gets
+            if err
+               raise TarError, err.chomp
+            end
+
+            while output = aout.gets
+               result << output.chomp
+            end
+         }
+         result
+      end
+      alias :info :archive_info
+
+      # Adds +files+ to an already existing archive.
+      #
+      def add_to_archive(*files)
+         if files.empty?
+            raise TarError, "there must be at least one file specified"
+         end
+
+         cmd = "#{@tar_program} rf #{@archive_name} #{files.join(" ")}"
+         Open3.popen3(cmd){ |ain, aout, aerr|
+            err = aerr.gets
+
+            if err
+               raise TarError, err.chomp
+            end
+         }
+         self
+      end
+      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 TarError, "there must be at least one file specified"
+         end
+
+         cmd = "#{@tar_program} uf #{@archive_name} #{files.join(" ")}"
+
+         Open3.popen3(cmd){ |ain, aout, aerr|
+            err = aerr.gets
+            if err
+               raise TarError, err.chomp
+            end
+         }
+         self
+      end
+      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.
+      # Otherwise, all files are extracted.
+      #
+      # Note that some tar programs, notably the tar program shipped by Sun,
+      # does not issue any sort of warning or error if you try to extract a
+      # file that does not exist in the archive.
+      #
+      def extract_archive(*files)
+         cmd = "#{@tar_program} xf #{@archive_name}"
+
+         unless files.empty?
+            cmd << " " << files.join(" ")
+         end
+
+         Open3.popen3(cmd){ |ain, aout, aerr|
+            err = aerr.gets
+
+            if err
+               raise TarError, err.chomp
+            end
+         }
+         self
+      end
+      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
+      # argument.  Also, the tar program is hard coded to 'tar xf'.
+      #
+      def self.extract_archive(archive, *files)
+         cmd = "tar xf #{archive}"
+
+         unless files.empty?
+            cmd << " " << files.join(" ")
+         end
+
+         Open3.popen3(cmd){ |ain, aout, aerr|
+            err = aerr.gets
+
+            if err
+               raise TarError, err.chomp
+            end
+         }
+         self
+      end
+
+      # Alias for self.extract_archive
+      def self.expand_archive(*args)
+         self.extract_archive(*args)
+      end
+
+      # Alias for self.extract_archive
+      def self.extract(*args)
+         self.extract_archive(*args)
+      end
+
+      # Alias for self.extract_archive
+      def self.expand(*args)
+         self.extract_archive(*args)
+      end
+   end
+end

data/test/tc_archive.rb

@@ -0,0 +1,158 @@
+###############################################################################
+# tc_archive.rb
+#
+# Test suite for the archive-tarsimple package.
+###############################################################################
+base = File.basename(Dir.pwd)
+if base == 'test' || base =~ /archive-tar-external/i
+   Dir.chdir('..') if base == 'test'
+   $LOAD_PATH.unshift(Dir.pwd + '/lib')
+   Dir.chdir('test') rescue nil
+end
+
+require 'archive/tar_external'
+require 'test/unit'
+include Archive
+
+class TC_Archive < Test::Unit::TestCase
+   def setup
+      @t        = Tar::External.new('test.tar')
+      @tar_name = 'test.tar'
+      @pattern  = '*.txt'
+      @archive  = 'temp.tar.gz'
+   end
+
+   def test_version
+      assert_equal('1.2.0', Tar::External::VERSION)
+   end
+
+   def test_constructor
+      assert_nothing_raised{ Tar::External.new(@tar_name) }
+      assert_nothing_raised{ Tar::External.new(@tar_name, '*.txt') }
+      assert_raises(ArgumentError){ Tar::External.new }
+   end
+
+   def test_tar_program
+      assert_respond_to(@t, :tar_program)
+      assert_equal('tar', @t.tar_program)
+   end
+
+   def test_archive_name
+      assert_respond_to(@t, :archive_name)
+      assert_respond_to(@t, :archive_name=)
+
+      assert_equal('test.tar', @t.archive_name)
+      assert_nothing_raised{ @t.archive_name }
+      assert_nothing_raised{ @t.archive_name = 'foo' }
+   end
+
+   def test_compressed_archive_name_get
+      assert_respond_to(@t, :compressed_archive_name)
+      assert_nil(@t.compressed_archive_name)
+   end
+
+   def test_compressed_archive_name_set
+      assert_respond_to(@t, :compressed_archive_name=)
+      assert_nothing_raised{ @t.compressed_archive_name = 'test.tar.gz' }
+      assert_equal('test.tar.gz', @t.compressed_archive_name)
+      assert_equal('test.tar', @t.archive_name)
+
+      assert_nothing_raised{ @t.compressed_archive_name = 'test.tgz' }
+      assert_equal('test.tgz', @t.compressed_archive_name)
+      assert_equal('test.tar', @t.archive_name)
+   end
+
+   def test_create_archive_basic
+      assert_respond_to(@t, :create_archive)
+      assert_respond_to(@t, :create) # Alias
+
+      assert_raises(ArgumentError){ @t.create_archive }
+      assert_raises(TarError){ @t.create_archive('*.blah') }
+
+      assert_nothing_raised{ @t.create_archive(@pattern) }
+      assert(@t.create_archive(@pattern))
+      assert(File.exists?(@tar_name))
+   end
+
+   def test_compress_archive_basic
+      assert_respond_to(@t, :compress_archive)
+      assert_respond_to(@t, :compress) # Alias
+   end
+
+   def test_compress_archive_gzip
+      assert_nothing_raised{ @t.create_archive('*.txt') }
+      assert_nothing_raised{ @t.compress_archive }
+
+      assert_equal('test.tar.gz', @t.compressed_archive_name)
+      assert(File.exists?('test.tar.gz'))
+   end
+
+   def test_compress_archive_bzip2
+      assert_nothing_raised{ @t.create_archive('*.txt') }
+      assert_nothing_raised{ @t.compress_archive('bzip2') }
+      assert(File.exists?('test.tar.bz2'))
+   end
+
+   def test_uncompress_archive
+      assert_respond_to(@t, :uncompress_archive)
+      assert_nothing_raised{ @t.create_archive('*.txt') }
+      assert_nothing_raised{ @t.compress_archive }
+      assert_nothing_raised{ @t.uncompress_archive }
+      assert(!File.exists?('test.tar.gz'))
+   end
+
+   def test_uncompress_archive_class_method
+      assert_respond_to(Tar::External, :uncompress_archive)
+      assert_respond_to(Tar::External, :uncompress)
+   end
+
+   def test_archive_info
+      assert_respond_to(@t, :archive_info)
+      assert_nothing_raised{ @t.create_archive('*.txt') }
+      assert_equal(['temp1.txt','temp2.txt','temp3.txt'], @t.archive_info)
+   end
+
+   def test_add_to_archive
+      assert_respond_to(@t,:add_to_archive)
+      assert_nothing_raised{ @t.create_archive('temp1.txt') }
+      assert_nothing_raised{ @t.add_to_archive('temp2.txt') }
+      assert_nothing_raised{ @t.add_to_archive('temp2.txt','temp3.txt') }
+   end
+
+   def test_update_archive
+      assert_respond_to(@t, :update_archive)
+      assert_nothing_raised{ @t.create_archive('*.txt') }
+      assert_nothing_raised{ @t.update_archive('temp2.txt') }
+   end
+
+   def test_extract_archive_basic
+      assert_respond_to(@t, :extract_archive)
+      assert_respond_to(@t, :expand_archive) # Alias
+      assert_respond_to(@t, :extract)        # Alias
+      assert_respond_to(@t, :expand)         # Alias
+   end
+
+   def test_extract_archive_advanced
+      @t.tar_program = 'gtar' if PLATFORM.match('solaris')
+      assert_nothing_raised{ @t.create('*.txt') }
+      assert_raises(TarError){ @t.expand('blah.txt') }
+
+      assert_nothing_raised{ @t.extract_archive }
+      assert_nothing_raised{ @t.extract_archive('temp2.txt') }
+   end
+
+   def test_extract_archive_class_method
+      assert_respond_to(Tar::External, :extract_archive)
+      assert_respond_to(Tar::External, :expand_archive)
+      assert_respond_to(Tar::External, :extract)
+      assert_respond_to(Tar::External, :expand)
+   end
+
+   def teardown
+      @t = nil
+      File.unlink('test.tar') if File.exists?('test.tar')
+      File.unlink('test.tar.gz') if File.exists?('test.tar.gz')
+      File.unlink('test.tar.bz2') if File.exists?('test.tar.bz2')
+      File.unlink('test.tar.zip') if File.exists?('test.tar.zip')
+   end
+end

data/test/temp1.txt

@@ -0,0 +1 @@
+This is a temporary text file

data/test/temp2.txt

@@ -0,0 +1,4 @@
+This is a temporary text file
+It is only used for testing
+It is only used for testing
+Feel free to delete these later

data/test/temp3.txt

@@ -0,0 +1,3 @@
+This is a temporary text file
+It is only used for testing
+Feel free to delete these later

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: archive-tar-external
+version: !ruby/object:Gem::Version 
+  version: 1.2.0
+date: 2006-04-07 00:00:00 -06:00
+summary: A simple way to create tar archives using external calls
+require_paths: 
+- lib
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/shards
+rubyforge_project: 
+description: A simple way to create tar archives using external calls
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Daniel Berger
+files: 
+- doc/tar_external.txt
+- lib/archive
+- lib/archive/tar_external.rb
+- test/tc_archive.rb
+- test/temp1.txt
+- test/temp2.txt
+- test/temp3.txt
+- README
+- CHANGES
+test_files: 
+- test/tc_archive.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+