ptools 1.0.0 → 1.1.0

data/CHANGES

@@ -1,3 +1,12 @@
+== 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,
+  and defaults to '.com', '.bat' and '.exe' only if it's not defined.
+* The File.which and File.whereis methods were tweaked a bit for Windows so
+  that they ignore the case of suffixes.
+* Modified the platform checking and path separator handling.
+* Added and tweaked some tests.
+
 == 1.0.0 - 2-Jun-2005
 * Modified the File.middle method to accept an optional block.
 * File.whereis is now limited to unique values so that redundant PATH entries

data/MANIFEST

@@ -11,6 +11,7 @@ test/tc_constants.rb
 test/tc_head.rb
 test/tc_middle.rb
 test/tc_nlconvert.rb
+test/tc_null.rb
 test/tc_tail.rb
 test/tc_touch.rb
 test/tc_wc.rb

data/README

@@ -6,6 +6,10 @@
    Ruby 1.8.0 or later is recommended but not required.
 
 == Installation
+=== Gem
+   ruby ptools.gemspec
+   gem install ptools-x.y.z.gem
+=== Manual
    ruby test/ts_all.rb (optional)
    ruby install.rb
 
@@ -21,6 +25,7 @@
    File.wc("myfile",'words')  # Returns the number of words in 'myfile'
 
    File.touch("newfile")      # "newfile" now exists
+   File.null                  # '/dev/null' on Unix, 'NUL' on Windows
 
    # Creates a copy of 'myfile' called 'newfile', in DOS format
    File.nl_convert("myfile", "newfile", "dos")
@@ -48,7 +53,7 @@
    Ruby's
     
 == Copyright
-   (C) 2003-2005 Daniel J. Berger
+   (C) 2003-2006 Daniel J. Berger
    All Rights Reserved.
     
 == Warranty

data/lib/ptools.rb

@@ -1,21 +1,41 @@
 class File
+   PTOOLS_VERSION = '1.1.0'
+   IS_WINDOWS     = RUBY_PLATFORM.match('mswin') ? true : false
 
-   PTOOLS_VERSION = "1.0.0"
-   WIN32EXTS      = %w/.exe .com .bat/
+   WIN32EXTS = ENV['PATHEXT'].split(';').map{ |e| e.downcase } rescue %w/.exe .com .bat/
+
+   # Returns the null device (aka bitbucket) on your platform.  On most
+   # Unix-like systems this is '/dev/null', on Windows it's 'NUL', etc.
+   #--
+   # Based on information from  http://en.wikipedia.org/wiki//dev/null
+   #
+   def self.null
+      case RUBY_PLATFORM
+         when /mswin/i
+            'NUL'
+         when /amiga/i
+            'NIL:'
+         when /openvms/i
+            'NL:'
+         else
+            '/dev/null'
+      end
+   end
    
    # Looks for the first occurrence of +program+ within +path+.
    # 
-   # On Win32, it looks for executables ending with .exe, .bat and .com
-   # which you may optionally include in the program name.
+   # 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.  
    def self.which(program, path=ENV['PATH'])
       programs = program.to_a
       
-      # If no file extension is provided on Windows, try .bat, .com
-      # and .exe in turn.
-      if File::ALT_SEPARATOR && File.extname(program).empty?
-         unless WIN32EXTS.include?(File.extname(program))
+      # If no file extension is provided on Windows, try the WIN32EXT's in turn
+      if IS_WINDOWS && File.extname(program).empty?
+         unless WIN32EXTS.include?(File.extname(program).downcase)
             WIN32EXTS.each{ |ext|
                programs.push(program + ext)
             }
@@ -29,7 +49,7 @@ class File
                f = File.join(dir, prog)
                if File.executable?(f) && !File.directory?(f)
                   location = File.join(dir, prog)
-                  location.tr!('/',File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+                  location.tr!('/', File::ALT_SEPARATOR) if File::ALT_SEPARATOR
                   throw(:done, location)
                end
             }
@@ -42,17 +62,20 @@ class File
 
    # In block form, yields each +program+ within +path+.  In non-block
    # form, returns an array of each +program+ within +path+.
-   #  
-   # On Win32, it looks for executables ending with .exe, .bat and .com
-   # which you may optionally include in the program name.
+   #
+   # 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.
+   #
    def self.whereis(program, path=ENV['PATH'])
       dirs = []
       programs = program.to_a
       
-      # If no file extension is provided on Windows, try .bat, .com
-      # and .exe in turn.
-      if File::ALT_SEPARATOR && File.extname(program).empty?
-         unless WIN32EXTS.include?(File.extname(program))
+      # If no file extension is provided on Windows, try the WIN32EXT's in turn
+      if IS_WINDOWS && File.extname(program).empty?
+         unless WIN32EXTS.include?(File.extname(program).downcase)
             WIN32EXTS.each{ |ext|
                programs.push(program + ext)
             }
@@ -62,7 +85,7 @@ class File
       path.split(File::PATH_SEPARATOR).each{ |dir|
          programs.each{ |prog|
             file = File.join(dir,prog)
-            file.tr!('/',File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+            file.tr!('/', File::ALT_SEPARATOR) if File::ALT_SEPARATOR
             if File.executable?(file) && !File.directory?(file)
                if block_given?
                   yield file
@@ -77,6 +100,7 @@ class File
 
    # In block form, yields the first +num_lines+ from +filename+.  In non-block
    # form, returns an Array of +num_lines+
+   #
    def self.head(filename, num_lines=10)
       a = []
       IO.foreach(filename){ |line|
@@ -93,6 +117,7 @@ class File
 
    # 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 }
@@ -107,6 +132,7 @@ class File
    # Note that this method slurps the entire file, so I don't recommend it
    # for very large files.  Also note that 'tail -f' functionality is not
    # present.
+   #
    def self.tail(filename, num_lines=10)
       if block_given?
          IO.readlines(filename).reverse[0..num_lines-1].reverse.each{ |line|
@@ -120,21 +146,21 @@ class File
    # Converts a text file from one OS platform format to another, ala
    # 'dos2unix'.  Valid values for 'format', which are case insensitve,
    # include:
-
-   # * MS Windows -> dos, windows, win32
+   #
+   # * 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(filename, newfilename=filename, platform="dos")
-
       unless File.ftype(filename) == "file"
          raise TypeError, "Only valid for plain text files"
       end
 
-      if platform =~ /dos|windows|win32/i
+      if platform =~ /dos|windows|win32|mswin/i
          format = "\cM\cJ"
       elsif platform =~ /unix|linux|bsd/i
          format = "\cJ"
@@ -173,17 +199,19 @@ class File
    end
 
    # Creates the 0 byte file +filename+.
+   #
    def self.touch(filename)
-      File.open(filename,"w+"){}
+      File.open(filename, 'w'){}
       self
    end
 
    # With no arguments, returns a four element array consisting of the number
    # of bytes, characters, words and lines in filename, respectively.
-
+   #
    # Valid options are 'bytes', 'characters' (or just 'chars'), 'words' and
    # 'lines'.
-   def self.wc(filename,option='all')
+   #
+   def self.wc(filename, option='all')
       option.downcase!
       valid = %w/all bytes characters chars lines words/
 

data/test/tc_constants.rb

@@ -17,6 +17,14 @@ require "ptools"
 
 class TC_Constants < Test::Unit::TestCase
    def test_version
-      assert_equal("1.0.0", File::PTOOLS_VERSION, "Bad VERSION")
+      assert_equal("1.1.0", File::PTOOLS_VERSION, "Bad VERSION")
+   end
+
+   def test_windows
+      assert_not_nil(File::IS_WINDOWS)
+   end
+
+   def test_win32exts
+      assert_not_nil(File::WIN32EXTS)
    end
 end

data/test/tc_nlconvert.rb

@@ -42,8 +42,8 @@ class TC_FileNLConvert < Test::Unit::TestCase
    end
 
    def test_nl_convert_to_mac
-      if File::ALT_SEPARATOR
-         msg = "test may fail on Win32" 
+      if PLATFORM.match("mswin")
+         msg = "test may fail on MS Windows" 
       else
          msg = "mac file should be the same size (or larger), but isn't"
       end
@@ -68,7 +68,9 @@ class TC_FileNLConvert < Test::Unit::TestCase
    
    def test_nl_convert_expected_errors
       assert_raises(ArgumentError){ File.nl_convert }
-      assert_raises(ArgumentError){ File.nl_convert(@test_file1, "bogus.txt", "blah") }
+      assert_raises(ArgumentError){
+         File.nl_convert(@test_file1, "bogus.txt", "blah")
+      }
    end
 
    def teardown

data/test/tc_null.rb

@@ -0,0 +1,40 @@
+##########################################
+# tc_null.rb
+# 
+# Test case for the File.null 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_Null < 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
+
+   def test_null_expected_results
+      assert_kind_of(String, File.null)
+      assert(@nulls.include?(File.null))
+   end
+
+   def test_null_expected_errors
+      assert_raises(ArgumentError){ File.null(1) }
+   end
+
+   def teardown
+      @nulls = nil
+   end
+end

data/test/tc_whereis.rb

@@ -36,8 +36,10 @@ class TC_FileWhereis < Test::Unit::TestCase
    end
 
    def test_whereis_expected_return_values
-      assert_kind_of(Array, File.whereis("ruby"))
-      assert_equal(true, @expected_locs.include?(File.whereis("ruby").first))
+      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
 

data/test/ts_all.rb

@@ -10,6 +10,7 @@ require 'tc_constants'
 require 'tc_head'
 require 'tc_middle'
 require 'tc_nlconvert'
+require 'tc_null'
 require 'tc_tail'
 require 'tc_touch'
 require 'tc_wc'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.9.0
 specification_version: 1
 name: ptools
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2005-06-02
+  version: 1.1.0
+date: 2006-08-23 00:00:00 -06:00
 summary: Extra methods for the File class
 require_paths: 
-  - lib
+- lib
 email: djberg96@gmail.com
 homepage: http://www.rubyforge.org/projects/shards
 rubyforge_project: 
@@ -18,38 +18,46 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
 authors: 
-  - Daniel J. Berger
+- Daniel J. Berger
 files: 
-  - lib/ptools.rb
-  - README
-  - CHANGES
-  - MANIFEST
-  - test/tc_head.rb
-  - test/ts_all.rb
-  - test/tc_whereis.rb
-  - test/tc_middle.rb
-  - test/tc_which.rb
-  - test/tc_constants.rb
-  - test/tc_tail.rb
-  - test/tc_wc.rb
-  - test/tc_nlconvert.rb
-  - test/test_file1.txt
-  - test/test_file2.txt
-  - test/tc_touch.rb
+- lib/ptools.rb
+- CHANGES
+- MANIFEST
+- README
+- test/tc_constants.rb
+- test/tc_head.rb
+- test/tc_middle.rb
+- test/tc_nlconvert.rb
+- test/tc_null.rb
+- test/tc_tail.rb
+- test/tc_touch.rb
+- test/tc_wc.rb
+- test/tc_whereis.rb
+- test/tc_which.rb
+- test/test_file1.txt
+- test/test_file2.txt
+- test/ts_all.rb
 test_files: 
-  - test/ts_all.rb
+- test/ts_all.rb
 rdoc_options: []
+
 extra_rdoc_files: 
-  - README
-  - CHANGES
+- README
+- CHANGES
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+