Class: Pathname
- Inherits:
-
Object
- Object
- Pathname
- Defined in:
- lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb
Overview
-
mixed *
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 proc {|a, b| a.casecmp(b).zero?} else proc {|a, b| a == b} end
- 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
. -
#blockdev? ⇒ Boolean
See
FileTest.blockdev?
. -
#chardev? ⇒ Boolean
See
FileTest.chardev?
. -
#chdir(&block) ⇒ Object
Pathname#chdir is obsoleted at 1.8.1.
-
#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
. -
#chroot ⇒ Object
Pathname#chroot is obsoleted at 1.8.1.
-
#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.
-
#dir_foreach(*args, &block) ⇒ Object
Pathname#dir_foreach is obsoleted at 1.8.1.
-
#directory? ⇒ Boolean
See
FileTest.directory?
. -
#dirname ⇒ Object
See
File.dirname
. -
#each_entry(&block) ⇒ 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(&block) ⇒ 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). -
#foreach(*args, &block) ⇒ Object
This method is obsoleted at 1.8.1.
-
#foreachline(*args, &block) ⇒ Object
Pathname#foreachline is obsoleted at 1.8.1.
- #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
. -
#link(old) ⇒ Object
Pathname#link is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.
-
#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
. -
#realpath ⇒ Object
Returns a real (absolute) pathname of
self
in the actual filesystem. -
#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.
-
#symlink(old) ⇒ Object
Pathname#symlink is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.
-
#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.
210 211 212 213 214 215 216 217 218 219 |
# File 'lib/pathname.rb', line 210 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 self.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.
948 |
# File 'lib/pathname.rb', line 948 def Pathname.getwd() self.new(Dir.getwd) end |
.glob(*args) ⇒ Object
See Dir.glob
. Returns or yields Pathname objects.
939 940 941 942 943 944 945 |
# File 'lib/pathname.rb', line 939 def Pathname.glob(*args) # :yield: p if block_given? Dir.glob(*args) {|f| yield self.new(f) } else Dir.glob(*args).map {|f| self.new(f) } end end |
Instance Method Details
#+(other) ⇒ Object
588 589 590 591 |
# File 'lib/pathname.rb', line 588 def +(other) other = Pathname.new(other) unless Pathname === other Pathname.new(plus(@path, other.to_s)) end |
#<=>(other) ⇒ Object
Provides for comparing pathnames, case-sensitively.
238 239 240 241 |
# File 'lib/pathname.rb', line 238 def <=>(other) return nil unless Pathname === other @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.
230 231 232 233 |
# File 'lib/pathname.rb', line 230 def ==(other) return false unless Pathname === other 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.
496 497 498 |
# File 'lib/pathname.rb', line 496 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.
568 569 570 571 572 573 574 575 576 |
# File 'lib/pathname.rb', line 568 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.
769 |
# File 'lib/pathname.rb', line 769 def atime() File.atime(@path) end |
#basename(*args) ⇒ Object
See File.basename
. Returns the last component of the path.
830 |
# File 'lib/pathname.rb', line 830 def basename(*args) self.class.new(File.basename(@path, *args)) end |
#blockdev? ⇒ Boolean
See FileTest.blockdev?
.
864 |
# File 'lib/pathname.rb', line 864 def blockdev?() FileTest.blockdev?(@path) end |
#chardev? ⇒ Boolean
See FileTest.chardev?
.
867 |
# File 'lib/pathname.rb', line 867 def chardev?() FileTest.chardev?(@path) end |
#chdir(&block) ⇒ Object
Pathname#chdir is obsoleted at 1.8.1.
952 953 954 955 |
# File 'lib/pathname.rb', line 952 def chdir(&block) warn "Pathname#chdir is obsoleted. Use Dir.chdir." Dir.chdir(@path, &block) 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:
p = Pathname("/usr/lib/ruby/1.8")
p.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, ... ]
p.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.
675 676 677 678 679 680 681 682 683 684 685 686 687 |
# File 'lib/pathname.rb', line 675 def children(with_directory=true) with_directory = false if @path == '.' result = [] Dir.foreach(@path) {|e| next if e == '.' || e == '..' if with_directory result << self.class.new(File.join(@path, e)) else result << self.class.new(e) end } result end |
#chmod(mode) ⇒ Object
See File.chmod
. Changes permissions.
778 |
# File 'lib/pathname.rb', line 778 def chmod(mode) File.chmod(mode, @path) end |
#chown(owner, group) ⇒ Object
See File.chown
. Change owner and group of file.
784 |
# File 'lib/pathname.rb', line 784 def chown(owner, group) File.chown(owner, group, @path) end |
#chroot ⇒ Object
Pathname#chroot is obsoleted at 1.8.1.
958 959 960 961 |
# File 'lib/pathname.rb', line 958 def chroot warn "Pathname#chroot is obsoleted. Use Dir.chroot." Dir.chroot(@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.
313 314 315 316 317 318 319 |
# File 'lib/pathname.rb', line 313 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.
772 |
# File 'lib/pathname.rb', line 772 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.
541 542 543 544 545 546 |
# File 'lib/pathname.rb', line 541 def descend vs = [] ascend {|v| vs << v } vs.reverse_each {|v| yield v } nil end |
#dir_foreach(*args, &block) ⇒ Object
Pathname#dir_foreach is obsoleted at 1.8.1.
976 977 978 979 |
# File 'lib/pathname.rb', line 976 def dir_foreach(*args, &block) warn "Pathname#dir_foreach is obsoleted. Use Pathname#each_entry." each_entry(*args, &block) end |
#directory? ⇒ Boolean
See FileTest.directory?
.
882 |
# File 'lib/pathname.rb', line 882 def directory?() FileTest.directory?(@path) end |
#dirname ⇒ Object
See File.dirname
. Returns all but the last component of the path.
833 |
# File 'lib/pathname.rb', line 833 def dirname() self.class.new(File.dirname(@path)) end |
#each_entry(&block) ⇒ 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.
971 972 973 |
# File 'lib/pathname.rb', line 971 def each_entry(&block) # :yield: p 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".
515 516 517 518 519 |
# File 'lib/pathname.rb', line 515 def each_filename # :yield: filename 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.
744 745 746 |
# File 'lib/pathname.rb', line 744 def each_line(*args, &block) # :yield: line IO.foreach(@path, *args, &block) end |
#entries ⇒ Object
Return the entries (files and subdirectories) in the directory, each as a Pathname object.
965 |
# File 'lib/pathname.rb', line 965 def entries() Dir.entries(@path).map {|f| self.class.new(f) } end |
#executable? ⇒ Boolean
See FileTest.executable?
.
870 |
# File 'lib/pathname.rb', line 870 def executable?() FileTest.executable?(@path) end |
#executable_real? ⇒ Boolean
See FileTest.executable_real?
.
873 |
# File 'lib/pathname.rb', line 873 def executable_real?() FileTest.executable_real?(@path) end |
#exist? ⇒ Boolean
See FileTest.exist?
.
876 |
# File 'lib/pathname.rb', line 876 def exist?() FileTest.exist?(@path) end |
#expand_path(*args) ⇒ Object
See File.expand_path
.
839 |
# File 'lib/pathname.rb', line 839 def (*args) self.class.new(File.(@path, *args)) end |
#extname ⇒ Object
See File.extname
. Returns the file's extension.
836 |
# File 'lib/pathname.rb', line 836 def extname() File.extname(@path) end |
#file? ⇒ Boolean
See FileTest.file?
.
885 |
# File 'lib/pathname.rb', line 885 def file?() FileTest.file?(@path) end |
#find(&block) ⇒ 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 ./
.
1005 1006 1007 1008 1009 1010 1011 1012 |
# File 'lib/pathname.rb', line 1005 def find(&block) # :yield: p 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.
791 |
# File 'lib/pathname.rb', line 791 def fnmatch(pattern, *args) File.fnmatch(pattern, @path, *args) end |
#fnmatch?(pattern, *args) ⇒ Boolean
See File.fnmatch?
(same as #fnmatch).
794 |
# File 'lib/pathname.rb', line 794 def fnmatch?(pattern, *args) File.fnmatch?(pattern, @path, *args) end |
#foreach(*args, &block) ⇒ Object
This method is obsoleted at 1.8.1. Use #each_line or #each_entry.
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 |
# File 'lib/pathname.rb', line 1049 def foreach(*args, &block) warn "Pathname#foreach is obsoleted. Use each_line or each_entry." if FileTest.directory? @path # For polymorphism between Dir.foreach and IO.foreach, # Pathname#foreach doesn't yield Pathname object. Dir.foreach(@path, *args, &block) else IO.foreach(@path, *args, &block) end end |
#foreachline(*args, &block) ⇒ Object
Pathname#foreachline is obsoleted at 1.8.1. Use #each_line.
749 750 751 752 |
# File 'lib/pathname.rb', line 749 def foreachline(*args, &block) warn "Pathname#foreachline is obsoleted. Use Pathname#each_line." each_line(*args, &block) end |
#freeze ⇒ Object
221 |
# File 'lib/pathname.rb', line 221 def freeze() super; @path.freeze; self end |
#ftype ⇒ Object
See File.ftype
. Returns "type" of file ("file", "directory", etc).
798 |
# File 'lib/pathname.rb', line 798 def ftype() File.ftype(@path) end |
#grpowned? ⇒ Boolean
See FileTest.grpowned?
.
879 |
# File 'lib/pathname.rb', line 879 def grpowned?() FileTest.grpowned?(@path) end |
#hash ⇒ Object
:nodoc:
243 244 245 |
# File 'lib/pathname.rb', line 243 def hash # :nodoc: @path.hash end |
#inspect ⇒ Object
:nodoc:
255 256 257 |
# File 'lib/pathname.rb', line 255 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
.
641 642 643 644 645 646 647 648 649 650 651 652 |
# File 'lib/pathname.rb', line 641 def join(*args) args.unshift self result = args.pop result = Pathname.new(result) unless Pathname === result return result if result.absolute? args.reverse_each {|arg| arg = Pathname.new(arg) unless Pathname === arg result = arg + result return result if result.absolute? } result end |
#lchmod(mode) ⇒ Object
See File.lchmod
.
781 |
# File 'lib/pathname.rb', line 781 def lchmod(mode) File.lchmod(mode, @path) end |
#lchown(owner, group) ⇒ Object
See File.lchown
.
787 |
# File 'lib/pathname.rb', line 787 def lchown(owner, group) File.lchown(owner, group, @path) end |
#link(old) ⇒ Object
Pathname#link is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.
847 848 849 850 |
# File 'lib/pathname.rb', line 847 def link(old) warn 'Pathname#link is obsoleted. Use Pathname#make_link.' File.link(old, @path) end |
#lstat ⇒ Object
See File.lstat
.
818 |
# File 'lib/pathname.rb', line 818 def lstat() File.lstat(@path) end |
#make_link(old) ⇒ Object
See File.link
. Creates a hard link.
801 |
# File 'lib/pathname.rb', line 801 def make_link(old) File.link(old, @path) end |
#make_symlink(old) ⇒ Object
See File.symlink
. Creates a symbolic link.
821 |
# File 'lib/pathname.rb', line 821 def make_symlink(old) File.symlink(old, @path) end |
#mkdir(*args) ⇒ Object
See Dir.mkdir
. Create the referenced directory.
982 |
# File 'lib/pathname.rb', line 982 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.
1019 1020 1021 1022 1023 |
# File 'lib/pathname.rb', line 1019 def mkpath require 'fileutils' FileUtils.mkpath(@path) nil end |
#mountpoint? ⇒ Boolean
#mountpoint? returns true
if self
points to a mountpoint.
472 473 474 475 476 477 478 479 480 481 |
# File 'lib/pathname.rb', line 472 def mountpoint? begin stat1 = self.lstat stat2 = self.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.
775 |
# File 'lib/pathname.rb', line 775 def mtime() File.mtime(@path) end |
#open(*args, &block) ⇒ Object
See File.open
. Opens the file for reading or writing.
804 805 806 |
# File 'lib/pathname.rb', line 804 def open(*args, &block) # :yield: file File.open(@path, *args, &block) end |
#opendir(&block) ⇒ Object
See Dir.open
.
988 989 990 |
# File 'lib/pathname.rb', line 988 def opendir(&block) # :yield: dir Dir.open(@path, &block) end |
#owned? ⇒ Boolean
See FileTest.owned?
.
894 |
# File 'lib/pathname.rb', line 894 def owned?() FileTest.owned?(@path) end |
#parent ⇒ Object
#parent returns the parent directory.
This is same as self + '..'
.
467 468 469 |
# File 'lib/pathname.rb', line 467 def parent self + '..' end |
#pipe? ⇒ Boolean
See FileTest.pipe?
.
888 |
# File 'lib/pathname.rb', line 888 def pipe?() FileTest.pipe?(@path) end |
#read(*args) ⇒ Object
See IO.read
. Returns all the bytes from the file, or the first N
if specified.
756 |
# File 'lib/pathname.rb', line 756 def read(*args) IO.read(@path, *args) end |
#readable? ⇒ Boolean
See FileTest.readable?
.
897 |
# File 'lib/pathname.rb', line 897 def readable?() FileTest.readable?(@path) end |
#readable_real? ⇒ Boolean
See FileTest.readable_real?
.
903 |
# File 'lib/pathname.rb', line 903 def readable_real?() FileTest.readable_real?(@path) end |
#readlines(*args) ⇒ Object
See IO.readlines
. Returns all the lines from the file.
759 |
# File 'lib/pathname.rb', line 759 def readlines(*args) IO.readlines(@path, *args) end |
#readlink ⇒ Object
See File.readlink
. Read symbolic link.
809 |
# File 'lib/pathname.rb', line 809 def readlink() self.class.new(File.readlink(@path)) end |
#realpath ⇒ Object
Returns a real (absolute) pathname of self
in the actual filesystem. The real pathname doesn't contain symlinks or useless dots.
No arguments should be given; the old behaviour is obsoleted.
453 454 455 456 457 458 459 460 461 462 |
# File 'lib/pathname.rb', line 453 def realpath path = @path prefix, names = split_names(path) if prefix == '' prefix, names2 = split_names(Dir.pwd) names = names2 + names end prefix, *names = realpath_rec(prefix, names, {}) self.class.new(prepend_prefix(prefix, File.join(*names))) end |
#relative? ⇒ Boolean
The opposite of #absolute?
501 502 503 504 505 506 507 |
# File 'lib/pathname.rb', line 501 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.
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'lib/pathname.rb', line 700 def relative_path_from(base_directory) dest_directory = self.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.
812 |
# File 'lib/pathname.rb', line 812 def rename(to) File.rename(@path, to) end |
#rmdir ⇒ Object
See Dir.rmdir
. Remove the referenced directory.
985 |
# File 'lib/pathname.rb', line 985 def rmdir() Dir.rmdir(@path) end |
#rmtree ⇒ Object
See FileUtils.rm_r
. Deletes a directory and all beneath it.
1026 1027 1028 1029 1030 1031 1032 |
# File 'lib/pathname.rb', line 1026 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/..
.
490 491 492 |
# File 'lib/pathname.rb', line 490 def root? !!(chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o =~ @path) end |
#setgid? ⇒ Boolean
See FileTest.setgid?
.
909 |
# File 'lib/pathname.rb', line 909 def setgid?() FileTest.setgid?(@path) end |
#setuid? ⇒ Boolean
See FileTest.setuid?
.
906 |
# File 'lib/pathname.rb', line 906 def setuid?() FileTest.setuid?(@path) end |
#size ⇒ Object
See FileTest.size
.
912 |
# File 'lib/pathname.rb', line 912 def size() FileTest.size(@path) end |
#size? ⇒ Boolean
See FileTest.size?
.
915 |
# File 'lib/pathname.rb', line 915 def size?() FileTest.size?(@path) end |
#socket? ⇒ Boolean
See FileTest.socket?
.
891 |
# File 'lib/pathname.rb', line 891 def socket?() FileTest.socket?(@path) end |
#split ⇒ Object
See File.split
. Returns the #dirname and the #basename in an Array.
843 |
# File 'lib/pathname.rb', line 843 def split() File.split(@path).map {|f| self.class.new(f) } end |
#stat ⇒ Object
See File.stat
. Returns a File::Stat
object.
815 |
# File 'lib/pathname.rb', line 815 def stat() File.stat(@path) end |
#sticky? ⇒ Boolean
See FileTest.sticky?
.
918 |
# File 'lib/pathname.rb', line 918 def sticky?() FileTest.sticky?(@path) end |
#sub(pattern, *rest, &block) ⇒ Object
Return a pathname which is substituted by String#sub.
260 261 262 |
# File 'lib/pathname.rb', line 260 def sub(pattern, *rest, &block) self.class.new(@path.sub(pattern, *rest, &block)) end |
#symlink(old) ⇒ Object
Pathname#symlink is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.
854 855 856 857 |
# File 'lib/pathname.rb', line 854 def symlink(old) warn 'Pathname#symlink is obsoleted. Use Pathname#make_symlink.' File.symlink(old, @path) end |
#symlink? ⇒ Boolean
See FileTest.symlink?
.
921 |
# File 'lib/pathname.rb', line 921 def symlink?() FileTest.symlink?(@path) end |
#sysopen(*args) ⇒ Object
See IO.sysopen
.
762 |
# File 'lib/pathname.rb', line 762 def sysopen(*args) IO.sysopen(@path, *args) end |
#taint ⇒ Object
222 |
# File 'lib/pathname.rb', line 222 def taint() super; @path.taint; self end |
#to_s ⇒ Object
Return the path as a String.
248 249 250 |
# File 'lib/pathname.rb', line 248 def to_s @path.dup end |
#truncate(length) ⇒ Object
See File.truncate
. Truncate the file to length
bytes.
824 |
# File 'lib/pathname.rb', line 824 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.
1039 1040 1041 1042 1043 1044 1045 |
# File 'lib/pathname.rb', line 1039 def unlink() begin Dir.unlink @path rescue Errno::ENOTDIR File.unlink @path end end |
#untaint ⇒ Object
223 |
# File 'lib/pathname.rb', line 223 def untaint() super; @path.untaint; self end |
#utime(atime, mtime) ⇒ Object
See File.utime
. Update the access and modification times.
827 |
# File 'lib/pathname.rb', line 827 def utime(atime, mtime) File.utime(atime, mtime, @path) end |
#world_readable? ⇒ Boolean
See FileTest.world_readable?
.
900 |
# File 'lib/pathname.rb', line 900 def world_readable?() FileTest.world_readable?(@path) end |
#world_writable? ⇒ Boolean
See FileTest.world_writable?
.
927 |
# File 'lib/pathname.rb', line 927 def world_writable?() FileTest.world_writable?(@path) end |
#writable? ⇒ Boolean
See FileTest.writable?
.
924 |
# File 'lib/pathname.rb', line 924 def writable?() FileTest.writable?(@path) end |
#writable_real? ⇒ Boolean
See FileTest.writable_real?
.
930 |
# File 'lib/pathname.rb', line 930 def writable_real?() FileTest.writable_real?(@path) end |
#zero? ⇒ Boolean
See FileTest.zero?
.
933 |
# File 'lib/pathname.rb', line 933 def zero?() FileTest.zero?(@path) end |