lib/find.rb

   1 #
   2 # find.rb: the Find module for processing all files under a given directory.
   3 #
   4
   5 #
   6 # The +Find+ module supports the top-down traversal of a set of file paths.
   7 #
   8 # For example, to total the size of all files under your home directory,
   9 # ignoring anything in a "dot" directory (e.g. $HOME/.ssh):
  10 #
  11 #   require 'find'
  12 #
  13 #   total_size = 0
  14 #
  15 #   Find.find(ENV["HOME"]) do |path|
  16 #     if FileTest.directory?(path)
  17 #       if File.basename(path)[0] == ?.
  18 #         Find.prune       # Don't look any further into this directory.
  19 #       else
  20 #         next
  21 #       end
  22 #     else
  23 #       total_size += FileTest.size(path)
  24 #     end
  25 #   end
  26 #
  27 module Find
  28
  29   #
  30   # Calls the associated block with the name of every file and directory listed
  31   # as arguments, then recursively on their subdirectories, and so on.
  32   #
  33   # See the +Find+ module documentation for an example.
  34   #
  35   def find(*paths) # :yield: path
  36     block_given? or return enum_for(__method__, *paths)
  37
  38     paths.collect!{|d| raise Errno::ENOENT unless File.exist?(d); d.dup}
  39     while file = paths.shift
  40       catch(:prune) do
  41         yield file.dup.taint
  42         next unless File.exist? file
  43         begin
  44           if File.lstat(file).directory? then
  45             d = Dir.open(file)
  46             begin
  47               for f in d
  48                 next if f == "." or f == ".."
  49                 if File::ALT_SEPARATOR and file =~ /^(?:[\/\\]|[A-Za-z]:[\/\\]?)$/ then
  50                   f = file + f
  51                 elsif file == "/" then
  52                   f = "/" + f
  53                 else
  54                   f = File.join(file, f)
  55                 end
  56                 paths.unshift f.untaint
  57               end
  58             ensure
  59               d.close
  60             end
  61           end
  62        rescue Errno::ENOENT, Errno::EACCES
  63         end
  64       end
  65     end
  66   end
  67
  68   #
  69   # Skips the current file or directory, restarting the loop with the next
  70   # entry. If the current file is a directory, that directory will not be
  71   # recursively entered. Meaningful only within the block associated with
  72   # Find::find.
  73   #
  74   # See the +Find+ module documentation for an example.
  75   #
  76   def prune
  77     throw :prune
  78   end
  79
  80   module_function :find, :prune
  81 end