file-find 0.2.0 → 0.2.1

data/CHANGES

@@ -1,3 +1,10 @@
+== 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
 * Fixed a bug where it was not traversing subdirectories.
 * Added support for the perm and prune options.

data/README

@@ -4,7 +4,7 @@ library. It is modeled on a typical 'find' command found on most Unix systems.
 
 = Synopsis
    rule = File::Find.new(
-      :name    => "*.rb",
+      :pattern => "*.rb",
       :follow  => false,
       :path    => ['/usr/local/lib', '/opt/local/lib']
    )
@@ -14,8 +14,8 @@ library. It is modeled on a typical 'find' command found on most Unix systems.
    }
 
 = Installation
-rake test (optional)
-rake install (non-gem) or rake install_gem (gem)
+* rake test (optional)
+* rake install (non-gem) -OR- rake install_gem (gem)
 
 = Rationale
 The current find module in the standard library is inadequate. It is, quite
@@ -31,11 +31,11 @@ few options, hasn't been updated in over six years and isn't packaged properly.
 * ctime
 * follow
 * ftype
-* inum
+* inum (except Windows)
 * group
-* name
+* name (or 'pattern')
 * path
-* perm
+* perm (except Windows)
 * prune
 * size
 * user
@@ -52,17 +52,17 @@ Some specific things I plan on adding:
 * exec
 * links
 
-= Options that 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
 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.
+* acl/xattr - Way too 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.
+  do it for you. The same goes for any similar options for 3rd party apps 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.
@@ -71,8 +71,13 @@ supported. These include the following options:
 
 = Options I may or may not support
 
-* local/mount/xdev - This will probably not be added until I'm satisified with
+* local/mount/xdev - This will probably not be added until I'm satisfied with
   the sys-filesystem package.
+  
+= Known Issues
+The 'perm' option does not work on MS Windows, even for its limited subset of
+permissions, i.e. 664 and 666. This is arguably a bug in Ruby's
+File::Stat.mode method on MS Windows.
 
 = Bugs
 None that I'm aware of. Please log any bug reports on the project page at

data/lib/file/find.rb

@@ -2,7 +2,7 @@ require 'date'
 
 class File::Find
    # The version of this package
-   VERSION = '0.2.0'
+   VERSION = '0.2.1'
 
    # :stopdoc:
    VALID_OPTIONS = %w/
@@ -13,6 +13,7 @@ class File::Find
       inum
       group
       name
+      pattern
       path
       perm
       prune
@@ -90,7 +91,12 @@ class File::Find
    #
    attr_accessor :user
 
+   # The file that matched previously in the current search.
+   #
+   attr_reader :previous
+
    alias pattern name
+   alias pattern= name=
 
    # Creates and returns a new File::Find object. The options set for this
    # object serve as the rules for determining what files the File::Find#find
@@ -112,6 +118,8 @@ class File::Find
 
       validate_and_set_options(options) unless options.empty?
 
+      @previous = nil
+
       @path ||= Dir.pwd
       @name ||= '*'
    end
@@ -130,8 +138,8 @@ class File::Find
          prune_regex = nil
       end
 
-      catch(:loop) do
-         paths.each{ |path|
+      paths.each{ |path|
+         begin
             Dir.foreach(path){ |file|
                next if file == '.'
                next if file == '..'
@@ -168,6 +176,11 @@ class File::Find
                   end
                end
 
+               # Dir[] doesn't like backslashes
+               if File::ALT_SEPARATOR
+                  file.tr!(File::ALT_SEPARATOR, File::SEPARATOR) 
+               end
+
                next unless Dir[glob].include?(file)
 
                if @atime
@@ -196,6 +209,10 @@ class File::Find
                   end
                end
 
+               # This currently doesn't work on MS Windows, even in limited
+               # fashion for 0666 and 0664, because File.stat.mode doesn't
+               # return the proper value.
+               #
                if @perm
                   next unless sprintf("%o", stat_info.mode & 07777) == @perm.to_s
                end
@@ -228,9 +245,13 @@ class File::Find
                else
                   results << file
                end
+
+               @previous = file unless @previous == file
             }
-         }
-      end
+         rescue Errno::EACCES
+            next # Skip inaccessible directories
+         end
+      }
 
       block_given? ? nil : results
    end

data/test/tc_find.rb

@@ -9,18 +9,23 @@ require 'fileutils'
 require 'file/find'
 
 class TC_File_Find < Test::Unit::TestCase
+   WINDOWS = RUBY_PLATFORM.match('mswin') ? true : false
+
    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)
+
+      unless WINDOWS
+         @link1 = 'link1'
+         File.symlink(@file1, @link1)
+      end
 
       Dir.mkdir(@dir1) unless File.exists?(@dir1)
       Dir.mkdir(@dir2) unless File.exists?(@dir2)
@@ -32,7 +37,7 @@ class TC_File_Find < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.2.0', File::Find::VERSION)
+      assert_equal('0.2.1', File::Find::VERSION)
    end
 
    def test_path
@@ -113,18 +118,28 @@ class TC_File_Find < Test::Unit::TestCase
       assert_equal('*.rb', @rule1.name)
    end
 
+   def test_pattern_alias
+      assert_respond_to(@rule1, :pattern)
+      assert_respond_to(@rule1, :pattern=)
+      assert_equal('*.rb', @rule1.pattern)
+   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))
+   # Skip on MS Windows for now
+   unless WINDOWS
+      def test_perm
+         File.chmod(0664, @file1) 
+         File.chmod(0644, @file2) 
+         results = File::Find.new(:name => "test1*", :perm => 664).find
+
+         assert_equal(1, results.length)
+         assert_equal('test1.rb', File.basename(results.first))
+      end
    end
 
    def test_prune_basic
@@ -150,6 +165,10 @@ class TC_File_Find < Test::Unit::TestCase
       assert_nil(@rule1.user)
    end
 
+   def test_previous_basic
+      assert_respond_to(@rule1, :previous)
+   end
+
    def test_expected_errors
       assert_raises(Errno::ENOENT){ File::Find.new(:path => '/bogus/dir').find }
    end
@@ -158,8 +177,8 @@ class TC_File_Find < Test::Unit::TestCase
       FileUtils.rm_rf(@file1)
       FileUtils.rm_rf(@file2)
       FileUtils.rm_rf(@file3)
-      FileUtils.rm_rf(@link1)
       FileUtils.rm_rf(@dir1)
       FileUtils.rm_rf(@dir2)
+      FileUtils.rm_rf(@link1) unless WINDOWS
    end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: file-find
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2007-04-26 00:00:00 -06:00
+  version: 0.2.1
+date: 2007-10-05 00:00:00 -06:00
 summary: A better way to find files
 require_paths: 
 - lib