pathname2 1.8.3 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ceebdb160d9cff955f151ea0dfc7d4bcdb9712aaa704a8da7c9313049cea9b
-  data.tar.gz: 9395e28af5ba15511e1438e3aa03de96a1cf60aa85c0444b5d602fd6f73546b8
+  metadata.gz: fddfb413b9216b72763294f0f0a96c4152136d1f260950689dedd19487d54c51
+  data.tar.gz: 624d9bd2f4a9d268e07576437cc8c759e324b4408fb4b845fc2c6a2cf251e4ec
 SHA512:
-  metadata.gz: 3d6f7a5782967efe3352ed26af74e48b73a321bc13cd01855d413577e9f97d1146e54a2c4562e6928c3dd6f4d6a066118e7f12af1a82f97e15f3cddd9048f5ff
-  data.tar.gz: 137597451e32bb50a4d13ed9a8e3d5e1fe497968e2bf1c917aa0ba20145c560a211ed64f1b230ea2a552ee79688d86431a02cdcbf933aeb9c051813b6d7b9527
+  metadata.gz: 68336850d8d55086487fd8a0677ec6193d390f32be805acb9c3b3630242d09662969bf1aae86b568e6d03d4c67a8da8e5d0f2418b465ceaa7b2d7abc31a089d9
+  data.tar.gz: 18997962fbefd926afbd7f57f10fc61bab6dcfc8857fd72cba6f1479ae9b2c91cb910eb40bd49f7b9d8e413905abd750b6199d250ae7ff31edd2fbfda4a1725e

data/{CHANGES → CHANGES.md}

@@ -1,51 +1,56 @@
-== 1.8.3 - 30-Aug-2020
+## 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 +59,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 +75,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 +95,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 +107,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 +116,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 +156,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,3 @@
+source 'https://rubygems.org' do
+  gemspec
+end

data/{MANIFEST → MANIFEST.md}

@@ -1,8 +1,9 @@
-* CHANGES
+* CHANGES.md
+* Gemfile
 * LICENSE
-* MANIFEST
+* MANIFEST.md
 * Rakefile
-* README
+* README.md
 * pathname2.gempsec
 * benchmarks/bench_all.rb
 * benchmarks/bench_plus.rb

data/README.md

@@ -0,0 +1,98 @@
+## Description
+A drop-in replacement for the current Pathname class.
+
+## Prerequisites
+* facade
+* ffi (Windows only)
+* test-unit (testing only)
+   
+## Installation
+`gem install pathname2`
+
+## 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

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
 
-CLEAN.include("**/*.gem", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
 
 namespace :gem do
   desc "Build the pathname2 gem"

data/lib/pathname2.rb

@@ -64,10 +64,10 @@ class Pathname < String
     :chdir, :entries, :glob, :foreach, :mkdir, :open, :children
   ]
 
-  private
-
   alias :_plus_ :+ # Used to prevent infinite loops in some cases
 
+  protected :_plus_
+
   if File::ALT_SEPARATOR
     extend FFI::Library
     ffi_lib :shlwapi
@@ -88,12 +88,17 @@ class Pathname < String
 
     attach_function :GetLongPathNameW, [:buffer_in, :buffer_out, :ulong], :ulong
     attach_function :GetShortPathNameW, [:buffer_in, :pointer, :ulong], :ulong
+
+    private_class_method :PathAppendW, :PathCanonicalizeW, :PathCreateFromUrlW
+    private_class_method :PathGetDriveNumberW, :PathIsRelativeW, :PathIsRelativeW
+    private_class_method :PathIsRootW, :PathIsUNCW, :PathIsURLW, :PathRemoveBackslashW
+    private_class_method :PathStripToRootW, :PathUndecorateW, :GetLongPathNameW, :GetShortPathNameW
   end
 
   public
 
   # The version of the pathname2 library
-  VERSION = '1.8.3'.freeze
+  VERSION = '1.8.4'.freeze
 
   # The maximum length of a path
   MAXPATH = 1024 unless defined? MAXPATH # Yes, I willfully violate POSIX
@@ -809,7 +814,7 @@ class Pathname < String
     raise ArgumentError if level < 0
     local_path = self.dup
 
-    level.times{ |n| local_path = File.dirname(local_path) }
+    level.times{ local_path = File.dirname(local_path) }
     self.class.new(local_path)
   end
 
@@ -854,8 +859,8 @@ class Pathname < String
   # If +self+ is ".", yielded pathnames begin with a filename in the current
   # current directory, not ".".
   #
-  def find(&block)
-    require "find"
+  def find
+    require 'find'
     if self == "."
       Find.find(self){ |f| yield self.class.new(f.sub(%r{\A\./}, '')) }
     else
@@ -1119,11 +1124,13 @@ module Kernel
     instance_eval{ Pathname.new(yield) }
   end
 
+  # rubocop:disable Lint/ShadowedException
   begin
     remove_method(:Pathname)
   rescue NoMethodError, NameError
     # Do nothing, not defined.
   end
+  # rubocop:enable Lint/ShadowedException
 
   # Synonym for Pathname.new
   #

data/pathname2.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name        = 'pathname2'
-  spec.version     = '1.8.3'
+  spec.version     = '1.8.4'
   spec.author      = 'Daniel J. Berger'
   spec.license     = 'Apache-2.0'
   spec.email       = 'djberg96@gmail.com'
@@ -11,8 +11,6 @@ Gem::Specification.new do |spec|
   spec.files       = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain  = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
-
   spec.add_dependency('facade')
   spec.add_development_dependency('test-unit')
   spec.add_development_dependency('rake')
@@ -20,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/pathname2',
     'bug_tracker_uri'   => 'https://github.com/djberg96/pathname2/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/pathname2/blob/ffi/CHANGES',
+    'changelog_uri'     => 'https://github.com/djberg96/pathname2/blob/ffi/CHANGES.md',
     'documentation_uri' => 'https://github.com/djberg96/pathname2/wiki',
     'source_code_uri'   => 'https://github.com/djberg96/pathname2',
     'wiki_uri'          => 'https://github.com/djberg96/pathname2/wiki'
@@ -28,10 +26,10 @@ Gem::Specification.new do |spec|
 
   if File::ALT_SEPARATOR
     spec.add_dependency('ffi')
-    spec.test_files = FileList['test/windows/*.rb', 'test/test_version.rb']
+    spec.test_files = Dir['test/windows/*.rb', 'test/test_version.rb']
     spec.platform = Gem::Platform.new(['universal', 'mingw32'])
   else
-    spec.test_files = FileList['test/test_pathname.rb', 'test/test_version.rb']
+    spec.test_files = Dir['test/test_pathname.rb', 'test/test_version.rb']
   end
 
   spec.description = <<-EOF

data/test/test_version.rb

@@ -8,7 +8,7 @@ require 'test-unit'
 
 class TC_Pathname_Version < Test::Unit::TestCase
   test "version is set to expected value" do
-    assert_equal('1.8.3', Pathname::VERSION)
+    assert_equal('1.8.4', Pathname::VERSION)
   end
 
   test "version is frozen" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pathname2
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.4
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -90,10 +90,7 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
 - LICENSE
 - test
@@ -129,10 +126,9 @@ files:
 - test/windows/test_to_a.rb
 - test/test_version.rb
 - pathname2.gemspec
-- CHANGES
-- MANIFEST
-- README
+- README.md
 - Rakefile
+- MANIFEST.md
 - certs
 - certs/djberg96_pub.pem
 - examples
@@ -142,13 +138,15 @@ files:
 - benchmarks/bench_plus.rb
 - lib
 - lib/pathname2.rb
+- Gemfile
+- CHANGES.md
 homepage: https://github.com/djberg96/pathname2
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/pathname2
   bug_tracker_uri: https://github.com/djberg96/pathname2/issues
-  changelog_uri: https://github.com/djberg96/pathname2/blob/ffi/CHANGES
+  changelog_uri: https://github.com/djberg96/pathname2/blob/ffi/CHANGES.md
   documentation_uri: https://github.com/djberg96/pathname2/wiki
   source_code_uri: https://github.com/djberg96/pathname2
   wiki_uri: https://github.com/djberg96/pathname2/wiki
@@ -167,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: An alternate implementation of the Pathname class

data/README

@@ -1,97 +0,0 @@
-== Description
-  A drop-in replacement for the current Pathname class.
-
-== Prerequisites
-  * facade
-  * ffi (Windows only)
-  * test-unit (testing only)
-   
-== Installation
-
-  gem install pathname2
-
-== Synopsis
-  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
-  Suggestions welcome.
-   
-== License
-  Apache-2.0
-   
-== Copyright
-  (C) 2003-2020 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