file-find 0.2.5 → 0.3.0

data/CHANGES

@@ -1,3 +1,7 @@
+== 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
 * Added maxdepth and mindepth support.
 * Added a 'clean' rake task to cleanup any test-unit results files.

data/MANIFEST

@@ -4,4 +4,4 @@
 * README
 * file-find.gemspec
 * lib/file/find.rb
-* test/tc_find.rb
+* test/test_file_find.rb

data/README

@@ -43,6 +43,9 @@ few options, hasn't been updated in over six years and isn't packaged properly.
 * 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 RDoc documentation for more details about these options.
 
 = Future Plans
@@ -52,7 +55,6 @@ http://www.rubyforge.org/projects/shards.
 
 Some specific things I plan on adding:
 
-* 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.5'
+   VERSION = '0.3.0'
 
    # :stopdoc:
    VALID_OPTIONS = %w/
@@ -58,6 +58,11 @@ class File::Find
    #
    attr_accessor :group
 
+   # An array of two element arrays for storing FileTest methods and their
+   # boolean value.
+   #
+   attr_accessor :filetest
+
    # Controls the behavior of how symlinks are followed. If set to true (the
    # default), then follows the file pointed to. If false, it considers the
    # symlink itself.
@@ -135,13 +140,17 @@ class File::Find
    # object serve as the rules for determining what files the File::Find#find
    # method will search for.
    #
+   # In addition to the standard list of valid options, you may also use
+   # FileTest methods as options, setting their value to true or false.
+   #
    # Example:
    #
    #    rule = File::Find.new(
-   #       :name    => "*.rb",
-   #       :follow  => false,
-   #       :path    => ['/usr/local/lib', '/opt/local/lib']
-   #    )  
+   #       :name      => "*.rb",
+   #       :follow    => false,
+   #       :path      => ['/usr/local/lib', '/opt/local/lib'],
+   #       :readable? => true
+   #    )
    #
    def initialize(options = {})
       @options = options      
@@ -161,6 +170,7 @@ class File::Find
       @previous = nil
       @maxdepth = nil
       @mindepth = nil
+      @filetest = []
 
       validate_and_set_options(options) unless options.empty?
 
@@ -262,6 +272,22 @@ class File::Find
 
                next unless Dir[glob].include?(file)
 
+               unless @filetest.empty?
+                  file_test = true
+
+                  @filetest.each{ |array|
+                     meth = array[0]
+                     bool = array[1]
+
+                     unless File.send(meth, file) == bool
+                        file_test = false
+                        break
+                     end
+                  }
+
+                  next unless file_test
+               end
+
                if @atime
                   date1 = Date.parse(Time.now.to_s)
                   date2 = Date.parse(stat_info.atime.to_s)
@@ -356,15 +382,28 @@ class File::Find
    private
 
    # This validates that the keys are valid. If they are, it sets the value
-   # of that key's corresponding method to the given value.
+   # of that key's corresponding method to the given value. If a key ends
+   # with a '?', it's validated as a File method.
    #
    def validate_and_set_options(options)
       options.each do |key, value|
          key = key.to_s.downcase
-         unless VALID_OPTIONS.include?(key)
-            raise ArgumentError, "invalid option '#{key}'"
+
+         if key[-1].chr == '?'
+            sym = key.to_sym
+
+            unless File.respond_to?(sym)
+               raise ArgumentError, "invalid option '#{key}'"
+            end
+
+            @filetest << [sym, value]
+         else
+            unless VALID_OPTIONS.include?(key)
+               raise ArgumentError, "invalid option '#{key}'"
+            end
+
+            send("#{key}=", value)
          end
-         send("#{key}=", value)
       end
    end
 

data/test/test_file_find.rb

@@ -52,7 +52,7 @@ class TC_File_Find < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.2.5', File::Find::VERSION)
+      assert_equal('0.3.0', File::Find::VERSION)
    end
 
    def test_path
@@ -100,6 +100,34 @@ class TC_File_Find < Test::Unit::TestCase
       assert_nothing_raised{ @rule1.find }
    end
 
+   def test_find
+      assert_kind_of(Array, @rule1.find)
+      assert_nil(@rule1.find{})
+   end
+
+   def test_filetest_basic
+      assert_respond_to(@rule1, :filetest)
+      assert_respond_to(@rule1, :filetest=)
+      assert_nothing_raised{ @rule1.filetest }
+      assert_kind_of(Array, @rule1.filetest)
+   end
+
+   def test_filetest_valid_options
+      assert_nothing_raised{ File::Find.new(:readable? => true) }
+      assert_nothing_raised{ File::Find.new(:writable? => true) }
+   end
+
+   def test_filetest
+      rule = File::Find.new(:name => "*.doc", :writable? => true)
+      File.chmod(0644, @file4)
+
+      assert_equal([@file4], rule.find.map{ |f| File.basename(f) })
+
+      File.chmod(0444, @file4)
+
+      assert_equal([], rule.find)
+   end
+
    def test_mtime
       rule1 = File::Find.new(:name => "*.rb", :mtime => 0)
       rule2 = File::Find.new(:name => "*.rb", :mtime => 1)
@@ -353,6 +381,7 @@ class TC_File_Find < Test::Unit::TestCase
    def test_expected_errors
       assert_raise(Errno::ENOENT){ File::Find.new(:path => '/bogus/dir').find }
       assert_raise(ArgumentError){ File::Find.new(:bogus => 1) }
+      assert_raise(ArgumentError){ File::Find.new(:bogus? => true) }
    end
 
    def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: file-find
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-29 00:00:00 -07:00
+date: 2008-12-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency