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.



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

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)



455
456
457
458
459
460
461
# File 'lib/rbfind.rb', line 455

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.



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

def name
  @name
end

#pathObject (readonly)

Returns the value of attribute path.



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

def path
  @path
end

Class Method Details

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



769
770
771
772
# File 'lib/rbfind.rb', line 769

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

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



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/rbfind.rb', line 775

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



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

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

#arrowObject



531
532
533
# File 'lib/rbfind.rb', line 531

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)


652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/rbfind.rb', line 652

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 Also known as: broken?

Returns:

  • (Boolean)


521
522
523
524
525
526
527
# File 'lib/rbfind.rb', line 521

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

#cageObject



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

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

#carrowObject



713
714
715
716
# File 'lib/rbfind.rb', line 713

def carrow
  r = creadlink
  ARROW + r if r
end

#cfullpathObject



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

def cfullpath  ; color fullpath  ; end

#cfullpath!Object



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

def cfullpath! ; color fullpath! ; end

#cnameObject



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

def cname      ; color name      ; end

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



719
720
721
# File 'lib/rbfind.rb', line 719

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)


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

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

#cpathObject



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

def cpath      ; color path      ; end

#cpath!Object



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

def cpath!     ; color path!     ; end


705
706
707
708
709
710
711
# File 'lib/rbfind.rb', line 705

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

#depthObject



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

def depth ; @walk.depth ; end

#dir?Boolean

Returns:

  • (Boolean)


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

def dir? ; stat.directory? ; end

#dirnameObject



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

def dirname
  File.basename File.dirname fullpath
end

#doneObject Also known as: done!

Raises:



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

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)


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

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.



564
565
566
567
# File 'lib/rbfind.rb', line 564

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

#extObject



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

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.



478
479
480
481
482
483
484
485
# File 'lib/rbfind.rb', line 478

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

#fullpathObject



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

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

#fullpath!Object



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

def fullpath! ; append_slash fullpath ; end

#grep(re, color = nil) ⇒ Object



632
633
634
635
636
637
638
639
640
641
642
643
644
645
# File 'lib/rbfind.rb', line 632

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



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

def group
  get_group stat.gid
end

#group!Object



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

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

#hidden?Boolean

Returns:

  • (Boolean)


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

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

#linesObject

:call-seq:

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

Yield line by line together with the line number i.



617
618
619
620
621
622
623
624
625
626
627
628
629
630
# File 'lib/rbfind.rb', line 617

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



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

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

#modeObject



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

def mode ; stat.mode ; end

#novcsObject Also known as: no_vcs



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

def novcs
  prune if vcs?
end

#nowObject



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

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.



582
583
584
585
586
# File 'lib/rbfind.rb', line 582

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

#path!Object



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

def path!     ; append_slash path     ; end

#pruneObject Also known as: prune!

Raises:



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

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.



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
# File 'lib/rbfind.rb', line 596

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


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

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

#rename(newname) ⇒ Object Also known as: mv



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

def rename newname ; @name = newname ; end

#rmObject



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

def rm ; @name = nil ; end

#rstatObject



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

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

#statObject



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

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

#userObject Also known as: owner



498
499
500
# File 'lib/rbfind.rb', line 498

def user
  get_user stat.uid
end

#user!Object Also known as: owner!



503
504
505
506
# File 'lib/rbfind.rb', line 503

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

#vcs?Boolean

Returns:

  • (Boolean)


571
572
573
# File 'lib/rbfind.rb', line 571

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

#vimswap?Boolean

Returns:

  • (Boolean)


669
670
671
672
673
674
# File 'lib/rbfind.rb', line 669

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

#visible?Boolean

Returns:

  • (Boolean)


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

def visible? ; not hidden?   ; end

#without_extObject



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

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