pathname2 1.5.0 → 1.5.1

data/CHANGES

@@ -1,3 +1,12 @@
+== 1.5.1 - 28-Aug-2006
+* Added the Kernel#pn method as a shortcut for Pathname.new.
+* The Pathname#readlink now properly handles symbolic links.  The 'fix'
+  from 1.4.4 did not work.
+* The C extension uses your system's realpath() function for the
+  Pathname#readlink method if it has one.
+* Added the '/' alias for '+'.  So, p1 / p2 is the same as p1 + p2.
+* The windows-pr package is now required on MS Windows.
+
 == 1.5.0 - 17-Apr-2006
 * Better subclass handling, in that some methods that previously returned
   hardcoded Pathname.new now return self.class.new.

data/README

@@ -3,7 +3,10 @@
 
 == Prerequisites
    * Ruby 1.8.0 or later
-   * facade 1.0.0 or later (available on the RAA)
+   * facade 1.0.0 or later (available on the RAA and as a gem)
+   * windows-pr 0.5.1 or later (available on the RAA and as a gem)
+   
+   The windows-pr package is only required on MS Windows.
    
 == Installation, pure Ruby
 === Manual Installation
@@ -31,6 +34,7 @@
    path2 = "../zap"
 
    path1 + path2 # "/foo/bar/zap"
+   path1 / path2 # "/foo/bar/zap" (same as +)
    path1.exists? # Does this path exist?
    path1.dirname # "/foo/bar"
    path1.to_a    # ['foo','bar','baz']
@@ -43,7 +47,7 @@
    path1.root    # "C:\\"
    path1.to_a    # ['C:','foo','bar','baz']
 
-== Win32 Notes
+== Windows Notes
    All forward slashes are converted to backslashes for Pathname objects.
 
 == Differences between Unix and Windows
@@ -52,7 +56,7 @@
    while on Unix "." is returned.  I consider this an extreme edge case and
    will not worry myself with it.
 
-== Differences between the old version and this version
+== Differences between Pathname in the standard library and this version
    * It is a subclass of String (and thus, mixes in Enumerable).
    * It has sensical to_a and root instance methods.
    * It works on Windows and Unix.  The current implementation does not work
@@ -60,15 +64,17 @@
      paths.
    * The Pathname#cleanpath method works differently - it always returns
      a canonical pathname.  In addition, there is no special consideration
-     for symlinks (yet).
+     for symlinks (yet), though I'm not sure it warrants it.
    * The Pathname#+ method auto cleans.
    * It uses a facade for all File and Dir methods, as well as all ftools
      methods and most FileUtils methods.
-   * Pathname#clean works slightly differently.  In the old version,
+   * Pathname#clean works slightly differently.  In the stdlib version,
      Pathname#clean("../a") returns "../a".  In this version, it returns "a".
      This affects other methods, such as Pathname#relative_path_from.
    * Accepts file urls and converts them to paths automatically, e.g.
      file:///foo%20bar/baz becomes '/foo bar/baz'.
+   * Adds a Kernel level +pn+ method as a shortcut.
+   * Allows you to add paths together with the '/' operator.
      
 == Method Priority
    Because there is some overlap in method names between File, Dir, ftools

data/lib/pathname2.rb

@@ -37,9 +37,9 @@
 # Copyright (c) 2005-2006 Daniel J. Berger.
 # Licensed under the same terms as Ruby itself.
 #
-require "facade"
-require "ftools"
-require "fileutils"
+require 'facade'
+require 'ftools'
+require 'fileutils'
 
 class PathnameError < StandardError; end
 
@@ -51,35 +51,13 @@ class Pathname < String
    alias :_plus_ :+ # Used to prevent infinite loops in some cases
    
    if RUBY_PLATFORM.match('mswin')
-      require 'Win32API'
-      @@PathStripToRoot  = Win32API.new('shlwapi', 'PathStripToRoot', 'P', 'L')
-      @@PathIsUNC        = Win32API.new('shlwapi', 'PathIsUNC', 'P', 'L')
-      @@PathIsURL        = Win32API.new('shlwapi', 'PathIsURL', 'P', 'L')
-      @@PathCanonicalize = Win32API.new('shlwapi', 'PathCanonicalize','PP','L')
-      @@PathAppend       = Win32API.new('shlwapi', 'PathAppend', 'PP', 'L')     
-      @@PathIsRoot       = Win32API.new('shlwapi', 'PathIsRoot', 'P', 'L')
-      @@PathIsDirectory  = Win32API.new('shlwapi', 'PathIsDirectory', 'P', 'L')
-      @@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')
-   
-      @@PathCreateFromUrl  =
-         Win32API.new('shlwapi', 'PathCreateFromUrl', 'PPPL', 'L')
-   
-      @@PathRemoveBackslash =
-         Win32API.new('shlwapi', 'PathRemoveBackslash', 'P', 'P')
+      require 'windows/path'
+      require 'windows/file'
+      include Windows::Path
+      include Windows::File
    end
 
-   VERSION  = '1.5.0'
+   VERSION  = '1.5.1'
    MAX_PATH = 260
    
    # Creates and returns a new Pathname object.
@@ -105,10 +83,10 @@ class Pathname < String
       # because Ruby's URI class does not (currently) parse absolute file URL's
       # properly when they include a drive letter. 
       if @win
-         if @@PathIsURL.call(path) > 0
+         if PathIsURL(path)
             buf = 0.chr * MAX_PATH
             len = [buf.length].pack("l")
-            if @@PathCreateFromUrl.call(path, buf, len, 0) >= 0
+            if PathCreateFromUrl(path, buf, len, 0)
                path = buf.strip
             else
                raise PathnameError, "invalid file url: #{path}"
@@ -132,12 +110,23 @@ class Pathname < String
    # exists on your filesystem.  If it doesn't, an error is raised.
    #
    def realpath
-      pwd = self.class.new(Dir.pwd)
       File.stat(self)               # Check to ensure that the path exists
       if File.symlink?(self)
-         self.class.new(File.readlink(self))
-      else 
-         pwd + self
+         path = self.class.new(File.readlink(self))
+         if File.symlink?(path)
+            while File.symlink?(path)
+               if path.relative?
+                  path = path + File.dirname(path)
+               else
+                  path = self.class.new(File.readlink(path))
+               end
+            end
+         else
+            path = self.class.new(File.dirname(self)) + path
+         end
+         path
+      else
+         self.class.new(Dir.pwd) + self
       end
    end
    
@@ -174,7 +163,7 @@ class Pathname < String
       end
       buf = 0.chr * MAX_PATH
       buf[0..self.length-1] = self
-      @@PathUndecorate.call(buf)
+      PathUndecorate(buf)
       self.class.new(buf.split(0.chr).first)
    end
    
@@ -188,7 +177,7 @@ class Pathname < String
       end
       buf = 0.chr * MAX_PATH
       buf[0..self.length-1] = self
-      @@PathUndecorate.call(buf)
+      PathUndecorate(buf)
       replace(buf.split(0.chr).first)
       self
    end
@@ -204,7 +193,7 @@ class Pathname < String
       end
       buf = 0.chr * MAX_PATH
       buf[0..self.length-1] = self
-      @@GetShortPathName.call(self, buf, buf.length)
+      GetShortPathName(self, buf, buf.length)
       self.class.new(buf.split(0.chr).first)
    end
    
@@ -219,7 +208,7 @@ class Pathname < String
       end
       buf = 0.chr * MAX_PATH
       buf[0..self.length-1] = self
-      @@GetLongPathName.call(self, buf, buf.length)
+      GetLongPathName(self, buf, buf.length)
       self.class.new(buf.split(0.chr).first)
    end
    
@@ -228,7 +217,7 @@ class Pathname < String
    def pstrip
       str = self.dup
       if @win
-         @@PathRemoveBackslash.call(str)
+         PathRemoveBackslash(str)
          str.strip!
       else
          if str[-1].chr == @sep
@@ -243,7 +232,7 @@ class Pathname < String
    #
    def pstrip!
       if @win
-         @@PathRemoveBackslash.call(self)
+         PathRemoveBackslash(self)
          strip!
       else
          if self[-1].chr == @sep
@@ -357,7 +346,7 @@ class Pathname < String
          buf = 0.chr * MAX_PATH
          buf[0..self.length-1] = self
       
-         if @@PathStripToRoot.call(buf) > 0
+         if PathStripToRoot(buf)
             dir = buf.split(0.chr).first
          end
       else
@@ -370,7 +359,7 @@ class Pathname < String
    #
    def root?
       if @win
-         @@PathIsRoot.call(self) > 0
+         PathIsRoot(self)
       else
          self == root
       end
@@ -386,7 +375,7 @@ class Pathname < String
          raise NotImplementedError, "not supported on this platform"
       end
 
-      @@PathIsUNC.call(self) > 0
+      PathIsUNC(self)
    end
    
    # Windows only
@@ -401,7 +390,7 @@ class Pathname < String
          raise NotImplementedError, "not supported on this platform"
       end
 
-      num = @@PathGetDriveNumber.call(self)
+      num = PathGetDriveNumber(self)
       num >= 0 ? num : nil
    end
 
@@ -497,7 +486,7 @@ class Pathname < String
       if @win
          buf = 0.chr * MAX_PATH
          buf[0..self.length-1] = self
-         @@PathAppend.call(buf, string)
+         PathAppend(buf, string)
          buf = buf.split("\0").first
          return self.class.new(buf) # PathAppend cleans automatically
       end
@@ -515,6 +504,7 @@ class Pathname < String
       
       self.class.new(new_string).clean
    end
+   alias :/ :+
 
    # Returns whether or not the path is an absolute path.
    #
@@ -526,7 +516,7 @@ class Pathname < String
    #
    def relative?
       if @win
-         @@PathIsRelative.call(self) > 0
+         PathIsRelative(self)
       else
          root == "."
       end
@@ -540,7 +530,7 @@ class Pathname < String
 
       if @win
          path = 0.chr * MAX_PATH
-         if @@PathCanonicalize.call(path, self) > 0
+         if PathCanonicalize(path, self)
             return self.class.new(path.split(0.chr).first)
          else
             return self
@@ -570,7 +560,7 @@ class Pathname < String
 
       if @win
          path = 0.chr * MAX_PATH
-         if @@PathCanonicalize.call(path, self) > 0
+         if PathCanonicalize(path, self)
             replace(path.split(0.chr).first)
          end
          return self
@@ -861,3 +851,13 @@ class Pathname < String
       FileUtils.copy_entry(self, *args)
    end
 end
+
+module Kernel
+   # Usage: pn{ path } 
+   #
+   # A shortcut for Pathname.new
+   #
+   def pn
+      instance_eval{ Pathname.new(yield) }
+   end
+end

data/test/tc_pathname.rb

@@ -38,7 +38,7 @@ class TC_Pathname < Test::Unit::TestCase
       @abs_array = []
       @rel_array = []
 
-      @mypath = MyPathname.new('/usr/local/bin')
+      @mypath = MyPathname.new('/usr/bin')
    end
 
    # Convenience method to verify that the receiver was not modified
@@ -77,7 +77,7 @@ class TC_Pathname < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.5.0', Pathname::VERSION)
+      assert_equal('1.5.1', Pathname::VERSION)
    end
 
    def test_file_url_path
@@ -88,7 +88,21 @@ class TC_Pathname < Test::Unit::TestCase
       assert_respond_to(@abs_path, :realpath)
       assert_equal(@pwd, Pathname.new('.').realpath)
       assert_raises(Errno::ENOENT){ Pathname.new('../bogus').realpath }
+      assert_kind_of(Pathname, Pathname.new('/dev/stdin').realpath)
+      assert(Pathname.new('/dev/stdin') != Pathname.new('/dev/stdin').realpath)
+   end
 
+   def test_realpath_platform
+      case RUBY_PLATFORM
+         when /linux/i
+            path1 = '/dev/stdin'
+            assert_equal('/dev/pts/0', Pathname.new(path1).realpath)
+         when /sunos|solaris/i
+            path1 = '/dev/null'
+            path2 = '/dev/stdin'
+            assert_equal('/devices/pseudo/mm@0:null', Pathname.new(path1).realpath)
+            assert_equal('/dev/fd/0', Pathname.new(path2).realpath)
+      end
    end
 
    # These tests taken directly from Tanaka's pathname.rb. The one failure
@@ -347,6 +361,9 @@ class TC_Pathname < Test::Unit::TestCase
       assert_pathname_plus('/', '/', '..')
       assert_pathname_plus('.', '..',  '..')
       assert_pathname_plus('.', 'foo', '..')
+
+      # Alias
+      assert_equal('/foo/bar', Pathname.new('/foo') / Pathname.new('bar'))
    end
 
    # Any tests marked with '***' mean that this behavior is different than
@@ -417,12 +434,22 @@ class TC_Pathname < Test::Unit::TestCase
 
    # Ensures that subclasses return the subclass as the class, not a hard
    # coded Pathname.
+   #
    def test_subclasses
       assert_kind_of(MyPathname, @mypath)
       assert_kind_of(MyPathname, @mypath + MyPathname.new('foo'))
       assert_kind_of(MyPathname, @mypath.realpath)
       assert_kind_of(MyPathname, @mypath.children.first)
    end
+
+   # Test to ensure that the pn{ } shortcut works
+   #
+   def test_kernel_method
+      assert_respond_to(Kernel, :pn)
+      assert_nothing_raised{ pn{'/foo'} }
+      assert_kind_of(Pathname, pn{'/foo'})
+      assert_equal('/foo', pn{'/foo'})
+   end
    
    def teardown
       @pwd      = nil

data/test/tc_pathname_win.rb

@@ -16,13 +16,14 @@ else
    $LOAD_PATH.unshift Dir.pwd + "/lib"
 end
 
-unless PLATFORM.match("mswin")
+unless RUBY_PLATFORM.match("mswin")
    STDERR.puts("Please run 'tc_pathname.rb' instead.")
    exit
 end
 
-require "pathname2"
-require "test/unit"
+require 'facade'     # Avoids annoying gems issue
+require 'pathname2'
+require 'test/unit'
 
 class MyPathname < Pathname; end
 
@@ -55,7 +56,7 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal("1.5.0", Pathname::VERSION)
+      assert_equal("1.5.1", Pathname::VERSION)
    end
 
    # Convenience method for test_plus
@@ -624,6 +625,15 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
       assert_kind_of(MyPathname, @mypath.realpath)
       assert_kind_of(MyPathname, @mypath.children.first)
    end
+
+   # Test to ensure that the pn{ } shortcut works
+   #
+   def test_kernel_method
+      assert_respond_to(Kernel, :pn)
+      assert_nothing_raised{ pn{'c:\foo'} }
+      assert_kind_of(Pathname, pn{'c:\foo'})
+      assert_equal('c:\foo', pn{'c:\foo'})
+   end
   
    def teardown
       @fpath = nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: pathname2
 version: !ruby/object:Gem::Version 
-  version: 1.5.0
-date: 2006-04-17 00:00:00 -06:00
+  version: 1.5.1
+date: 2006-08-28 00:00:00 -06:00
 summary: An alternate implementation of the Pathname class
 require_paths: 
-  - lib
+- lib
 email: djberg96@gmail.com
 homepage: http://www.rubyforge.org/projects/shards
 rubyforge_project: 
@@ -18,40 +18,43 @@ 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/pathname2.rb
-  - CHANGES
-  - MANIFEST
-  - README
-  - test/tc_pathname.rb
-  - test/tc_pathname_win.rb
+- lib/pathname2.rb
+- CHANGES
+- MANIFEST
+- README
+- test/tc_pathname.rb
+- test/tc_pathname_win.rb
 test_files: 
-  - test/tc_pathname.rb
+- test/tc_pathname.rb
 rdoc_options: []
+
 extra_rdoc_files: 
-  - README
-  - CHANGES
+- README
+- CHANGES
 executables: []
+
 extensions: []
+
 requirements: []
+
 dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: facade
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Version::Requirement 
-      requirements: 
-        - 
-          - ">="
-          - !ruby/object:Gem::Version 
-            version: 1.0.0
-      version: 
+- !ruby/object:Gem::Dependency 
+  name: facade
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: