ptools 1.1.0 → 1.1.1

data/CHANGES

@@ -1,3 +1,6 @@
+== 1.1.1 - 24-Aug-2006
+* Added the File.binary? method, based on code from Ryan Davis.
+
 == 1.1.0 - 23-Aug-2006
 * Added the File.null method which returns the bit bucket on your platform.
 * The suffixes on MS Windows are now based on the PATHEXT environment variable,

data/README

@@ -26,6 +26,7 @@
 
    File.touch("newfile")      # "newfile" now exists
    File.null                  # '/dev/null' on Unix, 'NUL' on Windows
+   File.binary?('some_file')  # true or false
 
    # Creates a copy of 'myfile' called 'newfile', in DOS format
    File.nl_convert("myfile", "newfile", "dos")
@@ -35,6 +36,9 @@
    converting to DOS or MAC format if nl_convert is run multiple times on
    the same file.  This appears to be fixed in 1.8.x.
 
+   One or two of The File.nl_convert tests may fail on Windows.  You can
+   ignore these.
+
 == Acknowledgements
    The which() method was adopted from the FileWhich code posted by Michael
    Granger on http://www.rubygarden.org.  The 'whereis' command is a minor
@@ -46,6 +50,9 @@
     
    The middle() method was provided by Shashank Date.
 
+   The binary?() method was based almost entirely on a blog post by Ryan
+   Davis (who, in turn, based his code on Perl's -B switch).
+
 == Future Plans
    Add whatever other tools people think might be useful.
    

data/lib/ptools.rb

@@ -1,5 +1,7 @@
+require 'win32/file/stat' if PLATFORM.match('mswin')
+
 class File
-   PTOOLS_VERSION = '1.1.0'
+   PTOOLS_VERSION = '1.1.1'
    IS_WINDOWS     = RUBY_PLATFORM.match('mswin') ? true : false
 
    WIN32EXTS = ENV['PATHEXT'].split(';').map{ |e| e.downcase } rescue %w/.exe .com .bat/
@@ -21,6 +23,18 @@ class File
             '/dev/null'
       end
    end
+
+   # Returns whether or not +file+ is a binary file.  Note that this is
+   # not guaranteed to be 100% accurate.  It performs a "best guess" based
+   # on a simple test of the first +File.blksize+ characters.
+   #--
+   # Based on code originally provided by Ryan Davis (which, in turn, is
+   # based on Perl's -B switch).
+   #
+   def self.binary?(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+.
    # 

data/test/tc_binary.rb

@@ -0,0 +1,38 @@
+##########################################
+# tc_binary.rb
+# 
+# Test case for the File.binary? method.
+##########################################
+base = File.basename(Dir.pwd)
+
+if base == 'test' or base =~ /ptools/
+   Dir.chdir('..') if base == 'test'
+   $LOAD_PATH.unshift(Dir.pwd)
+   $LOAD_PATH.unshift(Dir.pwd + '/lib')
+   Dir.chdir('test') if Dir.pwd != 'test'
+end
+
+require 'test/unit'
+require 'ptools'
+
+class TC_Binary < Test::Unit::TestCase
+   def setup
+      @text_file = 'test_file1.txt'
+   end
+
+   def test_binary_basic
+      assert_respond_to(File, :binary?)
+      assert_nothing_raised{ File.binary?(@text_file) }
+   end
+
+   def test_binary_expected_results
+      assert_equal(false, File.binary?(@text_file))
+   end
+
+   def test_binary_expected_errors
+      assert_raises(Errno::ENOENT){ File.binary?('bogus') }
+   end
+
+   def teardown
+   end
+end

data/test/tc_constants.rb

@@ -17,7 +17,7 @@ require "ptools"
 
 class TC_Constants < Test::Unit::TestCase
    def test_version
-      assert_equal("1.1.0", File::PTOOLS_VERSION, "Bad VERSION")
+      assert_equal("1.1.1", File::PTOOLS_VERSION, "Bad VERSION")
    end
 
    def test_windows

data/test/ts_all.rb

@@ -6,6 +6,7 @@
 $LOAD_PATH.unshift(Dir.pwd)
 $LOAD_PATH.unshift(Dir.pwd + "/test")
 
+require 'tc_binary'
 require 'tc_constants'
 require 'tc_head'
 require 'tc_middle'

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ptools
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 date: 2006-08-23 00:00:00 -06:00
 summary: Extra methods for the File class
 require_paths: 
@@ -33,6 +33,7 @@ files:
 - CHANGES
 - MANIFEST
 - README
+- test/tc_binary.rb
 - test/tc_constants.rb
 - test/tc_head.rb
 - test/tc_middle.rb