file-find 0.3.2 → 0.3.3

data/CHANGES

@@ -1,8 +1,17 @@
-== 0.3.2 - 20-Feb-2008
+== 0.3.3 - 3-Aug-2009
+* Now compatible with Ruby 1.9.x.
+* Added support for the :links option
+* Updated the :mount accessor to work properly if the value is changed
+  after the File::Find object is initially created.
+* Eliminated some 'shadowed variable' warnings in Ruby 1.9.x.
+* Added a fuller description to the gemspec.
+* Minor test refactoring.
+
+== 0.3.2 - 20-Feb-2009
 * Added support for the :mount option.
 * Added some basic tests for the :mount option.
 
-== 0.3.1 - 9-Jan-2008
+== 0.3.1 - 9-Jan-2009
 * Now defaults to using Etc instead of Sys::Admin for implementations
   that don't support building C extensions, e.g. JRuby.
 * Updated the test suite to work with JRuby.

data/README

@@ -99,7 +99,7 @@ http://www.rubyforge.org/projects/shards.
 * Hal Fulton for his implementation of symbolic permissions.
 
 = License
-Ruby's
+Artistic 2.0
 
 = Copyright
 (C) 2007-2009, Daniel J. Berger, All Rights Reserved

data/test/test_file_find.rb

@@ -23,7 +23,7 @@ include FileUtils
 
 class TC_File_Find < Test::Unit::TestCase
    def self.startup
-      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
+      Dir.chdir(File.dirname(File.expand_path(__FILE__)))
 
       @@windows = CONFIG['host_os'] =~ /windows|mswin/i
       @@jruby   = RUBY_PLATFORM.match('java')
@@ -40,35 +40,35 @@ class TC_File_Find < Test::Unit::TestCase
    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'){}
+      @file_rb    = 'test1.rb'
+      @file_txt1  = 'test1.txt'
+      @file_txt2  = 'foo.txt'
+      @file_doc   = 'foo.doc'
+      @directory1 = 'dir1'
+      @directory2 = 'dir2'
+
+      File.open(@file_rb, 'w'){}
+      File.open(@file_txt1, 'w'){}
+      File.open(@file_txt2, 'w'){}
+      File.open(@file_doc, 'w'){}
 
       unless @@windows
          @link1 = 'link1'
-         File.symlink(@file1, @link1)
+         File.symlink(@file_rb, @link1)
       end
 
-      Dir.mkdir(@dir1) unless File.exists?(@dir1)
-      Dir.mkdir(@dir2) unless File.exists?(@dir2)
+      Dir.mkdir(@directory1) unless File.exists?(@directory1)
+      Dir.mkdir(@directory2) unless File.exists?(@directory2)
 
-      File.open(File.join(@dir1, 'bar.txt'), 'w'){}
-      File.open(File.join(@dir2, 'baz.txt'), 'w'){}
+      File.open(File.join(@directory1, 'bar.txt'), 'w'){}
+      File.open(File.join(@directory2, 'baz.txt'), 'w'){}
 
       @rule1 = File::Find.new(:name => '*.txt')
       @rule2 = File::Find.new
    end
 
    def test_version
-      assert_equal('0.3.2', File::Find::VERSION)
+      assert_equal('0.3.3', File::Find::VERSION)
    end
 
    def test_path
@@ -137,11 +137,11 @@ class TC_File_Find < Test::Unit::TestCase
       omit_if(@@windows && @@jruby, "Skipping file test on JRuby/Windows")
 
       rule = File::Find.new(:name => "*.doc", :writable? => true)
-      File.chmod(0644, @file4)
+      File.chmod(0644, @file_doc)
 
-      assert_equal([@file4], rule.find.map{ |f| File.basename(f) })
+      assert_equal([@file_doc], rule.find.map{ |f| File.basename(f) })
 
-      File.chmod(0444, @file4)
+      File.chmod(0444, @file_doc)
 
       assert_equal([], rule.find)
    end
@@ -183,13 +183,13 @@ class TC_File_Find < Test::Unit::TestCase
    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)
+      assert_equal([File.expand_path(@file_doc)], @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)
+      assert_equal([File.expand_path(@file_doc)], @rule1.find)
    end
 
    def test_group_with_bad_id
@@ -212,6 +212,22 @@ class TC_File_Find < Test::Unit::TestCase
       assert_true(@rule1.follow)
    end
 
+   def test_links_basic
+      assert_respond_to(@rule1, :links)
+      assert_respond_to(@rule1, :links=)
+      assert_nil(@rule1.links)
+   end
+
+   def test_links
+      omit_if(@@windows, 'links test skipped on MS Windows')
+
+      @rule1 = File::Find.new(:name => '*.rb', :links => 2)
+      @rule2 = File::Find.new(:name => '*.doc', :links => 1)
+
+      assert_equal([], @rule1.find)
+      assert_equal([File.expand_path(@file_doc)], @rule2.find)
+   end
+
    def test_maxdepth_basic
       assert_respond_to(@rule1, :maxdepth)
       assert_respond_to(@rule1, :maxdepth=)
@@ -333,8 +349,8 @@ class TC_File_Find < Test::Unit::TestCase
 
    def test_perm
       omit_if(@@windows, 'perm test skipped on MS Windows')
-      File.chmod(0664, @file1) 
-      File.chmod(0644, @file2) 
+      File.chmod(0664, @file_rb) 
+      File.chmod(0644, @file_txt1) 
       results = File::Find.new(:name => "test1*", :perm => 664).find
 
       assert_equal(1, results.length)
@@ -344,8 +360,8 @@ class TC_File_Find < Test::Unit::TestCase
    def test_perm_with_symbolic_permissions
       omit_if(@@windows, 'symbolic perm test skipped on MS Windows')
 
-      File.chmod(0664, @file1)  # test1.rb
-      File.chmod(0644, @file2)  # test1.txt
+      File.chmod(0664, @file_rb)  # test1.rb
+      File.chmod(0644, @file_txt1)  # test1.txt
       results1 = File::Find.new(:name => "test1*", :perm => "g=rw").find
       results2 = File::Find.new(:name => "test1*", :perm => "u=rw").find
 
@@ -381,13 +397,13 @@ class TC_File_Find < Test::Unit::TestCase
    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)
+      assert_equal([File.expand_path(@file_doc)], @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)
+      assert_equal([File.expand_path(@file_doc)], @rule1.find)
    end
 
    def test_user_with_bad_id
@@ -409,12 +425,12 @@ class TC_File_Find < Test::Unit::TestCase
    end
 
    def teardown
-      rm_rf(@file1)
-      rm_rf(@file2)
-      rm_rf(@file3)
-      rm_rf(@file4)
-      rm_rf(@dir1)
-      rm_rf(@dir2)
+      rm_rf(@file_rb)
+      rm_rf(@file_txt1)
+      rm_rf(@file_txt2)
+      rm_rf(@file_doc)
+      rm_rf(@directory1)
+      rm_rf(@directory2)
       rm_rf(@link1) unless @@windows
       rm_rf('a')
       rm_rf('a1')
@@ -422,10 +438,10 @@ class TC_File_Find < Test::Unit::TestCase
 
       @rule1 = nil
       @rule2 = nil
-      @file1 = nil
-      @file2 = nil
-      @file3 = nil
-      @file4 = nil
+      @file_rb = nil
+      @file_txt1 = nil
+      @file_txt2 = nil
+      @file_doc = nil
    end
 
    def self.shutdown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: file-find
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Daniel Berger
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-20 00:00:00 -07:00
+date: 2009-08-03 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
-  type: :runtime
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.2
+        version: 2.0.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: sys-admin
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.4.4
     version: 
-description: A better, object oriented way to find files
+description: "      The file-find library provides a better, more object oriented approach\n      to finding files. It allows you to find files based on a variety of\n      properties, such as access time, size, owner, etc. You can also limit\n      directory depth.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -43,16 +43,14 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files: 
-- lib/file
-- lib/file/find.rb
 - test/test_file_find.rb
 - README
 - CHANGES
 - MANIFEST
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
-licenses: []
-
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -73,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: shards
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A better way to find files

data/lib/file/find.rb

@@ -1,487 +0,0 @@
-require 'date'
-require 'rbconfig'
-
-# For alternate implementations of Ruby, such as JRuby, that cannot
-# build C extensions fall back to the Etc module.
-begin
-   require 'sys/admin'
-rescue LoadError
-   require 'etc'
-end
-
-class File::Find
-   # The version of this library
-   VERSION = '0.3.2'
-
-   # :stopdoc:
-   VALID_OPTIONS = %w/
-      atime
-      ctime
-      follow
-      ftype
-      inum
-      group
-      maxdepth
-      mindepth
-      mount
-      mtime
-      name
-      pattern
-      path
-      perm
-      prune
-      size
-      user
-   /
-   # :startdoc:
-
-   # The starting path(s) for the search. The default is the current directory.
-   # This can be a single path or an array of paths.
-   #
-   attr_accessor :path
-
-   # The list of options passed to the constructor and/or used by the
-   # File::Find#find method.
-   #
-   attr_accessor :options
-
-   # Limits searches by file access time, where the value you supply is the
-   # number of days back from the time that the File::Find#find method was
-   # called.
-   #
-   attr_accessor :atime
-
-   # Limits searches by file change time, where the value you supply is the
-   # number of days back from the time that the File::Find#find method was
-   # called.
-   #
-   attr_accessor :ctime
-
-   # 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
-
-   # 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.
-   #
-   attr_accessor :follow
-
-   # Limits searches to specific types of files. The possible values here are
-   # those returned by the File.ftype method.
-   #
-   attr_accessor :ftype
-
-   # Limits search to a file with a specific inode number. Ignored on MS
-   # Windows.
-   #
-   attr_accessor :inum
-
-   # Limits search to a maximum depth into the tree relative to the starting
-   # search directory.
-   #
-   attr_accessor :maxdepth
-
-   # Limits searches to a minimum depth into the tree relative to the starting
-   # search directory.
-   #
-   attr_accessor :mindepth
-
-   # Limits searches to the same filesystem as the specified directory. For
-   # Windows users, this refers to the volume.
-   #
-   attr_accessor :mount
-
-   # 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.
-   #
-   attr_accessor :mtime
-
-   # The name pattern used to limit file searches. The patterns that are legal
-   # for Dir.glob are legal here. The default is '*', i.e. everything.
-   #
-   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.
-   #
-   # You may optionally use symbolic permissions, e.g. "g+rw", "u=rwx", etc.
-   #
-   # Not currently supported on MS Windows.
-   #
-   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
-   # limit searches to files greater than or equal to 200 bytes.
-   #
-   attr_accessor :size
-
-   # 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
-
-   # 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
-   # 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'],
-   #       :readable? => true
-   #    )
-   #
-   def initialize(options = {})
-      @options = options      
-
-      @atime  = nil
-      @ctime  = nil
-      @ftype  = nil
-      @group  = nil
-      @follow = true
-      @inum   = nil
-      @mount  = nil
-      @mtime  = nil
-      @perm   = nil
-      @prune  = nil
-      @size   = nil
-      @user   = nil
-
-      @previous = nil
-      @maxdepth = nil
-      @mindepth = nil
-      @filetest = []
-
-      validate_and_set_options(options) unless options.empty?
-
-      @filesystem = File.stat(@mount).dev if @mount
-
-      @path ||= Dir.pwd
-      @name ||= '*'
-   end
-
-   # Executes the find based on the rules you set for the File::Find object.
-   # 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
-
-      if @prune
-         prune_regex = Regexp.new(@prune)
-      else
-         prune_regex = nil
-      end
-
-      paths.each{ |path|
-         begin
-            Dir.foreach(path){ |file|
-               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
-
-               # Skip files we cannot access, stale links, etc.
-               begin
-                  stat_info = File.send(stat_method, file)
-               rescue Errno::ENOENT, Errno::EACCES
-                  next
-               rescue Errno::ELOOP
-                  stat_method = :lstat # Handle recursive symlinks
-                  retry if stat_method.to_s != 'lstat'
-               end
-
-               glob = File.join(File.dirname(file), @name)
-
-               # 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 @mount
-                  next unless stat_info.dev == @filesystem
-               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)
-
-               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 || @ctime || @mtime
-                  date1 = Date.parse(Time.now.to_s)
-
-                  if @atime
-                     date2 = Date.parse(stat_info.atime.to_s)
-                     next unless (date1 - date2).numerator == @atime
-                  end
-
-                  if @ctime
-                     date2 = Date.parse(stat_info.ctime.to_s)
-                     next unless (date1 - date2).numerator == @ctime
-                  end
-
-                  if @mtime
-                     date2 = Date.parse(stat_info.mtime.to_s)
-                     next unless (date1 - date2).numerator == @mtime
-                  end
-               end
-
-               if @ftype
-                  next unless File.ftype(file) == @ftype
-               end
-
-               if @group
-                  if @group.is_a?(String)
-                     next unless get_group(stat_info.gid).name == @group
-                  else
-                     next unless stat_info.gid == @group
-                  end
-               end
-
-               unless Config::CONFIG['host_os'] =~ /windows|mswin/i
-                  if @inum
-                     next unless stat_info.ino == @inum
-                  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
-                  if @perm.is_a?(String)
-                     octal_perm = sym2oct(@perm)
-                     next unless stat_info.mode & octal_perm == octal_perm
-                  else
-                     next unless sprintf("%o", stat_info.mode & 07777) == @perm.to_s
-                  end
-               end
-
-               # Allow plain numbers, or strings for comparison operators.
-               if @size
-                  if @size.is_a?(String)
-                     regex = /^([><=]+)\s*?(\d+)$/
-                     match = regex.match(@size)
-
-                     if match.nil? || match.captures.include?(nil)
-                        raise ArgumentError, "invalid size string: '#{@size}'"
-                     end
-
-                     operator = match.captures.first.strip
-                     number   = match.captures.last.strip.to_i
-
-                     next unless stat_info.size.send(operator, number)
-                  else
-                     next unless stat_info.size == @size
-                  end
-               end
-
-               if @user
-                  if @user.is_a?(String)
-                     next unless get_user(stat_info.uid).name == @user
-                  else
-                     next unless stat_info.uid == @user
-                  end
-               end
-
-               if block_given?
-                  yield file
-               else
-                  results << file
-               end
-
-               @previous = file unless @previous == file
-            }
-         rescue Errno::EACCES
-            next # Skip inaccessible directories
-         end
-      }
-
-      block_given? ? nil : results
-   end
-
-   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. 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
-
-         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
-      end
-   end
-
-   # Converts a symoblic permissions mode into its octal equivalent.
-   #--
-   # Taken almost entirely from ruby-talk: 96956 (Hal Fulton).
-   #
-   def sym2oct(str)
-      left  = {'u' => 0700, 'g' => 0070, 'o' => 0007, 'a' => 0777}
-      right = {'r' => 0444, 'w' => 0222, 'x' => 0111}
-      regex = /([ugoa]+)([+-=])([rwx]+)/
-
-      cmds = str.split(',')
-
-      perm = 0
-
-      cmds.each do |cmd|
-         match = cmd.match(regex)
-         raise "Invalid symbolic permissions: '#{str}'" if match.nil?
-
-         junk, who, what, how = match.to_a
-
-         who = who.split(//).inject(num=0) { |num,b| num |= left[b]; num }
-         how = how.split(//).inject(num=0) { |num,b| num |= right[b]; num }
-         mask = who & how
-
-         case what
-            when '+'
-               perm = perm | mask
-            when '-'
-               perm = perm & ~mask
-            when '='
-               perm = mask
-         end
-      end
-
-      perm
-   end
-
-   # Returns the group object based on the group id. Implemented for the
-   # sake of platforms that cannot build extensions, such as JRuby.
-   #
-   def get_group(gid)
-      if defined? Sys::Admin
-         Sys::Admin.get_group(gid)
-      else
-         Etc.getgrgid(gid)
-      end
-   end
-
-   # Returns the user object based on the group id. Implemented for the
-   # sake of platforms that cannot build extensions, such as JRuby.
-   #
-   def get_user(uid)
-      if defined? Sys::Admin
-         Sys::Admin.get_user(uid)
-      else
-         Etc.getpwuid(uid)
-      end
-   end
-end