archive-tar-external 1.2.2 → 1.2.3

data/CHANGES

@@ -1,3 +1,10 @@
+== 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.

data/MANIFEST

@@ -5,7 +5,4 @@
 * archive-tar-external.gemspec
 * doc/tar_external.txt
 * lib/archive/tar_external.rb
-* test/tc_archive.rb
-* test/temp1.txt
-* test/temp2.txt
-* test/temp3.txt
+* test/test_archive_tar_external.rb

data/Rakefile

@@ -0,0 +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

data/archive-tar-external.gemspec

@@ -0,0 +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

data/lib/archive/tar_external.rb

@@ -0,0 +1,303 @@
+require 'rbconfig'
+
+if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw/i
+   if RUBY_VERSION.to_f < 1.9 && RUBY_PLATFORM !~ /java/i
+      require 'win32/open3'
+   else
+      require 'open3'
+   end
+else
+   require 'open3'
+end
+
+# The Archive module serves as a namespace only.
+module Archive
+
+   # The Tar class serves as a toplevel class namespace only.
+   class Tar
+
+      # Raised if something goes wrong during the execution of any methods
+      # which use the tar command internally.
+      class Error < StandardError; end
+
+      # Raised if something goes wrong during the Tar#compress_archive or
+      # Tar#uncompress_archive methods.      
+      class CompressError < StandardError; end
+
+      # This class encapsulates tar & zip operations.
+      class Tar::External
+         # The version of the archive-tar-external library.
+         VERSION = '1.2.3'
+
+         # 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.downcase == '.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 Error.
+         #
+         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 Error, 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 Tar::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 Tar::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
+
+         class << self
+            alias uncompress uncompress_archive
+         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 Error, 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 Error, "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 Error, 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 Error, "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 Error, 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 Error, 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 Error, err.chomp
+               end
+            }
+
+            self
+         end
+
+         class << self
+            alias expand_archive extract_archive
+            alias extract extract_archive
+            alias expand extract_archive
+         end
+      end
+   end
+end

data/test/test_archive_tar_external.rb

@@ -38,7 +38,7 @@ class TC_ArchiveTarExternal < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.2.2', Tar::External::VERSION)
+      assert_equal('1.2.3', Tar::External::VERSION)
    end
 
    def test_constructor

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: archive-tar-external
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors: 
 - Daniel Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-28 00:00:00 -06:00
+date: 2009-09-25 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,11 +44,14 @@ extra_rdoc_files:
 - MANIFEST
 - doc/tar_external.txt
 files: 
-- doc/tar_external.txt
-- test/test_archive_tar_external.rb
-- README
+- archive-tar-external.gemspec
 - CHANGES
+- doc/tar_external.txt
+- lib/archive/tar_external.rb
 - MANIFEST
+- Rakefile
+- README
+- test/test_archive_tar_external.rb
 has_rdoc: true
 homepage: http://www.rubyforge.org/shards
 licenses: