pathname2 1.2.1 → 1.3.0

data/CHANGES

@@ -1,13 +1,19 @@
-== 1.2.1 - 1-Sep-2005
-* Bug fix for the ascend and descend methods wrt Windows and UNC paths.
-* More tests added for ascend and descend methods.
-
-== 1.2.0 - 29-Aug-2005
-* Added the 'ascend' and 'descend' methods.
-* Added corresponding test suite additions.
-
-== 1.1.0 - 13-Jul-2005
-* Added the 'find' facade.
-
-== 1.0.0 - 11-Jun-2005
-* Initial release
+== 1.3.0 - 28-Oct-2005
+* Added the short_path and long_path methods for MS Windows.
+* Optimization for the '+' method on Unix.
+* Added some examples under the 'examples' directory.
+* More tests added and some minor changes to the test suite in general.
+
+== 1.2.1 - 1-Sep-2005
+* Bug fix for the ascend and descend methods wrt Windows and UNC paths.
+* More tests added for ascend and descend methods.
+
+== 1.2.0 - 29-Aug-2005
+* Added the 'ascend' and 'descend' methods.
+* Added corresponding test suite additions.
+
+== 1.1.0 - 13-Jul-2005
+* Added the 'find' facade.
+
+== 1.0.0 - 11-Jun-2005
+* Initial release

data/lib/pathname2.rb

@@ -11,7 +11,7 @@
 #
 # == Usage
 #
-# require "pathname"
+# require "pathname2"
 # 
 # # Unix
 # path1 = Pathname.new("/foo/bar/baz")
@@ -58,6 +58,12 @@ class Pathname < String
       @@PathIsRelative   = Win32API.new("shlwapi","PathIsRelative","P","L")
       @@PathFileExists   = Win32API.new("shlwapi","PathFileExists","P","L")
       @@PathUndecorate   = Win32API.new("shlwapi","PathUndecorate","P","L")
+      
+      @@GetShortPathName = 
+         Win32API.new("kernel32","GetShortPathName","PPL","L")
+         
+      @@GetLongPathName = 
+         Win32API.new("kernel32","GetLongPathName","PPL","L")
 
       @@PathGetDriveNumber =
          Win32API.new("shlwapi","PathGetDriveNumber","P","L")
@@ -69,7 +75,7 @@ class Pathname < String
          Win32API.new("shlwapi", "PathRemoveBackslash", "P", "P")
    end
 
-   VERSION  = "1.2.1"
+   VERSION  = "1.3.0"
    MAX_PATH = 260
    
    # Creates and returns a new Pathname object.
@@ -115,16 +121,44 @@ class Pathname < String
       @@PathUndecorate.call(buf)
       Pathname.new(buf.split(0.chr).first)
    end
-
+   
+   # Win32 only
+   #
+   # Returns the short path for a long path name.  For example,
+   # C:\Program Files\Java would return C:\Progra~1\Java.
+   def short_path
+      unless @win
+         raise NotImplementedError, "not supported on this platform"
+      end
+      buf = 0.chr * MAX_PATH
+      buf[0..self.length-1] = self
+      @@GetShortPathName.call(self, buf, buf.length)
+      Pathname.new(buf.split(0.chr).first)
+   end
+   
+   # Win32 only
+   #
+   # Returns the long path for a long path name.  For example,
+   # C:\Progra~1\Java would return C:\Program Files\Java.
+   def long_path
+      unless @win
+         raise NotImplementedError, "not supported on this platform"
+      end
+      buf = 0.chr * MAX_PATH
+      buf[0..self.length-1] = self
+      @@GetLongPathName.call(self, buf, buf.length)
+      Pathname.new(buf.split(0.chr).first)
+   end
+   
    # Removes trailing slash, if present.
    def pstrip
       if @win
          @@PathRemoveBackslash.call(self)
-         self.strip!
+         strip!
       else
          if self[-1] == @sep
-            self.strip!
-            self.chop!
+            strip!
+            chop!
          end
       end
       self
@@ -140,7 +174,7 @@ class Pathname < String
    
    # Yields each component of the path name to a block.
    def each
-      self.to_a.each{ |element| yield element }
+      to_a.each{ |element| yield element }
    end
 
    # Yields each component of the path, concatenating the next component on
@@ -166,7 +200,7 @@ class Pathname < String
          yield root if absolute?
       end
 
-      self.each{ |element|
+      each{ |element|
          if @win && unc?
             next if root.to_a.include?(element)
          end
@@ -187,11 +221,11 @@ class Pathname < String
          return
       end
       
-      n = self.to_a.length
+      n = to_a.length
 
       while n > 0
-         path = self.to_a[0..n-1].join(@sep)
-         if self.absolute?
+         path = to_a[0..n-1].join(@sep)
+         if absolute?
             if @win && unc?
                path = "\\\\" << path
             end     
@@ -232,12 +266,8 @@ class Pathname < String
             dir = Pathname.new(buf.split(0.chr).first)
          end
       else
-         dir = File.dirname(self)
-         while dir != "/" && dir != "."
-            dir = File.dirname(dir)
-         end
+         dir = "/" if self =~ /^\//
       end
-      dir = "." if dir.empty?
       dir
    end
 
@@ -313,11 +343,11 @@ class Pathname < String
       # If the string is an absolute directory, return it
       return string if string.absolute?
 
-      array = self.to_a + string.to_a
+      array = to_a + string.to_a
       new_string = array.join(@sep)
       
-      unless self.relative? || @win
-         new_string = @sep + new_string   # Add root path back if needed
+      unless relative? || @win
+         new_string = @sep + new_string # Add root path back if needed
       end
       
       Pathname.new(new_string).clean
@@ -351,7 +381,7 @@ class Pathname < String
       end
 
       final = []
-      self.to_a.each{ |element|
+      to_a.each{ |element|
          next if element == "."
          final.push(element)
          if element == ".." && self != ".."

data/test/tc_pathname.rb

@@ -7,6 +7,11 @@ Dir.chdir ".." if File.basename(Dir.pwd) == "test"
 $LOAD_PATH.unshift Dir.pwd
 $LOAD_PATH.unshift Dir.pwd + "/lib"
 
+if PLATFORM.match("mswin")
+   STDERR.puts("Please run 'tc_pathname_win.rb' instead.")
+   exit
+end
+
 require "pathname2"
 require "test/unit"
 
@@ -36,7 +41,7 @@ class TC_Pathname < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("1.2.1", Pathname::VERSION)
+      assert_equal("1.3.0", Pathname::VERSION)
    end
 
    def test_ascend

data/test/tc_pathname_win.rb

@@ -1,19 +1,25 @@
-############################################
-# tc_pathname.rb
+######################################################
+# tc_pathname_win.rb
 #
-# Test suite for the pathname package.
-############################################
+# MS Windows test suite for the Pathname class.
+######################################################
 Dir.chdir ".." if File.basename(Dir.pwd) == "test"
 $LOAD_PATH.unshift Dir.pwd
 $LOAD_PATH.unshift Dir.pwd + "/lib"
 
+unless PLATFORM.match("mswin")
+   STDERR.puts("Please run 'tc_pathname.rb' instead.")
+   exit
+end
+
 require "pathname2"
 require "test/unit"
 
-class TC_Pathname < Test::Unit::TestCase
+class TC_Pathname_MSWin < Test::Unit::TestCase
    def setup
       @fpath = Pathname.new("C:/Program Files/Windows NT/Accessories")
       @bpath = Pathname.new("C:\\Program Files\\Windows NT\\Accessories")
+      @spath = Pathname.new("C:\\PROGRA~1\\WINDOW~1\\ACCESS~1")
       @upath = Pathname.new("\\\\foo\\bar\\baz")
       @npath = Pathname.new("foo\\bar\\baz")
       @rpath = Pathname.new("Z:\\")
@@ -28,7 +34,7 @@ class TC_Pathname < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal("1.2.1", Pathname::VERSION)
+      assert_equal("1.3.0", Pathname::VERSION)
    end
    
    # Convenience method for test_plus
@@ -47,6 +53,24 @@ class TC_Pathname < Test::Unit::TestCase
       assert_equal(int, result)
    end
    
+   def test_short_path
+      assert_respond_to(@bpath, :short_path)
+      assert_nothing_raised{ @bpath.short_path }      
+      assert_kind_of(Pathname, @bpath.short_path)
+      assert_equal("C:\\PROGRA~1\\WINDOW~1\\ACCESS~1", @bpath.short_path)
+   end
+   
+   def test_long_path
+      assert_respond_to(@spath, :long_path)
+      assert_nothing_raised{ @spath.long_path }     
+      assert_kind_of(Pathname, @spath.long_path)
+      
+      assert_equal(
+         "C:\\Program Files\\Windows NT\\Accessories",
+         @spath.long_path
+      )
+   end
+   
    def test_each
       assert_respond_to(@fpath, :each)
       assert_nothing_raised{ @fpath.each{ |e| } }
@@ -275,6 +299,7 @@ class TC_Pathname < Test::Unit::TestCase
    def teardown
       @fpath = nil
       @bpath = nil
+      @spath = nil
       @upath = nil
       @npath = nil
       @rpath = nil

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: pathname2
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
-date: 2005-09-01 00:00:00 -06:00
+  version: 1.3.0
+date: 2005-10-26 00:00:00 -06:00
 summary: An alternate implementation of the Pathname class
 require_paths: 
   - lib