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 is implemented so Pathname objects are usable with File.open, etc.

: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).to_s.freeze
SEPARATOR_PAT = 
/#{Regexp.quote File::SEPARATOR}/

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ Pathname

Create a Pathname object from the given String (or String-like object). If path contains a NUL character (\0), an ArgumentError is raised.



34
35
36
37
38
39
40
41
 
# 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
    raise ArgumentError, "pathname contains \\0: #{@path.inspect}"
  end
end

Class Method Details

.getwd ⇒ Object Also known as: pwd

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



925
926
927
 
# File 'lib/fakefs/pathname.rb', line 925

def self.getwd
  new(Dir.getwd)
end

.glob(*args, **opts) ⇒ Object

See Dir.glob. Returns or yields Pathname objects.



915
916
917
918
919
920
921
 
# File 'lib/fakefs/pathname.rb', line 915

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

Instance Method Details

#+(other) ⇒ Object Also known as: /

Pathname#+ appends a pathname fragment to this one to produce a new Pathname object.

p1 = Pathname.new("/usr")      # Pathname:/usr
p2 = p1 + "bin/ruby"           # Pathname:/usr/bin/ruby
p3 = p1 + "/etc/passwd"        # Pathname:/etc/passwd

This method doesn’t access the file system; it is pure string manipulation.



295
296
297
298
 
# File 'lib/fakefs/pathname.rb', line 295

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

#<=>(other) ⇒ Object

Provides for comparing pathnames, case-sensitively.



63
64
65
66
 
# File 'lib/fakefs/pathname.rb', line 63

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

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

Compare this pathname with other. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file.



54
55
56
57
 
# File 'lib/fakefs/pathname.rb', line 54

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

#absolute? ⇒ Boolean

Predicate method for testing whether a path is absolute. It returns true if the pathname begins with a slash.

Returns:

  • (Boolean) 


200
201
202
 
# File 'lib/fakefs/pathname.rb', line 200

def absolute?
  !relative?
end

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

Iterates over and yields a new Pathname object for each element in the given path in ascending order.

Pathname.new('/path/to/some/file.rb').ascend { |v| p v}
   #<Pathname:/path/to/some/file.rb>
   #<Pathname:/path/to/some>
   #<Pathname:/path/to>
   #<Pathname:/path>
   #<Pathname:/>

Pathname.new('path/to/some/file.rb').ascend { |v| p v}
   #<Pathname:path/to/some/file.rb>
   #<Pathname:path/to/some>
   #<Pathname:path/to>
   #<Pathname:path>

It doesn’t access actual filesystem.

This method is available since 1.8.5.

Yields:

  • (_self)

Yield Parameters:



273
274
275
276
277
278
279
280
281
 
# File 'lib/fakefs/pathname.rb', line 273

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

#atime ⇒ Object

See File.atime. Returns last access time.



654
655
656
 
# File 'lib/fakefs/pathname.rb', line 654

def atime
  File.atime(@path)
end

#basename(*args) ⇒ Object

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



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

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.



636
637
638
 
# File 'lib/fakefs/pathname.rb', line 636

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

#blockdev? ⇒ Boolean

See FileTest.blockdev?.

Returns:

  • (Boolean) 


792
793
794
 
# File 'lib/fakefs/pathname.rb', line 792

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

#chardev? ⇒ Boolean

See FileTest.chardev?.

Returns:

  • (Boolean) 


797
798
799
 
# File 'lib/fakefs/pathname.rb', line 797

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

#children(with_directory = true) ⇒ Object

Returns the children of the directory (files and subdirectories, not recursive) as an array of Pathname objects. By default, the returned 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.

For example:

pn = Pathname("/usr/lib/ruby/1.8")
pn.children
  # -> [ Pathname:/usr/lib/ruby/1.8/English.rb,
         Pathname:/usr/lib/ruby/1.8/Env.rb,
         Pathname:/usr/lib/ruby/1.8/abbrev.rb, ... ]
pn.children(false)
  # -> [ Pathname:English.rb,
         Pathname:Env.rb,
         Pathname:abbrev.rb, ... ]

Note that the result never contain the entries . and .. in the directory because they are not children.

This method has existed since 1.8.1.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/fakefs/pathname.rb', line 345

def children(with_directory = true)
  with_directory = false if @path == '.'
  result = []
  Dir.foreach(@path) do |e|
    next if ['.', '..'].include?(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.



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

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

#chown(owner, group) ⇒ Object

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



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

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

#cleanpath(consider_symlink = false) ⇒ Object

Returns clean pathname of self with consecutive slashes and useless dots removed. The filesystem is not accessed.

If consider_symlink is true, then a more conservative algorithm is used to avoid breaking symbolic linkages. This may retain more .. entries than absolutely necessary, but without accessing the filesystem, this can’t be avoided. See #realpath.



138
139
140
141
142
143
144
 
# File 'lib/fakefs/pathname.rb', line 138

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

#ctime ⇒ Object

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



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

def ctime
  File.ctime(@path)
end

#descend ⇒ Object

Iterates over and yields a new Pathname object for each element in the given path in descending order.

Pathname.new('/path/to/some/file.rb').descend { |v| p v}
   #<Pathname:/>
   #<Pathname:/path>
   #<Pathname:/path/to>
   #<Pathname:/path/to/some>
   #<Pathname:/path/to/some/file.rb>

Pathname.new('path/to/some/file.rb').descend { |v| p v}
   #<Pathname:path>
   #<Pathname:path/to>
   #<Pathname:path/to/some>
   #<Pathname:path/to/some/file.rb>

It doesn’t access actual filesystem.

This method is available since 1.8.5.



246
247
248
249
250
251
 
# File 'lib/fakefs/pathname.rb', line 246

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

#directory? ⇒ Boolean

See FileTest.directory?.

Returns:

  • (Boolean) 


822
823
824
 
# File 'lib/fakefs/pathname.rb', line 822

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

#dirname ⇒ Object

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



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

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

#each_child(with_directory = true, &block) ⇒ 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>



388
389
390
 
# File 'lib/fakefs/pathname.rb', line 388

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

#each_entry ⇒ Object

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.



941
942
943
 
# File 'lib/fakefs/pathname.rb', line 941

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

#each_filename ⇒ Object

Iterates over each component of the path.

Pathname.new("/usr/bin/ruby").each_filename { |filename| ... }
  # yields "usr", "bin", and "ruby".



219
220
221
222
223
224
 
# File 'lib/fakefs/pathname.rb', line 219

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.



618
619
620
621
622
623
624
625
626
 
# File 'lib/fakefs/pathname.rb', line 618

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.

Returns:

  • (Boolean) 


1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/fakefs/pathname.rb', line 1029

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

#entries ⇒ Object

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



933
934
935
 
# File 'lib/fakefs/pathname.rb', line 933

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

#executable? ⇒ Boolean

See FileTest.executable?.

Returns:

  • (Boolean) 


802
803
804
 
# File 'lib/fakefs/pathname.rb', line 802

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

#executable_real? ⇒ Boolean

See FileTest.executable_real?.

Returns:

  • (Boolean) 


807
808
809
 
# File 'lib/fakefs/pathname.rb', line 807

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

#exist? ⇒ Boolean

See FileTest.exist?.

Returns:

  • (Boolean) 


812
813
814
 
# File 'lib/fakefs/pathname.rb', line 812

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

#expand_path(*args) ⇒ Object

See File.expand_path.



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

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

#extname ⇒ Object

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



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

def extname
  File.extname(@path)
end

#file? ⇒ Boolean

See FileTest.file?.

Returns:

  • (Boolean) 


827
828
829
 
# File 'lib/fakefs/pathname.rb', line 827

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

#find ⇒ Object

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 ./.



982
983
984
985
986
987
988
989
 
# File 'lib/fakefs/pathname.rb', line 982

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



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

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

#fnmatch?(pattern, *args) ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#freeze ⇒ Object 



43
44
45
46
47
 
# File 'lib/fakefs/pathname.rb', line 43

def freeze
  super
  @path.freeze
  self
end

#ftype ⇒ Object

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



702
703
704
 
# File 'lib/fakefs/pathname.rb', line 702

def ftype
  File.ftype(@path)
end

#glob(pattern, flags = 0) ⇒ Object 



960
961
962
963
964
965
966
 
# File 'lib/fakefs/pathname.rb', line 960

def glob(pattern, flags = 0)
  if block_given?
    Dir.glob(pattern, flags: flags, base: self) { |f| yield join(f) }
  else
    Dir.glob(pattern, flags: flags, base: self).map { |f| join(f) }
  end
end

#grpowned? ⇒ Boolean

See FileTest.grpowned?.

Returns:

  • (Boolean) 


817
818
819
 
# File 'lib/fakefs/pathname.rb', line 817

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

#hash ⇒ Object

:nodoc:



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

def hash # :nodoc:
  @path.hash
end

#inspect ⇒ Object

:nodoc:



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

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

#join(*args) ⇒ Object

Pathname#join joins pathnames.

path0.join(path1, ..., pathN) is the same as path0 + path1 + ... + pathN.



307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/fakefs/pathname.rb', line 307

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.



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

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

#lchown(owner, group) ⇒ Object

See File.lchown.



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

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

#lstat ⇒ Object

See File.lstat.



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

def lstat
  File.lstat(@path)
end

#make_link(old) ⇒ Object

See File.link. Creates a hard link.



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

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

#make_symlink(old) ⇒ Object

See File.symlink. Creates a symbolic link.



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

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

#mkdir(*args) ⇒ Object

See Dir.mkdir. Create the referenced directory.



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

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

#mkpath ⇒ Object

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



996
997
998
999
1000
 
# File 'lib/fakefs/pathname.rb', line 996

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

#mountpoint? ⇒ Boolean

#mountpoint? returns true if self points to a mountpoint.

Returns:

  • (Boolean) 


175
176
177
178
179
180
181
182
183
184
 
# File 'lib/fakefs/pathname.rb', line 175

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

#mtime ⇒ Object

See File.mtime. Returns last modification time.



665
666
667
 
# File 'lib/fakefs/pathname.rb', line 665

def mtime
  File.mtime(@path)
end

#open(*args, &block) ⇒ Object

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



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

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

#opendir(&block) ⇒ Object

See Dir.open.



956
957
958
 
# File 'lib/fakefs/pathname.rb', line 956

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

#owned? ⇒ Boolean

See FileTest.owned?.

Returns:

  • (Boolean) 


842
843
844
 
# File 'lib/fakefs/pathname.rb', line 842

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

#parent ⇒ Object

#parent returns the parent directory.

This is same as self + '..'.



170
171
172
 
# File 'lib/fakefs/pathname.rb', line 170

def parent
  self + '..'
end

#pipe? ⇒ Boolean

See FileTest.pipe?.

Returns:

  • (Boolean) 


832
833
834
 
# File 'lib/fakefs/pathname.rb', line 832

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.



630
631
632
 
# File 'lib/fakefs/pathname.rb', line 630

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

#readable? ⇒ Boolean

See FileTest.readable?.

Returns:

  • (Boolean) 


847
848
849
 
# File 'lib/fakefs/pathname.rb', line 847

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

#readable_real? ⇒ Boolean

See FileTest.readable_real?.

Returns:

  • (Boolean) 


857
858
859
 
# File 'lib/fakefs/pathname.rb', line 857

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

#readlines(*args) ⇒ Object

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



641
642
643
 
# File 'lib/fakefs/pathname.rb', line 641

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

#readlink ⇒ Object

See File.readlink. Read symbolic link.



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

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

#realdirpath(basedir = nil) ⇒ Object

Returns the real (absolute) pathname of self in the actual filesystem. The real pathname doesn’t contain symlinks or useless dots.

The last component of the real pathname can be nonexistent.



163
164
165
 
# File 'lib/fakefs/pathname.rb', line 163

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

#realpath(basedir = nil) ⇒ Object

Returns the real (absolute) pathname of self in the actual filesystem not containing symlinks or useless dots.

All components of the pathname must exist when this method is called.



153
154
155
 
# File 'lib/fakefs/pathname.rb', line 153

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

#relative? ⇒ Boolean

The opposite of #absolute?

Returns:

  • (Boolean) 


205
206
207
208
209
210
211
 
# File 'lib/fakefs/pathname.rb', line 205

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.



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/fakefs/pathname.rb', line 404

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]
    raise 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? '..'
    raise 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.



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

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

#rmdir ⇒ Object

See Dir.rmdir. Remove the referenced directory.



951
952
953
 
# File 'lib/fakefs/pathname.rb', line 951

def rmdir
  Dir.rmdir(@path)
end

#rmtree ⇒ Object

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



1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/fakefs/pathname.rb', line 1003

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

#root? is a predicate for root directories. I.e. it returns true if the pathname consists of consecutive slashes.

It doesn’t access actual filesystem. So it may return false for some pathnames which points to roots such as /usr/...

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/fakefs/pathname.rb', line 194

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

#setgid? ⇒ Boolean

See FileTest.setgid?.

Returns:

  • (Boolean) 


867
868
869
 
# File 'lib/fakefs/pathname.rb', line 867

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

#setuid? ⇒ Boolean

See FileTest.setuid?.

Returns:

  • (Boolean) 


862
863
864
 
# File 'lib/fakefs/pathname.rb', line 862

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

#size ⇒ Object

See FileTest.size?.



872
873
874
 
# File 'lib/fakefs/pathname.rb', line 872

def size
  FileTest.size?(@path)
end

#size? ⇒ Boolean

See FileTest.size?.

Returns:

  • (Boolean) 


877
878
879
 
# File 'lib/fakefs/pathname.rb', line 877

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

#socket? ⇒ Boolean

See FileTest.socket?.

Returns:

  • (Boolean) 


837
838
839
 
# File 'lib/fakefs/pathname.rb', line 837

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

#split ⇒ Object

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



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

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

#stat ⇒ Object

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



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

def stat
  File.stat(@path)
end

#sticky? ⇒ Boolean

See FileTest.sticky?.

Returns:

  • (Boolean) 


882
883
884
 
# File 'lib/fakefs/pathname.rb', line 882

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

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

Return a pathname which is substituted by String#sub.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/fakefs/pathname.rb', line 86

def sub(pattern, *rest, &block)
  path =
    if block
      @path.sub(pattern, *rest) do |*args|
        begin
          old = Thread.current[:pathname_sub_matchdata]
          Thread.current[:pathname_sub_matchdata] = $~
          # TODO: rewrite without using eval
          eval(
            '$~ = Thread.current[:pathname_sub_matchdata]',
            block.binding,
            __FILE__,
            __LINE__ - 3
          )
        ensure
          Thread.current[:pathname_sub_matchdata] = old
        end
        yield(*args)
      end
    else
      @path.sub(pattern, *rest)
    end
  self.class.new(path)
end

#sub_ext(repl) ⇒ Object

Return a pathname which the extension of the basename is substituted by repl.

If self has no extension part, repl is appended.



124
125
126
127
 
# File 'lib/fakefs/pathname.rb', line 124

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

#symlink? ⇒ Boolean

See FileTest.symlink?.

Returns:

  • (Boolean) 


887
888
889
 
# File 'lib/fakefs/pathname.rb', line 887

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

#sysopen(*_args) ⇒ Object

See IO.sysopen. Not supported by fakefs.

Raises:

  • (NotImplementedError) 


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

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

#to_s ⇒ Object

Return the path as a String.



73
74
75
 
# File 'lib/fakefs/pathname.rb', line 73

def to_s
  @path.dup
end

#truncate(length) ⇒ Object

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



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

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

#unlink ⇒ Object Also known as: delete

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



1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/fakefs/pathname.rb', line 1016

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

#utime(atime, mtime) ⇒ Object

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



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

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

#world_readable? ⇒ Boolean

See FileTest.world_readable?.

Returns:

  • (Boolean) 


852
853
854
 
# File 'lib/fakefs/pathname.rb', line 852

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

#world_writable? ⇒ Boolean

See FileTest.world_writable?.

Returns:

  • (Boolean) 


897
898
899
 
# File 'lib/fakefs/pathname.rb', line 897

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

#writable? ⇒ Boolean

See FileTest.writable?.

Returns:

  • (Boolean) 


892
893
894
 
# File 'lib/fakefs/pathname.rb', line 892

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

#writable_real? ⇒ Boolean

See FileTest.writable_real?.

Returns:

  • (Boolean) 


902
903
904
 
# File 'lib/fakefs/pathname.rb', line 902

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

#write(string, *args) ⇒ Object

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



779
780
781
782
783
784
785
786
 
# File 'lib/fakefs/pathname.rb', line 779

def write(string, *args)
  offset = args[0]
  open_args = args[1]
  File.open(@path, open_args || 'w') do |file|
    file.seek(offset) if offset
    return file.write(string)
  end
end

#zero? ⇒ Boolean

See FileTest.zero?.

Returns:

  • (Boolean) 


907
908
909
 
# File 'lib/fakefs/pathname.rb', line 907

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