Extended maintenance of Ruby versions 1.8.7 and 1.9.2 will end on July 31, 2014. Read more

In Files

  • pathname.rb

Class/Module Index [+]

Quicksearch

Pathname

Constants

SEPARATOR_PAT

Public Class Methods

getwd() click to toggle source

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

 
               # File pathname.rb, line 962
def Pathname.getwd() self.new(Dir.getwd) end
            
Also aliased as: pwd
glob(*args) click to toggle source

See Dir.glob. Returns or yields Pathname objects.

 
               # File pathname.rb, line 953
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
            
new(path) click to toggle source

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

 
               # File 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
            
pwd() click to toggle source
Alias for: getwd

Public Instance Methods

+(other) click to toggle source

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 pathname.rb, line 602
def +(other)
  other = Pathname.new(other) unless Pathname === other
  Pathname.new(plus(@path, other.to_s))
end
            
<=>(other) click to toggle source

Provides for comparing pathnames, case-sensitively.

 
               # File pathname.rb, line 238
def <=>(other)
  return nil unless Pathname === other
  @path.tr('/', "\0") <=> other.to_s.tr('/', "\0")
end
            
==(other) click to toggle source

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 pathname.rb, line 230
def ==(other)
  return false unless Pathname === other
  other.to_s == @path
end
            
Also aliased as: ===, eql?
===(other) click to toggle source
Alias for: ==
TO_PATH() click to toggle source

to_path is implemented so Pathname objects are usable with File.open, etc.

Alias for: to_s
absolute?() click to toggle source

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

 
               # File pathname.rb, line 510
def absolute?
  !relative?
end
            
ascend() click to toggle source

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 pathname.rb, line 582
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() click to toggle source

See File.atime. Returns last access time.

 
               # File pathname.rb, line 783
def atime() File.atime(@path) end
            
basename(*args) click to toggle source

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

 
               # File pathname.rb, line 844
def basename(*args) self.class.new(File.basename(@path, *args)) end
            
blockdev?() click to toggle source

See FileTest.blockdev?.

 
               # File pathname.rb, line 878
def blockdev?() FileTest.blockdev?(@path) end
            
chardev?() click to toggle source

See FileTest.chardev?.

 
               # File pathname.rb, line 881
def chardev?() FileTest.chardev?(@path) end
            
chdir(&block) click to toggle source

#chdir is obsoleted at 1.8.1.

 
               # File pathname.rb, line 966
def chdir(&block)
  warn "Pathname#chdir is obsoleted.  Use Dir.chdir."
  Dir.chdir(@path, &block)
end
            
children(with_directory=true) click to toggle source

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.

 
               # File pathname.rb, line 689
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) click to toggle source

See File.chmod. Changes permissions.

 
               # File pathname.rb, line 792
def chmod(mode) File.chmod(mode, @path) end
            
chown(owner, group) click to toggle source

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

 
               # File pathname.rb, line 798
def chown(owner, group) File.chown(owner, group, @path) end
            
chroot() click to toggle source

#chroot is obsoleted at 1.8.1.

 
               # File pathname.rb, line 972
def chroot
  warn "Pathname#chroot is obsoleted.  Use Dir.chroot."
  Dir.chroot(@path)
end
            
cleanpath(consider_symlink=false) click to toggle source

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 pathname.rb, line 327
def cleanpath(consider_symlink=false)
  if consider_symlink
    cleanpath_conservative
  else
    cleanpath_aggressive
  end
end
            
ctime() click to toggle source

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

 
               # File pathname.rb, line 786
def ctime() File.ctime(@path) end
            
delete() click to toggle source
Alias for: unlink
descend() click to toggle source

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 pathname.rb, line 555
def descend
  vs = []
  ascend {|v| vs << v }
  vs.reverse_each {|v| yield v }
  nil
end
            
dir_foreach(*args, &block) click to toggle source

#dir_foreach is obsoleted at 1.8.1.

 
               # File pathname.rb, line 990
def dir_foreach(*args, &block)
  warn "Pathname#dir_foreach is obsoleted.  Use Pathname#each_entry."
  each_entry(*args, &block)
end
            
directory?() click to toggle source

See FileTest.directory?.

 
               # File pathname.rb, line 896
def directory?() FileTest.directory?(@path) end
            
dirname() click to toggle source

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

 
               # File pathname.rb, line 847
def dirname() self.class.new(File.dirname(@path)) end
            
each_entry() click to toggle source

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 pathname.rb, line 985
def each_entry(&block) # :yield: p
  Dir.foreach(@path) {|f| yield self.class.new(f) }
end
            
each_filename() click to toggle source

Iterates over each component of the path.

Pathname.new("/usr/bin/ruby").each_filename {|filename| ... }
  # yields "usr", "bin", and "ruby".
 
               # File pathname.rb, line 529
def each_filename # :yield: filename
  prefix, names = split_names(@path)
  names.each {|filename| yield filename }
  nil
end
            
each_line(*args) click to toggle source

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 pathname.rb, line 758
def each_line(*args, &block) # :yield: line
  IO.foreach(@path, *args, &block)
end
            
entries() click to toggle source

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

 
               # File pathname.rb, line 979
def entries() Dir.entries(@path).map {|f| self.class.new(f) } end
            
eql?(other) click to toggle source
Alias for: ==
executable?() click to toggle source

See FileTest.executable?.

 
               # File pathname.rb, line 884
def executable?() FileTest.executable?(@path) end
            
executable_real?() click to toggle source

See FileTest.executable_real?.

 
               # File pathname.rb, line 887
def executable_real?() FileTest.executable_real?(@path) end
            
exist?() click to toggle source

See FileTest.exist?.

 
               # File pathname.rb, line 890
def exist?() FileTest.exist?(@path) end
            
expand_path(*args) click to toggle source

See File.expand_path.

 
               # File pathname.rb, line 853
def expand_path(*args) self.class.new(File.expand_path(@path, *args)) end
            
extname() click to toggle source

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

 
               # File pathname.rb, line 850
def extname() File.extname(@path) end
            
file?() click to toggle source

See FileTest.file?.

 
               # File pathname.rb, line 899
def file?() FileTest.file?(@path) end
            
find() click to toggle source

#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 pathname.rb, line 1019
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) click to toggle source

See File.fnmatch. Return true if the receiver matches the given pattern.

 
               # File pathname.rb, line 805
def fnmatch(pattern, *args) File.fnmatch(pattern, @path, *args) end
            
fnmatch?(pattern, *args) click to toggle source

See File.fnmatch? (same as fnmatch).

 
               # File pathname.rb, line 808
def fnmatch?(pattern, *args) File.fnmatch?(pattern, @path, *args) end
            
foreach(*args, &block) click to toggle source

This method is obsoleted at 1.8.1. Use each_line or each_entry.

 
               # File pathname.rb, line 1063
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) click to toggle source

#foreachline is obsoleted at 1.8.1. Use each_line.

 
               # File pathname.rb, line 763
def foreachline(*args, &block)
  warn "Pathname#foreachline is obsoleted.  Use Pathname#each_line."
  each_line(*args, &block)
end
            
freeze() click to toggle source
 
               # File pathname.rb, line 221
def freeze() super; @path.freeze; self end
            
ftype() click to toggle source

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

 
               # File pathname.rb, line 812
def ftype() File.ftype(@path) end
            
grpowned?() click to toggle source

See FileTest.grpowned?.

 
               # File pathname.rb, line 893
def grpowned?() FileTest.grpowned?(@path) end
            
join(*args) click to toggle source

#join joins pathnames.

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

 
               # File pathname.rb, line 655
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) click to toggle source

See File.lchmod.

 
               # File pathname.rb, line 795
def lchmod(mode) File.lchmod(mode, @path) end
            
lchown(owner, group) click to toggle source

See File.lchown.

 
               # File pathname.rb, line 801
def lchown(owner, group) File.lchown(owner, group, @path) end
            
lstat() click to toggle source

See File.lstat.

 
               # File pathname.rb, line 832
def lstat() File.lstat(@path) end
            
mkdir(*args) click to toggle source

See Dir.mkdir. Create the referenced directory.

 
               # File pathname.rb, line 996
def mkdir(*args) Dir.mkdir(@path, *args) end
            
mkpath() click to toggle source

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

 
               # File pathname.rb, line 1033
def mkpath
  require 'fileutils'
  FileUtils.mkpath(@path)
  nil
end
            
mountpoint?() click to toggle source

mountpoint? returns true if self points to a mountpoint.

 
               # File pathname.rb, line 486
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() click to toggle source

See File.mtime. Returns last modification time.

 
               # File pathname.rb, line 789
def mtime() File.mtime(@path) end
            
open(*args) click to toggle source

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

 
               # File pathname.rb, line 818
def open(*args, &block) # :yield: file
  File.open(@path, *args, &block)
end
            
opendir() click to toggle source

See Dir.open.

 
               # File pathname.rb, line 1002
def opendir(&block) # :yield: dir
  Dir.open(@path, &block)
end
            
owned?() click to toggle source

See FileTest.owned?.

 
               # File pathname.rb, line 908
def owned?() FileTest.owned?(@path) end
            
parent() click to toggle source

parent returns the parent directory.

This is same as self + '..'.

 
               # File pathname.rb, line 481
def parent
  self + '..'
end
            
pipe?() click to toggle source

See FileTest.pipe?.

 
               # File pathname.rb, line 902
def pipe?() FileTest.pipe?(@path) end
            
read(*args) click to toggle source

See IO.read. Returns all the bytes from the file, or the first N if specified.

 
               # File pathname.rb, line 770
def read(*args) IO.read(@path, *args) end
            
readable?() click to toggle source

See FileTest.readable?.

 
               # File pathname.rb, line 911
def readable?() FileTest.readable?(@path) end
            
readable_real?() click to toggle source

See FileTest.readable_real?.

 
               # File pathname.rb, line 917
def readable_real?() FileTest.readable_real?(@path) end
            
readlines(*args) click to toggle source

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

 
               # File pathname.rb, line 773
def readlines(*args) IO.readlines(@path, *args) end
            
realpath() click to toggle source

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.

 
               # File pathname.rb, line 467
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?() click to toggle source

The opposite of absolute?

 
               # File pathname.rb, line 515
def relative?
  path = @path
  while r = chop_basename(path)
    path, basename = r
  end
  path == ''
end
            
relative_path_from(base_directory) click to toggle source

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 pathname.rb, line 714
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) click to toggle source

See File.rename. Rename the file.

 
               # File pathname.rb, line 826
def rename(to) File.rename(@path, to) end
            
rmdir() click to toggle source

See Dir.rmdir. Remove the referenced directory.

 
               # File pathname.rb, line 999
def rmdir() Dir.rmdir(@path) end
            
rmtree() click to toggle source

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

 
               # File pathname.rb, line 1040
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?() click to toggle source

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 pathname.rb, line 504
def root?
  !!(chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o =~ @path)
end
            
setgid?() click to toggle source

See FileTest.setgid?.

 
               # File pathname.rb, line 923
def setgid?() FileTest.setgid?(@path) end
            
setuid?() click to toggle source

See FileTest.setuid?.

 
               # File pathname.rb, line 920
def setuid?() FileTest.setuid?(@path) end
            
size() click to toggle source

See FileTest.size.

 
               # File pathname.rb, line 926
def size() FileTest.size(@path) end
            
size?() click to toggle source

See FileTest.size?.

 
               # File pathname.rb, line 929
def size?() FileTest.size?(@path) end
            
socket?() click to toggle source

See FileTest.socket?.

 
               # File pathname.rb, line 905
def socket?() FileTest.socket?(@path) end
            
split() click to toggle source

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

 
               # File pathname.rb, line 857
def split() File.split(@path).map {|f| self.class.new(f) } end
            
stat() click to toggle source

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

 
               # File pathname.rb, line 829
def stat() File.stat(@path) end
            
sticky?() click to toggle source

See FileTest.sticky?.

 
               # File pathname.rb, line 932
def sticky?() FileTest.sticky?(@path) end
            
sub(pattern, *rest, &block) click to toggle source

Return a pathname which is substituted by String#sub.

 
               # File pathname.rb, line 260
def sub(pattern, *rest, &block)
  if block
    path = @path.sub(pattern, *rest) {|*args|
      begin
        old = Thread.current[:pathname_sub_matchdata]
        Thread.current[:pathname_sub_matchdata] = $~
        eval("$~ = Thread.current[:pathname_sub_matchdata]", block.binding)
      ensure
        Thread.current[:pathname_sub_matchdata] = old
      end
      yield(*args)
    }
  else
    path = @path.sub(pattern, *rest)
  end
  self.class.new(path)
end
            
sysopen(*args) click to toggle source

See IO.sysopen.

 
               # File pathname.rb, line 776
def sysopen(*args) IO.sysopen(@path, *args) end
            
taint() click to toggle source
 
               # File pathname.rb, line 222
def taint() super; @path.taint; self end
            
to_s() click to toggle source

Return the path as a String.

 
               # File pathname.rb, line 248
def to_s
  @path.dup
end
            
Also aliased as: TO_PATH
truncate(length) click to toggle source

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

 
               # File pathname.rb, line 838
def truncate(length) File.truncate(@path, length) end
            
untaint() click to toggle source
 
               # File pathname.rb, line 223
def untaint() super; @path.untaint; self end
            
utime(atime, mtime) click to toggle source

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

 
               # File pathname.rb, line 841
def utime(atime, mtime) File.utime(atime, mtime, @path) end
            
world_readable?() click to toggle source

See FileTest.world_readable?.

 
               # File pathname.rb, line 914
def world_readable?() FileTest.world_readable?(@path) end
            
world_writable?() click to toggle source

See FileTest.world_writable?.

 
               # File pathname.rb, line 941
def world_writable?() FileTest.world_writable?(@path) end
            
writable?() click to toggle source

See FileTest.writable?.

 
               # File pathname.rb, line 938
def writable?() FileTest.writable?(@path) end
            
writable_real?() click to toggle source

See FileTest.writable_real?.

 
               # File pathname.rb, line 944
def writable_real?() FileTest.writable_real?(@path) end
            
zero?() click to toggle source

See FileTest.zero?.

 
               # File pathname.rb, line 947
def zero?() FileTest.zero?(@path) end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus