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.



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

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

  taint if @path.tainted?
end

Class Method Details

.getwdObject Also known as: pwd

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



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

def self.getwd
  new(Dir.getwd)
end

.glob(*args) ⇒ Object

See Dir.glob. Returns or yields Pathname objects.



923
924
925
926
927
928
929
# File 'lib/fakefs/pathname.rb', line 923

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



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

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.



75
76
77
78
# File 'lib/fakefs/pathname.rb', line 75

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.



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

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)


212
213
214
# File 'lib/fakefs/pathname.rb', line 212

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:



285
286
287
288
289
290
291
292
293
# File 'lib/fakefs/pathname.rb', line 285

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.



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

def atime
  File.atime(@path)
end

#basename(*args) ⇒ Object

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



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

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.



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

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

#blockdev?Boolean

See FileTest.blockdev?.

Returns:

  • (Boolean)


800
801
802
# File 'lib/fakefs/pathname.rb', line 800

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

#chardev?Boolean

See FileTest.chardev?.

Returns:

  • (Boolean)


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

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.



357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/fakefs/pathname.rb', line 357

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.



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

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

#chown(owner, group) ⇒ Object

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



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

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.



150
151
152
153
154
155
156
# File 'lib/fakefs/pathname.rb', line 150

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.



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

def ctime
  File.ctime(@path)
end

#descendObject

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.



258
259
260
261
262
263
# File 'lib/fakefs/pathname.rb', line 258

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

#directory?Boolean

See FileTest.directory?.

Returns:

  • (Boolean)


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

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

#dirnameObject

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



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

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>


400
401
402
# File 'lib/fakefs/pathname.rb', line 400

def each_child(with_directory = true, &block)
  children(with_directory).each(&block)
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.



949
950
951
# File 'lib/fakefs/pathname.rb', line 949

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

#each_filenameObject

Iterates over each component of the path.

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


231
232
233
234
235
236
# File 'lib/fakefs/pathname.rb', line 231

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.



629
630
631
632
633
634
635
636
637
# File 'lib/fakefs/pathname.rb', line 629

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

#entriesObject

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



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

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

#executable?Boolean

See FileTest.executable?.

Returns:

  • (Boolean)


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

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

#executable_real?Boolean

See FileTest.executable_real?.

Returns:

  • (Boolean)


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

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

#exist?Boolean

See FileTest.exist?.

Returns:

  • (Boolean)


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

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

#expand_path(*args) ⇒ Object

See File.expand_path.



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

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

#extnameObject

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



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

def extname
  File.extname(@path)
end

#file?Boolean

See FileTest.file?.

Returns:

  • (Boolean)


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

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



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



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

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

#fnmatch?(pattern, *args) ⇒ Boolean

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

Returns:

  • (Boolean)


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

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

#freezeObject



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

def freeze
  super
  @path.freeze
  self
end

#ftypeObject

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



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

def ftype
  File.ftype(@path)
end

#grpowned?Boolean

See FileTest.grpowned?.

Returns:

  • (Boolean)


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

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

#hashObject

:nodoc:



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

def hash # :nodoc:
  @path.hash
end

#inspectObject

:nodoc:



93
94
95
# File 'lib/fakefs/pathname.rb', line 93

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.



319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/fakefs/pathname.rb', line 319

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.



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

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

#lchown(owner, group) ⇒ Object

See File.lchown.



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

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

#lstatObject

See File.lstat.



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

def lstat
  File.lstat(@path)
end

See File.link. Creates a hard link.



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

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

See File.symlink. Creates a symbolic link.



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

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

#mkdir(*args) ⇒ Object

See Dir.mkdir. Create the referenced directory.



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

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.



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)


187
188
189
190
191
192
193
194
195
196
# File 'lib/fakefs/pathname.rb', line 187

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.



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

def mtime
  File.mtime(@path)
end

#open(*args, &block) ⇒ Object

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



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

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

#opendir(&block) ⇒ Object

See Dir.open.



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

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

#owned?Boolean

See FileTest.owned?.

Returns:

  • (Boolean)


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

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

#parentObject

#parent returns the parent directory.

This is same as self + '..'.



182
183
184
# File 'lib/fakefs/pathname.rb', line 182

def parent
  self + '..'
end

#pipe?Boolean

See FileTest.pipe?.

Returns:

  • (Boolean)


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

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.



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

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

#readable?Boolean

See FileTest.readable?.

Returns:

  • (Boolean)


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

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

#readable_real?Boolean

See FileTest.readable_real?.

Returns:

  • (Boolean)


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

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

#readlines(*args) ⇒ Object

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



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

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

See File.readlink. Read symbolic link.



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

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.



175
176
177
# File 'lib/fakefs/pathname.rb', line 175

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.



165
166
167
# File 'lib/fakefs/pathname.rb', line 165

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

#relative?Boolean

The opposite of #absolute?

Returns:

  • (Boolean)


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

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.



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/fakefs/pathname.rb', line 416

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.



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

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

#rmdirObject

See Dir.rmdir. Remove the referenced directory.



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

def rmdir
  Dir.rmdir(@path)
end

#rmtreeObject

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)


206
207
208
# File 'lib/fakefs/pathname.rb', line 206

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

#setgid?Boolean

See FileTest.setgid?.

Returns:

  • (Boolean)


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

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

#setuid?Boolean

See FileTest.setuid?.

Returns:

  • (Boolean)


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

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

#sizeObject

See FileTest.size?.



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

def size
  FileTest.size?(@path)
end

#size?Boolean

See FileTest.size?.

Returns:

  • (Boolean)


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

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

#socket?Boolean

See FileTest.socket?.

Returns:

  • (Boolean)


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

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

#splitObject

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



785
786
787
# File 'lib/fakefs/pathname.rb', line 785

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

#statObject

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



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

def stat
  File.stat(@path)
end

#sticky?Boolean

See FileTest.sticky?.

Returns:

  • (Boolean)


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

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

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

Return a pathname which is substituted by String#sub.



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

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.



136
137
138
139
# File 'lib/fakefs/pathname.rb', line 136

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

#symlink?Boolean

See FileTest.symlink?.

Returns:

  • (Boolean)


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

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

#sysopen(*_args) ⇒ Object

See IO.sysopen. Not supported by fakefs.

Raises:

  • (NotImplementedError)


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

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

#taintObject



49
50
51
52
53
# File 'lib/fakefs/pathname.rb', line 49

def taint
  super
  @path.taint
  self
end

#to_sObject

Return the path as a String.



85
86
87
# File 'lib/fakefs/pathname.rb', line 85

def to_s
  @path.dup
end

#truncate(length) ⇒ Object

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



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

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

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

#untaintObject



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

def untaint
  super
  @path.untaint
  self
end

#utime(atime, mtime) ⇒ Object

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



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

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

#world_readable?Boolean

See FileTest.world_readable?.

Returns:

  • (Boolean)


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

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

#world_writable?Boolean

See FileTest.world_writable?.

Returns:

  • (Boolean)


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

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

#writable?Boolean

See FileTest.writable?.

Returns:

  • (Boolean)


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

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

#writable_real?Boolean

See FileTest.writable_real?.

Returns:

  • (Boolean)


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

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

#write(path, data) ⇒ Object

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



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

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

#zero?Boolean

See FileTest.zero?.

Returns:

  • (Boolean)


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

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