pathname2 1.6.3-x86-mswin32-60

data/CHANGES

@@ -0,0 +1,120 @@
+== 1.6.3 - 2-Oct-2009
+* Updated Windows platform handling code to include mingw and cygwin.
+* Added the :gem rake task.
+* Minor gemspec updates.
+* Some minor test suite updates.
+
+== 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).
+* Refactoring the platform checking in the test suite to use rbconfig instead
+  of RUBY_PLATFORM.
+* More inline documentation examples.
+
+== 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.
+* 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.
+* 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).
+
+== 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.
+* File URL's are now handled on Unix as well (using the 'uri' package).
+* Some comment changes/clarifications.
+* Added the PathnameError class to the pure Ruby version.
+
+== 1.4.4 - 23-Mar-2006
+* If the path is a symbolic link the Pathname#realpath method
+  now returns the absolute path of that link, i.e. the result
+  of File.readlink (as a Pathname object).
+
+== 1.4.3 - 3-Mar-2006
+* Added the Pathname#realpath method.
+
+== 1.4.2 - 22-Feb-2006
+* Fixed the Pathname#relative_path_from method for Windows.  This really only
+  affected edge cases that you probably never saw anyway.
+* Added corresponding tests for Windows.
+
+== 1.4.1 - 18-Feb-2006
+* Added the Pathname#parent method.
+* Added the Pathname#relative_path_from method.
+* Bug fix for Pathname#pstrip on *nix.
+* Corresponding test suite additions.
+
+== 1.4.0 - 19-Dec-2005
+* Added destructive and non-destructive methods for some methods - pstrip,
+  pstrip!, undecorate, undecorate!, clean and clean!.
+* Added a C extension version of this package.  You can use the C version
+  instead of the pure Ruby version instead.  See the README for more details.
+* Fixed bug in the root method where the result wasn't guaranteed to be a
+  Pathname class.
+* Fixed bugs in Windows version where the receiver was inadvertantly modified
+  in some cases, and added tests to check for this in the future.
+* Modified the Dir.glob facade so that it (temporarily) changes to the path
+  directory, globs on that path, then returns to the original directory.
+* Added the bench_pathname.rb script to let you benchmark all Pathname
+  methods.
+
+== 1.3.1 - 21-Nov-2005
+* Added the Pathname#children method.
+* Added tests for the Pathname#children method.
+
+== 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/MANIFEST

@@ -0,0 +1,11 @@
+* CHANGES
+* MANIFEST
+* Rakefile
+* README
+* pathname2.gempsec
+* benchmarks/bench_all.rb
+* benchmarks/bench_plus.rb
+* examples/example_pathname.rb
+* lib/pathname2.rb
+* test/test_pathname.rb
+* test/test_pathname_windows.rb

data/README

@@ -0,0 +1,109 @@
+== Description
+   A drop-in replacement for the current Pathname class.
+
+== Prerequisites
+   * Ruby 1.8.0 or later
+   * 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 library is only required on MS Windows.
+   
+== Installation, pure Ruby
+=== Manual Installation
+   rake test (optional)
+   rake install
+   
+=== Gem Installation
+   rake test (optional)
+   gem install pathname2-<version>.gem
+   
+== Installation, C extension
+   rake test_c (optional)
+   rake install_c
+
+== Synopsis
+   require "pathname2"
+
+   # Unix
+   path1 = "/foo/bar/baz"
+   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']
+
+   # Windows
+   path1 = "C:/foo/bar/baz"
+   path2 = "../zap"
+
+   path1 + path2 # "C:\\foo\\bar\\zap"
+   path1.root    # "C:\\"
+   path1.to_a    # ['C:','foo','bar','baz']
+
+== Windows Notes
+   All forward slashes are converted to backslashes for Pathname objects.
+
+== Differences between Unix and Windows
+   If your pathname consists solely of ".", or "..", the return
+   value for Pathname#clean will be different. On Win32, "\\" is returned,
+   while on Unix "." is returned.  I consider this an extreme edge case and
+   will not worry myself with it.
+
+== 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
+     with Windows path names very well, and not at all when it comes to UNC
+     paths.
+   * The Pathname#cleanpath method works differently - it always returns
+     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 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.
+   * 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, and
+   FileUtils, the priority is as follows:
+   
+   * File
+   * Dir
+   * FileUtils
+   
+   In other words, whichever of these defines a given method first is the
+   method that is used by the pathname2 library.
+   
+== Known Issues
+   In Ruby 1.8.3 and 1.8.4 you will see a failure in the test suite regarding
+   'fu_world_writable?' from FileUtils.  You can ignore this.  That method is
+   supposed to be private.  See ruby-core:7383.
+   
+   Any other issues should be reported on the project page at
+   http://www.rubyforge.org/projects/shards
+
+== Future Plans
+   Suggestions welcome.
+   
+== License
+   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
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+
+== Author
+   Daniel J. Berger

data/Rakefile

@@ -0,0 +1,41 @@
+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 'Build the pathname2 gem'
+task :gem do
+  spec = eval(IO.read('pathname2.gemspec'))
+  Gem::Builder.new(spec).build
+end
+
+desc "Install the pathname2 libarary as a gem"
+task :install_gem => [:gem] do
+   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|win32|dos|cygwin|mingw/i
+      t.test_files = FileList['test/test_pathname_windows.rb']
+   else
+      t.test_files = FileList['test/test_pathname.rb']
+   end
+end
+
+desc 'Run the Pathname benchmark suite'
+task :benchmark do
+   sh 'ruby -Ilib benchmarks/bench_pathname.rb'
+end
+
+desc 'Run the benchmark suite for Pathname#+ vs File.join'
+task :benchmark_plus do
+   sh 'ruby -Ilib benchmarks/bench_plus.rb'

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