file-find 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68ea64b77319de8fe9035272d2fb5f3f62053fac3436412f377aa8d784a9e325
-  data.tar.gz: 1f719308185c8dd79c6074441b9333f3b151ed1d467f79fdb25d66d96eaa3353
+  metadata.gz: f6a005f38ff57e7ecba774576e6d8d8c005a386b50ec65197c4047cdd156d876
+  data.tar.gz: 50c000e4e15dd13bdab23fc396d0062ccc5392efd808036cc3df0a512f6ced50
 SHA512:
-  metadata.gz: c291ffb114be00097a9d45298dc0b5ddc5ae2b749cc0aaaab2880c97724be80cc8ceea4400220aaa9416cb7c84b10ebb57a0b142dd8221cfef573461e922aae6
-  data.tar.gz: 47a283df9c87c82be58ec18912e96b72b3659ba0c806738beb9a8a562e56c57ae26c05b6162c530a641c937c1e15710888f3974b6dde6dfe67078e4901a467b6
+  metadata.gz: '09d5c030c2312a89f03c21a69578ab08d437890151f943f37ebcf27cd62d51fb42694f833605207afbf8c2e6aeb2a7d852f9373a6bc251b5336d0933b6a0f082'
+  data.tar.gz: c2c7b029ba2fdf2ea2760e84ee5600ef5fa1670922d01924773688854edb9a7e2eee6b32581c25861ff5095c984c53ec86ffa54e7f4b71a3fda73d7dca732a26

data/{CHANGES → CHANGES.md}

@@ -1,16 +1,36 @@
-== 0.4.0 - 26-Dec-2018
+## 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
+* Added LICENSE file as required by the Apache-2.0 license.
+
+## 0.4.1 - 23-Jan-2019
+* Added metadata to the gemspec.
+
+## 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
@@ -20,27 +40,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
@@ -49,35 +69,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.
@@ -86,23 +106,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,3 @@
+source 'https://rubygems.org' do
+  gemspec
+end

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/{MANIFEST → MANIFEST.md}

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

data/README.md

@@ -0,0 +1,109 @@
+## 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
+
+`gem install file-find`
+
+## Synopsis
+```ruby
+  require 'file/find' # 'file-find' also works
+
+  rule = File::Find.new(
+    :pattern => "*.rb",
+    :follow  => false,
+    :path    => ['/usr/local/lib', '/opt/local/lib']
+  )
+
+  rule.find{ |f|
+    puts f
+  }
+```
+
+## 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
+
+* atime
+* ctime
+* follow
+* ftype
+* inum
+* group (name or id)
+* maxdepth
+* mindepth
+* mount
+* mtime
+* name (or 'pattern')
+* path
+* perm
+* prune
+* 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.
+
+See the documentation for more details about these options.
+
+## 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
+
+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
+supported. These include the following options:
+
+* acl/xattr - Way too difficult to implement in a cross platform manner, and
+  a rarely used option in practice.
+
+* cpio/ncpio - I will not shell out to this or any other 3rd party
+  application.
+
+* ls/print - Use Ruby's builtin printing methods to print as you see fit.
+
+* ok - This is not interactive software.
+
+## Known Issues
+
+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.
+
+## 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
+
+* 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
+
+Apache-2.0
+
+## Copyright
+
+(C) 2007-2021, Daniel J. Berger, All Rights Reserved
+
+## Author
+
+Daniel J. Berger