ptools 1.1.9 → 1.2.1

data/CHANGES

@@ -1,3 +1,11 @@
+== 1.2.1 - 20-May-2011
+* Added an (empty) .gemtest file so that it can be used with test.rubygems.org.
+* Fixed a sparse file test.
+
+== 1.2.0 - 8-Jan-2011
+* Added the File.sparse? method for Unix platforms. This method already
+  exists on Windows courtesy of the win32-file library.
+
 == 1.1.9 - 25-Mar-2010
 * Refactored File.which and File.whereis and added additional tests for each.
 * Removed the block form of File.whereis.

data/README

@@ -22,6 +22,7 @@
   File.touch("newfile")      # "newfile" now exists
   File.null                  # '/dev/null' on Unix, 'NUL' on Windows
   File.binary?('some_file')  # true or false
+  File.sparse?('some_file')  # true or false
 
   # Creates a copy of 'myfile' called 'newfile', in DOS format
   File.nl_convert("myfile", "newfile", "dos")
@@ -52,7 +53,7 @@
   Artistic 2.0
     
 == Copyright
-  (C) 2003-2010 Daniel J. Berger
+  (C) 2003-2011 Daniel J. Berger
   All Rights Reserved.
     
 == Warranty

data/Rakefile

@@ -1,8 +1,11 @@
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
 include Config
 
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*coverage*")
+
 desc 'Install the ptools package (non-gem)'
 task :install do
    sitelibdir = CONFIG["sitelibdir"]
@@ -12,7 +15,7 @@ end
 
 namespace 'gem' do
   desc 'Create the ptools gem'
-  task :create do
+  task :create => [:clean] do
     Dir["*.gem"].each{ |f| File.delete(f) } # Clean first
     spec = eval(IO.read('ptools.gemspec'))
     Gem::Builder.new(spec).build
@@ -26,11 +29,19 @@ namespace 'gem' do
 end
 
 Rake::TestTask.new do |t|
+  task :test => :clean
   t.verbose = true
   t.warning = true
 end
 
 namespace 'test' do
+  desc "Check test coverage using rcov"
+  task :coverage => [:clean] do
+    require 'rcov'
+    rm_rf 'coverage'
+    sh "rcov -Ilib test/test*.rb" 
+  end
+
   Rake::TestTask.new('binary') do |t|
     t.libs << 'test'
     t.verbose = true
@@ -73,6 +84,13 @@ namespace 'test' do
     t.test_files = FileList['test/test_null.rb']
   end
 
+  Rake::TestTask.new('sparse') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_is_sparse.rb']
+  end
+
   Rake::TestTask.new('tail') do |t|
     t.libs << 'test'
     t.verbose = true
@@ -108,3 +126,5 @@ namespace 'test' do
     t.test_files = FileList['test/test_which.rb']
   end
 end
+
+task :default => :test

data/lib/ptools.rb

@@ -1,17 +1,17 @@
 require 'rbconfig'
 
-if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw/i
+if File::ALT_SEPARATOR
   require 'win32/file'
 end
 
 class File
   # The version of the ptools library.
-  PTOOLS_VERSION = '1.1.9'
+  PTOOLS_VERSION = '1.2.1'
 
   # :stopdoc:
 
   # The WIN32EXTS string is used as part of a Dir[] call in certain methods.
-  if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw/i
+  if File::ALT_SEPARATOR
     MSWINDOWS = true
     if ENV['PATHEXT']
       WIN32EXTS = ('.{' + ENV['PATHEXT'].tr(';', ',').tr('.','') + '}').downcase
@@ -40,7 +40,7 @@ class File
   #    File.image?('somefile.txt') # => true
   #--
   # The approach I used here is based on information found at
-  # http://en.wikipedia.org/wiki/Magic_number_(programming) 
+  # http://en.wikipedia.org/wiki/Magic_number_(programming)
   #
   def self.image?(file)
     bool = IMAGE_EXT.include?(File.extname(file).downcase)      # Match ext
@@ -63,7 +63,7 @@ class File
   #
   def self.null
     case Config::CONFIG['host_os']
-      when /mswin|win32|msdos|cygwin|mingw/i
+      when /mswin|win32|msdos|cygwin|mingw|windows/i
         'NUL'
       when /amiga/i
         'NIL:'
@@ -94,14 +94,14 @@ class File
     s = (File.read(file, File.stat(file).blksize) || "").split(//)
     ((s.size - s.grep(" ".."~").size) / s.size.to_f) > 0.30
   end
-   
+
   # Looks for the first occurrence of +program+ within +path+.
-  # 
+  #
   # On Windows, it looks for executables ending with the suffixes defined
   # in your PATHEXT environment variable, or '.exe', '.bat' and '.com' if
   # that isn't defined, which you may optionally include in +program+.
   #
-  # Returns nil if not found. 
+  # Returns nil if not found.
   #
   # Examples:
   #
@@ -202,41 +202,43 @@ class File
     paths.empty? ? nil : paths.uniq
   end
 
-   # In block form, yields the first +num_lines+ from +filename+.  In non-block
-   # form, returns an Array of +num_lines+
-   #
-   # Examples:
-   #
-   #   # Return an array
-   #   File.head('somefile.txt') # => ['This is line1', 'This is line2', ...]
-   #
-   #   # Use a block
-   #   File.head('somefile.txt'){ |line| puts line }
-   #
-   def self.head(filename, num_lines=10)
-      a = []
-      IO.foreach(filename){ |line|
-         break if num_lines <= 0
-         num_lines -= 1
-         if block_given?
-            yield line
-         else
-            a << line
-         end
-      }
-      return a.empty? ? nil : a # Return nil in block form
-   end
+  # In block form, yields the first +num_lines+ from +filename+.  In non-block
+  # form, returns an Array of +num_lines+
+  #
+  # Examples:
+  #
+  #  # Return an array
+  #  File.head('somefile.txt') # => ['This is line1', 'This is line2', ...]
+  #
+  #  # Use a block
+  #  File.head('somefile.txt'){ |line| puts line }
+  #
+  def self.head(filename, num_lines=10)
+    a = []
 
-   # In block form, yields line +from+ up to line +to+.  In non-block form
-   # returns an Array of lines from +from+ to +to+.
-   #
-   def self.middle(filename, from=10, to=20)
+    IO.foreach(filename){ |line|
+      break if num_lines <= 0
+      num_lines -= 1
       if block_given?
-         IO.readlines(filename)[from-1..to-1].each{ |line| yield line }
+        yield line
       else
-         IO.readlines(filename)[from-1..to-1]
+        a << line
       end
-   end
+    }
+
+    return a.empty? ? nil : a # Return nil in block form
+  end
+
+  # In block form, yields line +from+ up to line +to+.  In non-block form
+  # returns an Array of lines from +from+ to +to+.
+  #
+  def self.middle(filename, from=10, to=20)
+    if block_given?
+      IO.readlines(filename)[from-1..to-1].each{ |line| yield line }
+    else
+      IO.readlines(filename)[from-1..to-1]
+    end
+  end
 
   # In block form, yields the last +num_lines+ of file +filename+.
   # In non-block form, it returns the lines as an array.
@@ -259,68 +261,69 @@ class File
     end
   end
 
-   # Converts a text file from one OS platform format to another, ala
-   # 'dos2unix'. The possible values for +platform+ include:
-   #
-   # * MS Windows -> dos, windows, win32, mswin
-   # * Unix/BSD   -> unix, linux, bsd
-   # * Mac        -> mac, macintosh, apple, osx
-   #
-   # Note that this method is only valid for an ftype of "file".  Otherwise a
-   # TypeError will be raised.  If an invalid format value is received, an
-   # ArgumentError is raised.
-   #
-   def self.nl_convert(old_file, new_file = old_file, platform = 'dos')
-      unless File.file?(old_file)
-         raise ArgumentError, 'Only valid for plain text files'
-      end
+  # Converts a text file from one OS platform format to another, ala
+  # 'dos2unix'. The possible values for +platform+ include:
+  #
+  # * MS Windows -> dos, windows, win32, mswin
+  # * Unix/BSD   -> unix, linux, bsd
+  # * Mac        -> mac, macintosh, apple, osx
+  #
+  # Note that this method is only valid for an ftype of "file".  Otherwise a
+  # TypeError will be raised.  If an invalid format value is received, an
+  # ArgumentError is raised.
+  #
+  def self.nl_convert(old_file, new_file = old_file, platform = 'dos')
+    unless File.file?(old_file)
+      raise ArgumentError, 'Only valid for plain text files'
+    end
 
-      if platform =~ /dos|windows|win32|mswin|cygwin|mingw/i
-         format = "\cM\cJ"
-      elsif platform =~ /unix|linux|bsd/i
-         format = "\cJ"
-      elsif platform =~ /mac|apple|macintosh|osx/i
-         format = "\cM"
-      else
-         raise ArgumentError, "Invalid platform string"
+    if platform =~ /dos|windows|win32|mswin|cygwin|mingw/i
+      format = "\cM\cJ"
+    elsif platform =~ /unix|linux|bsd/i
+      format = "\cJ"
+    elsif platform =~ /mac|apple|macintosh|osx/i
+      format = "\cM"
+    else
+      raise ArgumentError, "Invalid platform string"
+    end
+
+    orig = $\
+    $\ = format
+
+    if old_file == new_file
+      require 'fileutils'
+      require 'tempfile'
+
+      begin
+        temp_name = Time.new.strftime("%Y%m%d%H%M%S")
+        tf = Tempfile.new('ruby_temp_' + temp_name)
+        tf.open
+
+        IO.foreach(old_file){ |line|
+          line.chomp!
+          tf.print line
+        }
+      ensure
+        tf.close if tf && !tf.closed?
       end
 
-      orig = $\
-      $\ = format
-
-      if old_file == new_file
-         require 'fileutils'
-         require 'tempfile'
-
-         begin
-            temp_name = Time.new.strftime("%Y%m%d%H%M%S")
-            tf = Tempfile.new('ruby_temp_' + temp_name)
-            tf.open
-
-            IO.foreach(old_file){ |line|
-               line.chomp!
-               tf.print line
-            }
-         ensure
-            tf.close if tf && !tf.closed?
-         end
-         File.delete(old_file)
-         FileUtils.cp(tf.path, old_file)
-      else
-         begin
-            nf = File.new(new_file, 'w')  
-            IO.foreach(old_file){ |line|
-               line.chomp!
-               nf.print line
-            }
-         ensure
-            nf.close if nf && !nf.closed?
-         end
+      File.delete(old_file)
+      FileUtils.cp(tf.path, old_file)
+    else
+      begin
+        nf = File.new(new_file, 'w')
+        IO.foreach(old_file){ |line|
+          line.chomp!
+          nf.print line
+        }
+      ensure
+        nf.close if nf && !nf.closed?
       end
+    end
 
-      $\ = orig
-      self
-   end
+    $\ = orig
+    self
+  end
 
   # Changes the access and modification time if present, or creates a 0
   # byte file +filename+ if it doesn't already exist.
@@ -350,6 +353,7 @@ class File
     end
 
     n = 0
+
     if option == 'lines'
       IO.foreach(filename){ n += 1 }
       return n
@@ -386,6 +390,24 @@ class File
     end
   end
 
+  class << self
+    # Already provided by win32-file on MS Windows
+    unless respond_to?(:sparse?)
+      # Returns whether or not +file+ is a sparse file.
+      #
+      # A sparse file is a any file where its size is greater than the number
+      # of 512k blocks it consumes, i.e. its apparent and actual file size is
+      # not the same.
+      #
+      # See http://en.wikipedia.org/wiki/Sparse_file for more information.
+      #
+      def sparse?(file)
+        stats = File.stat(file)
+        stats.size > stats.blocks * 512
+      end
+    end
+  end
+
   private
 
   def self.bmp?(file)
@@ -401,6 +423,6 @@ class File
   end
 
   def self.gif?(file)
-     ['GIF89a', 'GIF97a'].include?(IO.read(file, 6))
+    ['GIF89a', 'GIF97a'].include?(IO.read(file, 6))
   end
 end

data/ptools.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |gem|
   gem.name       = 'ptools'
-  gem.version    = '1.1.9'
+  gem.version    = '1.2.1'
   gem.license    = 'Artistic 2.0'
   gem.author     = 'Daniel J. Berger'
   gem.email      = 'djberg96@gmail.com'
@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.summary    = 'Extra methods for the File class'
   gem.test_files = Dir['test/test*']
   gem.has_rdoc   = true
-  gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') || f.include?('git') }
+  gem.files      = Dir['**/*'] << '.gemtest'
 
   gem.rubyforge_project = 'shards'
   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
@@ -24,7 +24,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency('test-unit', '>= 2.0.7')
 
-  if Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i
+  if Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw|windows/i
     gem.platform = Gem::Platform::CURRENT
     gem.add_dependency('win32-file', '>= 0.5.4')
   end

data/test/test_constants.rb

@@ -13,7 +13,7 @@ require 'ptools'
 
 class TC_Constants < Test::Unit::TestCase
    def test_version
-      assert_equal('1.1.9', File::PTOOLS_VERSION)
+      assert_equal('1.2.1', File::PTOOLS_VERSION)
    end
 
    def test_image_ext

data/test/test_is_sparse.rb

@@ -0,0 +1,48 @@
+#####################################################################
+# test_is_sparse.rb
+#
+# Test case for the File.sparse? method. You should run this test
+# via the 'rake test:is_sparse' task.
+#####################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'ptools'
+
+class TC_IsSparse < Test::Unit::TestCase
+  def self.startup
+    Dir.chdir("test") if File.exists?("test")
+    @@win = Config::CONFIG['host_os'] =~ /windows|mswin|dos|cygwin|mingw/i
+    @@osx = Config::CONFIG['host_os'] =~ /darwin|osx/i
+  end
+
+  def setup
+    @sparse_file = '/var/log/lastlog'
+    @non_sparse_file = File.expand_path(File.basename(__FILE__))
+  end
+
+  test "is_sparse basic functionality" do
+    omit_if(@@win, "File.sparse? tests skipped on MS Windows")
+    assert_respond_to(File, :sparse?)
+    assert_nothing_raised{ File.sparse?(@sparse_file) }
+    assert_boolean(File.sparse?(@sparse_file))
+  end
+
+  test "is_sparse returns the expected results" do
+    omit_if(@@win, "File.sparse? tests skipped on MS Windows")
+    omit_if(@@osx, "File.sparse? tests skipped on OS X")
+    assert_true(File.sparse?(@sparse_file))
+    assert_false(File.sparse?(@non_sparse_file))
+  end
+
+  test "is_sparse only accepts one argument" do
+    omit_if(@@win, "File.sparse? tests skipped on MS Windows")
+    assert_raise(ArgumentError){ File.sparse?(@sparse_file, @sparse_file) }
+  end
+
+  def teardown
+    @sparse_file = nil
+    @non_sparse_file = nil
+  end
+end

data/test/test_nlconvert.rb

@@ -11,79 +11,91 @@ require 'test/unit'
 require 'ptools'
 
 class TC_FileNLConvert < Test::Unit::TestCase
-   def self.startup
-      Dir.chdir('test') if File.exists?('test')
-      File.open('test_file1.txt', 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
-      File.open('test_file2.txt', 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
-   end
-   
-   def setup   
-      @test_file1 = 'test_file1.txt'
-      @test_file2 = 'test_file2.txt'
-      @dos_file   = 'dos_test_file.txt'
-      @mac_file   = 'mac_test_file.txt'
-      @unix_file  = 'nix_test_file.txt'
-   end
-
-   def test_nl_convert_basic
-      assert_respond_to(File, :nl_convert)
-      assert_nothing_raised{ File.nl_convert(@test_file2) }
-      assert_nothing_raised{ File.nl_convert(@test_file2, @test_file2) }
-      assert_nothing_raised{ File.nl_convert(@test_file2, @test_file2, "unix") }
-   end
-
-   def test_nl_convert_to_dos
-      msg = "dos file should be larger, but isn't"
-
-      assert_nothing_raised{ File.nl_convert(@test_file1, @dos_file, "dos") }
-      assert_equal(true, File.size(@dos_file) > File.size(@test_file1), msg)
-      assert_equal(["\cM","\cJ"],
-         IO.readlines(@dos_file).first.split("")[-2..-1]
-      )
-   end
-
-   def test_nl_convert_to_mac
-      assert_nothing_raised{ File.nl_convert(@test_file1, @mac_file, 'mac') }
-      assert_equal("\cM", IO.readlines(@mac_file).first.split("").last)
-
-      omit_if(Config::CONFIG['host_os'] =~ /win32|mswin|dos|cygwin|mingw/i)
-      msg = "=> Mac file should be the same size (or larger), but isn't"
-      assert_true(File.size(@mac_file) == File.size(@test_file1), msg)
-   end
-   
-   def test_nl_convert_to_unix
-      msg = "unix file should be the same size (or smaller), but isn't"
-
-      assert_nothing_raised{ File.nl_convert(@test_file1, @unix_file, "unix") }
-      assert_equal("\n", IO.readlines(@unix_file).first.split("").last)
-
-      if File::ALT_SEPARATOR
-         assert_equal(true, File.size(@unix_file) >= File.size(@test_file1),msg)
-      else
-         assert_equal(true, File.size(@unix_file) <= File.size(@test_file1),msg)
-      end
-   end
-   
-   def test_nl_convert_expected_errors
-      assert_raises(ArgumentError){ File.nl_convert }
-      assert_raises(ArgumentError){
-         File.nl_convert(@test_file1, "bogus.txt", "blah")
-      }
-   end
-
-   def teardown
-      [@dos_file, @mac_file, @unix_file].each{ |file|
-         File.delete(file) if File.exists?(file)
-      }
-      @dos_file   = nil
-      @mac_file   = nil
-      @unix_file  = nil
-      @test_file1 = nil
-      @test_file2 = nil
-   end
-
-   def self.shutdown
-      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
-      File.delete('test_file2.txt') if File.exists?('test_file2.txt')
-   end
+  def self.startup
+    Dir.chdir('test') if File.exists?('test')
+    @@test_file1 = 'test_nl_convert1.txt'
+    @@test_file2 = 'test_nl_convert2.txt'
+    File.open(@@test_file1, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
+    File.open(@@test_file2, 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
+  end
+
+  def setup
+    @test_file1 = 'test_nl_convert1.txt'
+    @test_file2 = 'test_nl_convert2.txt'
+    @dos_file   = 'dos_test_file.txt'
+    @mac_file   = 'mac_test_file.txt'
+    @unix_file  = 'nix_test_file.txt'
+  end
+
+  test "nl_convert basic functionality" do
+    assert_respond_to(File, :nl_convert)
+  end
+
+  test "nl_convert accepts one, two or three arguments" do
+    assert_nothing_raised{ File.nl_convert(@test_file2) }
+    assert_nothing_raised{ File.nl_convert(@test_file2, @test_file2) }
+    assert_nothing_raised{ File.nl_convert(@test_file2, @test_file2, "unix") }
+  end
+
+  test "nl_convert with dos platform argument works as expected" do
+    msg = "dos file should be larger, but isn't"
+
+    assert_nothing_raised{ File.nl_convert(@test_file1, @dos_file, "dos") }
+    assert_true(File.size(@dos_file) > File.size(@test_file1), msg)
+    assert_equal(["\cM","\cJ"], IO.readlines(@dos_file).first.split("")[-2..-1])
+  end
+
+  test "nl_convert with mac platform argument works as expected" do
+    assert_nothing_raised{ File.nl_convert(@test_file1, @mac_file, 'mac') }
+    assert_equal("\cM", IO.readlines(@mac_file).first.split("").last)
+
+    omit_if(File::ALT_SEPARATOR)
+    msg = "=> Mac file should be the same size (or larger), but isn't"
+    assert_true(File.size(@mac_file) == File.size(@test_file1), msg)
+  end
+
+  test "nl_convert with unix platform argument works as expected" do
+    msg = "unix file should be the same size (or smaller), but isn't"
+
+    assert_nothing_raised{ File.nl_convert(@test_file1, @unix_file, "unix") }
+    assert_equal("\n", IO.readlines(@unix_file).first.split("").last)
+
+    if File::ALT_SEPARATOR
+      assert_true(File.size(@unix_file) >= File.size(@test_file1), msg)
+    else
+      assert_true(File.size(@unix_file) <= File.size(@test_file1), msg)
+    end
+  end
+
+  test "nl_convert requires at least one argument" do
+    assert_raise(ArgumentError){ File.nl_convert }
+  end
+
+  test "nl_convert requires a valid platform string" do
+    assert_raise(ArgumentError){ File.nl_convert(@test_file1, "bogus.txt", "blah") }
+  end
+
+  test "nl_convert accepts a maximum of three arguments" do
+    assert_raise(ArgumentError){ File.nl_convert(@test_file1, @test_file2, 'dos', 1) }
+  end
+
+  test "nl_convert will fail on anything but plain files" do
+    assert_raise(ArgumentError){ File.nl_convert(File.null_device, @test_file1) }
+  end
+
+  def teardown
+    [@dos_file, @mac_file, @unix_file].each{ |file|
+      File.delete(file) if File.exists?(file)
+    }
+    @dos_file   = nil
+    @mac_file   = nil
+    @unix_file  = nil
+    @test_file1 = nil
+    @test_file2 = nil
+  end
+
+  def self.shutdown
+    File.delete(@@test_file1) if File.exists?(@@test_file1)
+    File.delete(@@test_file2) if File.exists?(@@test_file2)
+  end
 end

data/test/test_null.rb

@@ -4,34 +4,37 @@
 # Test case for the File.null method. You should run this test via
 # the 'rake test_null' task.
 #####################################################################
+require 'rubygems'
+gem 'test-unit'
+
 require 'test/unit'
 require 'ptools'
 
-class TC_Null < Test::Unit::TestCase
-   def setup
-      @nulls = ['/dev/null', 'NUL', 'NIL:', 'NL:']
-   end
+class TC_FileNull < Test::Unit::TestCase
+  def setup
+    @nulls = ['/dev/null', 'NUL', 'NIL:', 'NL:']
+  end
 
-   def test_null_basic
-      assert_respond_to(File, :null)
-      assert_nothing_raised{ File.null }
-   end
+  test "null method basic functionality" do
+    assert_respond_to(File, :null)
+    assert_nothing_raised{ File.null }
+  end
 
-   def test_null_expected_results
-      assert_kind_of(String, File.null)
-      assert(@nulls.include?(File.null))
-   end
+  test "null method returns expected results" do
+    assert_kind_of(String, File.null)
+    assert(@nulls.include?(File.null))
+  end
 
-   def test_null_expected_errors
-      assert_raises(ArgumentError){ File.null(1) }
-   end
+  test "null method does not accept any arguments" do
+    assert_raises(ArgumentError){ File.null(1) }
+  end
 
-   def test_null_device_alias
-      assert_respond_to(File, :null_device)
-      assert_equal(true, File.method(:null) == File.method(:null_device))
-   end
+  test "null_device is an alias for null" do
+    assert_respond_to(File, :null_device)
+    assert_alias_method(File, :null_device, :null)
+  end
 
-   def teardown
-      @nulls = nil
-   end
+  def teardown
+    @nulls = nil
+  end
 end

data/test/test_wc.rb

@@ -4,47 +4,73 @@
 # Test case for the File.wc method. This test should be run via
 # the 'rake test_wc' task.
 #####################################################################
+require 'rubygems'
+gem 'test-unit'
+
 require 'test/unit'
 require 'ptools'
 
 class TC_FileWC < Test::Unit::TestCase
-   def self.startup
-      Dir.chdir('test') if File.exists?('test')      
-      File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
-   end
+  def self.startup
+    Dir.chdir('test') if File.exists?('test')      
+    File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
+    @@test_file = 'test_file1.txt'
+  end
    
-   def setup     
-      @test_file = 'test_file1.txt'
-   end
-
-   def test_wc_basic
-      assert_respond_to(File, :wc)
-      assert_nothing_raised{ File.wc(@test_file) }
-      assert_nothing_raised{ File.wc(@test_file, 'bytes') }
-      assert_nothing_raised{ File.wc(@test_file, 'chars') }
-      assert_nothing_raised{ File.wc(@test_file, 'words') }
-      assert_nothing_raised{ File.wc(@test_file, 'LINES') }
-   end
-
-   def test_wc_results
-      assert_kind_of(Array, File.wc(@test_file))
-      assert_equal([166,166,25,25], File.wc(@test_file))
-      assert_equal(166, File.wc(@test_file,'bytes'), "Wrong number of bytes")
-      assert_equal(166, File.wc(@test_file,'chars'), "Wrong number of chars")
-      assert_equal(25,  File.wc(@test_file,'words'), "Wrong number of words")
-      assert_equal(25,  File.wc(@test_file,'lines'), "Wrong number of lines")
-   end
-
-   def test_wc_expected_errors
-      assert_raises(ArgumentError){ File.wc }
-      assert_raises(ArgumentError){ File.wc(@test_file, "bogus") }
-   end
-
-   def teardown
-      @test_file = nil
-   end
-
-   def self.shutdown
-      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
-   end
+  def setup     
+    @test_file = 'test_file1.txt'
+  end
+
+  test "wc method basic functionality" do
+    assert_respond_to(File, :wc)
+    assert_nothing_raised{ File.wc(@test_file) }
+  end
+
+  test "wc accepts specific optional arguments" do
+    assert_nothing_raised{ File.wc(@test_file, 'bytes') }
+    assert_nothing_raised{ File.wc(@test_file, 'chars') }
+    assert_nothing_raised{ File.wc(@test_file, 'words') }
+    assert_nothing_raised{ File.wc(@test_file, 'lines') }
+  end
+
+  test "argument to wc ignores the case of the option argument" do
+    assert_nothing_raised{ File.wc(@test_file, 'LINES') }
+  end
+
+  test "wc with no option returns expected results" do
+    assert_kind_of(Array, File.wc(@test_file))
+    assert_equal([166,166,25,25], File.wc(@test_file))
+  end
+
+  test "wc with bytes option returns the expected result" do
+    assert_equal(166, File.wc(@test_file, 'bytes'), "Wrong number of bytes")
+  end
+
+  test "wc with chars option returns the expected result" do
+    assert_equal(166, File.wc(@test_file, 'chars'), "Wrong number of chars")
+  end
+
+  test "wc with words option returns the expected result" do
+    assert_equal(25, File.wc(@test_file, 'words'), "Wrong number of words")
+  end
+
+  test "wc with lines option returns the expected result" do
+    assert_equal(25, File.wc(@test_file, 'lines'), "Wrong number of lines")
+  end
+
+  test "wc requires at least on argument" do
+    assert_raises(ArgumentError){ File.wc }
+  end
+
+  test "an invalid option raises an error" do
+    assert_raises(ArgumentError){ File.wc(@test_file, 'bogus') }
+  end
+
+  def teardown
+    @test_file = nil
+  end
+
+  def self.shutdown
+    File.delete(@@test_file) if File.exists?(@@test_file)
+  end
 end

data/test/test_whereis.rb

@@ -14,10 +14,11 @@ include Config
 class TC_FileWhereis < Test::Unit::TestCase
   def self.startup
     @@windows = Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i
+    @@ruby = RUBY_PLATFORM == 'java' ? 'jruby' : 'ruby'
   end
 
   def setup
-    @expected_locs = [File.join(CONFIG['bindir'], 'ruby')]
+    @expected_locs = [File.join(CONFIG['bindir'], @@ruby)]
 
     if @@windows
       @expected_locs[0] << '.exe'
@@ -25,10 +26,10 @@ class TC_FileWhereis < Test::Unit::TestCase
     end
       
     unless @@windows
-      @expected_locs << '/usr/local/bin/ruby'
-      @expected_locs << '/opt/sfw/bin/ruby'
-      @expected_locs << '/opt/bin/ruby'
-      @expected_locs << '/usr/bin/ruby'
+      @expected_locs << "/usr/local/bin/#{@@ruby}"
+      @expected_locs << "/opt/sfw/bin/#{@@ruby}"
+      @expected_locs << "/opt/bin/#{@@ruby}"
+      @expected_locs << "/usr/bin/#{@@ruby}"
     end
 
     @actual_locs = nil
@@ -45,7 +46,7 @@ class TC_FileWhereis < Test::Unit::TestCase
   end
 
   test "whereis returns expected values" do
-    assert_nothing_raised{ @actual_locs = File.whereis('ruby') }
+    assert_nothing_raised{ @actual_locs = File.whereis(@@ruby) }
     assert_kind_of(Array, @actual_locs)
     assert_true((@expected_locs & @actual_locs).size > 0)
   end
@@ -55,19 +56,19 @@ class TC_FileWhereis < Test::Unit::TestCase
   end
 
   test "whereis returns nil if program cannot be found in provided path" do
-    assert_nil(File.whereis('ruby', '/foo/bar'))
+    assert_nil(File.whereis(@@ruby, '/foo/bar'))
   end
 
   test "whereis returns single element array or nil if absolute path is provided" do
-    absolute = File.join(CONFIG['bindir'], 'ruby')
+    absolute = File.join(CONFIG['bindir'], @@ruby)
     absolute << '.exe' if @@windows
     assert_equal([absolute], File.whereis(absolute))
-    assert_nil(File.whereis('/foo/bar/baz/ruby'))
+    assert_nil(File.whereis("/foo/bar/baz/#{@@ruby}"))
   end
 
   test "whereis works with an explicit extension on ms windows" do
     omit_unless(@@windows, 'test skipped except on MS Windows')
-    assert_not_nil(File.whereis('ruby.exe'))
+    assert_not_nil(File.whereis(@@ruby + '.exe'))
   end
 
   test "whereis requires at least one argument" do
@@ -75,16 +76,16 @@ class TC_FileWhereis < Test::Unit::TestCase
   end
 
   test "whereis returns unique paths only" do
-    assert_true(File.whereis('ruby') == File.whereis('ruby').uniq)
+    assert_true(File.whereis(@@ruby) == File.whereis(@@ruby).uniq)
   end
 
   test "whereis accepts a maximum of two arguments" do
-    assert_raise(ArgumentError){ File.whereis('ruby', 'foo', 'bar') }
+    assert_raise(ArgumentError){ File.whereis(@@ruby, 'foo', 'bar') }
   end
 
   test "the second argument to whereis cannot be nil or empty" do
-    assert_raise(ArgumentError){ File.whereis('ruby', nil) }
-    assert_raise(ArgumentError){ File.whereis('ruby', '') }
+    assert_raise(ArgumentError){ File.whereis(@@ruby, nil) }
+    assert_raise(ArgumentError){ File.whereis(@@ruby, '') }
   end
 
   def teardown

data/test/test_which.rb

@@ -14,7 +14,6 @@ require 'test/unit'
 require 'rbconfig'
 require 'fileutils'
 require 'ptools'
-include Config
 
 class TC_FileWhich < Test::Unit::TestCase
   def self.startup
@@ -30,7 +29,9 @@ class TC_FileWhich < Test::Unit::TestCase
 
   def setup
     @ruby = RUBY_PLATFORM.match('java') ? 'jruby' : 'ruby'
-    @exe = File.join(CONFIG['bindir'], CONFIG['ruby_install_name']) 
+    @ruby = 'rbx' if defined?(Rubinius)
+
+    @exe = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
 
     if @@windows
       @exe.tr!('/','\\')
@@ -38,7 +39,7 @@ class TC_FileWhich < Test::Unit::TestCase
     end
   end
 
-  test "which basic functionality" do
+  test "which method basic functionality" do
     assert_respond_to(File, :which)
     assert_nothing_raised{ File.which(@ruby) }
     assert_kind_of(String, File.which(@ruby))
@@ -66,7 +67,7 @@ class TC_FileWhich < Test::Unit::TestCase
   end
 
   test "which returns argument if an existent absolute path is provided" do
-    assert_equal(@exe, File.which(@ruby))
+    assert_equal(@exe, File.which(@ruby), "=> May fail on a symlink")
   end
 
   test "which returns nil if a non-existent absolute path is provided" do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ptools
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 29
+  prerelease: 
   segments: 
   - 1
+  - 2
   - 1
-  - 9
-  version: 1.1.9
+  version: 1.2.1
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-25 00:00:00 -06:00
+date: 2011-05-20 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 2
         - 0
@@ -42,24 +45,26 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files: 
-- CHANGES
-- lib/ptools.rb
-- MANIFEST
-- ptools.gemspec
 - Rakefile
 - README
-- test/test_binary.rb
-- test/test_constants.rb
-- test/test_head.rb
-- test/test_image.rb
+- ptools.gemspec
+- lib/ptools.rb
+- CHANGES
+- test/test_whereis.rb
 - test/test_middle.rb
+- test/test_binary.rb
 - test/test_nlconvert.rb
-- test/test_null.rb
-- test/test_tail.rb
 - test/test_touch.rb
-- test/test_wc.rb
-- test/test_whereis.rb
 - test/test_which.rb
+- test/test_null.rb
+- test/test_head.rb
+- test/test_is_sparse.rb
+- test/test_wc.rb
+- test/test_image.rb
+- test/test_constants.rb
+- test/test_tail.rb
+- MANIFEST
+- .gemtest
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
 licenses: 
@@ -70,36 +75,41 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   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 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: shards
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Extra methods for the File class
 test_files: 
-- test/test_binary.rb
-- test/test_constants.rb
-- test/test_head.rb
-- test/test_image.rb
+- test/test_whereis.rb
 - test/test_middle.rb
+- test/test_binary.rb
 - test/test_nlconvert.rb
-- test/test_null.rb
-- test/test_tail.rb
 - test/test_touch.rb
-- test/test_wc.rb
-- test/test_whereis.rb
 - test/test_which.rb
+- test/test_null.rb
+- test/test_head.rb
+- test/test_is_sparse.rb
+- test/test_wc.rb
+- test/test_image.rb
+- test/test_constants.rb
+- test/test_tail.rb