Class: RbFind::Entry

Inherits:
Object
  • Object
show all
Includes:
Csv
Defined in:
lib/rbfind.rb

Constant Summary collapse

ARROW =
" -> "

Constants included from Csv

Csv::COLON

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Csv

#colsep, #csv, outfile, putl, #spcsep, #tabsep

Constructor Details

#initialize(name, path, walk) ⇒ Entry

Returns a new instance of Entry.



412
413
414
# File 'lib/rbfind.rb', line 412

def initialize name, path, walk
  @name, @path, @walk = name, path, walk
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object (private)



447
448
449
450
451
452
453
# File 'lib/rbfind.rb', line 447

def method_missing sym, *args, &block
  if stat.respond_to? sym then
    stat.send sym, *args, &block
  else
    super
  end
end

Instance Attribute Details

#nameObject (readonly)

Returns the value of attribute name.



410
411
412
# File 'lib/rbfind.rb', line 410

def name
  @name
end

#pathObject (readonly)

Returns the value of attribute path.



410
411
412
# File 'lib/rbfind.rb', line 410

def path
  @path
end

Class Method Details

.colored(arg, num) ⇒ Object Also known as: coloured



758
759
760
761
# File 'lib/rbfind.rb', line 758

def colored arg, num
  colors col_str
  "\e[#{@colors[num]}m#{arg}\e[m"
end

.colors(str) ⇒ Object Also known as: colours



764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
# File 'lib/rbfind.rb', line 764

def colors str
  @colors ||= if str =~ /:/ then
    h = {}
    (str.split ":").each { |a|
      t, c = a.split "="
      h[  t] = c
    }
    %w(rs or di ln so pi ex bd cd su sg tw ow - -).map { |t| h[ t] }
  else
    cols = []
    str.scan /(.)(.)/i do
      fg, bg = $~.captures.map { |x| x.downcase.ord - ?a.ord }
      a = []
      case fg
        when 0..7 then a.push 30 + fg
      end
      a.push 1 if $1 == $1.upcase
      case bg
        when 0..7 then a.push 40 + bg
      end
      e = a.join ";"
      cols.push e
    end
    cols
  end
end

Instance Method Details

#aageObject



458
# File 'lib/rbfind.rb', line 458

def aage ; @walk.start - stat.atime ; end

#arrowObject



522
523
524
# File 'lib/rbfind.rb', line 522

def arrow
  ARROW + (File.readlink @path) if stat.symlink?
end

#binary?(n = 1) ⇒ Boolean Also known as: bin?

:call-seq:

binary?( n = 1)   -> true or false

Test whether the first n blocks contain null characters.

Returns:

  • (Boolean)


643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
# File 'lib/rbfind.rb', line 643

def binary? n = 1
  bs = stat.blksize
  open { |file|
    loop do
      if n then
        break if n <= 0
        n -= 1
      end
      b = file.read bs
      b or break
      return true if b[ "\0"]
    end
  }
  false
end

#broken_link?Boolean

Returns:

  • (Boolean)


513
514
515
516
517
518
519
# File 'lib/rbfind.rb', line 513

def broken_link?
  return if stat.symlink?
  rstat
  false
rescue
  true
end

#cageObject



460
# File 'lib/rbfind.rb', line 460

def cage ; @walk.start - stat.ctime ; end

#carrowObject



702
703
704
705
# File 'lib/rbfind.rb', line 702

def carrow
  r = creadlink
  ARROW + r if r
end

#cfullpathObject



690
# File 'lib/rbfind.rb', line 690

def cfullpath  ; color fullpath  ; end

#cfullpath!Object



692
# File 'lib/rbfind.rb', line 692

def cfullpath! ; color fullpath! ; end

#cnameObject



688
# File 'lib/rbfind.rb', line 688

def cname      ; color name      ; end

#color(arg) ⇒ Object Also known as: colour



708
709
710
# File 'lib/rbfind.rb', line 708

def color arg
  color_stat arg, stat
end

#contains?(name) ⇒ Boolean

:call-seq:

contains?( name)     -> true or false

Check whether a directory contains an entry.

Returns:

  • (Boolean)


545
546
547
# File 'lib/rbfind.rb', line 545

def contains? name
  File.exists? File.join @path, name
end

#cpathObject



689
# File 'lib/rbfind.rb', line 689

def cpath      ; color path      ; end

#cpath!Object



691
# File 'lib/rbfind.rb', line 691

def cpath!     ; color path!     ; end


694
695
696
697
698
699
700
# File 'lib/rbfind.rb', line 694

def creadlink
  l = readlink
  if l then
    s = rstat rescue nil
    color_stat l, s
  end
end

#depthObject



416
# File 'lib/rbfind.rb', line 416

def depth ; @walk.depth ; end

#dir?Boolean

Returns:

  • (Boolean)


456
# File 'lib/rbfind.rb', line 456

def dir? ; stat.directory? ; end

#dirnameObject



432
433
434
# File 'lib/rbfind.rb', line 432

def dirname
  File.basename File.dirname fullpath
end

#doneObject Also known as: done!

Raises:



669
# File 'lib/rbfind.rb', line 669

def done  ; raise Done  ; end

#empty?Boolean

:call-seq:

empty?()     -> true or false

Look up if the directory is empty. If the object is not a directory or not accessible, nil is returned.

Returns:

  • (Boolean)


534
535
536
537
538
# File 'lib/rbfind.rb', line 534

def empty?
  (Dir.new @path).each_child { |f| return false }
  true
rescue Errno::ENOTDIR
end

#entriesObject Also known as: children

:call-seq:

entries()     -> ary

Return all entries in an array. If the object is not a directory, nil is returned.



555
556
557
558
# File 'lib/rbfind.rb', line 555

def entries
  (Dir.new @path).children
rescue Errno::ENOTDIR
end

#extObject



437
# File 'lib/rbfind.rb', line 437

def ext         ; File.extname name ; end

#filesizeObject

:call-seq:

filesize => nil or int
filesize { |size| ... } => obj

Returns the files size. When the object is not a regular file, nil will be returned or the block will not be called.



470
471
472
473
474
475
476
477
# File 'lib/rbfind.rb', line 470

def filesize
  stat.file? or return
  if block_given? then
    yield stat.size
  else
    stat.size
  end
end

#fullpathObject



419
# File 'lib/rbfind.rb', line 419

def fullpath ; @fullpath ||= File.absolute_path @path, @walk.wd ; end

#fullpath!Object



430
# File 'lib/rbfind.rb', line 430

def fullpath! ; append_slash fullpath ; end

#grep(re, color = nil) ⇒ Object



623
624
625
626
627
628
629
630
631
632
633
634
635
636
# File 'lib/rbfind.rb', line 623

def grep re, color = nil
  case color
    when /\A\d+(?:;\d+)*\z/, nil, false then
    when true then color = "31;1"  # red
    else           raise "Illegal color spec: #{color}"
  end
  lines { |l,i|
    l.scrub!
    l =~ re or next
    color and l = "#$`\e[#{color}m#$&\e[m#$'"
    colsep @path, i, l
    true
  }
end

#groupObject



501
502
503
# File 'lib/rbfind.rb', line 501

def group
  get_group stat.gid
end

#group!Object



505
506
507
508
# File 'lib/rbfind.rb', line 505

def group!
  g = stat.gid
  g == Process.gid ? "." : (get_group g)
end

#hidden?Boolean

Returns:

  • (Boolean)


440
# File 'lib/rbfind.rb', line 440

def hidden?  ; name =~ /^\./ ; end

#linesObject

:call-seq:

lines { |l,i| ... }    -> nil

Yield line by line together with the line number i.



608
609
610
611
612
613
614
615
616
617
618
619
620
621
# File 'lib/rbfind.rb', line 608

def lines
  block_given? or return lines do end
  r = false
  open { |file|
    n = 0
    file.each_line { |l|
      l.chomp!
      n += 1
      $_, $. = l, n
      r ||= true if yield l, n
    }
    r
  }
end

#mageObject Also known as: age



459
# File 'lib/rbfind.rb', line 459

def mage ; @walk.start - stat.mtime ; end

#modeObject



444
# File 'lib/rbfind.rb', line 444

def mode ; stat.mode ; end

#novcsObject Also known as: no_vcs



675
676
677
# File 'lib/rbfind.rb', line 675

def novcs
  prune if vcs?
end

#nowObject



417
# File 'lib/rbfind.rb', line 417

def now   ; @walk.start ; end

#open(&block) ⇒ Object

:call-seq:

open() { |h| ... }    -> obj

Open the file for reading. If the object is not a regular file, nothing will be done.



573
574
575
576
577
# File 'lib/rbfind.rb', line 573

def open &block
  @ostat and @ostat.identical? @path and
    raise "Refusing to open output file."
  File.open @path, &block if file?
end

#path!Object



429
# File 'lib/rbfind.rb', line 429

def path!     ; append_slash path     ; end

#pruneObject Also known as: prune!

Raises:



672
# File 'lib/rbfind.rb', line 672

def prune ; raise Prune ; end

#read(n = nil) ⇒ Object

:call-seq:

read( n = nil)               -> str or nil
read( n = nil) { |b| ... }   -> nil

Read the first n bytes or return nil for others than regular files. nil reads to end of file. If a block is given, chonks of n bytes (or all) will be yielded.



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
# File 'lib/rbfind.rb', line 587

def read n = nil
  open { |o|
    if block_given? then
      if n then
        while (r = o.read n) do
          yield r
        end
      else
        yield o.read
      end
    else
      o.read n
    end
  }
end


511
# File 'lib/rbfind.rb', line 511

def readlink ; File.readlink @path if stat.symlink? ; end

#rename(newname) ⇒ Object



684
# File 'lib/rbfind.rb', line 684

def rename newname ; @name = newname ; end

#rstatObject



422
# File 'lib/rbfind.rb', line 422

def rstat ; @rstat ||= File.stat  @path ; end

#statObject



421
# File 'lib/rbfind.rb', line 421

def stat  ; @stat  ||= File.lstat @path ; end

#userObject Also known as: owner



490
491
492
# File 'lib/rbfind.rb', line 490

def user
  get_user stat.uid
end

#user!Object Also known as: owner!



495
496
497
498
# File 'lib/rbfind.rb', line 495

def user!
  u = stat.uid
  u == Process.uid ? "."  : (get_user u)
end

#vcs?Boolean

Returns:

  • (Boolean)


562
563
564
# File 'lib/rbfind.rb', line 562

def vcs?
  %w(CVS .svn .git .hg .fslckout).include? name
end

#vimswap?Boolean

Returns:

  • (Boolean)


660
661
662
663
664
665
# File 'lib/rbfind.rb', line 660

def vimswap?
  if name =~ /\A(\..+)?\.sw[a-z]\z/i then
    mark = read 5
    mark == "b0VIM"
  end
end

#visible?Boolean

Returns:

  • (Boolean)


441
# File 'lib/rbfind.rb', line 441

def visible? ; not hidden?   ; end

#without_extObject



438
# File 'lib/rbfind.rb', line 438

def without_ext ; name[ /^(.+?)(?:\.[^.]+)?$/, 1 ].to_s ; end