pathname2 1.6.1 → 1.6.2

data/CHANGES

@@ -1,3 +1,13 @@
+== 1.6.2 - 4-Aug-2009
+* Now compatible with Ruby 1.9.x.
+* License changed to Artistic 2.0.
+* Added the Pathname.pwd method as a synonym for Pathname.new(Dir.pwd).
+* Modified Pathname#dirname so that you can specify a level that indicates
+  how many levels up you want to retrieve. For example, if your path was
+  '/usr/local/bin', then path.dirname(2) would return '/usr'.
+* Now compatible with Ruby 1.9.x.
+* Bumped required version of the facade library to 1.0.4.
+
 == 1.6.1 - 8-Nov-2008
 * Added the Pathname#[] method, which accepts an index, an index plus a
   length, or a range, and returns appropriate the path element(s).

data/MANIFEST

@@ -3,8 +3,8 @@
 * Rakefile
 * README
 * pathname2.gempsec
-* examples/bench_all.rb
-* examples/bench_plus.rb
+* benchmarks/bench_all.rb
+* benchmarks/bench_plus.rb
 * examples/example_pathname.rb
 * lib/pathname2.rb
 * test/test_pathname.rb

data/README

@@ -94,7 +94,11 @@
    Suggestions welcome.
    
 == License
-   Ruby's
+   Artistic 2.0
+   
+== Copyright
+   (C) 2003-2009 Daniel J. Berger
+   All rights reserved.
 
 == Warranty
    This library is provided "as is" and without any express or
@@ -103,4 +107,3 @@
 
 == Author
    Daniel J. Berger
-   djberg96 at gmail dot com

data/benchmarks/bench_pathname.rb

@@ -0,0 +1,127 @@
+#####################################################################
+# bench_pathname.rb
+#
+# Benchmark suite for all methods of the Pathname class, excluding
+# the facade methods.
+#
+# Use the Rake tasks to run this benchmark:
+#
+# => rake benchmark to run the pure Ruby benchmark.
+#####################################################################
+require 'benchmark'
+require 'pathname2'
+require 'rbconfig'
+
+if Config::CONFIG['host_os'].match("mswin")
+   path1 = Pathname.new("C:\\Program Files\\Windows NT")
+   path2 = Pathname.new("Accessories")
+   path3 = Pathname.new("C:\\Program Files\\..\\.\\Windows NT")
+else
+   path1 = Pathname.new("/usr/local")
+   path2 = Pathname.new("bin")
+   path3 = Pathname.new("/usr/../local/./bin")
+   path4 = Pathname.new("/dev/stdin")
+end
+
+MAX = 10000
+
+Benchmark.bm(25) do |bench|
+   bench.report("Pathname.new(path)"){
+      MAX.times{ Pathname.new("/usr/local/bin") }
+   }
+
+   bench.report("Pathname#+(Pathname)"){
+      MAX.times{ path1 + path2 }
+   }
+
+   bench.report("Pathname#+(String)"){
+      MAX.times{ path1 + path2 }
+   }
+
+   bench.report("Pathname#children"){
+      MAX.times{ path1.children }
+   }
+
+   bench.report("Pathname#pstrip"){
+      MAX.times{ path1.pstrip }
+   }
+
+   bench.report("Pathname#pstrip!"){
+      MAX.times{ path1.pstrip! }
+   }
+
+   bench.report("Pathname#to_a"){
+      MAX.times{ path1.to_a }
+   }
+
+   bench.report("Pathname#descend"){
+      MAX.times{ path1.descend{} }
+   }
+
+   bench.report("Pathname#ascend"){
+      MAX.times{ path1.ascend{} }
+   }
+
+   bench.report("Pathname#root"){
+      MAX.times{ path1.root }
+   }
+
+   bench.report("Pathname#root?"){
+      MAX.times{ path1.root? }
+   }
+
+   bench.report("Pathname#<=>"){
+      MAX.times{ path1 <=> path2 }
+   }
+
+   bench.report("Pathname#absolute?"){
+      MAX.times{ path1.absolute? }
+   }
+
+   bench.report("Pathname#relative?"){
+      MAX.times{ path1.relative? }
+   }
+
+   bench.report("Pathname#clean"){
+      MAX.times{ path3.clean }
+   }
+
+   bench.report("Pathname#clean!"){
+      MAX.times{ path3.clean! }
+   }
+
+   # Platform specific tests
+   if Config::CONFIG['host_os'].match("mswin")
+      bench.report("Pathname.new(file_url)"){
+         MAX.times{ Pathname.new("file:///C:/usr/local/bin") }
+      }
+
+      bench.report("Pathname#drive_number"){
+         MAX.times{ path1.drive_number }
+      }
+
+      bench.report("Pathname#unc?"){
+         MAX.times{ path1.unc? }
+      }
+
+      bench.report("Pathname#undecorate"){
+         MAX.times{ path1.undecorate }
+      }
+
+      bench.report("Pathname#undecorate!"){
+         MAX.times{ path1.undecorate! }
+      }
+
+      bench.report("Pathname#short_path"){
+         MAX.times{ path1.short_path }
+      }
+
+      bench.report("Pathname#long_path"){
+         MAX.times{ path1.long_path }
+      }
+   else      
+      bench.report("Pathname#realpath"){
+         MAX.times{ path4.realpath }
+      }
+   end
+end

data/benchmarks/bench_plus.rb

@@ -0,0 +1,34 @@
+##############################################################################
+# Compare File.join vs. Pathname#+
+#
+# This benchmark was inspired by a post by Thomas Sawyer.  Note that
+# Pathname#+ will never be as fast as File.join, but this provides a
+# good base for further optimizations.
+#
+# Also keep in mind that File.join does no path normalization whatsoever,
+# e.g. File.join("foo", "/bar") behaves differently than Pathname.new("foo")
+# + Pathname.new("/bar").  This is true of both the pathname and pathname2
+# packages.
+#
+# You can run this via the 'rake benchmark_plus' task.
+##############################################################################
+require 'benchmark'
+require 'pathname2'
+
+MAX = 10000
+
+s1 = "a/b/c"
+s2 = "d/e/f"
+
+path1 = Pathname.new(s1)
+path2 = Pathname.new(s2)
+
+Benchmark.bm(10) do |bench|
+   bench.report("File.join"){
+      MAX.times{ File.join(s1, s2) }
+   }
+
+   bench.report("Pathname#+"){
+      MAX.times{ path1 + path2 }
+   }
+end

data/examples/example_pathname.rb

@@ -0,0 +1,25 @@
+########################################################################
+# example_pathname.rb
+#
+# Some examples to demonstrate the behavior of the pathname2 library.
+########################################################################
+require 'pathname2'
+
+puts "VERSION: " + Pathname::VERSION
+
+path1 = Pathname.new("foo/bar")
+path2 = Pathname.new("baz/blah")
+
+path3 = Pathname.new("foo/../bar")
+path4 = Pathname.new("../baz")
+
+p path1 + path2 # foo/bar/baz/blah
+p path3 + path4 # baz
+
+# Shortcut syntax
+path = pn{ "C:\\Documents and Settings\\snoopy\\My Documents" }
+
+p path[0]    # C:
+p path[1]    # Documents and Settings
+p path[0,2]  # C:\\Documents and Settings
+p path[0..2] # C:\\Documents and Settings\\snoopy

data/lib/pathname2.rb

@@ -52,13 +52,19 @@ class Pathname < String
    class Error < StandardError; end
    extend Facade
 
-   facade File, File.methods(false) - [
-      'chmod', 'lchmod', 'chown', 'lchown', 'fnmatch', 'fnmatch?', 'link',
-      'open', 'rename', 'symlink', 'truncate', 'utime', 'basename',
-      'expand_path', 'join'
+   facade File, File.methods(false).map{ |m| m.to_sym } - [
+      :chmod, :lchmod, :chown, :lchown, :dirname, :fnmatch, :fnmatch?,
+      :link, :open, :rename, :symlink, :truncate, :utime, :basename,
+      :expand_path, :join
    ]
 
-   facade Dir, Dir.methods(false) - ['chdir','glob','foreach','mkdir','open']
+   facade Dir, Dir.methods(false).map{ |m| m.to_sym } - [
+      :chdir,
+      :glob,
+      :foreach,
+      :mkdir, 
+      :open
+   ]
 
    private
    
@@ -73,12 +79,24 @@ class Pathname < String
    
    public
 
-   VERSION = '1.6.1'
+   # The version of this library
+   VERSION = '1.6.2'
 
-   if !defined? MAXPATH
-      MAXPATH = 1024
+   # The maximum length of a path
+   MAXPATH = 1024 unless defined? MAXPATH # Yes, I willfully violate POSIX
+   
+   # Returns the expanded path of the current working directory.
+   #
+   # Synonym for Pathname.new(Dir.pwd).
+   #
+   def self.pwd
+      new(Dir.pwd)      
    end
    
+   class << self
+      alias getwd pwd      
+   end
+
    # Creates and returns a new Pathname object.
    #
    # On platforms that define File::ALT_SEPARATOR, all forward slashes are
@@ -468,7 +486,7 @@ class Pathname < String
    # Examples:
    #
    #    Pathname.new('/usr/local').root       # => '/'
-   #    Pathname.new('lib')                   # => '.'
+   #    Pathname.new('lib').root              # => '.'
    #
    #    On MS Windows:
    #
@@ -476,7 +494,8 @@ class Pathname < String
    #    Pathname.new('\\some\share\foo').root # => '\\some\share'
    #
    def root
-      dir = "."   
+      dir = "." 
+        
       if @win
          buf = 0.chr * MAXPATH
          buf[0..self.length-1] = self
@@ -487,6 +506,7 @@ class Pathname < String
       else
          dir = "/" if self =~ /^\//
       end
+      
       self.class.new(dir)
    end
 
@@ -565,15 +585,15 @@ class Pathname < String
    #    Pathname.new('/usr/local/bin').parent # => '/usr/local'
    #
    def parent
-      self + ".."
+      self + ".." # Use our custom '+' method
    end
 
-   # Returns a relative path from the argument to the receiver.  If +self+
-   # is absolute, the argument must be absolute too.  If +self+ is relative,
-   # the argument must be relative too. For relative paths, this method
+   # Returns a relative path from the argument to the receiver. If +self+
+   # is absolute, the argument must be absolute too. If +self+ is relative,
+   # the argument must be relative too. For relative paths, this method uses
    # an imaginary, common parent path.
    #
-   # This method does not access the filesystem.  It assumes no symlinks.
+   # This method does not access the filesystem. It assumes no symlinks.
    # You should only compare directories against directories, or files against
    # files, or you may get unexpected results.
    #
@@ -780,6 +800,32 @@ class Pathname < String
 
    alias cleanpath! clean!
 
+   # Similar to File.dirname, but this method allows you to specify the number
+   # of levels up you wish to refer to.
+   #
+   # The default level is 1, i.e. it works the same as File.dirname. A level of
+   # 0 will return the original path. A level equal to or greater than the
+   # number of path elements will return the root path.
+   #
+   # A number less than 0 will raise an ArgumentError.
+   #
+   # Example:
+   #
+   #    path = Pathname.new('/usr/local/bin/ruby')
+   #
+   #    puts path.dirname    # => /usr/local/bin
+   #    puts path.dirname(2) # => /usr/local
+   #    puts path.dirname(3) # => /usr
+   #    puts path.dirname(9) # => /
+   #
+   def dirname(level = 1)
+      raise ArgumentError if level < 0
+      local_path = self.dup
+
+      level.times{ |n| local_path = File.dirname(local_path) }
+      local_path
+   end
+
    #-- Find facade
 
    # Pathname#find is an iterator to traverse a directory tree in a depth first

data/test/test_pathname.rb

@@ -5,23 +5,30 @@
 # via the Rake tasks, i.e. 'rake test_pr' to test the pure Ruby version, or
 # 'rake test_c' to test the C version.
 ##############################################################################
-require 'pathname2'
+require 'rubygems'
+gem 'test-unit'
+
 require 'test/unit'
+require 'pathname2'
 require 'rbconfig'
 include Config
 
 class MyPathname < Pathname; end
 
 class TC_Pathname < Test::Unit::TestCase
+   def self.startup
+      Dir.chdir(File.expand_path(File.dirname(__FILE__)))
+      @@pwd = Dir.pwd
+   end
+
    def setup
-      @pwd = Dir.pwd
       @abs_path = Pathname.new('/usr/local/bin')
       @rel_path = Pathname.new('usr/local/bin')
       @trl_path = Pathname.new('/usr/local/bin/')
       @mul_path = Pathname.new('/usr/local/lib/local/lib')
       @rul_path = Pathname.new('usr/local/lib/local/lib')
       @url_path = Pathname.new('file:///foo%20bar/baz')
-      @cur_path = Pathname.new(Dir.pwd)
+      @cur_path = Pathname.new(@@pwd)
 
       @abs_array = []
       @rel_array = []
@@ -65,7 +72,7 @@ class TC_Pathname < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.6.1', Pathname::VERSION)
+      assert_equal('1.6.2', Pathname::VERSION)
    end
 
    def test_file_url_path
@@ -74,7 +81,7 @@ class TC_Pathname < Test::Unit::TestCase
 
    def test_realpath
       assert_respond_to(@abs_path, :realpath)
-      assert_equal(@pwd, Pathname.new('.').realpath)
+      assert_equal(@@pwd, Pathname.new('.').realpath)
       assert_kind_of(Pathname, Pathname.new('/dev/stdin').realpath)
       assert(Pathname.new('/dev/stdin') != Pathname.new('/dev/stdin').realpath)
       if CONFIG['host_os'] =~ /bsd|darwin|mac/i
@@ -212,46 +219,27 @@ class TC_Pathname < Test::Unit::TestCase
       assert_non_destructive
    end
 
-   def test_children
+   def test_children_with_directory
       assert_respond_to(@cur_path, :children)
       assert_nothing_raised{ @cur_path.children }
       assert_kind_of(Array, @cur_path.children)
-
-      # Delete Eclipse related files
-      children = @cur_path.children
-      children.delete_if{ |e| File.basename(e) == 'CVS' }
-      children.delete_if{ |e| File.basename(e) == '.cvsignore' }
-      children.delete_if{ |e| File.basename(e) == '.project' }
-
-      assert_equal(
-         [
-            Dir.pwd + '/CHANGES',
-            Dir.pwd + '/MANIFEST',
-            Dir.pwd + '/README',
-            Dir.pwd + '/Rakefile',
-            Dir.pwd + '/examples',
-            Dir.pwd + '/ext',
-            Dir.pwd + '/lib',
-            Dir.pwd + '/pathname2.gemspec',
-            Dir.pwd + '/test'
-         ],
-         children.sort
-      )
-
-      # Delete Eclipse related files
-      children = @cur_path.children(false)
-      children.delete('CVS')
-      children.delete('.cvsignore')
-      children.delete('.project')
-
+      
+      children = @cur_path.children.sort.reject{ |f| f.include?('CVS') }
       assert_equal(
          [
-            'CHANGES', 'MANIFEST', 'README', 'Rakefile', 'examples', 'ext',
-            'lib', 'pathname2.gemspec', 'test'
+            Dir.pwd + '/test_pathname.rb',
+            Dir.pwd + '/test_pathname_windows.rb'
          ],
          children.sort
       )
    end
+   
+   def test_children_without_directory
+      assert_nothing_raised{ @cur_path.children(false) }
+         
+      children = @cur_path.children(false).reject{ |f| f.include?('CVS') }
+      assert_equal(['test_pathname.rb', 'test_pathname_windows.rb'], children.sort)
+   end
 
    def test_unc
       assert_raises(NotImplementedError){ @abs_path.unc? }
@@ -388,6 +376,25 @@ class TC_Pathname < Test::Unit::TestCase
       assert_non_destructive
    end
 
+   def test_dirname_basic
+      assert_respond_to(@abs_path, :dirname)
+      assert_nothing_raised{ @abs_path.dirname }
+      assert_kind_of(String, @abs_path.dirname)
+   end
+
+   def test_dirname
+      assert_equal('/usr/local', @abs_path.dirname)
+      assert_equal('/usr/local/bin', @abs_path.dirname(0))
+      assert_equal('/usr/local', @abs_path.dirname(1))
+      assert_equal('/usr', @abs_path.dirname(2))
+      assert_equal('/', @abs_path.dirname(3))
+      assert_equal('/', @abs_path.dirname(9))
+   end
+
+   def test_dirname_expected_errors
+      assert_raise(ArgumentError){ @abs_path.dirname(-1) }
+   end
+
    def test_facade_io
       assert_respond_to(@abs_path, :foreach)
       assert_respond_to(@abs_path, :read)
@@ -448,8 +455,13 @@ class TC_Pathname < Test::Unit::TestCase
       assert_equal('/foo', pn{'/foo'})
    end
    
+   def test_pwd_singleton_method
+      assert_respond_to(Pathname, :pwd)
+      assert_kind_of(String, Pathname.pwd)
+      assert_equal(@@pwd, Pathname.pwd)      
+   end
+   
    def teardown
-      @pwd      = nil
       @abs_path = nil
       @rel_path = nil
       @trl_path = nil
@@ -465,4 +477,8 @@ class TC_Pathname < Test::Unit::TestCase
       @abs_array.clear
       @rel_array.clear
    end
+
+   def self.shutdown
+      @@pwd = nil
+   end
 end

data/test/test_pathname_windows.rb

@@ -60,7 +60,7 @@ class TC_Pathname_MSWin < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("1.6.1", Pathname::VERSION)
+      assert_equal('1.6.2', Pathname::VERSION)
    end
 
    # Convenience method for test_plus

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pathname2
 version: !ruby/object:Gem::Version 
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-08 00:00:00 -07:00
+date: 2009-08-04 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,9 +20,19 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.0
+        version: 1.0.4
     version: 
-description: An alternate implementation of the Pathname class
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+description: "      The pathname2 library provides an implementation of the Pathname\n      class different from the one that ships as part of the Ruby standard\n      library. It is a subclass of String, though several methods have been\n      overridden to better fit a path context. In addition, it supports file\n      URL's as paths, provides additional methods for Windows paths, and\n      handles UNC paths on Windows properly. See the README file for more\n      details.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -33,15 +43,19 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files: 
+- benchmarks/bench_pathname.rb
+- benchmarks/bench_plus.rb
+- examples/example_pathname.rb
 - lib/pathname2.rb
-- CHANGES
-- MANIFEST
-- Rakefile
-- README
 - test/test_pathname.rb
 - test/test_pathname_windows.rb
+- README
+- CHANGES
+- MANIFEST
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -62,9 +76,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: shards
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: An alternate implementation of the Pathname class
 test_files: 
 - test/test_pathname.rb

data/Rakefile

@@ -1,32 +0,0 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-desc "Install pathname2 library (non-gem)"
-task :install do
-   cp 'lib/pathname2.rb', Config::CONFIG['sitelibdir']
-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.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/test_pathname.rb']
-   end
-end
-
-desc "Run the benchmark suite"
-task :benchmark do
-   sh 'ruby -Ilib examples/bench_pathname.rb'
-end