rbfind 1.3.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWM0NTUwYWZjYTk3NGNmNDQ4ZmZmZDA5Zjk4MDI1ZWVlMWYxOTliNA==
+  data.tar.gz: !binary |-
+    OGFjM2UxYjQwNjFmMmI2ZGI2ZDkyNDE0MDJlOTBmNzA2ZTJlMTdhYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODdhNDUxNjRiYjlhYTE1ZDFlYzA2ODRiNDJmNGIwZDhkNTE5MDU2ZDEzZGVm
+    ZWNhZTJmODI0ZDczZGE3MDEyOTUyZDY5YWJmNGYxZGY5NTQ4YzA4MmY4ZGY2
+    MTczYWYyODYwMzBjMTE3N2JhNTRjYWZhZWExYzY1OWM0Yzc0NmU=
+  data.tar.gz: !binary |-
+    NGQ0OTg5N2UyYmQ5ODlmMmNiYTJiMjc5ZmNkMjRjNjFmYjVmNjYxZjU4MWY1
+    MTJkMTk2OTQxYmRmMmNjOTAyZWEyYTkyYzBjMTRjNWE4Mzg0NmE3ZWQ2N2Zm
+    MmRhODE1OTQ3ODAzYzQ2ODRhZjZlMmJiZmU5NzM2Y2UxNzQwODk=

data/LICENSE

@@ -0,0 +1,34 @@
+   ____  _     _____ _           _
+  |  _ \| |__ |  ___(_)_ __   __| |
+  | |_) | '_ \| |_  | | '_ \ / _` |
+  |  _ <| |_) |  _| | | | | | (_| |
+  |_| \_\_.__/|_|   |_|_| |_|\__,_|
+
+
+Copyright (c) 2008-2013, Bertram Scharpf <software@bertram-scharpf.de>.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in
+      the documentation and/or other materials provided with the
+      distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Rakefile

@@ -0,0 +1,18 @@
+#
+#  Rakefile  --  build RbFind project
+#
+
+task "README" do |t|
+  File.open t.name, "w" do |readme|
+    readme.puts `ruby -I lib bin/rbfind --version`
+    readme.puts
+    readme.puts `ruby -I lib bin/rbfind --examples`
+  end
+end
+
+task :default => "README"
+
+task :clean do |t|
+  sh "rm", "-fv", "README"
+end
+

data/bin/rbfind

@@ -0,0 +1,474 @@
+#!/usr/bin/ruby
+
+#
+#  rbfind  --  Ruby Find with many features
+#
+
+require "rbfind"
+
+PROGRAM = <<EOT
+rbfind #{RbFind::VERSION}  --  A find tool using Ruby
+
+  Author: Bertram Scharpf <software@bertram-scharpf.de>
+  License: BSD
+EOT
+
+
+require 'getoptlong'
+
+OPTIONS = [
+  #    options          arg   description
+  [ %w(--help      -h), nil,  "print this help"],
+  [ %w(--examples  -X), nil,  "print this help and examples"],
+  [ %w(--version   -V), nil,  "print version information"],
+  [ %w(--verbose   -v), nil,  "standard Ruby error reports"],
+  [ %w(--show      -o), nil,  "just show Ruby block built from options"],
+  [ %w(--bw        -w), nil,  "black and white on -p or default output"],
+  [ %w(--colored   -c), nil,  "force color on -p or default output"],
+  [ %w(--depth     -d), nil,  "yield directory after its contents"],
+  [ %w(--maxdepth  -m), :num, "maxium step depth"],
+  [ %w(--follow    -y), nil,  "follow symbolic links"],
+  [ %w(--sort      -s), :str, "=reverse/desc/-1,unsorted; default is sorted"],
+  [ %w(--sort-by   -S), :str, "sort expression ('name' is name)"],
+  [ %w(--require   -r), :rb,  "require library"],
+  [ %w(--fileutils -U), nil,  "include FileUtils module"],
+  [ %w(--puts-path -p), nil,  "do 'puts path/cpath' on true block"],
+  [ %w(--ls-l      -P), nil,  "do 'ls -l' style output on true block"],
+  [ %w(--wider     -+), nil,  "widen fields in long output format (--ls-l)"],
+  [ %w(--lines     -l), :blk, "surround block by 'lines { |$_,$.| ... }'"],
+  [ %w(--reallines -L), :blk, "same as -l but stop at any null character"],
+  [ %w(--grep      -g), :blk, "grep files (implies -pL)"],
+  [ %w(--igrep     -G), :blk, "case insensitive grep"],
+  [ %w(--binary    -b), nil,  "grep even binary files"],
+  [ %w(--no-vcs    -C), nil,  "prune version control dirs (CVS/.svn/.git)"],
+  [ %w(--no-swap   -W), nil,  "ignore Vim swapfiles"],
+  [ %w(--skip      -k), :lst, "filenames to skip"],
+  [ %w(--demand    -D), :lst, "skip all filenames but these"],
+  [ %w(--ext       -e), :lst, "skip all filename extensions but these"],
+  [ %w(--visible   -I), nil,  "skip all hidden (starting with .dot)"],
+  [ %w(--begin     -B), :blk, "eval block before begin"],
+  [ %w(--end       -E), :blk, "eval block after end"],
+  [ %w(--file      -f), :blk, "read block expression from file"],
+  [ %w(--encoding  -K), :str, "encoding extern[:intern] (same as ruby -E)"],
+]
+
+def usage
+  puts <<EOT
+Usage:
+
+  rbfind [options] path... 'block'
+
+EOT
+  OPTIONS.each { |(long,short),arg,desc|
+    puts "    %-12s %2s  %-5s  %s" % [long,short,arg.to_s.upcase,desc]
+  }
+  puts <<'EOT'
+
+  "--" stops option processing.
+
+  The last argument is a block that will be executed on every found
+  file object. It may be omitted; then "puts path" is assumed or "cpath"
+  in case the output is a terminal.
+
+  Default sort order is alphabetical.
+
+EOT
+end
+
+def usage_examples
+  usage
+  puts <<'EOT'
+Examples:
+  $ rbfind -p 'file and age < 5.m'
+  $ rbfind -p 'file and age > 1.d'
+  $ rbfind -p '(90.d .. 183.d) === age'
+
+  $ rbfind -Cg require
+  $ rbfind -Cp
+  $ rbfind 'filesize < 100.kB and grep /require/'
+  $ rbfind -g 'define\s*ALLOC_N'
+  $ rbfind myproject -e rb -l '~/require/ and puts $_'
+
+  $ rbfind -pe '.rb c h'
+  $ rbfind /usr/include -e .h -g EACCES
+  $ rbfind -d -m3 -- /mnt/data
+  $ rbfind 'filesize > 10.MiB and colsep size.to_hib, path'
+
+  $ rbfind -S "name =~ /^\.*/ ; $'.downcase"
+  $ rbfind -B '$s=0' -E 'puts $s.to_h' 'filesize {|s|$s+=s}'
+  $ rbfind 'puts path if ext == ".rb"'
+  $ rbfind -p 'ext == ".rb"'
+  $ rbfind /usr/include -p -D '\.h$' -l '~/EACCES/'
+  $ rbfind /usr/include -pD 'pg|pq|postgres' dir
+  $ rbfind 'no_svn ; puts path'
+  $ rbfind 'prune if name == ".svn" ; puts path'
+  $ rbfind -p 'prune if name == ".svn"'
+  $ rbfind myproject 'name[/\.rb$/] and lines { |l,i| l=~/require/ and puts l }'
+  # rbfind /etc 'lines { |l,| l["192.168."] and (puts path ; break) }'
+  $ rbfind /etc 'readable? or raise "Access denied: #{path}" ;
+  >              lines { |l,| l["192.168."] and (puts path ; break) }'
+
+  $ rbfind 'col_sep stype+modes, size[10], path'
+  $ rbfind 'tab_sep stype+modes, size[10], path'
+  $ rbfind 'spc_sep stype+modes, size.to_h, user, group, mtime.lsish, path'
+  $ rbfind 'spacesep stype+modes, size.to_h, user, group, mtime.lsish, path'
+  $ rbfind 'spacesep stype+modes, size.to_h, user, group, mtime!, path'
+  $ rbfind 'spacesep stype+modes, size.to_h, user, group, mtime.i, path'
+  $ rbfind 'spacesep mtime.u, path'
+  $ rbfind 'spacesep modes, user|8, group|8, size[8], cpath + carrow.to_s'
+
+  $ rbfind 'spacesep digest_md5, size[8], path'
+  $ rbfind 'spacesep digest_sha256, size[8], path'
+
+  $ rbfind 'rename name.downcase'
+  $ rbfind 'ext == ".tgz" and rename without_ext+".tar.gz"'
+
+  See the RbFind class documentation or the "rbfind.rb" source file for more
+  sophisticated examples and for a full list of file examination methods.
+
+  Valid units are 1.s, 1.m, 1.h, 1.d, 1.w for time values and
+  1.kB == 1000, 1.kiB == 1024, 1.MB, 1.MiB for file sizes.
+EOT
+end
+
+
+require "humansiz"
+require "English"
+
+
+class Time
+
+  # autoload several formating methods
+  def method_missing sym, *args, &block
+    if require "time" then
+      send sym, *args, &block
+    else
+      super
+    end
+  end
+
+  # several common schemes
+  def i ; iso8601   ; end
+  def x ; xmlschema ; end
+  def r ; rfc822    ; end
+  def u ; utc.strftime "%Y-%m-%d %H:%M:%S" ; end
+
+end
+
+
+class Integer
+  # convenient formatting, right justification
+  def method_missing sym, *args
+    case sym.to_s   # .to_s for Ruby 1.8
+      when /\Aw_?(\d+)/ then "%#{$1}d" % self
+      else                   super
+    end
+  end
+end
+
+class String
+  # convenient formatting, left justification
+  def method_missing sym, *args
+    case sym.to_s   # .to_s for Ruby 1.8
+      when /\Aw_?(\d+)/ then ljust $1.to_i
+      else                   super
+    end
+  end
+  def | width
+    ljust width
+  end
+  # conventient date/time construction
+  def time
+    Time.parse self
+  end
+end
+
+class NilClass
+  # This makes it very easy to compare the return value of `filesize'.
+  def <  oth ; false ; end
+  def <= oth ; false ; end
+  def >  oth ; false ; end
+  def >= oth ; false ; end
+  def between? min, max ; false ; end
+
+  def [] width ; " "*width ; end
+  def |  width ; " "*width ; end
+end
+
+
+def set_encoding extern, intern = nil
+  Encoding.default_external = extern if extern and not extern.empty?
+  Encoding.default_internal = intern if intern and not intern.empty?
+  [ $stdin, $stdout, $stderr].each do |io|
+    io.set_encoding extern, intern
+  end
+end
+
+
+class RbFindX < RbFind
+
+  # Alias the question marks away from all method names because
+  # they're a nuisance on the command line.
+  alias hidden       hidden?
+  alias visible      visible?
+  alias broken_link  broken_link?
+  alias dir          dir?
+  alias binary       binary?
+  alias bin          bin?
+  alias vimswap      vimswap?
+
+  def blockdev        ; blockdev?         ; end
+  def chardev         ; chardev?          ; end
+  def directory       ; directory?        ; end
+  def executable      ; executable?       ; end
+  def executable_real ; executable_real?  ; end
+  def file            ; file?             ; end
+  def grpowned        ; grpowned?         ; end
+  def owned           ; owned?            ; end
+  def pipe            ; pipe?             ; end
+  def readable        ; readable?         ; end
+  def readable_real   ; readable_real?    ; end
+  def setgid          ; setgid?           ; end
+  def setuid          ; setuid?           ; end
+  def socket          ; socket?           ; end
+  def sticky          ; sticky?           ; end
+  def symlink         ; symlink?          ; end
+  def writable        ; writable?         ; end
+  def writable_real   ; writable_real?    ; end
+  def zero            ; zero?             ; end
+
+  # convenient digest and time format methods
+  def method_missing sym, *args, &block
+    case sym.to_s
+      when /\Adigest_(.*)/, /\A([a-z]+[0-9]+)\z/ then
+        m = $1
+        c = m.upcase
+        begin
+          (Digest.const_get c).hexdigest read
+        rescue NameError
+          if m =~ /sha\d\d\d/ then m = "sha2" end
+          require "digest/#{m}" and retry
+          raise
+        end
+      when /\A([amc]time)!\z/ then
+        (send $1).strftime "%Y-%m-%d %H:%M:%S %z"
+      else
+        super
+    end
+  end
+
+end
+
+
+@params = {}
+
+opts = GetoptLong.new *OPTIONS.map { |(long,short),arg,|
+  [long,short,(arg ? GetoptLong::REQUIRED_ARGUMENT : GetoptLong::NO_ARGUMENT)]
+}
+opts.ordering = GetoptLong::PERMUTE
+opts.quiet = true
+begin
+  opts.each do |opt,arg|
+    case opt
+      when '--help'      then usage          ; exit
+      when '--version'   then puts PROGRAM   ; exit
+      when '--examples'  then usage_examples ; exit
+      when '--verbose'   then @verbose = true
+      when '--show'      then @show = true
+      when '--bw'        then @color = false
+      when '--colored'   then @color = true
+      when '--depth'     then @params[ :depth] = true
+      when '--maxdepth'  then @params[ :max_depth] = arg
+      when '--follow'    then @params[ :follow] = true
+      when '--sort'      then @params[ :sort] = arg
+      when '--sort-by'   then
+                    @params[ :sort] = instance_eval "proc { |name| #{arg} }"
+      when '--require'   then require arg
+      when '--fileutils' then require "fileutils" ; include FileUtils
+      when '--puts-path' then @puts = true
+      when '--ls-l'      then @puts = true ; @wd = 6
+      when '--wider'     then @wd = @wd ? @wd.succ : 4
+      when '--lines'     then @lines = :plain ;                 @block = arg
+      when '--reallines' then @lines = :plain ; @real = true ;  @block = arg
+      when '--grep'      then @lines = :grep  ;                 @block = arg
+      when '--igrep'     then @lines = :grep  ; @icase = true ; @block = arg
+      when '--binary'    then @binary = true
+      when '--no-vcs'    then @vcs = true
+      when '--no-swap'   then @vim = true
+      when '--skip'      then @skip = arg
+      when '--demand'    then @demand = arg
+      when '--ext'       then @ext = arg
+      when '--visible'   then @visible = true
+      when '--begin'     then @blkbegin = arg
+      when '--end'       then @blkend   = arg
+      when '--file'      then @block = File.read arg
+      when '--encoding'  then e, i = arg.split ":" ; set_encoding e, i
+    end
+  end
+rescue GetoptLong::InvalidOption
+  $stderr.puts $!
+  $stderr.puts
+  usage
+  exit 9
+rescue
+  $stderr.puts $!
+  exit 8
+end
+
+def color_on stream
+  unless @color.nil? then
+    @color
+  else
+    !File::ALT_SEPARATOR && stream.tty?
+  end
+end
+
+if color_on $stderr then
+  def show_error e
+    $stderr.puts "\e[31m#{e.class}: \e[1m#{e}\e[m"
+  end
+else
+  def show_error e
+    $stderr.puts "#{e.class}: #{e}"
+  end
+end
+
+def error_handle
+  if @verbose then
+    yield
+  else
+    begin
+      yield
+    rescue ArgumentError
+      show_error $!
+      if $!.message[ "invalid byte sequence"] then
+        $stderr.puts <<-EOT
+Hint: Try to give me a different default encoding by explicitly giving one or
+by changing the locale.
+
+  $ rbfind -K ascii-8bit ...
+  $ LC_ALL="C" rbfind ...
+
+        EOT
+      end
+      exit 1
+    rescue
+      show_error $!
+      exit 1
+    rescue NoMemoryError, ScriptError, SignalException
+      show_error $!
+      exit 2
+    end
+  end
+end
+
+
+error_handle do
+
+  co = color_on $stdout
+  opath = co ? "cpath" : "path"
+  case @lines
+    when :plain then
+      @puts and @block = "( #@block ) and colsep #{opath}, $., $_"
+      @real and @block = "break if ~/\0/o ; #@block"
+      @block = "lines { |line,num| $_, $. = line, num ; #@block }"
+
+    when :grep then
+      RE = Regexp.new @block, @icase && Regexp::IGNORECASE
+      @block = "grep RE"
+      @block << ", true" if co
+      @binary or @block = "not binary? and #@block"
+
+    else
+      @block ||= if $*.last and not (File.exists? $*.last) then
+        $*.pop.dup
+      else
+        @puts ||= true
+        "true"
+      end
+      if @puts then
+        @block = "( #@block ) and "
+        @block << if @wd then
+          "spcsep stype+modes, user|#@wd, group|#@wd, size.w#@wd, " +
+              "mtime.lsish, #{opath} + #{co ? 'carrow' : 'arrow'}.to_s"
+        else
+          "puts #{opath}"
+        end
+      end
+
+  end
+
+  if @skip then
+    RE_SKIP = Regexp.new @skip, File::ALT_SEPARATOR&&Regexp::IGNORECASE
+    @block.insert 0, "next if name =~ RE_SKIP ; "
+  end
+
+  if @demand then
+    RE_DEMAND = Regexp.new @demand, File::ALT_SEPARATOR&&Regexp::IGNORECASE
+    @block.insert 0, "next unless name =~ RE_DEMAND ; "
+  end
+
+  if @ext then
+    RE_EXT = Regexp.new '\A\.(' +
+      @ext.split(/ +|,/).map { |e| e[ /\A\.?(.*)\z/, 1] }.join('|') + ')\z',
+      File::ALT_SEPARATOR&&Regexp::IGNORECASE
+    @block.insert 0, "ext =~ RE_EXT or next ; "
+  end
+
+  @visible and @block.insert 0, "visible? or prune ; "
+
+  @vcs and @block.insert 0, "no_vcs ; "
+  @vim and @block.insert 0, "vimswap? and next ; "
+
+  args = $*.dup
+  if args.empty? and not $stdin.tty? then
+    $stdin.each_line { |l|
+      l.chomp!
+      args.push l
+    }
+  end
+
+  if @show then
+    class Proc
+      def to_s
+        "#<%s:0x%08x>" % [ self.class, object_id]
+      end
+    end
+    INDENT = " "*2
+    def puts_val *args
+      l = [ INDENT, *args].join ""
+      puts l
+    end
+    puts "arguments:"
+    args.each { |a| puts_val a }.any?              or puts_val "(none)"
+    puts "parameters:"
+    @params.each { |k,v| puts_val k, "=", v }.any? or puts_val "(none)"
+    puts "block:"
+    self.class.constants.grep( /^RE(_[A-Z]+)?$/).each { |re|
+      v = self.class.const_get re
+      puts_val re, "=", v
+    }
+    puts_val @block
+    exit
+  end
+
+  @params[ :error] = proc do
+    case $!
+      when Errno::EPIPE         then raise
+      when NameError, TypeError then raise
+      when ArgumentError        then raise
+      else                           show_error $!
+    end
+  end
+
+  @block = <<-EOT
+handle_error do
+  #@block
+end
+  EOT
+
+  eval @blkbegin if @blkbegin
+  RbFindX.open args, @params do |f| f.instance_eval @block end
+  eval @blkend   if @blkend
+end
+

data/lib/humansiz.rb

@@ -0,0 +1,129 @@
+#
+#  humansiz.rb  --  human readable sizes
+#
+# Numeric class extensions for human readable sizes.
+
+=begin rdoc
+
+Human readable sizes, times, and modes.
+
+Examples:
+
+  4096.to_h   # => "  4.1kB"
+  4096.to_hib # => "   4.0kiB"
+  1.MB        # => 1000000
+  1.MiB       # => 1048576
+  1.5.kiB     # => 1536.0
+
+  1.h   # => 3600
+  1.w   # => 604800
+
+=end
+
+class Numeric                   # sizes in bytes
+
+  # :stopdoc:
+  K = 1000
+  M = K * K
+  G = K * M
+  T = K * G
+  # :startdoc:
+
+  def kB ; self * K ; end
+  def MB ; self * M ; end
+  def GB ; self * G ; end
+  def TB ; self * T ; end
+
+
+  # :stopdoc:
+  Kb = 1024
+  Mb = Kb * Kb
+  Gb = Kb * Mb
+  Tb = Kb * Gb
+  # :startdoc:
+
+  def kiB ; self * Kb ; end
+  def MiB ; self * Mb ; end
+  def GiB ; self * Gb ; end
+  def TiB ; self * Tb ; end
+
+  PREFIXES = " kMGTPEZY".scan /./   # :nodoc:
+
+  # :call-seq:
+  #    num.to_h()  -> str
+  #
+  # To human readable with decimal prefixes.
+  #
+  #   4096.to_h   #=> "  4.1kB"
+  #
+  def to_h
+    n = 0
+    s = to_f
+    while s >= K do s /= K ; n += 1 end
+    format = n.zero? ? "%3d  " : "%5.1f"
+    (format % s) + (PREFIXES[ n]||"?") + "B"
+  end
+
+  # :call-seq:
+  #    num.to_hib()  -> str
+  #
+  # To human readable with binary prefixes.
+  #
+  #   4096.to_hib   #=> "   4.0kiB"
+  #
+  def to_hib
+    n = 0
+    s = to_f
+    while s >= Kb do s /= Kb ; n += 1 end
+    format = n.zero? ? "%4d  " : "%6.1f"
+    (format % s) + (PREFIXES[ n]||"?") + "iB"
+  end
+
+end
+
+
+class Numeric                   # time values
+  def s ; self      ; end
+  def m ; s    * 60 ; end
+  def h ; m    * 60 ; end
+  def d ; h    * 24 ; end
+  def w ; d    *  7 ; end
+end
+
+
+
+class Time
+
+  # :call-seq:
+  #    time.lsish()  -> str
+  #
+  # Build a time string like in <code>ls -l</code>. When the year is
+  # the current, show the time. While <code>ls</code> doesn't show
+  # the seconds, this will allways include them.
+  #
+  #   Time.now.lsish           #=> " 8. Oct 15:15:19"
+  #   file.stat.mtime.lsish    #=> " 1. Apr 2008    "
+  #
+  def lsish
+    strftime "#{PERC_DAY}. %b " +
+              (year == Time.now.year ? "%H:%M:%S" : "%Y    ")
+  end
+
+  # Windows has no "%e".
+  PERC_DAY = Time.now.strftime("%e") =~ /\d/ ? "%e" : "%d"   # :nodoc:
+
+end
+
+
+class Integer
+  def hex
+    to_s 0x10
+  end
+  def oct
+    to_s 010
+  end
+  def bin
+    to_s 0b10
+  end
+end
+