Class: FakeFS::Pathname

Inherits:
Object
  • Object
show all
Defined in:
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb,
lib/fakefs/pathname.rb

Overview

Pathname class

Constant Summary collapse

TO_PATH =
:to_path
SAME_PATHS =
if File::FNM_SYSCASE.nonzero?
  proc { |a, b| a.casecmp(b).zero? }
else
  proc { |a, b| a == b }
end
SEPARATOR_LIST =
"#{Regexp.quote File::SEPARATOR}".freeze
SEPARATOR_PAT =
/#{Regexp.quote File::SEPARATOR}/

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ Pathname


34
35
36
37
38
39
40
41
42
43
# File 'lib/fakefs/pathname.rb', line 34

def initialize(path)
  path = path.__send__(TO_PATH) if path.respond_to? TO_PATH
  @path = path.dup

  if /\0/ =~ @path
    fail ArgumentError, "pathname contains \\0: #{@path.inspect}"
  end

  taint if @path.tainted?
end

Class Method Details

.getwdObject Also known as: pwd

See Dir.getwd. Returns the current working directory as a Pathname.


937
938
939
# File 'lib/fakefs/pathname.rb', line 937

def self.getwd
  new(Dir.getwd)
end

.glob(*args) ⇒ Object

See Dir.glob. Returns or yields Pathname objects.


927
928
929
930
931
932
933
# File 'lib/fakefs/pathname.rb', line 927

def self.glob(*args) # :yield: pathname
  if block_given?
    Dir.glob(*args) { |f| yield new(f) }
  else
    Dir.glob(*args).map { |f| new(f) }
  end
end

Instance Method Details

#+(other) ⇒ Object


431
432
433
434
# File 'lib/fakefs/pathname.rb', line 431

def +(other)
  other = Pathname.new(other) unless other.is_a?(Pathname)
  Pathname.new(plus(@path, other.to_s))
end

#<=>(other) ⇒ Object


77
78
79
80
# File 'lib/fakefs/pathname.rb', line 77

def <=>(other)
  return nil unless other.is_a?(Pathname)
  @path.tr('/', "\0") <=> other.to_s.tr('/', "\0")
end

#==(other) ⇒ Object Also known as: ===, eql?


68
69
70
71
# File 'lib/fakefs/pathname.rb', line 68

def ==(other)
  return false unless other.is_a?(Pathname)
  other.to_s == @path
end

#absolute?Boolean


336
337
338
# File 'lib/fakefs/pathname.rb', line 336

def absolute?
  !relative?
end

#ascend {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:


409
410
411
412
413
414
415
416
417
# File 'lib/fakefs/pathname.rb', line 409

def ascend
  path = @path
  yield self
  while (r = chop_basename(path))
    path, _name = r
    break if path.empty?
    yield self.class.new(del_trailing_separator(path))
  end
end

#atimeObject

See File.atime. Returns last access time.


669
670
671
# File 'lib/fakefs/pathname.rb', line 669

def atime
  File.atime(@path)
end

#basename(*args) ⇒ Object

See File.basename. Returns the last component of the path.


767
768
769
# File 'lib/fakefs/pathname.rb', line 767

def basename(*args)
  self.class.new(File.basename(@path, *args))
end

#binread(*args) ⇒ Object

See IO.binread. Returns all the bytes from the file, or the first N if specified.


651
652
653
# File 'lib/fakefs/pathname.rb', line 651

def binread(*args)
  File.binread(@path, *args)
end

#blockdev?Boolean

See FileTest.blockdev?.


804
805
806
# File 'lib/fakefs/pathname.rb', line 804

def blockdev?
  FileTest.blockdev?(@path)
end

#chardev?Boolean

See FileTest.chardev?.


809
810
811
# File 'lib/fakefs/pathname.rb', line 809

def chardev?
  FileTest.chardev?(@path)
end

#children(with_directory = true) ⇒ Object


528
529
530
531
532
533
534
535
536
537
538
539
540
541
# File 'lib/fakefs/pathname.rb', line 528

def children(with_directory = true)
  with_directory = false if @path == '.'
  result = []
  Dir.foreach(@path) do |e|
    next if e == '.' || e == '..'
    result <<
      if with_directory
        self.class.new(File.join(@path, e))
      else
        self.class.new(e)
      end
  end
  result
end

#chmod(mode) ⇒ Object

See File.chmod. Changes permissions.


685
686
687
# File 'lib/fakefs/pathname.rb', line 685

def chmod(mode)
  File.chmod(mode, @path)
end

#chown(owner, group) ⇒ Object

See File.chown. Change owner and group of file.


695
696
697
# File 'lib/fakefs/pathname.rb', line 695

def chown(owner, group)
  File.chown(owner, group, @path)
end

#cleanpath(consider_symlink = false) ⇒ Object


183
184
185
186
187
188
189
# File 'lib/fakefs/pathname.rb', line 183

def cleanpath(consider_symlink = false)
  if consider_symlink
    cleanpath_conservative
  else
    cleanpath_aggressive
  end
end

#ctimeObject

See File.ctime. Returns last (directory entry, not file) change time.


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

def ctime
  File.ctime(@path)
end

#descendObject


382
383
384
385
386
387
# File 'lib/fakefs/pathname.rb', line 382

def descend
  vs = []
  ascend { |v| vs << v }
  vs.reverse_each { |v| yield v }
  nil
end

#directory?Boolean

See FileTest.directory?.


834
835
836
# File 'lib/fakefs/pathname.rb', line 834

def directory?
  FileTest.directory?(@path)
end

#dirnameObject

See File.dirname. Returns all but the last component of the path.


773
774
775
# File 'lib/fakefs/pathname.rb', line 773

def dirname
  self.class.new(File.dirname(@path))
end

#each_child(with_directory = true, &b) ⇒ Object

Iterates over the children of the directory (files and subdirectories, not recursive). It yields Pathname object for each child. By default, the yielded pathnames will have enough information to access the files. If you set with_directory to false, then the returned pathnames will contain the filename only.

Pathname("/usr/local").each_child { |f| p f }
#=> #<Pathname:/usr/local/share>
#   #<Pathname:/usr/local/bin>
#   #<Pathname:/usr/local/games>
#   #<Pathname:/usr/local/lib>
#   #<Pathname:/usr/local/include>
#   #<Pathname:/usr/local/sbin>
#   #<Pathname:/usr/local/src>
#   #<Pathname:/usr/local/man>

Pathname("/usr/local").each_child(false) { |f| p f }
#=> #<Pathname:share>
#   #<Pathname:bin>
#   #<Pathname:games>
#   #<Pathname:lib>
#   #<Pathname:include>
#   #<Pathname:sbin>
#   #<Pathname:src>
#   #<Pathname:man>

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

def each_child(with_directory = true, &b)
  children(with_directory).each(&b)
end

#each_entryObject

Iterates over the entries (files and subdirectories) in the directory. It yields a Pathname object for each entry.

This method has existed since 1.8.1.


953
954
955
# File 'lib/fakefs/pathname.rb', line 953

def each_entry(*) # :yield: pathname
  Dir.foreach(@path) { |f| yield self.class.new(f) }
end

#each_filenameObject


355
356
357
358
359
360
# File 'lib/fakefs/pathname.rb', line 355

def each_filename # :yield: filename
  return to_enum(__method__) unless block_given?
  _prefix, names = split_names(@path)
  names.each { |filename| yield filename }
  nil
end

#each_line(*args, &block) ⇒ Object

#each_line iterates over the line in the file. It yields a String object for each line.

This method has existed since 1.8.1.


633
634
635
636
637
638
639
640
641
# File 'lib/fakefs/pathname.rb', line 633

def each_line(*args, &block) # :yield: line
  if block_given?
    File.open(@path, 'r') do |io|
      io.each_line(*args, &block)
    end
  else
    enum_for(:each_line, *args)
  end
end

#empty?Boolean

Checks if a file or directory is empty, using FileTest.empty? or Dir.empty? as necessary.


1033
1034
1035
1036
1037
1038
1039
# File 'lib/fakefs/pathname.rb', line 1033

def empty?
  if File.directory? @path
    Dir.empty? @path
  else
    FileTest.empty? @path
  end
end

#entriesObject

Return the entries (files and subdirectories) in the directory, each as a Pathname object.


945
946
947
# File 'lib/fakefs/pathname.rb', line 945

def entries
  Dir.entries(@path).map { |f| self.class.new(f) }
end

#executable?Boolean

See FileTest.executable?.


814
815
816
# File 'lib/fakefs/pathname.rb', line 814

def executable?
  FileTest.executable?(@path)
end

#executable_real?Boolean

See FileTest.executable_real?.


819
820
821
# File 'lib/fakefs/pathname.rb', line 819

def executable_real?
  FileTest.executable_real?(@path)
end

#exist?Boolean

See FileTest.exist?.


824
825
826
# File 'lib/fakefs/pathname.rb', line 824

def exist?
  FileTest.exist?(@path)
end

#expand_path(*args) ⇒ Object

See File.expand_path.


783
784
785
# File 'lib/fakefs/pathname.rb', line 783

def expand_path(*args)
  self.class.new(File.expand_path(@path, *args))
end

#extnameObject

See File.extname. Returns the file's extension.


778
779
780
# File 'lib/fakefs/pathname.rb', line 778

def extname
  File.extname(@path)
end

#file?Boolean

See FileTest.file?.


839
840
841
# File 'lib/fakefs/pathname.rb', line 839

def file?
  FileTest.file?(@path)
end

#findObject

Pathname#find is an iterator to traverse a directory tree in a depth first manner. It yields a Pathname for each file under “this” directory.

Since it is implemented by find.rb, Find.prune can be used to control the traverse.

If self is ., yielded pathnames begin with a filename in the current directory, not ./.


986
987
988
989
990
991
992
993
# File 'lib/fakefs/pathname.rb', line 986

def find(*) # :yield: pathname
  require 'find'
  if @path == '.'
    Find.find(@path) { |f| yield self.class.new(f.sub(%r{/\A\./}, '')) }
  else
    Find.find(@path) { |f| yield self.class.new(f) }
  end
end

#fnmatch(pattern, *args) ⇒ Object

See File.fnmatch. Return true if the receiver matches the given pattern


706
707
708
# File 'lib/fakefs/pathname.rb', line 706

def fnmatch(pattern, *args)
  File.fnmatch(pattern, @path, *args)
end

#fnmatch?(pattern, *args) ⇒ Boolean

See File.fnmatch? (same as #fnmatch).


711
712
713
# File 'lib/fakefs/pathname.rb', line 711

def fnmatch?(pattern, *args)
  File.fnmatch?(pattern, @path, *args)
end

#freezeObject


45
46
47
48
49
# File 'lib/fakefs/pathname.rb', line 45

def freeze
  super
  @path.freeze
  self
end

#ftypeObject

See File.ftype. Returns “type” of file (“file”, “directory”, etc).


717
718
719
# File 'lib/fakefs/pathname.rb', line 717

def ftype
  File.ftype(@path)
end

#grpowned?Boolean

See FileTest.grpowned?.


829
830
831
# File 'lib/fakefs/pathname.rb', line 829

def grpowned?
  FileTest.grpowned?(@path)
end

#hashObject


82
83
84
# File 'lib/fakefs/pathname.rb', line 82

def hash # :nodoc:
  @path.hash
end

#inspectObject


95
96
97
# File 'lib/fakefs/pathname.rb', line 95

def inspect # :nodoc:
  "#<#{self.class}:#{@path}>"
end

#join(*args) ⇒ Object


490
491
492
493
494
495
496
497
498
499
500
501
# File 'lib/fakefs/pathname.rb', line 490

def join(*args)
  args.unshift self
  result = args.pop
  result = Pathname.new(result) unless result.is_a?(Pathname)
  return result if result.absolute?
  args.reverse_each do |arg|
    arg = Pathname.new(arg) unless arg.is_a?(Pathname)
    result = arg + result
    return result if result.absolute?
  end
  result
end

#lchmod(mode) ⇒ Object

See File.lchmod.


690
691
692
# File 'lib/fakefs/pathname.rb', line 690

def lchmod(mode)
  File.lchmod(mode, @path)
end

#lchown(owner, group) ⇒ Object

See File.lchown.


700
701
702
# File 'lib/fakefs/pathname.rb', line 700

def lchown(owner, group)
  File.lchown(owner, group, @path)
end

#lstatObject

See File.lstat.


747
748
749
# File 'lib/fakefs/pathname.rb', line 747

def lstat
  File.lstat(@path)
end

See File.link. Creates a hard link.


722
723
724
# File 'lib/fakefs/pathname.rb', line 722

def make_link(old)
  File.link(old, @path)
end

See File.symlink. Creates a symbolic link.


752
753
754
# File 'lib/fakefs/pathname.rb', line 752

def make_symlink(old)
  File.symlink(old, @path)
end

#mkdir(*args) ⇒ Object

See Dir.mkdir. Create the referenced directory.


958
959
960
# File 'lib/fakefs/pathname.rb', line 958

def mkdir(*args)
  Dir.mkdir(@path, *args)
end

#mkpathObject

See FileUtils.mkpath. Creates a full path, including any intermediate directories that don't yet exist.


1000
1001
1002
1003
1004
# File 'lib/fakefs/pathname.rb', line 1000

def mkpath
  require 'fileutils'
  FileUtils.mkpath(@path)
  nil
end

#mountpoint?Boolean


311
312
313
314
315
316
317
318
319
320
# File 'lib/fakefs/pathname.rb', line 311

def mountpoint?
  stat1 = lstat
  begin
    stat2 = parent.lstat
    stat1.dev == stat2.dev && stat1.ino == stat2.ino ||
      stat1.dev != stat2.dev
  rescue Errno::ENOENT
    false
  end
end

#mtimeObject

See File.mtime. Returns last modification time.


680
681
682
# File 'lib/fakefs/pathname.rb', line 680

def mtime
  File.mtime(@path)
end

#open(*args, &block) ⇒ Object

See File.open. Opens the file for reading or writing.


727
728
729
# File 'lib/fakefs/pathname.rb', line 727

def open(*args, &block) # :yield: file
  File.open(@path, *args, &block)
end

#opendir(&block) ⇒ Object

See Dir.open.


968
969
970
# File 'lib/fakefs/pathname.rb', line 968

def opendir(&block) # :yield: dir
  Dir.open(@path, &block)
end

#owned?Boolean

See FileTest.owned?.


854
855
856
# File 'lib/fakefs/pathname.rb', line 854

def owned?
  FileTest.owned?(@path)
end

#parentObject


306
307
308
# File 'lib/fakefs/pathname.rb', line 306

def parent
  self + '..'
end

#pipe?Boolean

See FileTest.pipe?.


844
845
846
# File 'lib/fakefs/pathname.rb', line 844

def pipe?
  FileTest.pipe?(@path)
end

#read(*args) ⇒ Object

See IO.read. Returns all data from the file, or the first N bytes if specified.


645
646
647
# File 'lib/fakefs/pathname.rb', line 645

def read(*args)
  File.read(@path, *args)
end

#readable?Boolean

See FileTest.readable?.


859
860
861
# File 'lib/fakefs/pathname.rb', line 859

def readable?
  FileTest.readable?(@path)
end

#readable_real?Boolean

See FileTest.readable_real?.


869
870
871
# File 'lib/fakefs/pathname.rb', line 869

def readable_real?
  FileTest.readable_real?(@path)
end

#readlines(*args) ⇒ Object

See IO.readlines. Returns all the lines from the file.


656
657
658
# File 'lib/fakefs/pathname.rb', line 656

def readlines(*args)
  File.readlines(@path, *args)
end

See File.readlink. Read symbolic link.


732
733
734
# File 'lib/fakefs/pathname.rb', line 732

def readlink
  self.class.new(File.readlink(@path))
end

#realdirpath(basedir = nil) ⇒ Object


299
300
301
# File 'lib/fakefs/pathname.rb', line 299

def realdirpath(basedir = nil)
  self.class.new(File.realdirpath(@path, basedir))
end

#realpath(basedir = nil) ⇒ Object


289
290
291
# File 'lib/fakefs/pathname.rb', line 289

def realpath(basedir = nil)
  self.class.new(File.realpath(@path, basedir))
end

#relative?Boolean


341
342
343
344
345
346
347
# File 'lib/fakefs/pathname.rb', line 341

def relative?
  path = @path
  while (r = chop_basename(path))
    path, _basename = r
  end
  path == ''
end

#relative_path_from(base_directory) ⇒ Object

#relative_path_from returns a relative path from the argument to the receiver. If self is absolute, the argument must be absolute too. If self is relative, the argument must be relative too.

#relative_path_from doesn't access the filesystem. It assumes no symlinks.

ArgumentError is raised when it cannot find a relative path.

This method has existed since 1.8.1.


587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
# File 'lib/fakefs/pathname.rb', line 587

def relative_path_from(base_directory)
  dest_directory = cleanpath.to_s
  base_directory = base_directory.cleanpath.to_s
  dest_prefix = dest_directory
  dest_names = []
  while (r = chop_basename(dest_prefix))
    dest_prefix, basename = r
    dest_names.unshift basename if basename != '.'
  end
  base_prefix = base_directory
  base_names = []
  while (r = chop_basename(base_prefix))
    base_prefix, basename = r
    base_names.unshift basename if basename != '.'
  end
  unless SAME_PATHS[dest_prefix, base_prefix]
    fail ArgumentError, "different prefix: #{dest_prefix.inspect} " \
    "and #{base_directory.inspect}"
  end
  while !dest_names.empty? &&
        !base_names.empty? &&
        SAME_PATHS[dest_names.first, base_names.first]
    dest_names.shift
    base_names.shift
  end
  if base_names.include? '..'
    fail ArgumentError, "base_directory has ..: #{base_directory.inspect}"
  end
  base_names.fill('..')
  relpath_names = base_names + dest_names
  if relpath_names.empty?
    Pathname.new('.')
  else
    Pathname.new(File.join(*relpath_names))
  end
end

#rename(to) ⇒ Object

See File.rename. Rename the file.


737
738
739
# File 'lib/fakefs/pathname.rb', line 737

def rename(to)
  File.rename(@path, to)
end

#rmdirObject

See Dir.rmdir. Remove the referenced directory.


963
964
965
# File 'lib/fakefs/pathname.rb', line 963

def rmdir
  Dir.rmdir(@path)
end

#rmtreeObject

See FileUtils.rm_r. Deletes a directory and all beneath it.


1007
1008
1009
1010
1011
1012
1013
# File 'lib/fakefs/pathname.rb', line 1007

def rmtree
  # The name "rmtree" is borrowed from File::Path of Perl.
  # File::Path provides "mkpath" and "rmtree".
  require 'fileutils'
  FileUtils.rm_r(@path)
  nil
end

#root?Boolean


330
331
332
# File 'lib/fakefs/pathname.rb', line 330

def root?
  chop_basename(@path).nil? && /#{SEPARATOR_PAT}/o =~ @path
end

#setgid?Boolean

See FileTest.setgid?.


879
880
881
# File 'lib/fakefs/pathname.rb', line 879

def setgid?
  FileTest.setgid?(@path)
end

#setuid?Boolean

See FileTest.setuid?.


874
875
876
# File 'lib/fakefs/pathname.rb', line 874

def setuid?
  FileTest.setuid?(@path)
end

#sizeObject

See FileTest.size.


884
885
886
# File 'lib/fakefs/pathname.rb', line 884

def size
  FileTest.size(@path)
end

#size?Boolean

See FileTest.size?.


889
890
891
# File 'lib/fakefs/pathname.rb', line 889

def size?
  FileTest.size?(@path)
end

#socket?Boolean

See FileTest.socket?.


849
850
851
# File 'lib/fakefs/pathname.rb', line 849

def socket?
  FileTest.socket?(@path)
end

#splitObject

See File.split. Returns the #dirname and the #basename in an Array.


789
790
791
# File 'lib/fakefs/pathname.rb', line 789

def split
  File.split(@path).map { |f| self.class.new(f) }
end

#statObject

See File.stat. Returns a File::Stat object.


742
743
744
# File 'lib/fakefs/pathname.rb', line 742

def stat
  File.stat(@path)
end

#sticky?Boolean

See FileTest.sticky?.


894
895
896
# File 'lib/fakefs/pathname.rb', line 894

def sticky?
  FileTest.sticky?(@path)
end

#sub(pattern, *rest, &block) ⇒ Object


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/fakefs/pathname.rb', line 100

def sub(pattern, *rest, &block)
  if block
    path = @path.sub(pattern, *rest) do |*args|
      begin
        old = Thread.current[:pathname_sub_matchdata]
        Thread.current[:pathname_sub_matchdata] = $LAST_MATCH_INFO
        eval('$~ = Thread.current[:pathname_sub_matchdata]',
             block.binding)
      ensure
        Thread.current[:pathname_sub_matchdata] = old
      end
      yield(*args)
    end
  else
    path = @path.sub(pattern, *rest)
  end
  self.class.new(path)
end

#sub_ext(repl) ⇒ Object


132
133
134
135
# File 'lib/fakefs/pathname.rb', line 132

def sub_ext(repl)
  ext = File.extname(@path)
  self.class.new(@path.chomp(ext) + repl)
end

#symlink?Boolean

See FileTest.symlink?.


899
900
901
# File 'lib/fakefs/pathname.rb', line 899

def symlink?
  FileTest.symlink?(@path)
end

#sysopen(*_args) ⇒ Object

See IO.sysopen. Not supported by fakefs.


661
662
663
# File 'lib/fakefs/pathname.rb', line 661

def sysopen(*_args)
  fail NotImplementedError, 'sysopen is not supported by fakefs'
end

#taintObject


51
52
53
54
55
# File 'lib/fakefs/pathname.rb', line 51

def taint
  super
  @path.taint
  self
end

#to_sObject


87
88
89
# File 'lib/fakefs/pathname.rb', line 87

def to_s
  @path.dup
end

#truncate(length) ⇒ Object

See File.truncate. Truncate the file to length bytes.


757
758
759
# File 'lib/fakefs/pathname.rb', line 757

def truncate(length)
  File.truncate(@path, length)
end

Removes a file or directory, using File.unlink or Dir.unlink as necessary.


1020
1021
1022
1023
1024
1025
1026
# File 'lib/fakefs/pathname.rb', line 1020

def unlink
  if File.directory? @path
    Dir.unlink @path
  else
    File.unlink @path
  end
end

#untaintObject


57
58
59
60
61
# File 'lib/fakefs/pathname.rb', line 57

def untaint
  super
  @path.untaint
  self
end

#utime(atime, mtime) ⇒ Object

See File.utime. Update the access and modification times.


762
763
764
# File 'lib/fakefs/pathname.rb', line 762

def utime(atime, mtime)
  File.utime(atime, mtime, @path)
end

#world_readable?Boolean

See FileTest.world_readable?.


864
865
866
# File 'lib/fakefs/pathname.rb', line 864

def world_readable?
  FileTest.world_readable?(@path)
end

#world_writable?Boolean

See FileTest.world_writable?.


909
910
911
# File 'lib/fakefs/pathname.rb', line 909

def world_writable?
  FileTest.world_writable?(@path)
end

#writable?Boolean

See FileTest.writable?.


904
905
906
# File 'lib/fakefs/pathname.rb', line 904

def writable?
  FileTest.writable?(@path)
end

#writable_real?Boolean

See FileTest.writable_real?.


914
915
916
# File 'lib/fakefs/pathname.rb', line 914

def writable_real?
  FileTest.writable_real?(@path)
end

#write(path, data) ⇒ Object

See File.write. Returns the number of bytes written.


794
795
796
797
798
# File 'lib/fakefs/pathname.rb', line 794

def write(path, data)
  File.open(path, 'wb') do |file|
    return file.write(data)
  end
end

#zero?Boolean

See FileTest.zero?.


919
920
921
# File 'lib/fakefs/pathname.rb', line 919

def zero?
  FileTest.zero?(@path)
end