file-find 0.4.4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d99bb72ba56fc51995a186e6f06869318c1f29b1965d49d8aa42853aa341bf57
-  data.tar.gz: c04db8e76c5a4ab4f953a373a6d089379cf4f99064ec18883a70ed7db1d82963
+  metadata.gz: f1b89ade1ff89a891f6aa2a44fa801fa9d2758b3784074f8868a5b3319dc68a5
+  data.tar.gz: 52f17946eb45f73bd98b0804a9696e5e4d7c2f17d9ea002a20fa109fde7e10f3
 SHA512:
-  metadata.gz: bac0f7a26c507ae51dd15a19611bb0af91f43a93a717cf32a0c6787b244abb4680b8b12372525b51635696a4aa2c11f312107c1374c16f5f891c7d53cba111d8
-  data.tar.gz: d27462d46d37ad567c9d7eaa29cadd7962e08066850d75a4b35983feb0a81a03ad63e224b10348099da0ffe74992b4604a576099dd1fde4f81f401d678d9baf5
+  metadata.gz: e6d0e1a56de403c2e7327f2d9af3ec6c68528d53f0cb0b83e40362b1ab8dddda020212cc726428ea0791130c098c1a41f53f22a65fad314d8dd9fee05fdc7fa3
+  data.tar.gz: 6c68a1b0e85905844b44feb04036834bb39e3ccaff5b732bb64d6280bb3eb86248f92f74570e60d37704fbc4d42ea4f99f2406c6d4be61ce7c9a8e3f89f1f1bb

checksums.yaml.gz.sig

@@ -1,6 +1 @@
-h��߼�ɢϵ�g�Ï���o��($����>�u��J����D'���� ���nO�am� ����>�)��z+������?ސ����^O��"Ѫ	>v�d�O&��^�_9��/����:;µu
-xߎ\���Iv2�U��
-~��ẖq���B9AH�麋EPu�i��w3��楚2�M��Ӆ�>k�(�?��2��	�$y�j�Gu]�0J�z���#�,�'>�
-��9���'�~��RJE}�8{'�λ[�*ߗ
-b����۳w��X{�ţ;xE�%
-�9po�'���� k	e~�Oi��Nۡ��@,����HsV�nJj�w��uD
+]����j
��]i�<ǝ�ٲ�Ԕ�X�|sN��l�!ʋ��TT�%wtF�W�8�g�s�]����Էâ�g�Z
!1y`���|���."qe'V�?���$W�n���)��RNf�ʍ��ޠ�2���qiN�6_��Si^/q��A?�~��Θ����=$�O�"���-���VB���$����|�����xc����פ6h�WZnc��{�P���ܲ0��w����N]�/:ݧ%����:�ω�#��O��.�X�D2+��o`V��9�D؀.㫐���>d���p�_2@t�6�ԧ���S·�=�ea1$-T��3|_��woP��BJ��g|�P�x�au��l���a�T�3��5�x.��5��_�

data/{CHANGES.rdoc → CHANGES.md}

@@ -1,25 +1,44 @@
-== 0.4.3 - 8-Jun-2020
+## 0.5.1 - 17-Jun-2025
+* Updated, fixed or skipped some specs on Windows.
+* Some rubocop cleanup and minor refactors.
+* Added a github workflow matrix to the repo.
+* Added a rubocop config to the repo.
+* Minor tweaks to the Rakefile.
+* Added more information to the README.
+
+## 0.5.0 - 19-Jan-2021
+* Switched from test-unit to rspec, with an added development
+  dependency on the fakefs gem.
+* Switched from rdoc to markdown because github doesn't render rdoc
+  properly any more.
+* Fixed a bug in the maxdepth option with root paths.
+* Added a Gemfile.
+
+## 0.4.4 - 6-Aug-2020
+* Added .rdoc extensions to the CHANGES, README and MANIFEST files.
+
+## 0.4.3 - 8-Jun-2020
 * Fixed a bug with ELOOP handling. Thanks go to joast for the spot and fix.
 
-== 0.4.2 - 6-May-2020
+## 0.4.2 - 6-May-2020
 * Added LICENSE file as required by the Apache-2.0 license.
 
-== 0.4.1 - 23-Jan-2019
+## 0.4.1 - 23-Jan-2019
 * Added metadata to the gemspec.
 
-== 0.4.0 - 26-Dec-2018
+## 0.4.0 - 26-Dec-2018
 * License changed to Apache-2.0.
 * Fixed a bug where mindepth and maxdepth would break if more than one
   path was specified as part of the rule. Thanks go to flagos for the spot.
 * The VERSION constant is now frozen.
 * The cert has been updated.
 
-== 0.3.9 - 16-Dec-2015
+## 0.3.9 - 16-Dec-2015
 * This gem is now signed.
 * Added a file-find.rb file for convenience.
 * Updates to the Rakefile and gemspec.
 
-== 0.3.8 - 12-Feb-2014
+## 0.3.8 - 12-Feb-2014
 * Removed all references to the Etc module since the sys-admin library now uses
   FFI and works with JRuby.
 * The :user, :group, and :inum options will now work on MS Windows if you have
@@ -29,27 +48,27 @@
 * Some tests that were previously omitted on Windows are now included.
 * Updates to the test suite, readme, etc.
 
-== 0.3.7 - 15-Jan-2014
+## 0.3.7 - 15-Jan-2014
 * Fixed a bug with brackets in the path name. Thanks go to Jeremy Lawler
   for the spot and the patch.
 
-== 0.3.6 - 6-Sep-2013
+## 0.3.6 - 6-Sep-2013
 * Removed rbconfig from library and test file. Just use File::ALT_SEPARATOR
   to check for Windows instead.
 * Removed unused variables.
 * Updated dev dependencies.
 
-== 0.3.5 - 15-Jul-2011
+## 0.3.5 - 15-Jul-2011
 * Fixed a bug with the :follow option.
 * Gemspec, Rakefile and test cleanup.
 
-== 0.3.4 - 19-Sep-2009
+## 0.3.4 - 19-Sep-2009
 * Fixed a packaging bug. Thanks go to Gabriel Horner for the spot.
 * Added the 'gem' task to the Rakefile for building the gem. Removed the
   gem builder code that was in the gemspec itself.
 * Updated the dependency for sys-admin to 1.5.2.
 
-== 0.3.3 - 3-Aug-2009
+## 0.3.3 - 3-Aug-2009
 * Now compatible with Ruby 1.9.x.
 * Added support for the :links option
 * Updated the :mount accessor to work properly if the value is changed
@@ -58,35 +77,35 @@
 * Added a fuller description to the gemspec.
 * Minor test refactoring.
 
-== 0.3.2 - 20-Feb-2009
+## 0.3.2 - 20-Feb-2009
 * Added support for the :mount option.
 * Added some basic tests for the :mount option.
 
-== 0.3.1 - 9-Jan-2009
+## 0.3.1 - 9-Jan-2009
 * Now defaults to using Etc instead of Sys::Admin for implementations
   that don't support building C extensions, e.g. JRuby.
 * Updated the test suite to work with JRuby.
 * Minor optimizations for symbolic perms and atime/ctime/mtime checks.
   Thanks go in part to Ryan Davis' flay library.
 
-== 0.3.0 - 30-Dec-2008
+## 0.3.0 - 30-Dec-2008
 * Added support for FileTest operations. All options passed to the constructor
   that end with '?' are now validated and treated as FileTest operations.
 
-== 0.2.5 - 29-Dec-2008
+## 0.2.5 - 29-Dec-2008
 * Added maxdepth and mindepth support.
 * Added a 'clean' rake task to cleanup any test-unit results files.
 
-== 0.2.4 - 10-Dec-2008
+## 0.2.4 - 10-Dec-2008
 * Added support for symbolic permissions. Thanks go to Bill Kleb for the
   suggestion and to Hal Fulton for providing the solution.
 
-== 0.2.3 - 25-Nov-2008
+## 0.2.3 - 25-Nov-2008
 * Added mtime support. My previous concerns, which I believe stemmed from
   the find(2) man page on Solaris 10 with regards to atime checks modifying
   the mtime, appear have been unfounded.
 
-== 0.2.2 - 19-Nov-2008
+## 0.2.2 - 19-Nov-2008
 * The :user and :group options now accept a name or a numeric id. Thanks go
   to Bill Kleb for the suggestion.
 * Fixed yet another path bug for MS Windows.
@@ -95,23 +114,23 @@
 * Added sys-admin and test-unit as prerequisites.
 * Added tests for the :user and :group options.
 
-== 0.2.1 - 4-Oct-2007
+## 0.2.1 - 4-Oct-2007
 * Added the File::Find#previous method, which lets you see the previous
   match, if any.
 * Path name bug fix for MS Windows.
 * Test suite bug fixes for MS Windows (perm test now skipped).
 * Inaccessible directories are now skipped instead of raising an error.
 
-== 0.2.0 - 26-Apr-2007
+## 0.2.0 - 26-Apr-2007
 * Fixed a bug where it was not traversing subdirectories.
 * Added support for the perm and prune options.
 
-== 0.1.1 - 25-Apr-2007
+## 0.1.1 - 25-Apr-2007
 * The default for name is now '*', i.e. everything.
 * Fixed a bug where directories were not matched. Thanks go to Leslie Viljoen
   for the spot.
 * The size option now accepts strings with comparable operators. For example,
   you can now look for files greater than 400 bytes with the string "> 400".
 
-== 0.1.0 - 24-Apr-2007
+## 0.1.0 - 24-Apr-2007
 * Initial release

data/Gemfile

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

data/{MANIFEST.rdoc → MANIFEST.md}

@@ -1,6 +1,7 @@
-* CHANGES
-* LICENSE
-* MANIFEST
+* CHANGES.md
+* Gemfile
+* LICENSE.md
+* MANIFEST.md
 * Rakefile
 * README
 * file-find.gemspec

data/{README.rdoc → README.md}

@@ -1,15 +1,25 @@
-= Description
+[![Ruby](https://github.com/djberg96/file-find/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/file-find/actions/workflows/ruby.yml)
+
+## Description
 
 This is a drop-in replacement for the find module currently in the standard
 library. It is modeled on a typical 'find' command found on most Unix systems.
 
-= Installation
+## Installation
+
+`gem install file-find`
 
-gem install file-find
+## Specs
 
-= Synopsis
+Although this gem will work with Ruby 2.x or 3.x, you will need Ruby 3.x to
+run the specs locally because of development dependencies.
 
-  require 'file/find'
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/file-find/main/certs/djberg96_pub.pem)`
+
+## Synopsis
+```ruby
+  require 'file/find' # 'file-find' also works
 
   rule = File::Find.new(
     :pattern => "*.rb",
@@ -20,15 +30,16 @@ gem install file-find
   rule.find{ |f|
     puts f
   }
+```
 
-= Rationale
+## Rationale
 
 The current find module in the standard library is inadequate. It is, quite
 frankly, not much more than a plain Dir.glob call. This library provides an
 interface based on options typically available on your command line 'find'
 command, thus allowing you much greater control over how you find your files.
 
-= Options
+## Options
 
 * atime
 * ctime
@@ -47,18 +58,18 @@ command, thus allowing you much greater control over how you find your files.
 * size
 * user (name or id)
 
-In addition to the above options, FileTest methods such as 'readable?' and
-'writable?' may be used as keys, with true or false for their values.
+In addition to the above options, `FileTest` methods such as `readable?` and
+`writable?` may be used as keys, with true or false for their values.
 
-See the RDoc documentation for more details about these options.
+See the documentation for more details about these options.
 
-= Future Plans
+## Future Plans
 
 None at this time. Please log any feature requests on the project page at:
 
 http://github.com/djberg96/file-find
 
-= Options I won't support
+## Options I won't support
 
 Generally speaking, anything that would require mucking around with C code
 or is just too difficult to implement in a cross platform manner will not be
@@ -74,35 +85,38 @@ supported. These include the following options:
 
 * ok - This is not interactive software.
 
-= Known Issues
+## Known Issues
+
+The `:perm` option is limited to 0644 and 0444 on MS Windows.
 
-The :perm option is limited to 0644 and 0444 on MS Windows.
+The `:user`, `:group`, and `:inum` options require the win32-file gem to work
+properly on MS Windows. However, win32-file is not officially a dependency.
 
-The :user, :group, and :inum options require the win32-file gem to work
-properly on MS Windows. However, it is not officially a dependency.
+Some specs on Windows are marked pending for now because there's some issue
+interacting with the FakeFS gem on Windows.
 
-= Bugs
+## Bugs
 
 None that I'm aware of beyond the ones mentioned in the Known Issues. Please
 log any bug reports on the project page at:
 
 http://github.com/djberg96/file-find
 
-= Acknowledgements
+## Acknowledgements
 
 * Richard Clamp's File::Find::Rule Perl module for additional ideas and
   inspiration.
 * Bill Kleb for ideas regarding name, group and perm enhancements.
 * Hal Fulton for his implementation of symbolic permissions.
 
-= License
+## License
 
 Apache-2.0
 
-= Copyright
+## Copyright
 
-(C) 2007-2020, Daniel J. Berger, All Rights Reserved
+(C) 2007-2025, Daniel J. Berger, All Rights Reserved
 
-= Author
+## Author
 
 Daniel J. Berger

data/Rakefile

@@ -1,16 +1,17 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-CLEAN.include("**/*.gem", "**/*.rbc", "**/link*")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/link*", "*.lock")
 
 namespace :gem do
   desc 'Create the file-find gem'
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('file-find.gemspec'))
+    spec = Gem::Specification.load('file-find.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the file-find gem"
@@ -21,10 +22,15 @@ namespace :gem do
   end
 end
 
-Rake::TestTask.new do |t|
-  task :test => 'clean'
-  t.warning = true
-  t.verbose = true
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = ['spec/file_find_spec.rb']
+end
+
+# Clean up afterwards
+Rake::Task[:spec].enhance do
+  Rake::Task[:clean].invoke
 end
 
-task :default => :test
+task :default => :spec

data/file-find.gemspec

@@ -2,30 +2,34 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'file-find'
-  spec.version    = '0.4.4'
+  spec.version    = '0.5.1'
   spec.author     = 'Daniel Berger'
   spec.license    = 'Apache-2.0'
   spec.summary    = 'A better way to find files'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/file-find'
-  spec.test_file  = 'test/test_file_find.rb'
+  spec.test_file  = 'spec/file_find_spec.rb'
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files  = ['README.rdoc', 'CHANGES.rdoc', 'MANIFEST.rdoc']
-
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/file-find',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/file-find/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/file-find/blob/master/CHANGES',
-    'documentation_uri' => 'https://github.com/djberg96/file-find/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/file-find',
-    'wiki_uri'          => 'https://github.com/djberg96/file-find/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/file-find',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/file-find/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/file-find/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://github.com/djberg96/file-find/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/file-find',
+    'wiki_uri'              => 'https://github.com/djberg96/file-find/wiki',
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/file-find',
+    'funding_uri'           => 'https://github.com/sponsors/djberg96'
   }
 
-  spec.add_dependency('sys-admin', '>= 1.6.0')
-  spec.add_development_dependency('test-unit')
+  spec.add_dependency('sys-admin', '~> 1.7')
+  spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('fakefs', '~> 3.0')
   spec.add_development_dependency('rake')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   spec.description = <<-EOF
     The file-find library provides a better, more object oriented approach

data/lib/file/find.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'sys/admin'
 
@@ -7,9 +9,11 @@ rescue LoadError
   # Do nothing, not required, just nicer.
 end
 
+# The File::Find class encapsulates 'rules' that you create and use to find
+# files on your filesystem.
 class File::Find
   # The version of the file-find library
-  VERSION = '0.4.4'.freeze
+  VERSION = '0.5.1'
 
   # :stopdoc:
   VALID_OPTIONS = %w[
@@ -31,7 +35,7 @@ class File::Find
     prune
     size
     user
-  ]
+  ].freeze
   # :startdoc:
 
   # The starting path(s) for the search. The default is the current directory.
@@ -209,6 +213,7 @@ class File::Find
   def find
     results = [] unless block_given?
     paths   = @path.is_a?(String) ? [@path] : @path # Ruby 1.9.x compatibility
+    queue   = paths.dup
 
     if @prune
       prune_regex = Regexp.new(@prune)
@@ -216,14 +221,16 @@ class File::Find
       prune_regex = nil
     end
 
-    paths.each{ |path|
+    # rubocop:disable Metrics/BlockLength
+    until queue.empty?
+      path = queue.shift
       begin
-        Dir.foreach(path){ |file|
+        Dir.foreach(path) do |file|
           next if file == '.'
           next if file == '..'
 
-          if prune_regex
-            next if prune_regex.match(file)
+          if prune_regex && prune_regex.match(file)
+            next
           end
 
           file = File.join(path, file)
@@ -241,8 +248,9 @@ class File::Find
             end
           end
 
-          # We need to escape any brackets in the directory name.
-          glob = File.join(File.dirname(file).gsub(/([\[\]])/,'\\\\\1'), @name)
+          # We need to escape any brackets in the directory name, unless already escaped.
+          temp = File.dirname(file).gsub(/(?<!\\)([\[\]])/, '\\\\\1')
+          glob = File.join(temp, @name)
 
           # Dir[] doesn't like backslashes
           if File::ALT_SEPARATOR
@@ -250,38 +258,32 @@ class File::Find
             glob.tr!(File::ALT_SEPARATOR, File::SEPARATOR)
           end
 
-          if @mount
-            next unless stat_info.dev == @filesystem
+          if @mount && stat_info.dev != @filesystem
+            next
           end
 
-          if @links
-            next unless stat_info.nlink == @links
+          if @links && stat_info.nlink != @links
+            next
           end
 
           if @maxdepth || @mindepth
-            file_depth = file.split(File::SEPARATOR).length
+            file_depth = file.split(File::SEPARATOR).reject(&:empty?).length
             current_base_path = [@path].flatten.find{ |tpath| file.include?(tpath) }
             path_depth = current_base_path.split(File::SEPARATOR).length
 
             depth = file_depth - path_depth
 
             if @maxdepth && (depth > @maxdepth)
-              if File.directory?(file)
-                unless paths.include?(file) && depth > @maxdepth
-                  paths << file
-                end
+              if File.directory?(file) && !(paths.include?(file) && depth > @maxdepth)
+                queue << file
               end
-
               next
             end
 
             if @mindepth && (depth < @mindepth)
-              if File.directory?(file)
-                unless paths.include?(file) && depth < @mindepth
-                  paths << file
-                end
+              if File.directory?(file) && !(paths.include?(file) && depth < @mindepth)
+                queue << file
               end
-
               next
             end
           end
@@ -289,8 +291,8 @@ class File::Find
           # Add directories back onto the list of paths to search unless
           # they've already been added
           #
-          if stat_info.directory?
-            paths << file unless paths.include?(file)
+          if stat_info.directory? && !paths.include?(file)
+            queue << file
           end
 
           next unless Dir[glob].include?(file)
@@ -298,7 +300,7 @@ class File::Find
           unless @filetest.empty?
             file_test = true
 
-            @filetest.each{ |array|
+            @filetest.each do |array|
               meth = array[0]
               bool = array[1]
 
@@ -306,7 +308,7 @@ class File::Find
                 file_test = false
                 break
               end
-            }
+            end
 
             next unless file_test
           end
@@ -330,8 +332,8 @@ class File::Find
             end
           end
 
-          if @ftype
-            next unless File.ftype(file) == @ftype
+          if @ftype && File.ftype(file) != @ftype
+            next
           end
 
           if @group
@@ -354,8 +356,8 @@ class File::Find
             end
           end
 
-          if @inum
-            next unless stat_info.ino == @inum
+          if @inum && stat_info.ino != @inum
+            next
           end
 
           # Note that only 0644 and 0444 are supported on MS Windows.
@@ -364,7 +366,7 @@ class File::Find
               octal_perm = sym2oct(@perm)
               next unless stat_info.mode & octal_perm == octal_perm
             else
-              next unless sprintf("%o", stat_info.mode & 07777) == sprintf("%o", @perm)
+              next unless format('%o', stat_info.mode & 07777) == format('%o', @perm)
             end
           end
 
@@ -414,11 +416,12 @@ class File::Find
           end
 
           @previous = file unless @previous == file
-        }
+        end
       rescue Errno::EACCES
         next # Skip inaccessible directories
       end
-    }
+    end
+    # rubocop:enable Metrics/BlockLength
 
     block_given? ? nil : results
   end
@@ -475,17 +478,17 @@ class File::Find
       match = cmd.match(regex)
       raise "Invalid symbolic permissions: '#{str}'" if match.nil?
 
-      who, what, how = match.to_a[1..-1]
+      who, what, how = match.to_a[1..]
 
-      who  = who.split(//).inject(0){ |num,b| num |= left[b]; num }
-      how  = how.split(//).inject(0){ |num,b| num |= right[b]; num }
+      who  = who.chars.inject(0){ |num, b| num | left[b] }
+      how  = how.chars.inject(0){ |num, b| num | right[b] }
       mask = who & how
 
       case what
         when '+'
-          perm = perm | mask
+          perm |= mask
         when '-'
-          perm = perm & ~mask
+          perm &= ~mask
         when '='
           perm = mask
       end

data/lib/file-find.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'file/find'