file-find 0.2.1 → 0.2.2

data/CHANGES

@@ -1,3 +1,12 @@
+== 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.
+* Updated platform check to use CONFIG instead of RUBY_PLATFORM, because the
+  latter does not work as I intended with other implementations, e.g. JRuby.
+* Added sys-admin and test-unit as prerequisites.
+* Added tests for the :user and :group options.
+
 == 0.2.1 - 4-Oct-2007
 * Added the File::Find#previous method, which lets you see the previous
   match, if any.

data/README

@@ -49,8 +49,10 @@ http://www.rubyforge.org/projects/shards.
 
 Some specific things I plan on adding:
 
+* symbolic permissions for the :perm option
 * exec
 * links
+* support for :user and :group on MS Windows
 
 = Options I won't support
 Generally speaking, anything that would require mucking around with C code
@@ -79,6 +81,10 @@ 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.
 
+The 'user' and 'group' options are not currently supported on MS Windows.
+This can be supported, but will require changes in the win32-file and
+win32-file-stat libraries (which would then become dependencies).
+
 = Bugs
 None that I'm aware of. Please log any bug reports on the project page at
 http://www.rubyforge.org/projects/shards.
@@ -91,7 +97,7 @@ http://www.rubyforge.org/projects/shards.
 Ruby's
 
 = Copyright
-(C) 2007, Daniel J. Berger, All Rights Reserved
+(C) 2007-2008, Daniel J. Berger, All Rights Reserved
 
 = Author
 Daniel J. Berger

data/lib/file/find.rb

@@ -1,8 +1,12 @@
 require 'date'
+require 'rbconfig'
+require 'sys/admin'
+include Config
+include Sys
 
 class File::Find
-   # The version of this package
-   VERSION = '0.2.1'
+   # The version of this library
+   VERSION = '0.2.2'
 
    # :stopdoc:
    VALID_OPTIONS = %w/
@@ -45,7 +49,10 @@ class File::Find
    #
    attr_accessor :ctime
 
-   # Limits searches to files that belong to a specific group ID.
+   # Limits searches to files that belong to a specific group, where the
+   # group can be either a group name or ID.
+   #
+   # Not currently supported on MS Windows.
    #
    attr_accessor :group
 
@@ -74,6 +81,8 @@ class File::Find
    # group, and world settings are used. Do not use a leading 0 in the values
    # that you supply, e.g. use 755 not 0755.
    #
+   # Not currently supported on MS Windows.
+   #
    attr_accessor :perm
 
    # Skips files or directories that match the string provided as an argument.
@@ -87,7 +96,10 @@ class File::Find
    #
    attr_accessor :size
 
-   # Limits searches to files that belong to a specific user ID.
+   # Limits searches to files that belong to a specific user, where the user
+   # can be either a user name or an ID.
+   #
+   # Not currently supported on MS Windows.
    #
    attr_accessor :user
 
@@ -102,6 +114,14 @@ class File::Find
    # object serve as the rules for determining what files the File::Find#find
    # method will search for.
    #
+   # Example:
+   #
+   #    rule = File::Find.new(
+   #       :name    => "*.rb",
+   #       :follow  => false,
+   #       :path    => ['/usr/local/lib', '/opt/local/lib']
+   #    )  
+   #
    def initialize(options = {})
       @options = options      
 
@@ -128,6 +148,18 @@ class File::Find
    # In block form, yields each file in turn that matches the specified rules.
    # In non-block form it will return an array of matches instead.
    #
+   # Example:
+   #
+   #   rule = File::Find.new(
+   #      :name    => "*.rb",
+   #      :follow  => false,
+   #      :path    => ['/usr/local/lib', '/opt/local/lib']
+   #   )   
+   #
+   #   rule.find{ |f|
+   #      puts f
+   #   }    
+   #
    def find
       results = [] unless block_given?
       paths   = @path.to_a
@@ -179,6 +211,7 @@ class File::Find
                # Dir[] doesn't like backslashes
                if File::ALT_SEPARATOR
                   file.tr!(File::ALT_SEPARATOR, File::SEPARATOR) 
+                  glob.tr!(File::ALT_SEPARATOR, File::SEPARATOR) 
                end
 
                next unless Dir[glob].include?(file)
@@ -200,10 +233,14 @@ class File::Find
                end
 
                if @group
-                  next unless stat_info.gid == @group
+                  if @group.is_a?(String)
+                     next unless Admin.get_group(stat_info.gid).name == @group
+                  else
+                     next unless stat_info.gid == @group
+                  end
                end
 
-               unless RUBY_PLATFORM.match('mswin')
+               unless CONFIG['host_os'] =~ /windows|mswin/i
                   if @inum
                      next unless stat_info.ino == @inum
                   end
@@ -237,7 +274,11 @@ class File::Find
                end
 
                if @user
-                  next unless stat_info.uid == @user
+                  if @user.is_a?(String)
+                     next unless Admin.get_user(stat_info.uid).name == @user
+                  else
+                     next unless stat_info.uid == @user
+                  end
                end
 
                if block_given?

data/test/{tc_find.rb → test_file_find.rb}

@@ -1,28 +1,41 @@
 ######################################################################
-# tc_find.rb
+# test_file_find.rb
 #
 # Test case for the File::Find package. You should run this via the
 # 'rake test' task.
 ######################################################################
+require 'rubygems'
+gem 'test-unit'
+
 require 'test/unit'
 require 'fileutils'
 require 'file/find'
+require 'rbconfig'
+require 'sys/admin'
+include Config
 
 class TC_File_Find < Test::Unit::TestCase
-   WINDOWS = RUBY_PLATFORM.match('mswin') ? true : false
+   def self.startup
+      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      @@windows = CONFIG['host_os'] =~ /windows|mswin/i
+      @@loguser = Sys::Admin.get_user(Admin.get_login) unless @@windows
+      @@logroup = Sys::Admin.get_group(@@loguser.gid) unless @@windows
+   end
 
    def setup
       @file1 = 'test1.rb'
       @file2 = 'test1.txt'
       @file3 = 'foo.txt'
+      @file4 = 'foo.doc'
       @dir1  = 'dir1'
       @dir2  = 'dir2'
 
       File.open(@file1, 'w'){}
       File.open(@file2, 'w'){}
       File.open(@file3, 'w'){}
+      File.open(@file4, 'w'){}
 
-      unless WINDOWS
+      unless @@windows
          @link1 = 'link1'
          File.symlink(@file1, @link1)
       end
@@ -33,11 +46,12 @@ class TC_File_Find < Test::Unit::TestCase
       File.open(File.join(@dir1, 'bar.txt'), 'w'){}
       File.open(File.join(@dir2, 'baz.txt'), 'w'){}
 
-      @rule1 = File::Find.new(:name => '*.rb')
+      @rule1 = File::Find.new(:name => '*.txt')
+      @rule2 = File::Find.new
    end
 
    def test_version
-      assert_equal('0.2.1', File::Find::VERSION)
+      assert_equal('0.2.2', File::Find::VERSION)
    end
 
    def test_path
@@ -49,7 +63,7 @@ class TC_File_Find < Test::Unit::TestCase
    def test_options
       assert_respond_to(@rule1, :options)
       assert_respond_to(@rule1, :options=)
-      assert_equal({:name => '*.rb'}, @rule1.options)
+      assert_equal({:name => '*.txt'}, @rule1.options)
    end
 
    def test_atime_basic
@@ -100,6 +114,26 @@ class TC_File_Find < Test::Unit::TestCase
       assert_nil(@rule1.group)
    end
 
+   def test_group_with_numeric_id
+      omit_if(@@windows, 'group test skipped on MS Windows')
+      @rule1 = File::Find.new(:name => '*.doc', :group => @@loguser.gid)
+      assert_equal([File.expand_path(@file4)], @rule1.find)
+   end
+
+   def test_group_with_string
+      omit_if(@@windows, 'group test skipped on MS Windows')
+      @rule1 = File::Find.new(:name => '*.doc', :group => @@logroup.name)
+      assert_equal([File.expand_path(@file4)], @rule1.find)
+   end
+
+   def test_group_with_bad_id
+      omit_if(@@windows, 'group test skipped on MS Windows')
+      @rule1 = File::Find.new(:name => '*.doc', :group => 'totallybogus')
+      @rule2 = File::Find.new(:name => '*.doc', :group => 99999999)
+      assert_equal([], @rule1.find)
+      assert_equal([], @rule2.find)
+   end
+
    def test_inum_basic
       assert_respond_to(@rule1, :inum)
       assert_respond_to(@rule1, :inum=)
@@ -115,13 +149,14 @@ class TC_File_Find < Test::Unit::TestCase
    def test_name_basic
       assert_respond_to(@rule1, :name)
       assert_respond_to(@rule1, :name=)
-      assert_equal('*.rb', @rule1.name)
+      assert_equal('*.txt', @rule1.name)
    end
 
    def test_pattern_alias
       assert_respond_to(@rule1, :pattern)
       assert_respond_to(@rule1, :pattern=)
-      assert_equal('*.rb', @rule1.pattern)
+      assert_true(@rule1.method(:name) == @rule1.method(:pattern))
+      assert_true(@rule1.method(:name=) == @rule1.method(:pattern=))
    end
 
    def test_perm_basic
@@ -130,16 +165,14 @@ class TC_File_Find < Test::Unit::TestCase
       assert_nil(@rule1.perm)
    end
 
-   # 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
+   def test_perm
+      omit_if(@@windows, 'perm test skipped on MS Windows')
+      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
+      assert_equal(1, results.length)
+      assert_equal('test1.rb', File.basename(results.first))
    end
 
    def test_prune_basic
@@ -165,6 +198,26 @@ class TC_File_Find < Test::Unit::TestCase
       assert_nil(@rule1.user)
    end
 
+   def test_user_with_numeric_id
+      omit_if(@@windows, 'user test skipped on MS Windows')
+      @rule1 = File::Find.new(:name => '*.doc', :user => @@loguser.uid)
+      assert_equal([File.expand_path(@file4)], @rule1.find)
+   end
+
+   def test_user_with_string
+      omit_if(@@windows, 'user test skipped on MS Windows')
+      @rule1 = File::Find.new(:name => '*.doc', :user => @@loguser.name)
+      assert_equal([File.expand_path(@file4)], @rule1.find)
+   end
+
+   def test_user_with_bad_id
+      omit_if(@@windows, 'user test skipped on MS Windows')
+      @rule1 = File::Find.new(:name => '*.doc', :user => 'totallybogus')
+      @rule2 = File::Find.new(:name => '*.doc', :user => 99999999)
+      assert_equal([], @rule1.find)
+      assert_equal([], @rule2.find)
+   end
+
    def test_previous_basic
       assert_respond_to(@rule1, :previous)
    end
@@ -177,8 +230,22 @@ class TC_File_Find < Test::Unit::TestCase
       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
+      FileUtils.rm_rf(@link1) unless @@windows
+
+      @rule1 = nil
+      @rule2 = nil
+      @file1 = nil
+      @file2 = nil
+      @file3 = nil
+      @file4 = nil
+   end
+
+   def self.shutdown
+      @@windows = nil
+      @@loguser = nil unless @@windows
+      @@logroup = nil unless @@windows
    end
 end

metadata

@@ -1,53 +1,79 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: file-find
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-10-05 00:00:00 -06:00
-summary: A better way to find files
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/shards
-rubyforge_project: 
-description: A better way to find files
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.2
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sys-admin
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.1
+    version: 
+description: A better way to find files
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
 files: 
 - lib/file
 - lib/file/find.rb
-- test/tc_find.rb
+- test/test_file_find.rb
 - README
 - CHANGES
 - MANIFEST
-test_files: 
-- test/tc_find.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-- CHANGES
-- MANIFEST
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A better way to find files
+test_files: 
+- test/test_file_find.rb