Class: FakeFS::Pathname
- Inherits:
-
Object
- Object
- FakeFS::Pathname
- 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}".freeze
- SEPARATOR_PAT =
/#{Regexp.quote File::SEPARATOR}/
Class Method Summary collapse
-
.getwd ⇒ Object
(also: pwd)
See
Dir.getwd
. -
.glob(*args) ⇒ Object
See
Dir.glob
.
Instance Method Summary collapse
-
#+(other) ⇒ Object
Pathname#+ appends a pathname fragment to this one to produce a new Pathname object.
-
#<=>(other) ⇒ Object
Provides for comparing pathnames, case-sensitively.
-
#==(other) ⇒ Object
(also: #===, #eql?)
Compare this pathname with
other
. -
#absolute? ⇒ Boolean
Predicate method for testing whether a path is absolute.
-
#ascend {|_self| ... } ⇒ Object
Iterates over and yields a new Pathname object for each element in the given path in ascending order.
-
#atime ⇒ Object
See
File.atime
. -
#basename(*args) ⇒ Object
See
File.basename
. -
#binread(*args) ⇒ Object
See
IO.binread
. -
#blockdev? ⇒ Boolean
See
FileTest.blockdev?
. -
#chardev? ⇒ Boolean
See
FileTest.chardev?
. -
#children(with_directory = true) ⇒ Object
Returns the children of the directory (files and subdirectories, not recursive) as an array of Pathname objects.
-
#chmod(mode) ⇒ Object
See
File.chmod
. -
#chown(owner, group) ⇒ Object
See
File.chown
. -
#cleanpath(consider_symlink = false) ⇒ Object
Returns clean pathname of
self
with consecutive slashes and useless dots removed. -
#ctime ⇒ Object
See
File.ctime
. -
#descend ⇒ Object
Iterates over and yields a new Pathname object for each element in the given path in descending order.
-
#directory? ⇒ Boolean
See
FileTest.directory?
. -
#dirname ⇒ Object
See
File.dirname
. -
#each_child(with_directory = true, &b) ⇒ Object
Iterates over the children of the directory (files and subdirectories, not recursive).
-
#each_entry ⇒ Object
Iterates over the entries (files and subdirectories) in the directory.
-
#each_filename ⇒ Object
Iterates over each component of the path.
-
#each_line(*args, &block) ⇒ Object
#each_line iterates over the line in the file.
-
#entries ⇒ Object
Return the entries (files and subdirectories) in the directory, each as a Pathname object.
-
#executable? ⇒ Boolean
See
FileTest.executable?
. -
#executable_real? ⇒ Boolean
See
FileTest.executable_real?
. -
#exist? ⇒ Boolean
See
FileTest.exist?
. -
#expand_path(*args) ⇒ Object
See
File.expand_path
. -
#extname ⇒ Object
See
File.extname
. -
#file? ⇒ Boolean
See
FileTest.file?
. -
#find ⇒ Object
Pathname#find is an iterator to traverse a directory tree in a depth first manner.
-
#fnmatch(pattern, *args) ⇒ Object
See
File.fnmatch
. -
#fnmatch?(pattern, *args) ⇒ Boolean
See
File.fnmatch?
(same as #fnmatch). - #freeze ⇒ Object
-
#ftype ⇒ Object
See
File.ftype
. -
#grpowned? ⇒ Boolean
See
FileTest.grpowned?
. -
#hash ⇒ Object
:nodoc:.
-
#initialize(path) ⇒ Pathname
constructor
Create a Pathname object from the given String (or String-like object).
-
#inspect ⇒ Object
:nodoc:.
-
#join(*args) ⇒ Object
Pathname#join joins pathnames.
-
#lchmod(mode) ⇒ Object
See
File.lchmod
. -
#lchown(owner, group) ⇒ Object
See
File.lchown
. -
#lstat ⇒ Object
See
File.lstat
. -
#make_link(old) ⇒ Object
See
File.link
. -
#make_symlink(old) ⇒ Object
See
File.symlink
. -
#mkdir(*args) ⇒ Object
See
Dir.mkdir
. -
#mkpath ⇒ Object
See
FileUtils.mkpath
. -
#mountpoint? ⇒ Boolean
#mountpoint? returns
true
ifself
points to a mountpoint. -
#mtime ⇒ Object
See
File.mtime
. -
#open(*args, &block) ⇒ Object
See
File.open
. -
#opendir(&block) ⇒ Object
See
Dir.open
. -
#owned? ⇒ Boolean
See
FileTest.owned?
. -
#parent ⇒ Object
#parent returns the parent directory.
-
#pipe? ⇒ Boolean
See
FileTest.pipe?
. -
#read(*args) ⇒ Object
See
IO.read
. -
#readable? ⇒ Boolean
See
FileTest.readable?
. -
#readable_real? ⇒ Boolean
See
FileTest.readable_real?
. -
#readlines(*args) ⇒ Object
See
IO.readlines
. -
#readlink ⇒ Object
See
File.readlink
. -
#realdirpath(basedir = nil) ⇒ Object
Returns the real (absolute) pathname of
self
in the actual filesystem. -
#realpath(basedir = nil) ⇒ Object
Returns the real (absolute) pathname of
self
in the actual filesystem not containing symlinks or useless dots. -
#relative? ⇒ Boolean
The opposite of #absolute?.
-
#relative_path_from(base_directory) ⇒ Object
#relative_path_from returns a relative path from the argument to the receiver.
-
#rename(to) ⇒ Object
See
File.rename
. -
#rmdir ⇒ Object
See
Dir.rmdir
. -
#rmtree ⇒ Object
See
FileUtils.rm_r
. -
#root? ⇒ Boolean
#root? is a predicate for root directories.
-
#setgid? ⇒ Boolean
See
FileTest.setgid?
. -
#setuid? ⇒ Boolean
See
FileTest.setuid?
. -
#size ⇒ Object
See
FileTest.size
. -
#size? ⇒ Boolean
See
FileTest.size?
. -
#socket? ⇒ Boolean
See
FileTest.socket?
. -
#split ⇒ Object
See
File.split
. -
#stat ⇒ Object
See
File.stat
. -
#sticky? ⇒ Boolean
See
FileTest.sticky?
. -
#sub(pattern, *rest, &block) ⇒ Object
Return a pathname which is substituted by String#sub.
-
#sub_ext(repl) ⇒ Object
Return a pathname which the extension of the basename is substituted by repl.
-
#symlink? ⇒ Boolean
See
FileTest.symlink?
. -
#sysopen(*_args) ⇒ Object
See
IO.sysopen
. - #taint ⇒ Object
-
#to_s ⇒ Object
Return the path as a String.
-
#truncate(length) ⇒ Object
See
File.truncate
. -
#unlink ⇒ Object
(also: #delete)
Removes a file or directory, using
File.unlink
orDir.unlink
as necessary. - #untaint ⇒ Object
-
#utime(atime, mtime) ⇒ Object
See
File.utime
. -
#world_readable? ⇒ Boolean
See
FileTest.world_readable?
. -
#world_writable? ⇒ Boolean
See
FileTest.world_writable?
. -
#writable? ⇒ Boolean
See
FileTest.writable?
. -
#writable_real? ⇒ Boolean
See
FileTest.writable_real?
. -
#zero? ⇒ Boolean
See
FileTest.zero?
.
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 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
.getwd ⇒ Object Also known as: pwd
See Dir.getwd
. Returns the current working directory as a Pathname.
930 931 932 |
# File 'lib/fakefs/pathname.rb', line 930 def self.getwd new(Dir.getwd) 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
Provides for comparing pathnames, case-sensitively.
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?
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.
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
Predicate method for testing whether a path is absolute. It returns true
if the pathname begins with a slash.
336 337 338 |
# File 'lib/fakefs/pathname.rb', line 336 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.
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 |
#atime ⇒ Object
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?
.
797 798 799 |
# File 'lib/fakefs/pathname.rb', line 797 def blockdev? FileTest.blockdev?(@path) end |
#chardev? ⇒ Boolean
See FileTest.chardev?
.
802 803 804 |
# File 'lib/fakefs/pathname.rb', line 802 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.
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
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.
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 |
#ctime ⇒ Object
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 |
#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.
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?
.
827 828 829 |
# File 'lib/fakefs/pathname.rb', line 827 def directory? FileTest.directory?(@path) end |
#dirname ⇒ Object
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_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.
946 947 948 |
# File 'lib/fakefs/pathname.rb', line 946 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".
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 |
#entries ⇒ Object
Return the entries (files and subdirectories) in the directory, each as a Pathname object.
938 939 940 |
# File 'lib/fakefs/pathname.rb', line 938 def entries Dir.entries(@path).map { |f| self.class.new(f) } end |
#executable? ⇒ Boolean
See FileTest.executable?
.
807 808 809 |
# File 'lib/fakefs/pathname.rb', line 807 def executable? FileTest.executable?(@path) end |
#executable_real? ⇒ Boolean
See FileTest.executable_real?
.
812 813 814 |
# File 'lib/fakefs/pathname.rb', line 812 def executable_real? FileTest.executable_real?(@path) end |
#exist? ⇒ Boolean
See FileTest.exist?
.
817 818 819 |
# File 'lib/fakefs/pathname.rb', line 817 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 (*args) self.class.new(File.(@path, *args)) end |
#extname ⇒ Object
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?
.
832 833 834 |
# File 'lib/fakefs/pathname.rb', line 832 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 ./
.
979 980 981 982 983 984 985 986 |
# File 'lib/fakefs/pathname.rb', line 979 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 |
#freeze ⇒ Object
45 46 47 48 49 |
# File 'lib/fakefs/pathname.rb', line 45 def freeze super @path.freeze self end |
#ftype ⇒ Object
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?
.
822 823 824 |
# File 'lib/fakefs/pathname.rb', line 822 def grpowned? FileTest.grpowned?(@path) end |
#hash ⇒ Object
:nodoc:
82 83 84 |
# File 'lib/fakefs/pathname.rb', line 82 def hash # :nodoc: @path.hash end |
#inspect ⇒ Object
:nodoc:
95 96 97 |
# File 'lib/fakefs/pathname.rb', line 95 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
.
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 |
#lstat ⇒ Object
See File.lstat
.
747 748 749 |
# File 'lib/fakefs/pathname.rb', line 747 def lstat File.lstat(@path) end |
#make_link(old) ⇒ Object
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 |
#make_symlink(old) ⇒ Object
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.
951 952 953 |
# File 'lib/fakefs/pathname.rb', line 951 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.
993 994 995 996 997 |
# File 'lib/fakefs/pathname.rb', line 993 def mkpath require 'fileutils' FileUtils.mkpath(@path) nil end |
#mountpoint? ⇒ Boolean
#mountpoint? returns true
if self
points to a mountpoint.
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 |
#mtime ⇒ Object
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
.
961 962 963 |
# File 'lib/fakefs/pathname.rb', line 961 def opendir(&block) # :yield: dir Dir.open(@path, &block) end |
#owned? ⇒ Boolean
See FileTest.owned?
.
847 848 849 |
# File 'lib/fakefs/pathname.rb', line 847 def owned? FileTest.owned?(@path) end |
#parent ⇒ Object
#parent returns the parent directory.
This is same as self + '..'
.
306 307 308 |
# File 'lib/fakefs/pathname.rb', line 306 def parent self + '..' end |
#pipe? ⇒ Boolean
See FileTest.pipe?
.
837 838 839 |
# File 'lib/fakefs/pathname.rb', line 837 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?
.
852 853 854 |
# File 'lib/fakefs/pathname.rb', line 852 def readable? FileTest.readable?(@path) end |
#readable_real? ⇒ Boolean
See FileTest.readable_real?
.
862 863 864 |
# File 'lib/fakefs/pathname.rb', line 862 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 |
#readlink ⇒ Object
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
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.
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
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.
289 290 291 |
# File 'lib/fakefs/pathname.rb', line 289 def realpath(basedir = nil) self.class.new(File.realpath(@path, basedir)) end |
#relative? ⇒ Boolean
The opposite of #absolute?
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 |
#rmdir ⇒ Object
See Dir.rmdir
. Remove the referenced directory.
956 957 958 |
# File 'lib/fakefs/pathname.rb', line 956 def rmdir Dir.rmdir(@path) end |
#rmtree ⇒ Object
See FileUtils.rm_r
. Deletes a directory and all beneath it.
1000 1001 1002 1003 1004 1005 1006 |
# File 'lib/fakefs/pathname.rb', line 1000 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/..
.
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?
.
872 873 874 |
# File 'lib/fakefs/pathname.rb', line 872 def setgid? FileTest.setgid?(@path) end |
#setuid? ⇒ Boolean
See FileTest.setuid?
.
867 868 869 |
# File 'lib/fakefs/pathname.rb', line 867 def setuid? FileTest.setuid?(@path) end |
#size ⇒ Object
See FileTest.size
.
877 878 879 |
# File 'lib/fakefs/pathname.rb', line 877 def size FileTest.size(@path) end |
#size? ⇒ Boolean
See FileTest.size?
.
882 883 884 |
# File 'lib/fakefs/pathname.rb', line 882 def size? FileTest.size?(@path) end |
#socket? ⇒ Boolean
See FileTest.socket?
.
842 843 844 |
# File 'lib/fakefs/pathname.rb', line 842 def socket? FileTest.socket?(@path) end |
#split ⇒ Object
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 |
#stat ⇒ Object
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?
.
887 888 889 |
# File 'lib/fakefs/pathname.rb', line 887 def sticky? FileTest.sticky?(@path) end |
#sub(pattern, *rest, &block) ⇒ Object
Return a pathname which is substituted by String#sub.
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
Return a pathname which the extension of the basename is substituted by repl.
If self has no extension part, repl is appended.
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?
.
892 893 894 |
# File 'lib/fakefs/pathname.rb', line 892 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 |
#taint ⇒ Object
51 52 53 54 55 |
# File 'lib/fakefs/pathname.rb', line 51 def taint super @path.taint self end |
#to_s ⇒ Object
Return the path as a String.
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 |
#unlink ⇒ Object Also known as: delete
Removes a file or directory, using File.unlink
or Dir.unlink
as necessary.
1013 1014 1015 1016 1017 1018 1019 |
# File 'lib/fakefs/pathname.rb', line 1013 def unlink if File.directory? @path Dir.unlink @path else File.unlink @path end end |
#untaint ⇒ Object
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?
.
857 858 859 |
# File 'lib/fakefs/pathname.rb', line 857 def world_readable? FileTest.world_readable?(@path) end |
#world_writable? ⇒ Boolean
See FileTest.world_writable?
.
902 903 904 |
# File 'lib/fakefs/pathname.rb', line 902 def world_writable? FileTest.world_writable?(@path) end |
#writable? ⇒ Boolean
See FileTest.writable?
.
897 898 899 |
# File 'lib/fakefs/pathname.rb', line 897 def writable? FileTest.writable?(@path) end |
#writable_real? ⇒ Boolean
See FileTest.writable_real?
.
907 908 909 |
# File 'lib/fakefs/pathname.rb', line 907 def writable_real? FileTest.writable_real?(@path) end |
#zero? ⇒ Boolean
See FileTest.zero?
.
912 913 914 |
# File 'lib/fakefs/pathname.rb', line 912 def zero? FileTest.zero?(@path) end |