pathname2 1.5.2 → 1.6.0

data/CHANGES

@@ -1,11 +1,24 @@
+== 1.6.0 - 13-July-2008
+* The facade for ftools (and ftools itself) has been removed. The ftools
+  library is deprecated in favor of FileUtils.
+* PathnameError is now Pathname::Error.
+* Bug fix for Pathname#relative_path_from for MS Windows. Thanks go to an
+  anonymous user for the spot.
+* Fixed a bug where frozen strings would raise an error on MS Windows.
+* The code is now -w clean.
+* Removed the C version as part of the release because it was just too
+  difficult to maintain both versions. The C code remains in CVS, however.
+* Changed platform checking to use rbconfig instead of RUBY_PLATFORM to avoid
+  potential issues with other Ruby implementation.
+
 == 1.5.2 - 9-Mar-2007
 * Bug fix for the Pathname#realpath method where it was not handling recursive
-   symlinks. The C version was also fixed, but it only affected platforms that
-   don't have the realpath() function.
+  symlinks. The C version was also fixed, but it only affected platforms that
+  don't have the realpath() function.
 * Added a test for recursive symlinks (for Solaris, anyway).
 * Updated the docs for Pathname#realpath.
 * Minor speed enhancements for the C version and the elimination of one
-   (potential) segfault.
+  (potential) segfault.
 * Added a 'Future Plans' section to the README.
 * Added a Rakefile. You can now build, clean, and test and install (both the
   pure Ruby and C versions).

data/MANIFEST

@@ -1,18 +1,11 @@
-CHANGES
-MANIFEST
-Rakefile
-README
-install.rb
-pathname2.gempsec
-
-examples/bench_all.rb
-examples/bench_plus.rb
-examples/example_pathname.rb
-
-ext/extconf.rb
-ext/pathname2.c
-
-lib/pathname2.rb
-
-test/tc_pathname.rb
-test/tc_pathname_win.rb
+* CHANGES
+* MANIFEST
+* Rakefile
+* README
+* pathname2.gempsec
+* examples/bench_all.rb
+* examples/bench_plus.rb
+* examples/example_pathname.rb
+* lib/pathname2.rb
+* test/test_pathname.rb
+* test/test_pathname_windows.rb

data/README

@@ -61,8 +61,8 @@
      a canonical pathname.  In addition, there is no special consideration
      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.
+   * It uses a facade for all File and Dir methods, as well as most FileUtils
+     methods.
    * 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.
@@ -70,20 +70,23 @@
      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.
+   
+== Differences between Unix platforms - C version
+   * On BSD systems, including OS X, the Pathname#realpath() method requires
+     that all components of a path *except the last* actually exist. Other
+     platforms require that the *entire* path actually exist. This is the
+     way the underlying realpath() C function works on these systems.
      
 == Method Priority
-   Because there is some overlap in method names between File, Dir, ftools
-   and FileUtils, the priority is as follows:
+   Because there is some overlap in method names between File, Dir, and
+   FileUtils, the priority is as follows:
    
    * File
    * Dir
-   * ftools
    * FileUtils
    
    In other words, whichever of these defines a given method first is the
-   method that is used by the pathname2 package.  For example, the
-   Pathname#safe_unlink method used is the one defined in ftools.rb,
-   not the one defined in the FileUtils module.
+   method that is used by the pathname2 package.
    
 == Known Issues
    You cannot pass a frozen string to the constructor on Windows using the
@@ -98,9 +101,7 @@
    supposed to be private.  See ruby-core:7383.
 
 == Future Plans
-   Because ftools is more or less deprecated, and FileUtils can generally do
-   everything ftools can do, and better, I'm going to remove ftools in the
-   1.6.0 release.
+   Suggestions welcome.
    
 == License
    Ruby's

data/Rakefile

@@ -2,73 +2,31 @@ require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
 
-desc "Clean the build files from the pathname2 source"
-task :clean do
-   Dir.chdir('ext') do
-      if RUBY_PLATFORM.match('mswin')
-         sh 'nmake distclean' if File.exists?('pathname2.so')
-      else
-         sh 'make distclean' if File.exists?('pathname2.so')
-      end
-   end
-end
-
-desc "Build the pathname2 package on UNIX systems (but don't install it)"
-task :build => [:clean] do
-   Dir.chdir('ext') do
-      ruby 'extconf.rb'
-      if RUBY_PLATFORM.match('mswin')
-         sh 'nmake'
-      else
-         sh 'make'
-      end
-   end
-end
-
-desc "Install the pure Ruby version of the pathname2 package"
+desc "Install pathname2 library (non-gem)"
 task :install do
    cp 'lib/pathname2.rb', Config::CONFIG['sitelibdir']
 end
 
-desc "Install the C version of the pathname2 package"
-task :install_c => [:build] do
-   Dir.chdir('ext') do
-      if RUBY_PLATFORM.match('mswin')
-         sh 'nmake install'
-      else
-         sh 'make install'
-      end
-   end
+desc "Install the pathname2 libarary as a gem"
+task :install_gem do
+   ruby 'pathname2.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
 end
 
 desc "Run the test suite for the pure Ruby version"
 Rake::TestTask.new('test') do |t|
-   t.libs << 'lib'
-   if RUBY_PLATFORM.match('mswin')
-      t.test_files = FileList['test/tc_pathname_win.rb']
+   t.warning = true
+   t.verbose = true
+   
+   if Config::CONFIG['host_os'] =~ /mswin/i
+      t.test_files = FileList['test/test_pathname_windows.rb']
    else
-      t.test_files = FileList['test/tc_pathname.rb']
+      t.test_files = FileList['test/test_pathname.rb']
    end
 end
 
-desc "Run the test suite for the C version."
-Rake::TestTask.new('test_c') do |t|
-   task :test_c => :build
-   t.libs << 'ext'
-   t.libs.delete('lib')
-   if RUBY_PLATFORM.match('mswin')
-      t.test_files = FileList['test/tc_pathname_win.rb']
-   else
-      t.test_files = FileList['test/tc_pathname.rb']
-   end
-end
-
-desc "Run the benchmark suite for the pure Ruby version"
+desc "Run the benchmark suite"
 task :benchmark do
    sh 'ruby -Ilib examples/bench_pathname.rb'
 end
-
-desc "Run the benchmark suite for the C version"
-task :benchmark_c => [:build] do
-   sh 'ruby -Iext examples/bench_pathname.rb c'
-end

data/lib/pathname2.rb

@@ -34,36 +34,48 @@
 # imperator on IRC (irc.freenode.net)
 #
 # == Copyright
-# Copyright (c) 2005-2006 Daniel J. Berger.
+# Copyright (c) 2005-2008 Daniel J. Berger.
 # Licensed under the same terms as Ruby itself.
 #
 require 'facade'
-require 'ftools'
 require 'fileutils'
+require 'rbconfig'
 
-class PathnameError < StandardError; end
+if Config::CONFIG['host_os'].match('mswin')
+   require 'windows/path'
+   require 'windows/file'
+   require 'windows/error'
+   require 'windows/limits'
+end
 
 class Pathname < String
+   class Error < StandardError; end
    extend Facade
-   facade File
-   facade Dir
+
+   facade File, File.methods(false) - [
+      'chmod', 'lchmod', 'chown', 'lchown', 'fnmatch', 'fnmatch?', 'link',
+      'open', 'rename', 'symlink', 'truncate', 'utime', 'basename',
+      'expand_path', 'join'
+   ]
+
+   facade Dir, Dir.methods(false) - ['chdir','glob','foreach','mkdir','open']
 
    alias :_plus_ :+ # Used to prevent infinite loops in some cases
    
-   if RUBY_PLATFORM.match('mswin')
-      require 'windows/path'
-      require 'windows/file'
+   if Config::CONFIG['host_os'].match('mswin')
       include Windows::Path
       include Windows::File
+      include Windows::Error
+      include Windows::Limits
    end
 
-   VERSION  = '1.5.2'
-   MAX_PATH = 260
+   VERSION = '1.6.0'
+   MAXPATH = 260
    
    # Creates and returns a new Pathname object.
    #
    # On platforms that define File::ALT_SEPARATOR, all forward slashes are
-   # replaced with the value of File::ALT_SEPARATOR.  On MS Windows, for
+   # replaced with the value of File::ALT_SEPARATOR. On MS Windows, for
    # example, all forward slashes are replaced with backslashes.
    #
    # File URL's will be converted to Pathname objects, e.g. the file URL
@@ -71,25 +83,25 @@ class Pathname < String
    # 'C:\Documents and Settings'.
    #
    def initialize(path)
-      if path.length > MAX_PATH
-         msg = "string too long.  maximum string length is " + MAX_PATH.to_s
-         raise PathnameError, msg
+      if path.length > MAXPATH
+         msg = "string too long.  maximum string length is " + MAXPATH.to_s
+         raise Error, msg
       end
 
       @sep = File::ALT_SEPARATOR || File::SEPARATOR
-      @win = RUBY_PLATFORM.match('mswin')
+      @win = Config::CONFIG['host_os'].match('mswin')
 
-      # Handle File URL's.  The separate methods for Windows are necessary
+      # Handle File URL's. The separate methods for Windows are necessary
       # because Ruby's URI class does not (currently) parse absolute file URL's
       # properly when they include a drive letter. 
       if @win
-         if PathIsURL(path)
-            buf = 0.chr * MAX_PATH
+         if PathIsURL(path.dup) # Dup to avoid frozen string issues
+            buf = 0.chr * MAXPATH
             len = [buf.length].pack("l")
-            if PathCreateFromUrl(path, buf, len, 0)
+            if PathCreateFromUrl(path, buf, len, 0) == S_OK
                path = buf.strip
             else
-               raise PathnameError, "invalid file url: #{path}"
+               raise Error, "invalid file url: #{path}"
             end
          end
       else
@@ -158,7 +170,7 @@ class Pathname < String
       unless @win
          raise NotImplementedError, "not supported on this platform"
       end
-      buf = 0.chr * MAX_PATH
+      buf = 0.chr * MAXPATH
       buf[0..self.length-1] = self
       PathUndecorate(buf)
       self.class.new(buf.split(0.chr).first)
@@ -172,7 +184,7 @@ class Pathname < String
       unless @win
          raise NotImplementedError, "not supported on this platform"
       end
-      buf = 0.chr * MAX_PATH
+      buf = 0.chr * MAXPATH
       buf[0..self.length-1] = self
       PathUndecorate(buf)
       replace(buf.split(0.chr).first)
@@ -188,7 +200,7 @@ class Pathname < String
       unless @win
          raise NotImplementedError, "not supported on this platform"
       end
-      buf = 0.chr * MAX_PATH
+      buf = 0.chr * MAXPATH
       buf[0..self.length-1] = self
       GetShortPathName(self, buf, buf.length)
       self.class.new(buf.split(0.chr).first)
@@ -203,7 +215,7 @@ class Pathname < String
       unless @win
          raise NotImplementedError, "not supported on this platform"
       end
-      buf = 0.chr * MAX_PATH
+      buf = 0.chr * MAXPATH
       buf[0..self.length-1] = self
       GetLongPathName(self, buf, buf.length)
       self.class.new(buf.split(0.chr).first)
@@ -340,7 +352,7 @@ class Pathname < String
    def root
       dir = "."   
       if @win
-         buf = 0.chr * MAX_PATH
+         buf = 0.chr * MAXPATH
          buf[0..self.length-1] = self
       
          if PathStripToRoot(buf)
@@ -428,6 +440,10 @@ class Pathname < String
       # Because of the way the Windows version handles Pathname#clean, we need
       # a little extra help here.
       if @win
+         if root != base.root
+            msg = 'cannot determine relative paths from different root paths'
+            raise ArgumentError, msg
+         end
          if base == '..' && (self != '..' || self != '.')
             raise ArgumentError, "base directory may not contain '..'"
          end
@@ -481,7 +497,7 @@ class Pathname < String
       
       # Use the builtin PathAppend() function if on Windows - much easier
       if @win
-         buf = 0.chr * MAX_PATH
+         buf = 0.chr * MAXPATH
          buf[0..self.length-1] = self
          PathAppend(buf, string)
          buf = buf.split("\0").first
@@ -526,7 +542,7 @@ class Pathname < String
       return self if self.empty?
 
       if @win
-         path = 0.chr * MAX_PATH
+         path = 0.chr * MAXPATH
          if PathCanonicalize(path, self)
             return self.class.new(path.split(0.chr).first)
          else
@@ -556,7 +572,7 @@ class Pathname < String
       return self if self.empty?
 
       if @win
-         path = 0.chr * MAX_PATH
+         path = 0.chr * MAXPATH
          if PathCanonicalize(path, self)
             replace(path.split(0.chr).first)
          end
@@ -731,13 +747,9 @@ class Pathname < String
       File.expand_path(self, *args)
    end
 
-   #--
-   # ftools facade
-   #++
-
-   # ftools File.copy
-   def copy(*args)
-      File.copy(self, *args)
+   # File.join
+   def join(*args)
+      File.join(self, *args)
    end
 
    #--
@@ -806,7 +818,11 @@ class Pathname < String
    def rm_rf(*args)
       FileUtils.rm_rf(self, *args)
    end
-   alias rmtree rm_rf
+   
+   # FileUtils.rmtree
+   def rmtree(*args)
+      FileUtils.rmtree(self, *args)
+   end
 
    # FileUtils.install
    def install(*args)
@@ -860,10 +876,5 @@ module Kernel
 end
 
 if $0 == __FILE__
-   path1 = '/dev/fd0'
-   path2 = 'link2'
-
-   path = Pathname.new(path1)
-   path = path.realpath
-   p path
+   path = Pathname.new(Dir.pwd)
 end

data/test/{tc_pathname.rb → test_pathname.rb}

@@ -63,7 +63,7 @@ class TC_Pathname < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.5.2', Pathname::VERSION)
+      assert_equal('1.6.0', Pathname::VERSION)
    end
 
    def test_file_url_path
@@ -73,9 +73,13 @@ class TC_Pathname < Test::Unit::TestCase
    def test_realpath
       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)
+      if RUBY_PLATFORM =~ /bsd|darwin|mac/i
+         assert_raises(Errno::ENOENT){ Pathname.new('../blahblah/bogus').realpath }
+      else
+         assert_raises(Errno::ENOENT){ Pathname.new('../bogus').realpath }
+      end
    end
 
    def test_realpath_platform

data/test/{tc_pathname_win.rb → test_pathname_windows.rb}

@@ -1,27 +1,11 @@
 ##########################################################################
 # tc_pathname_win.rb
 #
-# MS Windows test suite for the Pathname class.  To test explicitly
-# against the C extension pass the letter 'c' as an argument.
+# MS Windows test suite for the Pathname class. To test explicitly
+# against the C extension pass the letter 'c' as an argument. You should
+# use the 'rake test' task to run this test suite.
 ###########################################################################
-Dir.chdir ".." if File.basename(Dir.pwd) == "test"
-$LOAD_PATH.unshift Dir.pwd
-$c_extension = false
-
-# If the user passes a 'c', test against the C extension
-if ARGV[0] && ARGV[0].downcase == "c"
-   $c_extension = true
-   $LOAD_PATH.unshift Dir.pwd + "/ext"
-else
-   $LOAD_PATH.unshift Dir.pwd + "/lib"
-end
-
-unless RUBY_PLATFORM.match("mswin")
-   STDERR.puts("Please run 'tc_pathname.rb' instead.")
-   exit
-end
-
-require 'facade'     # Avoids annoying gems issue
+require 'facade'
 require 'pathname2'
 require 'test/unit'
 
@@ -56,7 +40,7 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal("1.5.1", Pathname::VERSION)
+      assert_equal("1.6.0", Pathname::VERSION)
    end
 
    # Convenience method for test_plus
@@ -81,7 +65,7 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
    end
 
    # Convenience method for test_relative_path_from_expected_errors
-   def assert_relpath_err(to, from)
+   def assert_relative_path_error(to, from)
       assert_raise(ArgumentError) {
          Pathname.new(to).relative_path_from(from)
       }
@@ -89,7 +73,7 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
    
    def test_file_urls
       assert_equal("C:\\Documents and Settings", @url_path)
-      assert_raises(PathnameError){ Pathname.new('http://rubyforge.org') }
+      assert_raises(Pathname::Error){ Pathname.new('http://rubyforge.org') }
    end
 
    def test_realpath
@@ -131,11 +115,15 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
 
       assert_relpath("a", "a", "b\\..")
       assert_relpath("b\\c", "b\\c", "b\\..")
+   end
 
-      assert_relpath_err("c:\\", ".")
-      assert_relpath_err(".", "c:\\")
-      assert_relpath_err("a", "..")
-      assert_relpath_err(".", "..")
+   def test_relative_path_from_expected_errors
+      assert_relative_path_error("c:\\", ".")
+      assert_relative_path_error(".", "c:\\")
+      assert_relative_path_error("a", "..")
+      assert_relative_path_error(".", "..")
+      assert_relative_path_error("C:\\Temp", "D:\\Temp")
+      assert_relative_path_error("\\\\Server\\Temp", "D:\\Temp")
    end
    
    # Convenience method to verify that the receiver was not modified
@@ -332,14 +320,11 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
       assert_non_destructive     
    end
   
-   # Fails due to PathIsURL for some reason in pure Ruby
    def test_immutability
-      if $c_extension
-         path = "C:\\Program Files\\foo\\bar".freeze
-         assert_equal(true, path.frozen?)
-         assert_nothing_raised{ Pathname.new(path) }
-         assert_nothing_raised{ Pathname.new(path).root }
-      end
+      path = "C:\\Program Files\\foo\\bar".freeze
+      assert_equal(true, path.frozen?)
+      assert_nothing_raised{ Pathname.new(path) }
+      assert_nothing_raised{ Pathname.new(path).root }
    end
    
    def test_plus_operator
@@ -544,7 +529,6 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
       File.methods(false).each{ |method|
          assert_respond_to(@fpath, method.to_sym)
       }
-      assert_respond_to(@fpath, :catname) # ftools check
    end
 
    def test_facade_dir
@@ -586,32 +570,34 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
       children.delete_if{ |e| File.basename(e) == "CVS" }
       children.delete_if{ |e| File.basename(e) == ".cvsignore" }
       children.delete_if{ |e| File.basename(e) == ".project" }
+      children.delete_if{ |e| File.basename(e) == ".loadpath" }
 
       assert_equal(
          [
             Dir.pwd + "/CHANGES",
             Dir.pwd + "/examples",
             Dir.pwd + "/ext",
-            Dir.pwd + "/install.rb",
             Dir.pwd + "/lib",
             Dir.pwd + "/MANIFEST",
             Dir.pwd + "/pathname2.gemspec",
+            Dir.pwd + "/Rakefile",
             Dir.pwd + "/README",
             Dir.pwd + "/test"
-         ].map{ |e| e.tr("/","\\") },
+         ].map{ |e| e.tr("/", "\\") },
          children
       )
-      
+
       # Delete Eclipse related files
       children = @cur_path.children(false)
       children.delete("CVS")
       children.delete(".cvsignore")
       children.delete(".project")
+      children.delete(".loadpath")
       
       assert_equal(
          [
             "CHANGES","examples","ext","install.rb","lib",
-            "MANIFEST", "pathname2.gemspec", "README", "test"
+            "MANIFEST", "pathname2.gemspec", "Rakefile", "README", "test"
          ],
          children
       )

metadata

@@ -1,61 +1,72 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: pathname2
 version: !ruby/object:Gem::Version 
-  version: 1.5.2
-date: 2007-03-09 00:00:00 -07:00
-summary: An alternate implementation of the Pathname class
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/shards
-rubyforge_project: 
-description: An alternate implementation of the Pathname class
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.6.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
-files: 
-- lib/pathname2.rb
-- CHANGES
-- MANIFEST
-- README
-- Rakefile
-- test/tc_pathname.rb
-- test/tc_pathname_win.rb
-test_files: 
-- test/tc_pathname.rb
-rdoc_options: []
-
-extra_rdoc_files: 
-- README
-- CHANGES
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2008-07-15 00:00:00 -06:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: facade
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 1.0.0
     version: 
+description: An alternate implementation of the Pathname class
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
+files: 
+- lib/pathname2.rb
+- CHANGES
+- MANIFEST
+- README
+- Rakefile
+- CVS
+- test/test_pathname.rb
+- test/test_pathname_windows.rb
+- test/CVS
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: shards
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An alternate implementation of the Pathname class
+test_files: 
+- test/test_pathname.rb