file-find 0.1.1 → 0.2.0

data/CHANGES

@@ -1,3 +1,7 @@
+== 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
 * The default for name is now '*', i.e. everything.
 * Fixed a bug where directories were not matched. Thanks go to Leslie Viljoen

data/README

@@ -35,6 +35,8 @@ few options, hasn't been updated in over six years and isn't packaged properly.
 * group
 * name
 * path
+* perm
+* prune
 * size
 * user
 
@@ -47,13 +49,39 @@ http://www.rubyforge.org/projects/shards.
 
 Some specific things I plan on adding:
 
-* Support for limiting depth.
-* Greater flexibility with the size option (and perhaps others).
+* exec
+* links
+
+= Options that 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 to difficult to implement in a cross platform manner, and a
+  rarely used option to boot.
+
+* cpio/ncpio - You can shell out on your own if you want, but I'm not going to
+  do it for you. The same goes for any similar options that your particular
+  platform may support.
+
+* ls/print - You can print file names as you see fit on your own. This isn't
+  a shell command replacement.
+
+* ok - This is not interactive software.
+
+= Options I may or may not support
+
+* local/mount/xdev - This will probably not be added until I'm satisified with
+  the sys-filesystem package.
 
 = Bugs
 None that I'm aware of. Please log any bug reports on the project page at
 http://www.rubyforge.org/projects/shards.
 
+= Acknowledgements
+* Richard Clamp's File::Find::Rule Perl module for additional ideas and
+  inspiration.
+
 = License
 Ruby's
 

data/lib/file/find.rb

@@ -2,7 +2,7 @@ require 'date'
 
 class File::Find
    # The version of this package
-   VERSION = '0.1.1'
+   VERSION = '0.2.0'
 
    # :stopdoc:
    VALID_OPTIONS = %w/
@@ -14,6 +14,8 @@ class File::Find
       group
       name
       path
+      perm
+      prune
       size
       user
    /
@@ -66,6 +68,17 @@ class File::Find
    #
    attr_accessor :name
 
+   # Limits searches to files which have permissions that match the octal
+   # value that you provide. For purposes of this comparison, only the user,
+   # group, and world settings are used. Do not use a leading 0 in the values
+   # that you supply, e.g. use 755 not 0755.
+   #
+   attr_accessor :perm
+
+   # Skips files or directories that match the string provided as an argument.
+   #
+   attr_accessor :prune
+
    # If the value passed is an integer, this option limits searches to files
    # that match the size, in bytes, exactly. If a string is passed, you can
    # use the standard comparable operators to match files, e.g. ">= 200" would
@@ -92,6 +105,8 @@ class File::Find
       @group  = nil
       @follow = true
       @inum   = nil
+      @perm   = nil
+      @prune  = nil
       @size   = nil
       @user   = nil
 
@@ -107,7 +122,13 @@ class File::Find
    #
    def find
       results = [] unless block_given?
-      paths   = [@path]
+      paths   = @path.to_a
+
+      if @prune
+         prune_regex = Regexp.new(@prune)
+      else
+         prune_regex = nil
+      end
 
       catch(:loop) do
          paths.each{ |path|
@@ -115,6 +136,11 @@ class File::Find
                next if file == '.'
                next if file == '..'
 
+               if prune_regex
+                  next if prune_regex.match(file)
+               end
+
+               orig = file.dup
                file = File.join(path, file)
 
                stat_method = @follow ? :lstat : :stat
@@ -130,17 +156,20 @@ class File::Find
                end
 
                glob = File.join(File.dirname(file), @name)
-               next unless Dir[glob].include?(file)
 
                # 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
 
+               next unless Dir[glob].include?(file)
+
                if @atime
                   date1 = Date.parse(Time.now.to_s)
                   date2 = Date.parse(stat_info.atime.to_s)
@@ -167,6 +196,10 @@ class File::Find
                   end
                end
 
+               if @perm
+                  next unless sprintf("%o", stat_info.mode & 07777) == @perm.to_s
+               end
+
                # Allow plain numbers, or strings for comparison operators.
                if @size
                   if @size.is_a?(String)

data/test/tc_find.rb

@@ -12,17 +12,27 @@ class TC_File_Find < Test::Unit::TestCase
    def setup
       @file1 = 'test1.rb'
       @file2 = 'test1.txt'
+      @file3 = 'foo.txt'
       @link1 = 'link1'
+      @dir1  = 'dir1'
+      @dir2  = 'dir2'
 
       File.open(@file1, 'w'){}
       File.open(@file2, 'w'){}
+      File.open(@file3, 'w'){}
       File.symlink(@file1, @link1)
 
+      Dir.mkdir(@dir1) unless File.exists?(@dir1)
+      Dir.mkdir(@dir2) unless File.exists?(@dir2)
+
+      File.open(File.join(@dir1, 'bar.txt'), 'w'){}
+      File.open(File.join(@dir2, 'baz.txt'), 'w'){}
+
       @rule1 = File::Find.new(:name => '*.rb')
    end
 
    def test_version
-      assert_equal('0.1.1', File::Find::VERSION)
+      assert_equal('0.2.0', File::Find::VERSION)
    end
 
    def test_path
@@ -103,6 +113,31 @@ class TC_File_Find < Test::Unit::TestCase
       assert_equal('*.rb', @rule1.name)
    end
 
+   def test_perm_basic
+      assert_respond_to(@rule1, :perm)
+      assert_respond_to(@rule1, :perm=)
+      assert_nil(@rule1.perm)
+   end
+
+   def test_perm
+      File.chmod(0666, @file1) 
+      File.chmod(0644, @file2) 
+      results = File::Find.new(:name => "test1*", :perm => 666).find
+      assert_equal(true, results.length == 1)
+      assert_equal('test1.rb', File.basename(results.first))
+   end
+
+   def test_prune_basic
+      assert_respond_to(@rule1, :prune)
+      assert_respond_to(@rule1, :prune=)
+      assert_nil(@rule1.prune)
+   end
+
+   def test_prune
+      rule = File::Find.new(:name => "*.txt", :prune => 'foo')
+      assert_equal('test1.txt', File.basename(rule.find.first))
+   end
+
    def test_size_basic
       assert_respond_to(@rule1, :size)
       assert_respond_to(@rule1, :size=)
@@ -122,6 +157,9 @@ class TC_File_Find < Test::Unit::TestCase
    def teardown
       FileUtils.rm_rf(@file1)
       FileUtils.rm_rf(@file2)
+      FileUtils.rm_rf(@file3)
       FileUtils.rm_rf(@link1)
+      FileUtils.rm_rf(@dir1)
+      FileUtils.rm_rf(@dir2)
    end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: file-find
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-04-25 00:00:00 -06:00
+  version: 0.2.0
+date: 2007-04-26 00:00:00 -06:00
 summary: A better way to find files
 require_paths: 
 - lib