pathname2 1.8.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ceebdb160d9cff955f151ea0dfc7d4bcdb9712aaa704a8da7c9313049cea9b
-  data.tar.gz: 9395e28af5ba15511e1438e3aa03de96a1cf60aa85c0444b5d602fd6f73546b8
+  metadata.gz: 60bcd738b7fad0467fcfb58b1b388ed6ac4887d70658774c1560b39465eaa143
+  data.tar.gz: 3c9f9c5e5642e4a0ea514a8f6d416a987b74e7ef69443b502a4b706298fe5420
 SHA512:
-  metadata.gz: 3d6f7a5782967efe3352ed26af74e48b73a321bc13cd01855d413577e9f97d1146e54a2c4562e6928c3dd6f4d6a066118e7f12af1a82f97e15f3cddd9048f5ff
-  data.tar.gz: 137597451e32bb50a4d13ed9a8e3d5e1fe497968e2bf1c917aa0ba20145c560a211ed64f1b230ea2a552ee79688d86431a02cdcbf933aeb9c051813b6d7b9527
+  metadata.gz: 4a1ef3a4b5932b7482fecc28809f8281059d5081c93004da2bc93d1f34666bd6db2b8d4a6a7a237ba878c40143622ddb7388b6fb2e915639a5ff697720d408b6
+  data.tar.gz: 6c3472bb068e00671398a1f6be05fa528f30c18de5dd770f7b7d72e3352e1c2e57666abef1d347d7d148d3a2b35112b4e19e18be781037c762e57db786a9d228

data/{CHANGES → CHANGES.md}

@@ -1,51 +1,63 @@
-== 1.8.3 - 30-Aug-2020
+## 2.0.0 - 29-Nov-2025
+* Pathname has been renamed Pathname2, so it's no longer competing for the
+  same constant name as the stdlib vedrsion. Recent versions of Ruby simply
+  weren't allowing it, and this is probably the better way to go anyway.
+* Added addressable as a dependency since the stdlib uri library is a constant
+  source of warnings.
+
+## 1.8.4 - 19-Jan-2021
+* Cleaned up the Rubocop warnings.
+* Added a Gemfile.
+* Some minor updates to the gemspec and Rakefile.
+
+## 1.8.3 - 30-Aug-2020
 * Updated the tests to match the version. Thanks go to Cédric Boutillier for the spot.
 * Fixed a redefinition warning for the :children method.
 * Fixed a Fixnum deprecation warning.
 
-== 1.8.2 - 21-Jul-2020
+## 1.8.2 - 21-Jul-2020
 * Added a LICENSE file as required by the Apache-2.0 license.
 
-== 1.8.1 - 31-Jan-2019
+## 1.8.1 - 31-Jan-2019
 * The VERSION constant is now frozen.
 * Added metadata to the gemspec.
 * Fixed missing hyphen in license name.
 * Updated cert, should be good for about 10 years.
 
-== 1.8.0 - 19-Jun-2016
+## 1.8.0 - 19-Jun-2016
 * Changed license to Apache-2.0.
 * Some cleanup and updates to the Rakefile and benchmarks.
 * Refactored some realpath tests so they're not touching system files like
   /dev/stdin any more. Thanks go to Michael R. Crusoe for pointing out the
   potential pitfalls of doing that.
 
-== 1.7.4 - 7-Sep-2015
+## 1.7.4 - 7-Sep-2015
 * This gem is now signed.
 * Rakefile now assumes Rubygems 2.x for some tasks.
 
-== 1.7.3 - 24-Apr-2014
+## 1.7.3 - 24-Apr-2014
 * The basename and dirname methods now return Pathname objects.
 
-== 1.7.2 - 23-Apr-2014
+## 1.7.2 - 23-Apr-2014
 * The join and expand_path methods now return Pathname objects.
 
-== 1.7.1 - 28-Mar-2014
+## 1.7.1 - 28-Mar-2014
 * Updated gemspec for Windows vs Unix.
 * Updated README and MANIFEST.
 
-== 1.7.0 - 28-Mar-2014
+## 1.7.0 - 28-Mar-2014
 * Windows now uses FFI internally instead of win32-api.
 * Added a custom pretty_print method for the pp library.
 * Reorganized the test suite for Windows, and added many
   more test tasks to the Rakefile.
 
-== 1.6.5 - 19-Sep-2011
+## 1.6.5 - 19-Sep-2011
 * Added the String#to_path instance method. This returns a Pathname
   object.
 * The architecture for the Windows gem is now "universal", and some
   gemspec dependencies were simplified.
 
-== 1.6.4 - 20-Jan-2011
+## 1.6.4 - 20-Jan-2011
 * Explicitly remove the Pathname const if it is already defined in order
   to avoid a superclass mismatch error. This library assumes that if you
   require pathname2, you want my version of the Pathname class.
@@ -54,13 +66,13 @@
 * Some Rakefile and gemspec tweaks.
 * Some updates to the test suite, including some specifically for Windows 7.
 
-== 1.6.3 - 2-Oct-2009
+## 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
+## 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).
@@ -70,14 +82,14 @@
 * Now compatible with Ruby 1.9.x.
 * Bumped required version of the facade library to 1.0.4.
 
-== 1.6.1 - 8-Nov-2008
+## 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
+## 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.
@@ -90,7 +102,7 @@
 * Changed platform checking to use rbconfig instead of RUBY_PLATFORM to avoid
   potential issues with other Ruby implementation.
 
-== 1.5.2 - 9-Mar-2007
+## 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.
@@ -102,7 +114,7 @@
 * 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
+## 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.
@@ -111,33 +123,33 @@
 * 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
+## 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
+## 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
+## 1.4.3 - 3-Mar-2006
 * Added the Pathname#realpath method.
 
-== 1.4.2 - 22-Feb-2006
+## 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
+## 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
+## 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
@@ -151,26 +163,26 @@
 * Added the bench_pathname.rb script to let you benchmark all Pathname
   methods.
 
-== 1.3.1 - 21-Nov-2005
+## 1.3.1 - 21-Nov-2005
 * Added the Pathname#children method.
 * Added tests for the Pathname#children method.
 
-== 1.3.0 - 28-Oct-2005
+## 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
+## 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
+## 1.2.0 - 29-Aug-2005
 * Added the 'ascend' and 'descend' methods.
 * Added corresponding test suite additions.
 
-== 1.1.0 - 13-Jul-2005
+## 1.1.0 - 13-Jul-2005
 * Added the 'find' facade.
 
-== 1.0.0 - 11-Jun-2005
+## 1.0.0 - 11-Jun-2005
 * Initial release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/{MANIFEST → MANIFEST.md}

@@ -1,15 +1,16 @@
-* CHANGES
+* CHANGES.md
+* Gemfile
 * LICENSE
-* MANIFEST
+* MANIFEST.md
 * Rakefile
-* README
+* README.md
 * pathname2.gempsec
 * benchmarks/bench_all.rb
 * benchmarks/bench_plus.rb
 * certs/djberg96_pub.pem
-* examples/example_pathname.rb
+* examples/example_pathname2.rb
 * lib/pathname2.rb
-* test/test_pathname.rb
+* test/test_pathname2.rb
 * test/test_version.rb
 * test/windows/test_append.rb
 * test/windows/test_aref.rb

data/README.md

@@ -0,0 +1,104 @@
+[![Ruby](https://github.com/djberg96/pathname2/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/pathname2/actions/workflows/ruby.yml)
+
+## Description
+A drop-in replacement for the current Pathname class.
+
+## Prerequisites
+* facade
+* ffi (Windows only)
+* test-unit (testing only)
+   
+## Installation
+`gem install pathname2`
+
+## Adding the Trusted Cert
+
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/pathname2/main/certs/djberg96_pub.pem)`
+
+## Synopsis
+```ruby
+require 'pathname2'
+
+# Unix
+path1 = Pathname.new("/foo/bar/baz")
+path2 = Pathname.new("../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 = Pathname.new("C:/foo/bar/baz")
+path2 = Pathname.new("../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
+On MS Windows, some methods may not work on pathnames greater than 260
+characters because of internal function limitations.
+   
+Any issues you find should be reported on the project page at
+https://github.com/djberg96/pathname2
+
+## Future Plans
+None at this time. Suggestions welcome.
+   
+## License
+Apache-2.0
+   
+## Copyright
+(C) 2003-2021 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