ptools 1.1.7 → 1.1.9

data/ptools.gemspec

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rbconfig'
+
+Gem::Specification.new do |gem|
+  gem.name       = 'ptools'
+  gem.version    = '1.1.9'
+  gem.license    = 'Artistic 2.0'
+  gem.author     = 'Daniel J. Berger'
+  gem.email      = 'djberg96@gmail.com'
+  gem.homepage   = 'http://www.rubyforge.org/projects/shards'
+  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.rubyforge_project = 'shards'
+  gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+
+  gem.description = <<-EOF
+    The ptools (power tools) library provides several handy methods to
+    Ruby's core File class, such as File.which for finding executables,
+    File.null to return the null device on your platform, and so on.
+  EOF
+
+  gem.add_development_dependency('test-unit', '>= 2.0.7')
+
+  if Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i
+    gem.platform = Gem::Platform::CURRENT
+    gem.add_dependency('win32-file', '>= 0.5.4')
+  end
+end

data/test/test_binary.rb

@@ -12,7 +12,8 @@ require 'ptools'
 
 class TC_Binary < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'      
+      Dir.chdir('test') if File.exists?('test')
+      File.open('test_file1.txt', 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
    end
    
    def setup
@@ -29,10 +30,14 @@ class TC_Binary < Test::Unit::TestCase
    end
 
    def test_binary_expected_errors
-      assert_raises(Errno::ENOENT, ArgumentError){ File.binary?('bogus') }
+      assert_raise_kind_of(SystemCallError){ File.binary?('bogus') }
    end
 
    def teardown
       @text_file = nil
    end
+
+   def self.shutdown
+      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
+   end
 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.7', File::PTOOLS_VERSION)
+      assert_equal('1.1.9', File::PTOOLS_VERSION)
    end
 
    def test_image_ext

data/test/test_head.rb

@@ -12,10 +12,11 @@ require 'ptools'
 
 class TC_FileHead < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'    
+      Dir.chdir('test') if File.exists?('test')
+      File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
    end
    
-   def setup  
+   def setup
       @test_file = 'test_file1.txt'
       @expected_head1 = ["line1\n","line2\n","line3\n","line4\n","line5\n"]
       @expected_head1.push("line6\n","line7\n","line8\n","line9\n","line10\n")
@@ -43,4 +44,8 @@ class TC_FileHead < Test::Unit::TestCase
    def teardown
       @test_file = nil
    end
+
+   def self.shutdown
+      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
+   end
 end

data/test/test_image.rb

@@ -12,7 +12,8 @@ require 'ptools'
 
 class TC_Ptools_Image < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'      
+      Dir.chdir('test') if File.exists?('test')
+      File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
    end
    
    def setup   
@@ -35,4 +36,8 @@ class TC_Ptools_Image < Test::Unit::TestCase
    def teardown
       @text_file = nil
    end
+
+   def self.shutdown
+      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
+   end
 end

data/test/test_middle.rb

@@ -12,7 +12,8 @@ require 'ptools'
 
 class TC_FileMiddle < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir('test') if File.exists?('test')
+      File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
    end
    
    def setup   

data/test/test_nlconvert.rb

@@ -12,7 +12,9 @@ require 'ptools'
 
 class TC_FileNLConvert < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      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   
@@ -41,15 +43,12 @@ class TC_FileNLConvert < Test::Unit::TestCase
    end
 
    def test_nl_convert_to_mac
-      if Config::CONFIG['host_os'].match("mswin")
-         msg = "** test may fail on MS Windows **" 
-      else
-         msg = "** mac file should be the same size (or larger), but isn't **"
-      end
-
-      assert_nothing_raised{ File.nl_convert(@test_file1, @mac_file, "mac") }
-      assert_equal(true, File.size(@mac_file) == File.size(@test_file1), msg)
+      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
@@ -82,4 +81,9 @@ class TC_FileNLConvert < Test::Unit::TestCase
       @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
 end

data/test/test_null.rb

@@ -26,6 +26,11 @@ class TC_Null < Test::Unit::TestCase
       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
+
    def teardown
       @nulls = nil
    end

data/test/test_tail.rb

@@ -12,7 +12,8 @@ require 'ptools'
 
 class TC_FileTail < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir('test') if File.exists?('test')
+      File.open('test_file1.txt', 'w'){ |fh| 25.times{ |n| fh.puts "line#{n+1}" } }
    end
    
    def setup     
@@ -48,4 +49,8 @@ class TC_FileTail < Test::Unit::TestCase
       @expected_tail1 = nil
       @expected_tail2 = nil
    end
+
+   def self.shutdown
+      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
+   end
 end

data/test/test_touch.rb

@@ -12,7 +12,8 @@ require 'ptools'
 
 class TC_FileTouch < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'      
+      Dir.chdir('test') if File.exists?('test')
+      File.open('test_file1.txt', 'w'){ |fh| 10.times{ |n| fh.puts "line #{n}" } }
    end
    
    def setup   
@@ -47,4 +48,8 @@ class TC_FileTouch < Test::Unit::TestCase
       File.delete(@test_file) if File.exists?(@test_file)
       @test_file = nil
    end
+
+   def self.shutdown
+      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
+   end
 end

data/test/test_wc.rb

@@ -10,6 +10,7 @@ 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 setup     
@@ -42,4 +43,8 @@ class TC_FileWC < Test::Unit::TestCase
    def teardown
       @test_file = nil
    end
+
+   def self.shutdown
+      File.delete('test_file1.txt') if File.exists?('test_file1.txt')
+   end
 end

data/test/test_whereis.rb

@@ -1,8 +1,7 @@
 ######################################################################
 # test_whereis.rb
 #
-# Test case for the File.whereis method. This test should be run
-# via the 'rake test_whereis' task.
+# Tests for the File.whereis method.
 ######################################################################
 require 'rubygems'
 gem 'test-unit'
@@ -13,40 +12,87 @@ require 'rbconfig'
 include Config
 
 class TC_FileWhereis < Test::Unit::TestCase
-   def setup
-      @expected_locs = [CONFIG['bindir']]
+  def self.startup
+    @@windows = Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i
+  end
+
+  def setup
+    @expected_locs = [File.join(CONFIG['bindir'], 'ruby')]
+
+    if @@windows
+      @expected_locs[0] << '.exe'
+      @expected_locs[0].tr!("/", "\\")
+    end
       
-      if Config::CONFIG['host_os'].match('mswin')
-         @expected_locs = ["c:\\ruby\\bin\\ruby.exe"]
-      else
-         @expected_locs << '/usr/local/bin/ruby'
-         @expected_locs << '/opt/sfw/bin/ruby'
-         @expected_locs << '/opt/bin/ruby'
-         @expected_locs << '/usr/bin/ruby'
-      end
-   end
-
-   def test_whereis_basic
-      assert_respond_to(File, :whereis)
-      assert_nothing_raised{ File.whereis("ruby") }
-      assert_nothing_raised{ File.whereis("ruby","/usr/bin:/usr/local/bin") }
-      assert_nothing_raised{ File.whereis("ruby"){} }
-   end
-
-   def test_whereis_expected_return_values
-      msg = "You may need to adjust the setup method if this test failed"
-      locs = File.whereis('ruby').map{ |e| e.downcase }
-      assert_kind_of(Array, locs)
-      assert(@expected_locs.include?(locs.first), msg)
-      assert_equal(nil, File.whereis("blahblah"))
-   end
-
-   def test_whereis_expected_errors
-      assert_raises(ArgumentError){ File.whereis }
-      assert_raises(ArgumentError){ File.whereis("ruby", "foo", "bar") }
-   end
-
-   def teardown
-      @expected_locs = nil
-   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'
+    end
+
+    @actual_locs = nil
+  end
+
+  test "whereis basic functionality" do
+    assert_respond_to(File, :whereis)
+    assert_nothing_raised{ File.whereis('ruby') }
+    assert_kind_of([Array, NilClass], File.whereis('ruby'))
+  end
+
+  test "whereis accepts an optional second argument" do
+    assert_nothing_raised{ File.whereis('ruby', '/usr/bin:/usr/local/bin') }
+  end
+
+  test "whereis returns expected values" do
+    assert_nothing_raised{ @actual_locs = File.whereis('ruby') }
+    assert_kind_of(Array, @actual_locs)
+    assert_true((@expected_locs & @actual_locs).size > 0)
+  end
+
+  test "whereis returns nil if program not found" do
+    assert_nil(File.whereis('xxxyyy'))
+  end
+
+  test "whereis returns nil if program cannot be found in provided path" do
+    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 << '.exe' if @@windows
+    assert_equal([absolute], File.whereis(absolute))
+    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'))
+  end
+
+  test "whereis requires at least one argument" do
+    assert_raise(ArgumentError){ File.whereis }
+  end
+
+  test "whereis returns unique paths only" do
+    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') }
+  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', '') }
+  end
+
+  def teardown
+    @expected_locs = nil
+    @actual_locs = nil
+  end
+
+  def self.shutdown
+    @@windows = nil
+  end
 end

data/test/test_which.rb

@@ -12,40 +12,98 @@ gem 'test-unit'
 
 require 'test/unit'
 require 'rbconfig'
+require 'fileutils'
 require 'ptools'
 include Config
 
 class TC_FileWhich < Test::Unit::TestCase
-   def setup
-      @ruby = RUBY_PLATFORM.match('java') ? 'jruby' : 'ruby'
-      @exe = File.join(CONFIG["bindir"], CONFIG["ruby_install_name"]) 
-
-      if Config::CONFIG['host_os'].match('mswin')
-         @exe.tr!('/','\\')
-         @exe << ".exe"
-      end
-   end
-
-   def test_which_basic
-      assert_respond_to(File, :which)
-      assert_nothing_raised{ File.which(@ruby) }
-      assert_nothing_raised{ File.which(@ruby, "/usr/bin:/usr/local/bin") }
-   end
-
-   def test_which_expected_return_values
-      assert_kind_of(String, File.which(@ruby))
-      assert_equal(@exe, File.which(@ruby))
-      assert_equal(nil, File.which(@ruby, "/bogus/path"))
-      assert_equal(nil, File.which("blahblah"))
-   end
-
-   def test_which_expected_errors
-      assert_raises(ArgumentError){ File.which }
-      assert_raises(ArgumentError){ File.which(@ruby, "foo", "bar") }
-   end
-
-   def teardown
-      @exe  = nil
-      @ruby = nil
-   end
+  def self.startup
+    @@windows = Config::CONFIG['host_os'] =~ /mswin|msdos|win32|cygwin|mingw/i
+    @@dir = File.join(Dir.pwd, 'tempdir')
+    @@non_exe = File.join(Dir.pwd, 'tempfile')
+
+    Dir.mkdir(@@dir) unless File.exists?(@@dir)
+    FileUtils.touch(@@non_exe)
+    File.chmod(775, @@dir)
+    File.chmod(644, @@non_exe)
+  end
+
+  def setup
+    @ruby = RUBY_PLATFORM.match('java') ? 'jruby' : 'ruby'
+    @exe = File.join(CONFIG['bindir'], CONFIG['ruby_install_name']) 
+
+    if @@windows
+      @exe.tr!('/','\\')
+      @exe << ".exe"
+    end
+  end
+
+  test "which basic functionality" do
+    assert_respond_to(File, :which)
+    assert_nothing_raised{ File.which(@ruby) }
+    assert_kind_of(String, File.which(@ruby))
+  end
+
+  test "which accepts an optional path to search" do
+    assert_nothing_raised{ File.which(@ruby, "/usr/bin:/usr/local/bin") }
+  end
+
+  test "which returns nil if not found" do
+    assert_equal(nil, File.which(@ruby, '/bogus/path'))
+    assert_equal(nil, File.which('blahblahblah'))
+  end
+
+  test "which handles executables without extensions on windows" do
+    omit_unless(@@windows, "test skipped unless MS Windows")
+    assert_not_nil(File.which('ruby'))
+    assert_not_nil(File.which('notepad'))
+  end
+
+  test "which handles executables that already contain extensions on windows" do
+    omit_unless(@@windows, "test skipped unless MS Windows")
+    assert_not_nil(File.which('ruby.exe'))
+    assert_not_nil(File.which('notepad.exe'))
+  end
+
+  test "which returns argument if an existent absolute path is provided" do
+    assert_equal(@exe, File.which(@ruby))
+  end
+
+  test "which returns nil if a non-existent absolute path is provided" do
+    assert_nil(File.which('/foo/bar/baz/ruby'))
+  end
+
+  test "which does not pickup files that are not executable" do
+    assert_nil(File.which(@@non_exe))
+  end
+
+  test "which does not pickup executable directories" do
+    assert_nil(File.which(@@dir))
+  end
+
+  test "which accepts a minimum of one argument" do
+    assert_raises(ArgumentError){ File.which }
+  end
+
+  test "which accepts a maximum of two arguments" do
+    assert_raises(ArgumentError){ File.which(@ruby, "foo", "bar") }
+  end
+
+  test "the second argument cannot be nil or empty" do
+    assert_raises(ArgumentError){ File.which(@ruby, nil) }
+    assert_raises(ArgumentError){ File.which(@ruby, '') }
+  end
+
+  def teardown
+    @exe  = nil
+    @ruby = nil
+  end
+
+  def self.shutdown
+    FileUtils.rm(@@non_exe)
+    FileUtils.rm_rf(@@dir)
+    @@windows = nil
+    @@dir = nil
+    @@non_exe = nil
+  end
 end