class FakeFS::Pathname
Pathname class
Constants
- SAME_PATHS
- SEPARATOR_LIST
- SEPARATOR_PAT
- TO_PATH
to_path is implemented so Pathname objects are usable with File.open, etc.
Public Class Methods
See Dir.getwd
. Returns the current working directory as a Pathname.
# File lib/fakefs/pathname.rb, line 928 def self.getwd new(Dir.getwd) end
See Dir.glob
. Returns or yields Pathname objects.
# File lib/fakefs/pathname.rb, line 918 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
Create a Pathname object from the given String
(or String-like object). If path
contains a NUL character
(\0
), an ArgumentError is raised.
# File lib/fakefs/pathname.rb, line 33 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
Public Instance Methods
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.
# File lib/fakefs/pathname.rb, line 430 def +(other) other = Pathname.new(other) unless other.is_a?(Pathname) Pathname.new(plus(@path, other.to_s)) end
Provides for comparing pathnames, case-sensitively.
# File lib/fakefs/pathname.rb, line 76 def <=>(other) return nil unless other.is_a?(Pathname) @path.tr('/', "\0") <=> other.to_s.tr('/', "\0") end
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.
# File lib/fakefs/pathname.rb, line 67 def ==(other) return false unless other.is_a?(Pathname) other.to_s == @path end
to_path is implemented so Pathname objects are usable with File.open, etc.
Predicate method for testing whether a path is absolute. It returns
true
if the pathname begins with a slash.
# File lib/fakefs/pathname.rb, line 335 def absolute? !relative? end
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.
# File lib/fakefs/pathname.rb, line 408 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
See File.atime
. Returns last access time.
# File lib/fakefs/pathname.rb, line 667 def atime File.atime(@path) end
See File.basename
. Returns the last component of the path.
# File lib/fakefs/pathname.rb, line 765 def basename(*args) self.class.new(File.basename(@path, *args)) end
See IO.binread
. Returns all the bytes from the file, or the
first N
if specified.
# File lib/fakefs/pathname.rb, line 649 def binread(*args) File.binread(@path, *args) end
See FileTest.blockdev?
.
# File lib/fakefs/pathname.rb, line 795 def blockdev? FileTest.blockdev?(@path) end
See FileTest.chardev?
.
# File lib/fakefs/pathname.rb, line 800 def chardev? FileTest.chardev?(@path) end
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.
# File lib/fakefs/pathname.rb, line 527 def children(with_directory = true) with_directory = false if @path == '.' result = [] Dir.foreach(@path) do |e| next if e == '.' || e == '..' if with_directory result << self.class.new(File.join(@path, e)) else result << self.class.new(e) end end result end
See File.chmod
. Changes permissions.
# File lib/fakefs/pathname.rb, line 683 def chmod(mode) File.chmod(mode, @path) end
See File.chown
. Change owner and group of file.
# File lib/fakefs/pathname.rb, line 693 def chown(owner, group) File.chown(owner, group, @path) end
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.
# File lib/fakefs/pathname.rb, line 182 def cleanpath(consider_symlink = false) if consider_symlink cleanpath_conservative else cleanpath_aggressive end end
See File.ctime
. Returns last (directory entry, not file)
change time.
# File lib/fakefs/pathname.rb, line 673 def ctime File.ctime(@path) end
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.
# File lib/fakefs/pathname.rb, line 381 def descend vs = [] ascend { |v| vs << v } vs.reverse_each { |v| yield v } nil end
See FileTest.directory?
.
# File lib/fakefs/pathname.rb, line 825 def directory? FileTest.directory?(@path) end
See File.dirname
. Returns all but the last component of the
path.
# File lib/fakefs/pathname.rb, line 771 def dirname self.class.new(File.dirname(@path)) end
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>
# File lib/fakefs/pathname.rb, line 569 def each_child(with_directory = true, &b) children(with_directory).each(&b) end
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.
# File lib/fakefs/pathname.rb, line 944 def each_entry(*) # :yield: pathname Dir.foreach(@path) { |f| yield self.class.new(f) } end
Iterates over each component of the path.
Pathname.new("/usr/bin/ruby").each_filename { |filename| ... } # yields "usr", "bin", and "ruby".
# File lib/fakefs/pathname.rb, line 354 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 iterates over the line in the file. It yields a String object for each line.
This method has existed since 1.8.1.
# File lib/fakefs/pathname.rb, line 631 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
Return the entries (files and subdirectories) in the directory, each as a Pathname object.
# File lib/fakefs/pathname.rb, line 936 def entries Dir.entries(@path).map { |f| self.class.new(f) } end
See FileTest.executable?
.
# File lib/fakefs/pathname.rb, line 805 def executable? FileTest.executable?(@path) end
See FileTest.executable_real?
.
# File lib/fakefs/pathname.rb, line 810 def executable_real? FileTest.executable_real?(@path) end
See FileTest.exist?
.
# File lib/fakefs/pathname.rb, line 815 def exist? FileTest.exist?(@path) end
See File.expand_path
.
# File lib/fakefs/pathname.rb, line 781 def expand_path(*args) self.class.new(File.expand_path(@path, *args)) end
See File.extname
. Returns the file's extension.
# File lib/fakefs/pathname.rb, line 776 def extname File.extname(@path) end
See FileTest.file?
.
# File lib/fakefs/pathname.rb, line 830 def file? FileTest.file?(@path) end
#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 ./
.
# File lib/fakefs/pathname.rb, line 977 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
See File.fnmatch
. Return true
if the receiver
matches the given pattern
# File lib/fakefs/pathname.rb, line 704 def fnmatch(pattern, *args) File.fnmatch(pattern, @path, *args) end
See File.fnmatch?
(same as fnmatch).
# File lib/fakefs/pathname.rb, line 709 def fnmatch?(pattern, *args) File.fnmatch?(pattern, @path, *args) end
# File lib/fakefs/pathname.rb, line 44 def freeze super @path.freeze self end
See File.ftype
. Returns “type” of file (“file”, “directory”,
etc).
# File lib/fakefs/pathname.rb, line 715 def ftype File.ftype(@path) end
See FileTest.grpowned?
.
# File lib/fakefs/pathname.rb, line 820 def grpowned? FileTest.grpowned?(@path) end
#join joins pathnames.
path0.join(path1, ..., pathN)
is the same as path0 +
path1 + ... + pathN
.
# File lib/fakefs/pathname.rb, line 489 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
See File.lchmod
.
# File lib/fakefs/pathname.rb, line 688 def lchmod(mode) File.lchmod(mode, @path) end
See File.lchown
.
# File lib/fakefs/pathname.rb, line 698 def lchown(owner, group) File.lchown(owner, group, @path) end
See File.lstat
.
# File lib/fakefs/pathname.rb, line 745 def lstat File.lstat(@path) end
See File.link
. Creates a hard link.
# File lib/fakefs/pathname.rb, line 720 def make_link(old) File.link(old, @path) end
See File.symlink
. Creates a symbolic link.
# File lib/fakefs/pathname.rb, line 750 def make_symlink(old) File.symlink(old, @path) end
See Dir.mkdir
. Create the referenced directory.
# File lib/fakefs/pathname.rb, line 949 def mkdir(*args) Dir.mkdir(@path, *args) end
See FileUtils.mkpath
. Creates a full path, including any
intermediate directories that don't yet exist.
# File lib/fakefs/pathname.rb, line 991 def mkpath require 'fileutils' FileUtils.mkpath(@path) nil end
mountpoint? returns true
if self
points to a
mountpoint.
# File lib/fakefs/pathname.rb, line 310 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
See File.mtime
. Returns last modification time.
# File lib/fakefs/pathname.rb, line 678 def mtime File.mtime(@path) end
See File.open
. Opens the file for reading or writing.
# File lib/fakefs/pathname.rb, line 725 def open(*args, &block) # :yield: file File.open(@path, *args, &block) end
See Dir.open
.
# File lib/fakefs/pathname.rb, line 959 def opendir(&block) # :yield: dir Dir.open(@path, &block) end
See FileTest.owned?
.
# File lib/fakefs/pathname.rb, line 845 def owned? FileTest.owned?(@path) end
parent returns the parent directory.
This is same as self + '..'
.
# File lib/fakefs/pathname.rb, line 305 def parent self + '..' end
See FileTest.pipe?
.
# File lib/fakefs/pathname.rb, line 835 def pipe? FileTest.pipe?(@path) end
See IO.read
. Returns all data from the file, or the first
N
bytes if specified.
# File lib/fakefs/pathname.rb, line 643 def read(*args) File.read(@path, *args) end
See FileTest.readable?
.
# File lib/fakefs/pathname.rb, line 850 def readable? FileTest.readable?(@path) end
See FileTest.readable_real?
.
# File lib/fakefs/pathname.rb, line 860 def readable_real? FileTest.readable_real?(@path) end
See IO.readlines
. Returns all the lines from the file.
# File lib/fakefs/pathname.rb, line 654 def readlines(*args) File.readlines(@path, *args) end
See File.readlink
. Read symbolic link.
# File lib/fakefs/pathname.rb, line 730 def readlink self.class.new(File.readlink(@path)) end
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.
# File lib/fakefs/pathname.rb, line 298 def realdirpath(basedir = nil) self.class.new(File.realdirpath(@path, basedir)) end
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.
# File lib/fakefs/pathname.rb, line 288 def realpath(basedir = nil) self.class.new(File.realpath(@path, basedir)) end
The opposite of absolute?
# File lib/fakefs/pathname.rb, line 340 def relative? path = @path while (r = chop_basename(path)) path, _basename = r end path == '' end
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.
# File lib/fakefs/pathname.rb, line 585 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
See File.rename
. Rename the file.
# File lib/fakefs/pathname.rb, line 735 def rename(to) File.rename(@path, to) end
See Dir.rmdir
. Remove the referenced directory.
# File lib/fakefs/pathname.rb, line 954 def rmdir Dir.rmdir(@path) end
See FileUtils.rm_r
. Deletes a directory and all beneath it.
# File lib/fakefs/pathname.rb, line 998 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? 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/..
.
# File lib/fakefs/pathname.rb, line 329 def root? !(chop_basename(@path).nil? && /#{SEPARATOR_PAT}/o =~ @path).nil? end
See FileTest.setgid?
.
# File lib/fakefs/pathname.rb, line 870 def setgid? FileTest.setgid?(@path) end
See FileTest.setuid?
.
# File lib/fakefs/pathname.rb, line 865 def setuid? FileTest.setuid?(@path) end
See FileTest.size
.
# File lib/fakefs/pathname.rb, line 875 def size FileTest.size(@path) end
See FileTest.size?
.
# File lib/fakefs/pathname.rb, line 880 def size? FileTest.size?(@path) end
See FileTest.socket?
.
# File lib/fakefs/pathname.rb, line 840 def socket? FileTest.socket?(@path) end
See File.stat
. Returns a File::Stat
object.
# File lib/fakefs/pathname.rb, line 740 def stat File.stat(@path) end
See FileTest.sticky?
.
# File lib/fakefs/pathname.rb, line 885 def sticky? FileTest.sticky?(@path) end
Return a pathname which is substituted by String#sub.
# File lib/fakefs/pathname.rb, line 99 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
Return a pathname which the extension of the basename is substituted by repl.
If self has no extension part, repl is appended.
# File lib/fakefs/pathname.rb, line 131 def sub_ext(repl) ext = File.extname(@path) self.class.new(@path.chomp(ext) + repl) end
See FileTest.symlink?
.
# File lib/fakefs/pathname.rb, line 890 def symlink? FileTest.symlink?(@path) end
See IO.sysopen
. Not supported by fakefs.
# File lib/fakefs/pathname.rb, line 659 def sysopen(*_args) fail NotImplementedError, 'sysopen is not supported by fakefs' end
# File lib/fakefs/pathname.rb, line 50 def taint super @path.taint self end
Return the path as a String.
# File lib/fakefs/pathname.rb, line 86 def to_s @path.dup end
See File.truncate
. Truncate the file to length
bytes.
# File lib/fakefs/pathname.rb, line 755 def truncate(length) File.truncate(@path, length) end
Removes a file or directory, using File.unlink
or
Dir.unlink
as necessary.
# File lib/fakefs/pathname.rb, line 1011 def unlink Dir.unlink @path if File.directory? @path File.unlink @path unless File.directory? @path end
# File lib/fakefs/pathname.rb, line 56 def untaint super @path.untaint self end
See File.utime
. Update the access and modification times.
# File lib/fakefs/pathname.rb, line 760 def utime(atime, mtime) File.utime(atime, mtime, @path) end
See FileTest.world_readable?
.
# File lib/fakefs/pathname.rb, line 855 def world_readable? FileTest.world_readable?(@path) end
See FileTest.world_writable?
.
# File lib/fakefs/pathname.rb, line 900 def world_writable? FileTest.world_writable?(@path) end
See FileTest.writable?
.
# File lib/fakefs/pathname.rb, line 895 def writable? FileTest.writable?(@path) end
See FileTest.writable_real?
.
# File lib/fakefs/pathname.rb, line 905 def writable_real? FileTest.writable_real?(@path) end
See FileTest.zero?
.
# File lib/fakefs/pathname.rb, line 910 def zero? FileTest.zero?(@path) end
Private Instance Methods
#add_trailing_separator(path) -> path
# File lib/fakefs/pathname.rb, line 233 def add_trailing_separator(path) if File.basename(path + 'a') == 'a' path else # xxx: Is File.join is appropriate to add separator? File.join(path, '') end end
#chop_basename(path) -> [pre-basename, basename] or nil
# File lib/fakefs/pathname.rb, line 137 def chop_basename(path) base = File.basename(path) if /\A#{SEPARATOR_PAT}?\z/o =~ base return nil else return path[0, path.rindex(base)], base end end
Clean the path simply by resolving and removing excess “.” and “..” entries. Nothing more, nothing less.
# File lib/fakefs/pathname.rb, line 195 def cleanpath_aggressive path = @path names = [] pre = path while (r = chop_basename(pre)) pre, base = r case base when '.' when '..' names.unshift base else if names[0] == '..' names.shift else names.unshift base end end end if /#{SEPARATOR_PAT}/o =~ File.basename(pre) names.shift while names[0] == '..' end self.class.new(prepend_prefix(pre, File.join(*names))) end
# File lib/fakefs/pathname.rb, line 255 def cleanpath_conservative path = @path names = [] pre = path while (r = chop_basename(pre)) pre, base = r names.unshift base if base != '.' end if /#{SEPARATOR_PAT}/o =~ File.basename(pre) names.shift while names[0] == '..' end if names.empty? self.class.new(File.dirname(pre)) else names << '.' if names.last != '..' && File.basename(path) == '.' result = prepend_prefix(pre, File.join(*names)) if /\A(?:\.|\.\.)\z/ !~ names.last && trailing_separator?(path) self.class.new(add_trailing_separator(result)) else self.class.new(result) end end end
# File lib/fakefs/pathname.rb, line 243 def del_trailing_separator(path) if (r = chop_basename(path)) pre, basename = r pre + basename elsif /#{SEPARATOR_PAT}+\z/o =~ path $` + File.dirname(path)[/#{SEPARATOR_PAT}*\z/o] else path end end
# File lib/fakefs/pathname.rb, line 435 def plus(path1, path2) # -> path prefix2 = path2 index_list2 = [] basename_list2 = [] while (r2 = chop_basename(prefix2)) prefix2, basename2 = r2 index_list2.unshift prefix2.length basename_list2.unshift basename2 end return path2 if prefix2 != '' prefix1 = path1 while (r1 = chop_basename(prefix1)) while !basename_list2.empty? && basename_list2.first == '.' index_list2.shift basename_list2.shift end prefix1, basename1 = r1 next if basename1 == '.' if basename1 == '..' || basename_list2.empty? || basename_list2.first != '..' prefix1 += basename1 break end index_list2.shift basename_list2.shift end r1 = chop_basename(prefix1) if !r1 && /#{SEPARATOR_PAT}/o =~ File.basename(prefix1) while !basename_list2.empty? && basename_list2.first == '..' index_list2.shift basename_list2.shift end end if !basename_list2.empty? suffix2 = path2[index_list2.first..-1] r1 ? File.join(prefix1, suffix2) : prefix1 + suffix2 else r1 ? prefix1 : File.dirname(prefix1) end end
# File lib/fakefs/pathname.rb, line 160 def prepend_prefix(prefix, relpath) if relpath.empty? File.dirname(prefix) elsif /#{SEPARATOR_PAT}/o =~ prefix prefix = File.dirname(prefix) prefix = File.join(prefix, '') if File.basename(prefix + 'a') != 'a' prefix + relpath else prefix + relpath end end
#split_names(path) -> prefix, [name, …]
# File lib/fakefs/pathname.rb, line 148 def split_names(path) names = [] while (r = chop_basename(path)) path, basename = r names.unshift basename end [path, names] end
trailing_separator?(path) -> bool
# File lib/fakefs/pathname.rb, line 221 def trailing_separator?(path) if (r = chop_basename(path)) pre, basename = r pre.length + basename.length < path.length else false end end