# File pathname_builtin.rb, line 1327
def Pathname.getwd() self.new(Dir.getwd) end

Returns a new Pathname object containing the path to the current working directory (equivalent to Pathname.new(Dir.getwd)):

Pathname.getwd # => #<Pathname:/home>

# File pathname_builtin.rb, line 1296
def Pathname.glob(*args, **kwargs) # :yield: pathname
  if block_given?
    Dir.glob(*args, **kwargs) {|f| yield self.new(f) }
  else
    Dir.glob(*args, **kwargs).map {|f| self.new(f) }
  end
end

Calls Dir.glob(patterns, **kwargs), which yields or returns entry names; see Dir.glob.

Required argument patterns is a string pattern or an array of string patterns; note that these patterns are not regexps.

Keyword arguments **kwargs are passed through to Dir.glob; see the documentation there.

With no block given, returns an array of Pathname objects; each is Pathname.new(entry_name) for an entry name returned by Dir.glob.

Pathname.glob('*').take(3)
# => [#<Pathname:BSDL>, #<Pathname:CONTRIBUTING.md>, #<Pathname:COPYING>]
Pathname.glob(['o*', 'a*']).take(3)
# => [#<Pathname:object.c>, #<Pathname:aclocal.m4>, #<Pathname:addr2line.c>]

With a block given, calls the block with each pathname Pathname.new(entry_name), where each entry_name is a Pathname object created by the value yielded by Dir.glob.

a = []
Pathname.glob(['o*', 'a*']) {|pathname| a << pathname }
a.take(3)
# => [#<Pathname:object.c>, #<Pathname:aclocal.m4>, #<Pathname:addr2line.c>]

Optional keyword argument base is of particular interest. When it is given, its value specifies the base directory for the pathnames; each pattern string specifies entries relative to the base directory:

Pathname.glob('*', base: 'lib').take(2)
# => [#<Pathname:English.gemspec>, #<Pathname:English.rb>]
Pathname.glob('*', base: 'lib/bundler').take(2)
# => [#<Pathname:build_metadata.rb>, #<Pathname:bundler.gemspec>]

Note that the base directory is not prepended to the entry names in the result.

# File lib/pathname.rb, line 87
def self.mktmpdir
  require 'tmpdir' unless defined?(Dir.mktmpdir)
  if block_given?
    Dir.mktmpdir do |dir|
      dir = self.new(dir)
      yield dir
    end
  else
    self.new(Dir.mktmpdir)
  end
end

Creates:

• A temporary directory via Dir.mktmpdir.

• A Pathname object that contains the path to that directory.

With no block given, returns the created pathname; the caller should delete the created directory when it is no longer needed (FileUtils.rm_r is a convenient method for the deletion):

pathname = Pathname.mktmpdir
dirpath = pathname.to_s
Dir.exist?(dirpath) # => true
# Do something with the directory.
require 'fileutils'
FileUtils.rm_r(dirpath)

With a block given, calls the block with the created pathname; on block exit, automatically deletes the created directory and all its contents; returns the block’s exit value:

pathname = Pathname.mktmpdir do |p|
  # Do something with the directory.
  p
end
Dir.exist?(pathname.to_s) # => false

# File pathname_builtin.rb, line 224
def initialize(path)
  @path = File.path(path).dup
rescue TypeError => e
  raise e.class, "Pathname.new requires a String, #to_path or #to_str", cause: nil
end

Returns a new Pathname object based on the given path, via File.path(path).dup. the path may be a String, a File, a Dir, or another Pathname; see File.path:

Pathname.new('.')               # => #<Pathname:.>
Pathname.new('/usr/bin')        # => #<Pathname:/usr/bin>
Pathname.new(File.new('LEGAL')) # => #<Pathname:LEGAL>
Pathname.new(Dir.new('.'))      # => #<Pathname:.>
Pathname.new(Pathname.new('.')) # => #<Pathname:.>

# File pathname_builtin.rb, line 812
def +(other)
  other = Pathname.new(other) unless Pathname === other
  Pathname.new(plus(@path, other.path))
end

Returns a new Pathname object based on the content of self and other; argument other may be a String, a File, a Dir, or another Pathname:

pn = Pathname.new('foo') # => #<Pathname:foo>
pn + 'bar'               # => #<Pathname:foo/bar>
pn + File.new('LEGAL')   # => #<Pathname:foo/LEGAL>
pn + Dir.new('lib')      # => #<Pathname:foo/lib>
pn + Pathname.new('bar') # => #<Pathname:foo/bar>

When other specifies a relative path (see relative?), it is combined with self to form a new pathname:

Pathname.new('/a/b') + 'c' # => #<Pathname:/a/b/c>

Extra component separators ('/') are removed:

Pathname.new('/a/b/') + 'c' # => #<Pathname:/a/b/c>

Extra current-directory components ('.') are removed:

Pathname.new('a') + '.' # => #<Pathname:a>
Pathname.new('.') + 'a' # => #<Pathname:a>
Pathname.new('.') + '.' # => #<Pathname:.>

Parent-directory components ('..') are:

• Resolved, when possible:

  Pathname.new('a')      + '..'      # => #<Pathname:.>
  Pathname.new('a/b')    + '..'      # => #<Pathname:a>
  Pathname.new('/')      + '../a'    # => #<Pathname:/a>
  Pathname.new('a')      + '../b'    # => #<Pathname:b>
  Pathname.new('a/b')    + '../c'    # => #<Pathname:a/c>
  Pathname.new('a//b/c') + '../d//e' # => #<Pathname:a//b/d//e>
  

• Removed, when not needed:

  Pathname.new('/') + '..' # => #<Pathname:/>
  

• Retained, when needed:

  Pathname.new('..') + '..'   # => #<Pathname:../..>
  Pathname.new('..') + '../a' # => #<Pathname:../../a>
  

When other specifies an absolute path (see absolute?), equivalent to Pathname.new(other.to_s):

Pathname.new('/a') + '/b/c' # => #<Pathname:/b/c>

Occurrences of '/', '.', and '..' are preserved:

Pathname.new('/a') + '//b//c/./../d' # => #<Pathname://b//c/./../d>

This method does not access the file system, so other need not represent an existing (or even a valid) file or directory path:

Pathname.new('/var') + 'nosuch:ever' # => #<Pathname:/var/nosuch:ever>

static VALUE
path_cmp(VALUE self, VALUE other)
{
    VALUE s1, s2;
    char *p1, *p2;
    char *e1, *e2;
    if (!rb_obj_is_kind_of(other, rb_cPathname))
        return Qnil;
    s1 = get_strpath(self);
    s2 = get_strpath(other);
    p1 = RSTRING_PTR(s1);
    p2 = RSTRING_PTR(s2);
    e1 = p1 + RSTRING_LEN(s1);
    e2 = p2 + RSTRING_LEN(s2);
    while (p1 < e1 && p2 < e2) {
        int c1, c2;
        c1 = (unsigned char)*p1++;
        c2 = (unsigned char)*p2++;
        if (c1 == '/') c1 = '\0';
        if (c2 == '/') c2 = '\0';
        if (c1 != c2) {
            if (c1 < c2)
                return INT2FIX(-1);
            else
                return INT2FIX(1);
        }
    }
    if (p1 < e1)
        return INT2FIX(1);
    if (p2 < e2)
        return INT2FIX(-1);
    return INT2FIX(0);
}

Compares the contents of self and other as strings; see String#<=>.

Returns:

• -1 if self‘s string is smaller than other’s string.

• 0 if the two are equal.

• 1 if self‘s string is larger than other’s string.

• nil if other is not a Pathname.

Examples:

Pathname.new('a')  <=> Pathname.new('b')      # => -1
Pathname.new('a')  <=> Pathname.new('ab')     # => -1
Pathname.new('a')  <=> Pathname.new('a')      # => 0
Pathname.new('b')  <=> Pathname.new('a')      # => 1
Pathname.new('ab') <=> Pathname.new('a')      # => 1
Pathname.new('ab') <=> 'a'                    # => nil

Two pathnames that are different may refer to the same entry in the filesystem:

Pathname.new('lib') <=> Pathname.new('./lib') # => 1

# File pathname_builtin.rb, line 252
def ==(other)
  return false unless Pathname === other
  other.path == @path
end

Returns whether the stored paths in self and other are equal:

pn = Pathname.new('lib')
pn == Pathname.new('lib')   # => true
pn == Pathname.new('./lib') # => false

Returns false if other is not a pathname:

pn == 'lib'                 # => false

# File pathname_builtin.rb, line 652
def absolute?
  ABSOLUTE_PATH.match? @path
end

Returns whether self contains an absolute path:

Pathname.new('/home').absolute? # => true
Pathname.new('lib').absolute?   # => false

OS-dependent for some paths:

Pathname.new('C:/').absolute?   # => true   # On Windows.
Pathname.new('C:/').absolute?   # => false  # Elsewhere.

# File pathname_builtin.rb, line 740
def ascend
  return to_enum(__method__) unless block_given?
  path = @path
  yield self
  while r = chop_basename(path)
    path, = r
    break if path.empty?
    yield self.class.new(del_trailing_separator(path))
  end
end

With a block given, yields self, then a new pathname for each successive dirname in the stored path; see File.dirname:

Pathname.new('/path/to/some/file.rb').ascend {|dirname| p dirname}
#<Pathname:/path/to/some/file.rb>
#<Pathname:/path/to/some>
#<Pathname:/path/to>
#<Pathname:/path>
#<Pathname:/>

With no block given, returns a new Enumerator.

# File pathname_builtin.rb, line 1059
def atime() File.atime(@path) end

Returns a new Time object containing the time of the most recent access (read or write) to the entry; via File.atime:

pn = Pathname.new('t.tmp')
pn.write('foo')
pn.atime # => 2026-03-22 13:49:44.5165608 -0500
pn.read  # => "foo"
pn.atime # => 2026-03-22 13:49:57.5359349 -0500
pn.delete

# File pathname_builtin.rb, line 1133
def basename(...) self.class.new(File.basename(@path, ...)) end

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

# File pathname_builtin.rb, line 1029
def binread(...) File.binread(@path, ...) end

See File.binread. Returns all the bytes from the file, or the first N if specified.

# File pathname_builtin.rb, line 1043
def binwrite(...) File.binwrite(@path, ...) end

Writes contents to the file, opening it in binary mode.

See File.binwrite.

# File pathname_builtin.rb, line 1065
def birthtime() File.birthtime(@path) end

Returns the birth time for the file. If the platform doesn’t have birthtime, raises NotImplementedError.

See File.birthtime.

# File pathname_builtin.rb, line 1171
def blockdev?() FileTest.blockdev?(@path) end

See FileTest.blockdev?.

# File pathname_builtin.rb, line 1174
def chardev?() FileTest.chardev?(@path) end

See FileTest.chardev?.

# File pathname_builtin.rb, line 906
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

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 results never contain the entries . and .. in the directory because they are not children.

# File pathname_builtin.rb, line 1074
def chmod(mode) File.chmod(mode, @path) end

See File.chmod. Changes permissions.

# File pathname_builtin.rb, line 1080
def chown(owner, group) File.chown(owner, group, @path) end

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

# File pathname_builtin.rb, line 511
def cleanpath(consider_symlink=false)
  if consider_symlink
    cleanpath_conservative
  else
    cleanpath_aggressive
  end
end

Returns a new Pathname object, “cleaned” of unnecessary separators, single-dot entries, and double-dot entries.

When self is empty, returns pathname with a single-dot entry:

Pathname.new('').cleanpath # => #<Pathname:.>

Separators

A lone separator is preserved:

Pathname.new('/').cleanpath # => #<Pathname:/>

Non-lone trailing separators are removed:

Pathname.new('foo/////').cleanpath # => #<Pathname:foo>
Pathname.new('foo/').cleanpath     # => #<Pathname:foo>

Multiple embedded separators are reduced to a single separator:

Pathname.new('foo///bar').cleanpath # => #<Pathname:foo/bar>

Multiple leading separators are reduced:

# On Windows, where File.dirname('//') == '//'.
Pathname.new('/////foo').cleanpath # => #<Pathname://foo>
Pathname.new('/////').cleanpath    # => #<Pathname://>
# Otherwise, where File.dirname('//') == '/'.
Pathname.new('/////foo').cleanpath # => #<Pathname:/foo>
Pathname.new('/////').cleanpath    # => #<Pathname:/>

Single-Dot Entries

A lone single-dot entry is preserved:

Pathname.new('.').cleanpath  # => #<Pathname:.>

A non-lone single-dot entry, regardless of its location, is removed:

Pathname.new('foo/././././bar').cleanpath  # => #<Pathname:foo/bar>
Pathname.new('./foo/./././bar').cleanpath  # => #<Pathname:foo/bar>
Pathname.new('foo/./././bar/./').cleanpath # => #<Pathname:foo/bar>

Double-Dot Entries

A lone double-dot entry is preserved:

Pathname.new('..').cleanpath # => #<Pathname:..>

When a non-lone double-dot entry is preceded by a named entry, both are removed:

Pathname.new('foo/..').cleanpath          # => #<Pathname:.>
Pathname.new('foo/../bar').cleanpath      # => #<Pathname:bar>
Pathname.new('foo/../bar/..').cleanpath   # => #<Pathname:.>
Pathname.new('foo/bar/./../..').cleanpath # => #<Pathname:.>

When a non-lone double-dot entry is not preceded by a named entry, it is preserved:

Pathname.new('../..').cleanpath # => #<Pathname:../..>

A non-lone meaningless double-dot entry is removed:

Pathname.new('/..').cleanpath    # => #<Pathname:/>
Pathname.new('/../..').cleanpath # => #<Pathname:/>

Symbolic Links

If the path may contain symbolic links, consider give optional argument symlinks as true; the method then uses a more conservative algorithm that avoids breaking symbolic links. This may preserve more double-dot entries than are absolutely necessary, but without accessing the filesystem, this can’t be avoided.

Examples:

Pathname.new('a/').cleanpath           # => #<Pathname:a>
Pathname.new('a/').cleanpath(true)     # => #<Pathname:a/>

Pathname.new('a/.').cleanpath          # => #<Pathname:a>
Pathname.new('a/.').cleanpath(true)    # => #<Pathname:a/.>

Pathname.new('a/./').cleanpath         # => #<Pathname:a>
Pathname.new('a/./').cleanpath(true)   # => #<Pathname:a/.>

Pathname.new('a/b/.').cleanpath        # => #<Pathname:a/b>
Pathname.new('a/b/.').cleanpath(true)  # => #<Pathname:a/b/.>

Pathname.new('a/../.').cleanpath       # => #<Pathname:.>
Pathname.new('a/../.').cleanpath(true) # => #<Pathname:a/..>

Pathname.new('a/b/../../../../c/../d').cleanpath
# => #<Pathname:../../d>
Pathname.new('a/b/../../../../c/../d').cleanpath(true)
# => #<Pathname:a/b/../../../../c/../d>

# File pathname_builtin.rb, line 1068
def ctime() File.ctime(@path) end

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

# File pathname_builtin.rb, line 716
def descend
  return to_enum(__method__) unless block_given?
  vs = []
  ascend {|v| vs << v }
  vs.reverse_each {|v| yield v }
  nil
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>

Returns an Enumerator if no block was given.

enum = Pathname.new("/usr/bin/ruby").descend
  # ... do stuff ...
enum.each { |e| ... }
  # yields Pathnames /, /usr, /usr/bin, and /usr/bin/ruby.

It doesn’t access the filesystem.

# File pathname_builtin.rb, line 1200
def directory?() FileTest.directory?(@path) end

See FileTest.directory?.

# File pathname_builtin.rb, line 1136
def dirname() self.class.new(File.dirname(@path)) end

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

# File pathname_builtin.rb, line 956
def each_child(with_directory=true, &b)
  children(with_directory).each(&b)
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>

Note that the results never contain the entries . and .. in the directory because they are not children.

See Pathname#children

# File pathname_builtin.rb, line 1340
def each_entry(&block) # :yield: pathname
  return to_enum(__method__) unless block_given?
  Dir.foreach(@path) {|f| yield self.class.new(f) }
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 pathname_builtin.rb, line 684
def each_filename # :yield: filename
  return to_enum(__method__) unless block_given?
  _, names = split_names(@path)
  names.each {|filename| yield filename }
  nil
end

Iterates over each component of the path.

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

Returns an Enumerator if no block was given.

enum = Pathname.new("/usr/bin/ruby").each_filename
  # ... do stuff ...
enum.each { |e| ... }
  # yields "usr", "bin", and "ruby".

# File pathname_builtin.rb, line 1019
def each_line(...) # :yield: line
  File.foreach(@path, ...)
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 pathname_builtin.rb, line 1179
def empty?
  if FileTest.directory?(@path)
    Dir.empty?(@path)
  else
    File.empty?(@path)
  end
end

Tests the file is empty.

See Dir#empty? and FileTest.empty?.

# File pathname_builtin.rb, line 1334
def entries() Dir.entries(@path).map {|f| self.class.new(f) } end

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

# File pathname_builtin.rb, line 1188
def executable?() FileTest.executable?(@path) end

See FileTest.executable?.

# File pathname_builtin.rb, line 1191
def executable_real?() FileTest.executable_real?(@path) end

See FileTest.executable_real?.

# File pathname_builtin.rb, line 1194
def exist?() FileTest.exist?(@path) end

See FileTest.exist?.

# File pathname_builtin.rb, line 1142
def expand_path(...) self.class.new(File.expand_path(@path, ...)) end

See File.expand_path.

# File pathname_builtin.rb, line 1139
def extname() File.extname(@path) end

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

# File pathname_builtin.rb, line 1203
def file?() FileTest.file?(@path) end

See FileTest.file?.

# File lib/pathname.rb, line 30
def find(ignore_error: true) # :yield: pathname
  return to_enum(__method__, ignore_error: ignore_error) unless block_given?
  require 'find'
  if @path == '.'
    Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f.delete_prefix('./')) }
  else
    Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f) }
  end
end

Iterates over the directory tree in a depth first manner, yielding a Pathname for each file under “this” directory.

Note that you need to require ‘pathname’ to use this method.

Returns an Enumerator if no block is given.

Since it is implemented by the standard library module Find, Find.prune can be used to control the traversal.

If self is ., yielded pathnames begin with a filename in the current directory, not ./.

See Find.find

# File pathname_builtin.rb, line 1087
def fnmatch(pattern, ...) File.fnmatch(pattern, @path, ...) end

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

# File pathname_builtin.rb, line 1090
def fnmatch?(pattern, ...) File.fnmatch?(pattern, @path, ...) end

See File.fnmatch? (same as fnmatch).

# File pathname_builtin.rb, line 233
def freeze
  super
  @path.freeze
  self
end

Freze self.

# File pathname_builtin.rb, line 1094
def ftype() File.ftype(@path) end

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

# File pathname_builtin.rb, line 1311
def glob(*args, **kwargs) # :yield: pathname
  if block_given?
    Dir.glob(*args, **kwargs, base: @path) {|f| yield self + f }
  else
    Dir.glob(*args, **kwargs, base: @path).map {|f| self + f }
  end
end

Returns or yields Pathname objects.

Pathname("ruby-2.4.2").glob("R*.md")
#=> [#<Pathname:ruby-2.4.2/README.md>, #<Pathname:ruby-2.4.2/README.ja.md>]

See Dir.glob. This method uses the base keyword argument of Dir.glob.

# File pathname_builtin.rb, line 1197
def grpowned?() FileTest.grpowned?(@path) end

See FileTest.grpowned?.

# File pathname_builtin.rb, line 873
def join(*args)
  return self if args.empty?
  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?
  }
  self + result
end

Joins the given pathnames onto self to create a new Pathname object. This is effectively the same as using Pathname#+ to append self and all arguments sequentially.

path0 = Pathname.new("/usr")                # Pathname:/usr
path0 = path0.join("bin/ruby")              # Pathname:/usr/bin/ruby
    # is the same as
path1 = Pathname.new("/usr") + "bin/ruby"   # Pathname:/usr/bin/ruby
path0 == path1
    #=> true

# File pathname_builtin.rb, line 1077
def lchmod(mode) File.lchmod(mode, @path) end

See File.lchmod.

# File pathname_builtin.rb, line 1083
def lchown(owner, group) File.lchown(owner, group, @path) end

See File.lchown.

# File pathname_builtin.rb, line 1114
def lstat() File.lstat(@path) end

See File.lstat.

# File pathname_builtin.rb, line 1130
def lutime(atime, mtime) File.lutime(atime, mtime, @path) end

Update the access and modification times of the file.

Same as Pathname#utime, but does not follow symbolic links.

See File.lutime.

# File pathname_builtin.rb, line 1097
def make_link(old) File.link(old, @path) end

See File.link. Creates a hard link.

# File pathname_builtin.rb, line 1117
def make_symlink(old) File.symlink(old, @path) end

See File.symlink. Creates a symbolic link.

# File pathname_builtin.rb, line 1346
def mkdir(...) Dir.mkdir(@path, ...) end

See Dir.mkdir. Create the referenced directory.

# File pathname_builtin.rb, line 352
def mkpath(mode: nil)
  path = @path == '/' ? @path : @path.chomp('/')

  stack = []
  until File.directory?(path) || File.dirname(path) == path
    stack.push path
    path = File.dirname(path)
  end

  stack.reverse_each do |dir|
    dir = dir == '/' ? dir : dir.chomp('/')
    if mode
      Dir.mkdir dir, mode
      File.chmod mode, dir
    else
      Dir.mkdir dir
    end
  rescue SystemCallError
    raise unless File.directory?(dir)
  end

  self
end

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

See FileUtils.mkpath and FileUtils.mkdir_p

# File pathname_builtin.rb, line 618
def mountpoint?
  begin
    stat1 = self.lstat
    stat2 = self.parent.lstat
    stat1.dev != stat2.dev || stat1.ino == stat2.ino
  rescue Errno::ENOENT
    false
  end
end

Returns true if self points to a mountpoint.

# File pathname_builtin.rb, line 1071
def mtime() File.mtime(@path) end

See File.mtime. Returns last modification time.

# File pathname_builtin.rb, line 1100
def open(...) # :yield: file
  File.open(@path, ...)
end

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

# File pathname_builtin.rb, line 1352
def opendir(&block) # :yield: dir
  Dir.open(@path, &block)
end

See Dir.open.

# File pathname_builtin.rb, line 1212
def owned?() FileTest.owned?(@path) end

See FileTest.owned?.

# File pathname_builtin.rb, line 613
def parent
  self + '..'
end

Returns the parent directory.

This is same as self + '..'.

# File pathname_builtin.rb, line 1206
def pipe?() FileTest.pipe?(@path) end

See FileTest.pipe?.

# File pathname_builtin.rb, line 1025
def read(...) File.read(@path, ...) end

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

# File pathname_builtin.rb, line 1215
def readable?() FileTest.readable?(@path) end

See FileTest.readable?.

# File pathname_builtin.rb, line 1221
def readable_real?() FileTest.readable_real?(@path) end

See FileTest.readable_real?.

# File pathname_builtin.rb, line 1032
def readlines(...) File.readlines(@path, ...) end

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

# File pathname_builtin.rb, line 1105
def readlink() self.class.new(File.readlink(@path)) end

See File.readlink. Read symbolic link.

# File pathname_builtin.rb, line 1164
def realdirpath(...) self.class.new(File.realdirpath(@path, ...)) end

Returns the real (absolute) pathname of self in the actual filesystem.

Does not contain symlinks or useless dots, .. and ..

The last component of the real pathname can be nonexistent.

# File pathname_builtin.rb, line 1157
def realpath(...) self.class.new(File.realpath(@path, ...)) end

Returns the real (absolute) pathname for self in the actual filesystem.

Does not contain symlinks or useless dots, .. and ..

All components of the pathname must exist when this method is called.

# File pathname_builtin.rb, line 667
def relative?
  !absolute?
end

The opposite of Pathname#absolute?

It returns false if the pathname begins with a slash.

p = Pathname.new('/im/sure')
p.relative?
    #=> false

p = Pathname.new('not/so/sure')
p.relative?
    #=> true

# File pathname_builtin.rb, line 974
def relative_path_from(base_directory)
  base_directory = Pathname.new(base_directory) unless base_directory.is_a? Pathname
  dest_directory = self.cleanpath.path
  base_directory = base_directory.cleanpath.path
  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

Returns a relative path from the given base_directory to the receiver.

If self is absolute, then base_directory must be absolute too.

If self is relative, then base_directory must be relative too.

This method doesn’t access the filesystem. It assumes no symlinks.

ArgumentError is raised when it cannot find a relative path.

Note that this method does not handle situations where the case sensitivity of the filesystem in use differs from the operating system default.

# File pathname_builtin.rb, line 1108
def rename(to) File.rename(@path, to) end

See File.rename. Rename the file.

# File pathname_builtin.rb, line 1349
def rmdir() Dir.rmdir(@path) end

See Dir.rmdir. Remove the referenced directory.

# File lib/pathname.rb, line 48
def rmtree(noop: nil, verbose: nil, secure: nil)
  # The name "rmtree" is borrowed from File::Path of Perl.
  # File::Path provides "mkpath" and "rmtree".
  require 'fileutils'
  FileUtils.rm_rf(@path, noop: noop, verbose: verbose, secure: secure)
  self
end

Recursively deletes a directory, including all directories beneath it.

Note that you need to require ‘pathname’ to use this method.

See FileUtils.rm_rf

# File pathname_builtin.rb, line 635
def root?
  chop_basename(@path) == nil && SEPARATOR_PAT.match?(@path)
end

Predicate method for root directories. Returns true if the pathname consists of consecutive slashes.

It doesn’t access the filesystem. So it may return false for some pathnames which points to roots such as /usr/...

# File pathname_builtin.rb, line 1227
def setgid?() FileTest.setgid?(@path) end

See FileTest.setgid?.

# File pathname_builtin.rb, line 1224
def setuid?() FileTest.setuid?(@path) end

See FileTest.setuid?.

# File pathname_builtin.rb, line 1230
def size() FileTest.size(@path) end

See FileTest.size.

# File pathname_builtin.rb, line 1233
def size?() FileTest.size?(@path) end

See FileTest.size?.

# File pathname_builtin.rb, line 1209
def socket?() FileTest.socket?(@path) end

See FileTest.socket?.

# File pathname_builtin.rb, line 1146
def split()
  array = File.split(@path)
  raise TypeError, 'wrong argument type nil (expected Array)' unless Array === array
  array.map {|f| self.class.new(f) }
end

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

# File pathname_builtin.rb, line 1111
def stat() File.stat(@path) end

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

# File pathname_builtin.rb, line 1236
def sticky?() FileTest.sticky?(@path) end

See FileTest.sticky?.

static VALUE
path_sub(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);

    if (rb_block_given_p()) {
        str = rb_block_call(str, id_sub, argc, argv, 0, 0);
    }
    else {
        str = rb_funcallv(str, id_sub, argc, argv);
    }
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

Return a pathname which is substituted by String#sub.

path1 = Pathname.new('/usr/bin/perl')
path1.sub('perl', 'ruby')
    #=> #<Pathname:/usr/bin/ruby>

# File pathname_builtin.rb, line 310
def sub_ext(repl)
  ext = File.extname(@path)

  # File.extname("foo.bar:stream") returns ".bar" on NTFS and not ".bar:stream"
  # (see ruby_enc_find_extname()).
  # The behavior of Pathname#sub_ext is to replace everything
  # from the start of the extname until the end of the path with repl.
  unless @path.end_with?(ext)
    ext = @path[@path.rindex(ext)..]
  end

  self.class.new(@path.chomp(ext) + repl)
end

Return a pathname with repl added as a suffix to the basename.

If self has no extension part, repl is appended.

Pathname.new('/usr/bin/shutdown').sub_ext('.rb')
    #=> #<Pathname:/usr/bin/shutdown.rb>

# File pathname_builtin.rb, line 1239
def symlink?() FileTest.symlink?(@path) end

See FileTest.symlink?.

# File pathname_builtin.rb, line 1035
def sysopen(...) File.sysopen(@path, ...) end

See File.sysopen.

# File pathname_builtin.rb, line 272
def to_s
  @path.dup
end

Return the path as a String.

# File pathname_builtin.rb, line 1120
def truncate(length) File.truncate(@path, length) end

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

# File pathname_builtin.rb, line 1360
def unlink()
  Dir.unlink @path
rescue Errno::ENOTDIR
  File.unlink @path
end

Removes a file or directory, using File.unlink or Dir.unlink as necessary.

# File pathname_builtin.rb, line 1123
def utime(atime, mtime) File.utime(atime, mtime, @path) end

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

# File pathname_builtin.rb, line 1218
def world_readable?() File.world_readable?(@path) end

See FileTest.world_readable?.

# File pathname_builtin.rb, line 1245
def world_writable?() File.world_writable?(@path) end

See FileTest.world_writable?.

# File pathname_builtin.rb, line 1242
def writable?() FileTest.writable?(@path) end

See FileTest.writable?.

# File pathname_builtin.rb, line 1248
def writable_real?() FileTest.writable_real?(@path) end

See FileTest.writable_real?.

# File pathname_builtin.rb, line 1038
def write(...) File.write(@path, ...) end

Writes contents to the file. See File.write.

# File pathname_builtin.rb, line 1251
def zero?() FileTest.zero?(@path) end

See FileTest.zero?.