file-find 0.2.4 → 0.2.5

data/CHANGES

@@ -1,3 +1,7 @@
+== 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
 * Added support for symbolic permissions. Thanks go to Bill Kleb for the
   suggestion and to Hal Fulton for providing the solution.

data/README

@@ -33,6 +33,8 @@ few options, hasn't been updated in over six years and isn't packaged properly.
 * ftype
 * inum (except Windows)
 * group (name or id)
+* maxdepth
+* mindepth
 * mtime
 * name (or 'pattern')
 * path
@@ -50,7 +52,7 @@ http://www.rubyforge.org/projects/shards.
 
 Some specific things I plan on adding:
 
-* symbolic permissions for the :perm option
+* general FileTest operations
 * exec
 * links
 * support for :user and :group on MS Windows

data/lib/file/find.rb

@@ -6,7 +6,7 @@ include Sys
 
 class File::Find
    # The version of this library
-   VERSION = '0.2.4'
+   VERSION = '0.2.5'
 
    # :stopdoc:
    VALID_OPTIONS = %w/
@@ -16,6 +16,8 @@ class File::Find
       ftype
       inum
       group
+      maxdepth
+      mindepth
       mtime
       name
       pattern
@@ -72,6 +74,16 @@ class File::Find
    #
    attr_accessor :inum
 
+   # Limits search to a maximum depth into the tree relative to the starting
+   # search directory.
+   #
+   attr_accessor :maxdepth
+
+   # Limits search to a minimum depth into the tree relative to the starting
+   # search directory.
+   #
+   attr_accessor :mindepth
+
    # Limits searches by file modification time, where the value you supply is
    # the number of days back from the time that the File::Find#find method was
    # called.
@@ -147,6 +159,8 @@ class File::Find
       @user   = nil
 
       @previous = nil
+      @maxdepth = nil
+      @mindepth = nil
 
       validate_and_set_options(options) unless options.empty?
 
@@ -207,23 +221,45 @@ class File::Find
 
                glob = File.join(File.dirname(file), @name)
 
-               # Add directories back onto the list of paths to search unless
-               # they've already been added.
-               #
-               # TODO: Add max_depth support here
-               #
-               if stat_info.directory?
-                  unless paths.include?(file)
-                     paths << file
-                  end
-               end
-
                # Dir[] doesn't like backslashes
                if File::ALT_SEPARATOR
                   file.tr!(File::ALT_SEPARATOR, File::SEPARATOR) 
                   glob.tr!(File::ALT_SEPARATOR, File::SEPARATOR) 
                end
 
+               if @maxdepth || @mindepth
+                  file_depth = file.split(File::SEPARATOR).length
+                  path_depth = @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
+                     end
+
+                     next
+                  end
+
+                  if @mindepth && (depth < @mindepth)
+                     if File.directory?(file)
+                        unless paths.include?(file) && depth < @mindepth
+                           paths << file
+                        end
+                     end
+
+                     next
+                  end
+               end
+
+               # 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)
+               end
+
                next unless Dir[glob].include?(file)
 
                if @atime

data/test/test_file_find.rb

@@ -13,6 +13,7 @@ require 'file/find'
 require 'rbconfig'
 require 'sys/admin'
 include Config
+include FileUtils
 
 class TC_File_Find < Test::Unit::TestCase
    def self.startup
@@ -51,7 +52,7 @@ class TC_File_Find < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.2.4', File::Find::VERSION)
+      assert_equal('0.2.5', File::Find::VERSION)
    end
 
    def test_path
@@ -94,6 +95,11 @@ class TC_File_Find < Test::Unit::TestCase
       assert_true(rule2.find.empty?)
    end
 
+   def test_find_basic
+      assert_respond_to(@rule1, :find)
+      assert_nothing_raised{ @rule1.find }
+   end
+
    def test_mtime
       rule1 = File::Find.new(:name => "*.rb", :mtime => 0)
       rule2 = File::Find.new(:name => "*.rb", :mtime => 1)
@@ -160,6 +166,100 @@ class TC_File_Find < Test::Unit::TestCase
       assert_true(@rule1.follow)
    end
 
+   def test_maxdepth_basic
+      assert_respond_to(@rule1, :maxdepth)
+      assert_respond_to(@rule1, :maxdepth=)
+      assert_nil(@rule1.maxdepth)
+   end
+   
+   def test_maxdepth_file
+      mkpath('a1/a2/a3')
+      touch('a1/a.foo')
+      touch('a1/a2/b.foo')
+      touch('a1/a2/c.foo')
+      touch('a1/a2/a3/d.foo')
+      touch('a1/a2/a3/e.foo')
+      touch('a1/a2/a3/f.foo')
+      
+      @rule2.pattern = "*.foo"
+      @rule2.maxdepth = 1    
+      assert_equal([], @rule2.find)
+      
+      @rule2.maxdepth = 2
+      assert_equal(['a.foo'], @rule2.find.map{ |e| File.basename(e) })
+      
+      @rule2.maxdepth = 3
+      assert_equal(['a.foo', 'b.foo', 'c.foo'], @rule2.find.map{ |e| File.basename(e) })
+      
+      @rule2.maxdepth = nil
+      assert_equal(['a.foo', 'b.foo', 'c.foo', 'd.foo', 'e.foo', 'f.foo'], @rule2.find.map{ |e| File.basename(e) })
+   end
+
+   def test_maxdepth_directory
+      mkpath('a/b/c')
+      @rule2.pattern = "c"
+
+      @rule2.maxdepth = 1    
+      assert_equal([], @rule2.find)
+      
+      @rule2.maxdepth = 2
+      assert_equal([], @rule2.find)
+      
+      @rule2.maxdepth = 3
+      assert_equal(['c'], @rule2.find.map{ |e| File.basename(e) })
+   end
+
+   def test_mindepth_basic
+      assert_respond_to(@rule1, :mindepth)
+      assert_respond_to(@rule1, :mindepth=)
+      assert_nil(@rule1.mindepth)
+   end
+
+   def test_mindepth_file
+      mkpath('a1/a2/a3')
+      touch('z.min')
+      touch('a1/a.min')
+      touch('a1/a2/b.min')
+      touch('a1/a2/c.min')
+      touch('a1/a2/a3/d.min')
+      touch('a1/a2/a3/e.min')
+      touch('a1/a2/a3/f.min')
+      
+      @rule2.pattern = "*.min"
+
+      @rule2.mindepth = 0
+      assert_equal(['z.min', 'a.min', 'b.min', 'c.min', 'd.min', 'e.min', 'f.min'], @rule2.find.map{ |e| File.basename(e) })
+
+      @rule2.mindepth = 1
+      assert_equal(['z.min', 'a.min', 'b.min', 'c.min', 'd.min', 'e.min', 'f.min'], @rule2.find.map{ |e| File.basename(e) })
+
+      @rule2.mindepth = 2
+      assert_equal(['a.min', 'b.min', 'c.min', 'd.min', 'e.min', 'f.min'], @rule2.find.map{ |e| File.basename(e) })
+      
+      @rule2.mindepth = 3
+      assert_equal(['b.min', 'c.min', 'd.min', 'e.min', 'f.min'], @rule2.find.map{ |e| File.basename(e) })
+      
+      @rule2.mindepth = 4
+      assert_equal(['d.min', 'e.min', 'f.min'], @rule2.find.map{ |e| File.basename(e) })
+
+      @rule2.mindepth = 5
+      assert_equal([], @rule2.find.map{ |e| File.basename(e) })
+   end
+
+   def test_mindepth_directory
+      mkpath('a/b/c')
+      @rule2.pattern = "a"
+
+      @rule2.mindepth = 1    
+      assert_equal(['a'], @rule2.find.map{ |e| File.basename(e) })
+      
+      @rule2.mindepth = 2
+      assert_equal([], @rule2.find)
+      
+      @rule2.mindepth = 3
+      assert_equal([], @rule2.find)
+   end
+
    def test_name_basic
       assert_respond_to(@rule1, :name)
       assert_respond_to(@rule1, :name=)
@@ -251,17 +351,21 @@ class TC_File_Find < Test::Unit::TestCase
    end
 
    def test_expected_errors
-      assert_raises(Errno::ENOENT){ File::Find.new(:path => '/bogus/dir').find }
+      assert_raise(Errno::ENOENT){ File::Find.new(:path => '/bogus/dir').find }
+      assert_raise(ArgumentError){ File::Find.new(:bogus => 1) }
    end
 
    def teardown
-      FileUtils.rm_rf(@file1)
-      FileUtils.rm_rf(@file2)
-      FileUtils.rm_rf(@file3)
-      FileUtils.rm_rf(@file4)
-      FileUtils.rm_rf(@dir1)
-      FileUtils.rm_rf(@dir2)
-      FileUtils.rm_rf(@link1) unless @@windows
+      rm_rf(@file1)
+      rm_rf(@file2)
+      rm_rf(@file3)
+      rm_rf(@file4)
+      rm_rf(@dir1)
+      rm_rf(@dir2)
+      rm_rf(@link1) unless @@windows
+      rm_rf('a')
+      rm_rf('a1')
+      rm_rf('z.min') if File.exists?('z.min')
 
       @rule1 = nil
       @rule2 = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: file-find
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Daniel Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-10 00:00:00 -07:00
+date: 2008-12-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.1
+        version: 2.0.2
     version: 
 description: A better way to find files
 email: djberg96@gmail.com