123456789_123456789_123456789_123456789_123456789_

Class: Pathname

Overview

A Pathname object contains a string directory path or filepath; it does not represent a corresponding actual file or directory -- which in fact may or may not exist.

A Pathname object is immutable (except for method #freeze).

A pathname may be relative or absolute:

Pathname.new('lib')            # => #<Pathname:lib>
Pathname.new('/usr/local/bin') # => #<Pathname:/usr/local/bin>

About the Examples

Many examples here use these variables:

English text with newlines.

text = <<~EOT First line Second line

Fourth line
Fifth line

EOT

Japanese text.

japanese = 'こんにちは'

Binary data.

data = "\u9990\u9991\u9992\u9993\u9994"

Text file.

File.write('t.txt', text)

::File with Japanese text.

File.write('t.ja', japanese)

::File with binary data.

f = File.new('t.dat', 'wb:UTF-16') f.write(data) f.close

Convenience Methods

The class provides all functionality from class ::File and module ::FileTest, along with some functionality from class ::Dir and module FileUtils.

Here's an example string path and corresponding Pathname object:

path = 'lib/fileutils.rb'
pn = Pathname.new(path) # => #<Pathname:lib/fileutils.rb>

Each of these method pairs (Pathname vs. File) gives exactly the same result:

pn.size               # => 83777
File.size(path)       # => 83777

pn.directory?         # => false
File.directory?(path) # => false

pn.read.size          # => 81074
File.read(path).size# # => 81074

Each of these method pairs gives similar results, but each Pathname method returns a more versatile Pathname object, instead of a string:

pn.dirname          # => #<Pathname:lib>
File.dirname(path)  # => "lib"

pn.basename         # => #<Pathname:fileutils.rb>
File.basename(path) # => "fileutils.rb"

pn.split            # => [#<Pathname:lib>, #<Pathname:fileutils.rb>]
File.split(path)    # => ["lib", "fileutils.rb"]

Each of these methods takes a block:

pn.open do |file|
p file
end
File.open(path) do |file|
p file
end

The outputs for each:

#<File:lib/fileutils.rb (closed)>
#<File:lib/fileutils.rb (closed)>

Each of these methods takes a block:

pn.each_line do |line|
p line
break
end
File.foreach(path) do |line|
p line
break
end

The outputs for each:

"# frozen_string_literal: true\n"
"# frozen_string_literal: true\n"

More Methods

Here is a sampling of other available methods:

p1 = Pathname.new('/usr/lib')  # => #<Pathname:/usr/lib>
p1.absolute?                   # => true
p2 = p1 + 'ruby/4.0'           # => #<Pathname:/usr/lib/ruby/4.0>
p3 = p1.parent                 # => #<Pathname:/usr>
p4 = p2.relative_path_from(p3) # => #<Pathname:lib/ruby/4.0>
p4.absolute?                   # => false
p5 = Pathname.new('.')         # => #<Pathname:.>
p6 = p5 + 'usr/../var'         # => #<Pathname:usr/../var>
p6.cleanpath                   # => #<Pathname:var>
p6.realpath                    # => #<Pathname:/var>
p6.children.take(2)
# => [#<Pathname:usr/../var/local>, #<Pathname:usr/../var/spool>]

Breakdown of functionality

Core methods

These methods are effectively manipulating a ::String, because that's all a path is. None of these access the file system except for #mountpoint?, #children, #each_child, #realdirpath and #realpath.

File status predicate methods

These methods are a facade for ::FileTest:

File property and manipulation methods

These methods are a facade for ::File:

Directory methods

These methods are a facade for ::Dir:

Utilities

These methods are a mixture of Find, FileUtils, and others:

Method documentation

As the above section shows, most of the methods in Pathname are facades. The documentation for these methods generally just says, for instance, "See FileTest.writable?", as you should be familiar with the original method anyway, and its documentation (e.g. through ri) will contain more information. In some cases, a brief description will follow.

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(path) ⇒ Pathname

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:.>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 243

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

Class Method Details

.pwd

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1817

alias pwd getwd

Instance Attribute Details

#absolute?Boolean (readonly)

Returns whether self contains an absolute path:

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

The result is OS-dependent for some paths:

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

  
# File 'pathname.c', line 168

static VALUE
path_absolute_p(VALUE self)
{
    VALUE path = get_strpath(self);
    const char *ptr = RSTRING_PTR(path);
    long len = RSTRING_LEN(path);
    if (len < 1) return Qfalse;
    if (drive_letter) {
        if (len >= 2 && ISALPHA(ptr[0]) && (ptr[1] == ':')) return Qtrue;
    }
    return RBOOL(isdirsep(ptr[0]));
}

#empty?Boolean (readonly)

Returns whether the entry represented by self exists and is empty:

dir_pn = Pathname('example_dir')
dir_pn.empty?  # => false  # Dir does not exist.
dir_pn.mkdir
dir_pn.empty?  # => true   # Dir exists and is empty.

file_pn = Pathname('example_dir/example.txt')
file_pn.empty? # => false  # File does not exist.
file_pn.write('')
file_pn.empty? # => true   # File exists and is empty.
dir_pn.empty?  # => false  # Dir exists and is not empty.
file_pn.write('foo')
file_pn.empty? # => false  # File exists and is not empty.

file_pn.delete
dir_pn.delete
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1614

def empty?
  if FileTest.directory?(@path)
    Dir.empty?(@path)
  else
    File.empty?(@path)
  end
end

#mountpoint?Boolean (readonly)

Returns true if self points to a mountpoint.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 537

def mountpoint?
  begin
    stat1 = self.lstat
    stat2 = self.parent.lstat
    stat1.dev != stat2.dev || stat1.ino == stat2.ino
  rescue Errno::ENOENT
    false
  end
end

#path (readonly, protected)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 224

attr_reader :path

#relative?Boolean (readonly)

The opposite of #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
[ GitHub ]

  
# File 'pathname_builtin.rb', line 558

def relative?
  !absolute?
end

#root?Boolean (readonly)

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/...

[ GitHub ]

  
# File 'pathname.c', line 142

static VALUE
path_root_p(VALUE self)
{
    VALUE path = get_strpath(self);
    if (RSTRING_LEN(path) == 0) return Qfalse;
    const char *ptr = RSTRING_PTR(path), *end = RSTRING_END(path);
    rb_encoding *enc = rb_enc_get(path);
    const char *base = rb_enc_path_skip_prefix_root(ptr, end, enc);
    return RBOOL(base == end);
}

Instance Method Details

#+(other) ⇒ Pathname Also known as: #/

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('foo')     # => #<Pathname:foo>
pn + 'bar'               # => #<Pathname:foo/bar>
pn + File.new('LEGAL')   # => #<Pathname:foo/LEGAL>
pn + Dir.new('lib')      # => #<Pathname:foo/lib>
pn + Pathname('bar')     # => #<Pathname:foo/bar>

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

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

Extra component separators ('/') are removed:

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

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

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

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

  • Resolved, when possible:

    Pathname('a')      + '..'      # => #<Pathname:.>
    Pathname('a/b')    + '..'      # => #<Pathname:a>
    Pathname('/')      + '../a'    # => #<Pathname:/a>
    Pathname('a')      + '../b'    # => #<Pathname:b>
    Pathname('a/b')    + '../c'    # => #<Pathname:a/c>
    Pathname('a//b/c') + '../d//e' # => #<Pathname:a//b/d//e>
  • Removed, when not needed:

    Pathname('/') + '..' # => #<Pathname:/>
  • Retained, when needed:

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

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

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

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

Pathname('/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('/var') + 'nosuch:ever' # => #<Pathname:/var/nosuch:ever>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 713

def +(other)
  other = Pathname.new(other) unless Pathname === other
  Pathname.new(plus(@path, other.path))
end

#/(other)

Alias for #+.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 717

alias / +

#<=>(other) ⇒ 1, ...

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('a')  <=> Pathname('b')  # => -1
Pathname('a')  <=> Pathname('ab') # => -1
Pathname('a')  <=> Pathname('a')  # => 0
Pathname('b')  <=> Pathname('a')  # => 1
Pathname('ab') <=> Pathname('a')  # => 1
Pathname('ab') <=> 'a'            # => nil

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

Pathname('lib') <=> Pathname('./lib') # => 1
[ GitHub ]

  
# File 'pathname.c', line 68

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);
}

#==(other) ⇒ Boolean Also known as: #===, #eql?

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

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

Returns false if other is not a pathname:

pn == 'lib'             # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 273

def ==(other)
  return false unless Pathname === other
  other.path == @path
end

#===(other)

Alias for #==.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 277

alias === ==

#add_trailing_separator(path) (private)

add_trailing_separator(path) -> path

[ GitHub ]

  
# File 'pathname.c', line 286

static VALUE
add_trailing_separator(VALUE self, VALUE path)
{
    if (RSTRING_LEN(check_strpath(path)) <= 0) return path;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *end = RSTRING_END(path);
    const char *top = rb_enc_path_skip_prefix(name, end, enc);
    if (top < end && isdirsep(end[-1])) {
        if (end[-1] == '/' || rb_enc_prev_char(top, end, end, enc) == end - 1)
            return path;
    }
    return rb_str_cat_cstr(rb_str_dup(path), "/");
}

#ascend {|entry| ... } ⇒ nil #ascendEnumerator

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

Pathname('/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.

Yields:

  • (_self)

Yield Parameters:

  • _self (Pathname)

    the object that the method was called on

[ GitHub ]

  
# File 'pathname_builtin.rb', line 641

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

#atimeTime

Returns a new ::Time object containing the time of the most recent access (read or write) to the entry represented by self; see {File System Timestamps}:

# Work in a temporary directory.
require 'tmpdir'
Dir.mktmpdir do |tmpdirpath|
# A subdirectory therein, and its Pathname.
dirpath = File.join(tmpdirpath, 'subdir')
Dir.mkdir(dirpath)
dir_pn = Pathname(dirpath)
puts "Create directory; establishes atime for directory."
puts "  Directory atime: #{dir_pn.atime}"
sleep(1)

# A file in the subdirectory, and its Pathname.
filepath = File.join(dirpath, 't.txt')
puts "Create file; establishes atime for file, updates atime for directory."
File.write(filepath, 'foo')
file_pn = Pathname(filepath)
puts "  File atime:      #{file_pn.atime}"
puts "  Directory atime: #{dir_pn.atime}"
sleep(1)
puts "Write file; updates atimes for file and directory."
File.write(filepath, 'bar')
puts "  File atime:      #{file_pn.atime}"
puts "  Directory atime: #{dir_pn.atime}"
end

Output:

Create directory; establishes atime for directory.
Directory atime: 2026-05-14 14:36:43 +0100
Create file; establishes atime for file, updates atime for directory.
File atime:      2026-05-14 14:36:44 +0100
Directory atime: 2026-05-14 14:36:44 +0100
Write file; updates atimes for file and directory.
File atime:      2026-05-14 14:36:45 +0100
Directory atime: 2026-05-14 14:36:45 +0100
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1107

def atime() File.atime(@path) end

#basename(path, suffix = '') ⇒ Pathname

Returns a new Pathname object containing all or part of the last entry of the path represented by self. Entries are delimited by the value of constant File::SEPARATOR and, if non-nil, the value of constant File::ALT_SEPARATOR.

When suffix is the empty string '', returns all of the last entry:

Pathname.new('foo/bar/baz/bat.txt').basename # => #<Pathname:bat.txt>
Pathname.new('foo/bar/baz').basename         # => #<Pathname:baz>

File::SEPARATOR                              # => "/"
Pathname.new('foo/bar.txt////').basename     # => #<Pathname:bar.txt>
File::ALT_SEPARATOR # => "\\"                # On Windows.
Pathname.new('foo/bar.txt//\\\\//').basename # => #<Pathname:bar.txt>

When suffix is '.*', the last filename extension, if any, is removed:

Pathname.new('foo/bar.txt').basename('.*')     # => #<Pathname:bar>
Pathname.new('foo/bar.txt.old').basename('.*') # => #<Pathname:bar.txt>
Pathname.new('foo/bar').basename('.*')         # => #<Pathname:bar>

When suffix is any string other than '' or '.*', the matching trailing substring, if any, is removed:

Pathname.new('foo/bar.txt').basename('.txt') # => #<Pathname:bar>
Pathname.new('foo/bar.txt').basename('txt')  # => #<Pathname:bar.>
Pathname.new('foo/bar.txt').basename('*')    # => #<Pathname:bar.txt>
Pathname.new('foo/bar.txt').basename('.')    # => #<Pathname:bar.txt>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1441

def basename(...) self.class.new(File.basename(@path, ...)) end

#binread(length = nil, offset = 0) ⇒ String?

Behaves like #read, except that the file is opened in binary mode with ASCII-8BIT encoding.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1012

def binread(...) File.binread(@path, ...) end

#binwrite(string, offset = 0, **opts) ⇒ nonnegative_integer

Behaves like #write, except that the file is opened in binary mode with ASCII-8BIT encoding.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1062

def binwrite(...) File.binwrite(@path, ...) end

#birthtimeTime

Returns a new ::Time object containing the create time of the entry represented by self; see {File System Timestamps}:

#### Work in a temporary directory.
Pathname.mktmpdir do |tmpdirpath|
  # A subdirectory therein, and its Pathname.
  dirpath = File.join(tmpdirpath, 'subdir')
  dir_pn = Pathname(dirpath)
  puts "Create directory; directory birthtime established."
  dir_pn.mkdir
  puts "  Directory birthtime: #{dir_pn.birthtime}"
  sleep(1)

  # A file in the subdirectory, and its Pathname.
  filepath = File.join(dirpath, 't.txt')
  file_pn = Pathname(filepath)
  puts "Create file; file birthtime established; directory birthtime not updated."
  file_pn.write('foo')
  puts "  File birthtime:      #{file_pn.birthtime}"
  puts "  Directory birthtime: #{dir_pn.birthtime}"
  sleep(1)
  puts "Write file; neither birthtime updated."
  file_pn.write('bar')
  puts "  File birthtime:      #{file_pn.birthtime}"
  puts "  Directory birthtime: #{dir_pn.birthtime}"
end

Output:

Create directory; directory birthtime established.
  Directory birthtime: 2026-05-14 23:41:12 +0100
Create file; file birthtime established; directory birthtime not updated.
  File birthtime:      2026-05-14 23:41:13 +0100
  Directory birthtime: 2026-05-14 23:41:12 +0100
Write file; neither birthtime updated.
  File birthtime:      2026-05-14 23:41:13 +0100
  Directory birthtime: 2026-05-14 23:41:12 +0100
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1157

def birthtime() File.birthtime(@path) end

#blockdev?Boolean

Returns whether self represents a path to a block device (i.e., a direct-access device):

Pathname('/dev/nvme0n1').blockdev? # => true
Pathname('/dev/loop0').blockdev?   # => true
Pathname('/dev/tty').blockdev?     # => false
Pathname('/dev/null').blockdev?    # => false
Pathname('nosuch').blockdev?       # => false
Pathname($stdin).blockdev?         # => false

The returned value is OS-dependent; on Windows, almost always false.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1567

def blockdev?() FileTest.blockdev?(@path) end

#chardev?Boolean

Returns whether self represents a path to a character device (i.e., a sequential-access device):

Pathname('/dev/tty').chardev?     # => true
Pathname('/dev/null').chardev?    # => true
Pathname('/dev/nvme0n1').chardev? # => false
Pathname('/dev/loop0').chardev?   # => false
Pathname($stdin).chardev?         # => false
Pathname('nosuch').chardev?       # => false

The returned value is OS-dependent; on Windows, almost always false.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1587

def chardev?() FileTest.chardev?(@path) end

#children(with_dirnames = true) ⇒ Pathname

Returns an array of pathnames; each represents a child of the entry represented by self, which must be an existing directory in the underlying file system.

With with_dirnames given as true (the default), each pathname contains the full entry:

Pathname('lib').children.size # => 72
Pathname('lib').children.take(3)
#### => [#<Pathname:lib/bundled_gems.rb>, #<Pathname:lib/bundler>, #<Pathname:lib/bundler.rb>]

With with_dirnames given as false, each pathname contains only the basename of the entry:

Pathname('lib').children(false).take(3)
#### => [#<Pathname:bundled_gems.rb>, #<Pathname:bundler>, #<Pathname:bundler.rb>]

Note that entries . and .. in directory are not actually children, and so are never included in the result.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 814

def children(with_directory=true)
  with_directory = false if @path == '.'
  result = Dir.children(@path)
  if with_directory
    result.map! {|e| self.class.new(File.join(@path, e))}
  else
    result.map! {|e| self.class.new(e)}
  end
  result
end

#chmod(mode) ⇒ 1

Changes the mode (i.e., permissions) of the entry represented by self; see {File Permissions}; returns 1:

#### A helper method to make an integer mode display as octal.
def pretty(mode); '0' + (mode & 0777).to_s(8); end

#### Work in a temporary directory.
Pathname.mktmpdir do |tmpdirpath|
  # A subdirectory therein, and its Pathname.
  dirpath = File.join(tmpdirpath, 'subdir')
  dir_pn = Pathname(dirpath)
  dir_pn.mkdir
  # The directory mode.
  puts "Original directory mode: #{pretty(dir_pn.stat.mode)}"
  # Change the directory mode.
  dir_pn.chmod(0777)
  puts "New directory mode:      #{pretty(dir_pn.stat.mode)}"

  # A file in the subdirectory, and its Pathname.
  filepath = File.join(dirpath, 't.txt')
  file_pn = Pathname(filepath)
  # Create the file.
  file_pn.write('foo')
  # The file mode.
  puts "Original file mode:      #{pretty(file_pn.stat.mode)}"
  # Change the file modes.
  file_pn.chmod(0777)
  puts "New file mode:           #{pretty(file_pn.stat.mode)}"
end

Output:

Original directory mode: 0775
New directory mode:      0777
Original file mode:      0664
New file mode:           0777
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1271

def chmod(mode) File.chmod(mode, @path) end

#chop_basename(path) (private)

chop_basename(path) -> [pre-basename, basename] or nil

[ GitHub ]

  
# File 'pathname.c', line 231

static VALUE
chop_basename(VALUE self, VALUE path)
{
    long baselen, alllen = RSTRING_LEN(check_strpath(path));
    if (alllen <= 0) return Qnil;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *base = ruby_enc_find_basename(name, &baselen, &alllen, enc);
    if (baselen < 1) return Qnil;
    if (baselen == 1 && isdirsep(*base)) return Qnil;
    RUBY_ASSERT(base >= name);
    RUBY_ASSERT(base <= RSTRING_END(path));
    VALUE dir = rb_str_subseq(path, 0, base - name);
    VALUE basename = rb_enc_str_new(base, alllen, enc);
    RB_GC_GUARD(path);
    return rb_assoc_new(dir, basename);
}

#chown(owner_id, group_id) ⇒ 0

Changes the owner and group of an entry (directory or file):

#### Work in a temporary directory.
Pathname.mktmpdir do |tmpdirpath|
  # A subdirectory therein, and its Pathname.
  dirpath = File.join(tmpdirpath, 'subdir')
  dir_pn = Pathname(dirpath)
  dir_pn.mkdir
  dir_stat = File.stat(dirpath)
  puts "Original directory owner: #{dir_stat.uid}"
  puts "Original directory group: #{dir_stat.gid}"
  dir_pn.chown(1000, 1000)
  dir_stat = File.stat(dirpath)
  puts "New directory owner:      #{dir_stat.uid}"
  puts "New directory group:      #{dir_stat.gid}"

  # A file in the subdirectory, and its Pathname.
  filepath = File.join(dirpath, 't.txt')
  file_pn = Pathname(filepath)
  # Create the file.
  file_pn.write('foo')
  file_stat = File.stat(filepath)
  puts "Original file owner:      #{file_stat.uid}"
  puts "Original file group:      #{file_stat.gid}"
  file_pn = Pathname(dirpath)
  file_pn.chown(1000, 1000)
  file_stat = File.stat(dirpath)
  puts "New file owner:           #{file_stat.uid}"
  puts "New file group:           #{file_stat.gid}"
end

Output:

Original directory owner: 0
Original directory group: 0
New directory owner:      1000
New directory group:      1000
Original file owner:      0
Original file group:      0
New file owner:           1000
New file group:           1000

Notes:

  • On Windows, the owner and group are not changed.
  • Only a process with superuser privileges can change the owner of an entry.
  • The owner of an entry can change its group to any group to which the owner belongs.
  • A nil or -1 owner or group id is ignored.
  • The method follows symbolic links to the target entry.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1336

def chown(owner, group) File.chown(owner, group, @path) end

#cleanpath(symlinks = false) ⇒ Pathname

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

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

Pathname('').cleanpath # => {#<}Pathname:.>

Separators

A lone separator is preserved:

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

Multiple trailing separators are removed:

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

Multiple embedded separators are reduced to a single separator:

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

Multiple leading separators are reduced:

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

Single-Dot Entries

A lone single-dot entry is preserved:

Pathname('.').cleanpath  # => {#<}Pathname:.>

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

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

Double-Dot Entries

A lone double-dot entry is preserved:

Pathname('..').cleanpath # => {#<}Pathname:..>

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

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

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

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

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

Pathname('/..').cleanpath    # => {#<}Pathname:/>
Pathname('/../..').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('a/').cleanpath           # => {#<}Pathname:a>
Pathname('a/').cleanpath(true)     # => {#<}Pathname:a/>

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

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

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

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

Pathname('a/b/../../../../c/../d').cleanpath
#### => {#<}Pathname:../../d>
Pathname('a/b/../../../../c/../d').cleanpath(true)
#### => {#<}Pathname:a/b/../../../../c/../d>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 463

def cleanpath(consider_symlink=false)
  if consider_symlink
    cleanpath_conservative
  else
    cleanpath_aggressive
  end
end

#cleanpath_aggressive (private)

This method is for internal use only.

Clean the path simply by resolving and removing excess . and .. entries. Nothing more, nothing less.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 475

def cleanpath_aggressive # :nodoc:
  path = @path
  names = []
  pre = path
  while r = chop_basename(pre)
    pre, base = r
    case base
    when '.'
    when '..'
      names.unshift base
    else
      if names[0] == '..'
        names.shift
      else
        names.unshift base
      end
    end
  end
  pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
  if has_separator?(File.basename(pre))
    names.shift while names[0] == '..'
  end
  self.class.new(prepend_prefix(pre, File.join(*names)))
end

#cleanpath_conservative (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 501

def cleanpath_conservative # :nodoc:
  path = @path
  names = []
  pre = path
  while r = chop_basename(pre)
    pre, base = r
    names.unshift base if base != '.'
  end
  pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
  if has_separator?(File.basename(pre))
    names.shift while names[0] == '..'
  end
  if names.empty?
    self.class.new(File.dirname(pre))
  else
    if names.last != '..' && File.basename(path) == '.'
      names << '.'
    end
    result = prepend_prefix(pre, File.join(*names))
    if /\A(?:\.|\.\.)\z/ !~ names.last && has_trailing_separator?(path)
      self.class.new(add_trailing_separator(result))
    else
      self.class.new(result)
    end
  end
end

#ctimeTime

On Windows, returns the #birthtime.

On other systems, returns a new ::Time object containing the time of the most recent metadata change to the entry represented by self; see {File System Timestamps}:

#### Work in a temporary directory.
Pathname.mktmpdir do |tmpdirpath|
  # A subdirectory therein, and its Pathname.
  dirpath = File.join(tmpdirpath, 'subdir')
  dir_pn = Pathname(dirpath)
  puts "Create directory; directory ctime established."
  dir_pn.mkdir
  puts "  Directory ctime: #{dir_pn.ctime}"
  sleep(1)

  # A file in the subdirectory, and its Pathname.
  filepath = File.join(dirpath, 't.txt')
  file_pn = Pathname(filepath)
  puts "Create file; file ctime established; directory ctime updated."
  file_pn.write('foo')
  puts "  File ctime:      #{file_pn.ctime}"
  puts "  Directory ctime: #{dir_pn.ctime}"
  sleep(1)
  puts "Write file; file ctime updated; directory ctime not updated."
  file_pn.write('bar')
  puts "  File ctime:      #{file_pn.ctime}"
  puts "  Directory ctime: #{dir_pn.ctime}"
  sleep(1)
  puts "Read file; neither ctime not updated."
  file_pn.read
  puts "  File ctime:      #{file_pn.ctime}"
  puts "  Directory ctime: #{dir_pn.ctime}"
end

Output:

Create directory; directory ctime established.
  Directory ctime: 2026-05-20 14:05:05 -0500
Create file; file ctime established; directory ctime updated.
  File ctime:      2026-05-20 14:05:06 -0500
  Directory ctime: 2026-05-20 14:05:06 -0500
Write file; file ctime updated; directory ctime not updated.
  File ctime:      2026-05-20 14:05:07 -0500
  Directory ctime: 2026-05-20 14:05:06 -0500
Read file; neither ctime not updated.
  File ctime:      2026-05-20 14:05:07 -0500
  Directory ctime: 2026-05-20 14:05:06 -0500
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1218

def ctime() File.ctime(@path) end

#del_trailing_separator(path) (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname.c', line 302

static VALUE
del_trailing_separator(VALUE self, VALUE path)
{
    long len = RSTRING_LEN(check_strpath(path));
    if (len <= 0) return path;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *end = name + len, *tail = end;
    const char *top = rb_enc_path_skip_prefix(name, end, enc);
    if (tail > top && isdirsep(tail[-1])) {
        while (--tail > top && isdirsep(tail[-1]));
        if (tail > top &&
            tail[0] != '/' &&
            !rb_str_enc_fastpath(path) &&
            rb_enc_left_char_head(top, tail, end, enc) != tail) {
            /* trailing byte, not a directory separator */
            ++tail;
        }
        if (tail < end) {
            if (tail == name || (drive_letter && tail == top && top[-1] == ':')) {
                ++tail;
            }
        }
    }
    if (tail == end) return path;
    return rb_str_subseq(path, 0, tail - name);
}

#delete

Alias for #unlink.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1902

alias delete unlink

#descend {|entry| ... } ⇒ nil #descendEnumerator

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

#### Absolute path.
Pathname('/path/to/some/file.rb').descend {|pn| p pn }
#### #<Pathname:/>
#### #<Pathname:/path>
#### #<Pathname:/path/to>
#### #<Pathname:/path/to/some>
#### #<Pathname:/path/to/some/file.rb>
#### Relative path.
Pathname('path/to/some/file.rb').descend {|pn| p pn }
#### #<Pathname:path>
#### #<Pathname:path/to>
#### #<Pathname:path/to/some>
#### #<Pathname:path/to/some/file.rb>

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 617

def descend
  return to_enum(__method__) unless block_given?
  vs = []
  ascend {|v| vs << v }
  vs.reverse_each {|v| yield v }
  nil
end

#directory?Boolean

Returns whether the entry represented by self is a directory:

Pathname('/etc').directory?      # => true
Pathname('lib').directory?       # => true
Pathname('README.md').directory? # => false
Pathname('nosuch').directory?    # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1688

def directory?() FileTest.directory?(@path) end

#dirname

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

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1444

def dirname() self.class.new(File.dirname(@path)) end

#each_child(with_dirnames = true) {|entry| ... } ⇒ Pathname #each_child(with_dirnames = true) ⇒ Enumerator

With a block given and with_dirnames given as true (the default), yields a new pathname for each child of the entry represented by self; returns an array of those pathnames:

Pathname('include').each_child {|child| p child }
#### #<Pathname:include/ruby>
#### #<Pathname:include/ruby.h>
#### => [#<Pathname:include/ruby>, #<Pathname:include/ruby.h>]

With a block given and with_dirnames given as false, yields a new pathname for each child of the entry represented by self with its dirname omitted; returns an array of those pathnames:

Pathname('include').each_child(false) {|child| p child }
#### #<Pathname:ruby>
#### #<Pathname:ruby.h>
#### => [#<Pathname:ruby>, #<Pathname:ruby.h>]

Note that entries '.' and '..' are not children.

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 858

def each_child(with_directory=true, &b)
  children(with_directory).each(&b)
end

#each_entry {|entry| ... } ⇒ nil #each_entryEnumerator

With a block given, yields a new pathname for each entry in the entry represented by self; returns nil:

Pathname('include').each_entry {|entry| p entry }
#### #<Pathname:ruby>
#### #<Pathname:..>
#### #<Pathname:ruby.h>
#### #<Pathname:.>
#### => nil

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1861

def each_entry(&block) # :yield: pathname
  return to_enum(__method__) unless block_given?
  Dir.foreach(@path) {|f| yield self.class.new(f) }
end

#each_filename {|component| ... } ⇒ nil #each_filenameEnumerator

With a block given, yields each component of the string path:

Pathname('/foo/bar/baz').each_filename {|filename| p filename }
#=> nil

Output:

"foo"
"bar"
"baz"

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 584

def each_filename # :yield: filename
  return to_enum(__method__) unless block_given?
  _, names = split_names(@path)
  names.each {|filename| yield filename }
  nil
end

#each_line(sep = $/, **opts) {|line| ... } → nil) #each_line(limit, **opts) {|line| ... } → nil) #each_line(sep, limit, **opts) {|line| ... } → nil) #each_line(...) → new_enumerator)

With a block given, calls the block with each line from the file represented by self; returns nil:

lines = []
Pathname('COPYING').each_line {|line| lines << line }
lines.take(3)
#### =>
#### ["{日本語}[rdoc-ref:COPYING.ja]\n",
####  "\n",
####  "Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.\n"]

The lines are read using IO.foreach, all arguments and options are passed to that method; see details at IO.foreach.

With no block given, returns a new Enumerator.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 943

def each_line(...) # :yield: line
  File.foreach(@path, ...)
end

#entriesPathname

Returns an array of pathnames, one for each entry in the directory represented by self:

Pathname('.').entries.take(5)
#### =>
#### [#<Pathname:.>,
####  #<Pathname:..>,
####  #<Pathname:gc.rb>,
####  #<Pathname:yjit.rb>,
####  #<Pathname:iseq.h>]
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1838

def entries() Dir.entries(@path).map {|f| self.class.new(f) } end

#eql?(other)

Alias for #==.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 278

alias eql? ==

#executable?Boolean

Returns whether the entry represented by self is executable; calls FileTest#executable? with argument self.to_s:

Pathname('bin/gem').executable?   # => true
Pathname('README.md').executable? # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1635

def executable?() FileTest.executable?(@path) end

#executable_real?Boolean

Returns whether the entry represented by self is executable by the real user and group id of the current process; calls FileTest#executable_real? with argument self.to_s:

pn = Pathname('example')
pn.write('')
pn.executable_real? # => false
pn.chmod(0100)
pn.executable_real? # => true
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1654

def executable_real?() FileTest.executable_real?(@path) end

#exist?Boolean

Returns whether the entry represented by self exists:

Pathname('.').exist?         # => true
Pathname('README.md').exist? # => true
Pathname('nosuch').exist?    # => false
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1669

def exist?() FileTest.exist?(@path) end

#expand_path(dirpath = '.') ⇒ Pathname

Returns a new pathname containing the absolute path for self.

Evaluates a relative path with respect to the directory given by dirpath:

Dir.chdir('/snap')
#### Default dirpath.
Pathname('README').expand_path                  # => #<Pathname:/snap/README>
Pathname('bin').expand_path                     # => #<Pathname:/snap/bin>
Pathname('bin/../var').expand_path              # => #<Pathname:/snap/var>  # Cleaned.
#### Other dirpath.
Pathname('../zip').expand_path('/usr/bin/ruby') # => #<Pathname:/usr/bin/zip>
Dir.chdir('/usr/bin')
Pathname('../../snap').expand_path(__FILE__)    # => #<Pathname:/usr/snap>

Evaluates an absolute path without respect to dirpath:

Pathname('/snap').expand_path                       # => #<Pathname:/snap>
Pathname('/snap').expand_path.expand_path('nosuch') # => #<Pathname:/snap>
Pathname('/snap/../snap').expand_path               # => #<Pathname:/snap>  # Cleaned.

More examples:

{Dir.chdir}('/usr/bin')
Pathname('../../snap').expand_path(__FILE__) # => {#<}Pathname:/usr/snap>
Pathname('../../snap').expand_path           # => {#<}Pathname:/snap>
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1521

def expand_path(...) self.class.new(File.expand_path(@path, ...)) end

#extnameextension

Returns the filename extension of self -- usually the portion of the string path beginning from the last period:

Pathname('t.rb').extname               # => ".rb"
Pathname('foo.bar.t.rb').extname       # => ".rb"
Pathname('foo/bar/t.rb').extname       # => ".rb"
Pathname('nosuch.txt').extname         # => ".txt"  # Path need not exist.

Returns the entire string when there is no period:

Pathname('foo').extname # => ""

Returns an empty string when the only period is the first character:

Pathname('.irbrc').extname # => ""

Returns an empty string or '.' when #path ends with a period:

Pathname('foo.').extname    # => ""   # On Windows.
Pathname('foo.').extname    # => "."  # Elsewhere.
Pathname('foo....').extname # => ""   # On Windows.
Pathname('foo....').extname # => "."  # Elsewhere.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 1482

def extname() File.extname(@path) end

#file?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1691

def file?() FileTest.file?(@path) end

#fnmatch(pattern)

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

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1343

def fnmatch(pattern, ...) File.fnmatch(pattern, @path, ...) end

#fnmatch?(pattern) ⇒ Boolean

See File.fnmatch? (same as #fnmatch).

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1346

def fnmatch?(pattern, ...) File.fnmatch?(pattern, @path, ...) end

#freezeself

Freezes self, preventing further modifications; see Frozen Objects.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 254

def freeze
  super
  @path.freeze
  self
end

#ftypeString

Returns the string type of the object at the path in self:

Pathname('README.md').ftype   # => "file"
Pathname('lib').ftype         # => "directory"
Pathname('/dev/null').ftype   # => "characterSpecial"
Pathname('/dev/loop0').ftype  # => "blockSpecial"

File.mkfifo('/tmp/pipe', 0666)
Pathname('/tmp/pipe').ftype   # => "fifo"

File.symlink('lib', 'lib_link')
Pathname('lib_link').ftype    # => "link"

require 'socket'
UNIXServer.new('/tmp/socket')
Pathname('/tmp/socket').ftype # => "socket"

Returns 'unknown' if the type cannot be determined.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1369

def ftype() File.ftype(@path) end

#glob(*args, **kwargs)

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.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1799

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

#grpowned?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1672

def grpowned?() FileTest.grpowned?(@path) end

#has_separator?(path) ⇒ Boolean (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname.c', line 182

static VALUE
has_separator_p(VALUE self, VALUE path)
{
    const char *ptr = RSTRING_PTR(check_strpath(path));
    const char *end = RSTRING_END(path);
    if (alt_separator) {
        rb_encoding *enc = rb_enc_get(path);
        bool mb = !rb_str_enc_fastpath(path);
        while (ptr < end) {
            if (isdirsep(*ptr)) return Qtrue;
            ptr += (mb ? rb_enc_mbclen(ptr, end, enc) : 1);
        }
    }
    else {
        /* assume '/' will never be trailing bytes */
        if (memchr(ptr, '/', end - ptr)) return Qtrue;
    }
    return Qfalse;
}

#has_trailing_separator?(path) ⇒ Boolean (private)

has_trailing_separator?(path) -> bool

[ GitHub ]

  
# File 'pathname.c', line 271

static VALUE
has_trailing_separator(VALUE self, VALUE path)
{
    long baselen, alllen = RSTRING_LEN(check_strpath(path));
    if (alllen <= 0) return Qfalse;
    rb_encoding *enc = rb_enc_get(path);
    const char *name = RSTRING_PTR(path);
    const char *base = ruby_enc_find_basename(name, &baselen, &alllen, enc);
    if (baselen < 1) return Qfalse;
    if (baselen == 1 && isdirsep(*base)) return Qfalse;
    return RBOOL(base + alllen < RSTRING_END(path));
}

#hash

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 280

def hash # :nodoc:
  @path.hash
end

#inspect

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 292

def inspect # :nodoc:
  "#<#{self.class}:#{@path}>"
end

#join(*args)

Joins the given pathnames onto self to create a new Pathname object. This is effectively the same as using #+ 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
[ GitHub ]

  
# File 'pathname_builtin.rb', line 774

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

#lchmod(mode)

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1274

def lchmod(mode) File.lchmod(mode, @path) end

#lchown(owner, group)

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1339

def lchown(owner, group) File.lchown(owner, group, @path) end

#lstat

See File.lstat.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1389

def lstat() File.lstat(@path) end

#lutime(atime, mtime)

Update the access and modification times of the file.

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

See File.lutime.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1405

def lutime(atime, mtime) File.lutime(atime, mtime, @path) end

#mkdir

See Dir.mkdir. Create the referenced directory.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1867

def mkdir(...) Dir.mkdir(@path, ...) end

#mkpath(mode: nil)

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

See FileUtils.mkpath and FileUtils.mkdir_p

[ GitHub ]

  
# File 'pathname_builtin.rb', line 300

def mkpath(mode: nil)
  path = @path == '/' ? @path : @path.chomp('/')

  stack = []
  until File.directory?(path) || (parent = File.dirname(path)) == path
    stack.push path
    path = parent
  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

#mtime

See File.mtime. Returns last modification time.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1221

def mtime() File.mtime(@path) end

#open

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

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1375

def open(...) # :yield: file
  File.open(@path, ...)
end

#opendir(&block)

See Dir.open.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1873

def opendir(&block) # :yield: dir
  Dir.open(@path, &block)
end

#owned?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1700

def owned?() FileTest.owned?(@path) end

#parent

Returns the parent directory.

This is same as self + '..'.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 532

def parent
  self + '..'
end

#pipe?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1694

def pipe?() FileTest.pipe?(@path) end

#plus(path1, path2) (private)

This method is for internal use only.

(path1, path2) -> path

[ GitHub ]

  
# File 'pathname_builtin.rb', line 720

def plus(path1, path2) # :nodoc:
  prefix2 = path2
  index_list2 = []
  basename_list2 = []
  while r2 = chop_basename(prefix2)
    prefix2, basename2 = r2
    index_list2.unshift prefix2.length
    basename_list2.unshift basename2
  end
  return path2 if prefix2 != ''
  prefix1 = path1
  while true
    while !basename_list2.empty? && basename_list2.first == '.'
      index_list2.shift
      basename_list2.shift
    end
    break unless r1 = chop_basename(prefix1)
    prefix1, basename1 = r1
    next if basename1 == '.'
    if basename1 == '..' || basename_list2.empty? || basename_list2.first != '..'
      prefix1 = prefix1 + basename1
      break
    end
    index_list2.shift
    basename_list2.shift
  end
  r1 = chop_basename(prefix1)
  if !r1 && (r1 = has_separator?(File.basename(prefix1)))
    while !basename_list2.empty? && basename_list2.first == '..'
      index_list2.shift
      basename_list2.shift
    end
  end
  if !basename_list2.empty?
    suffix2 = path2[index_list2.first..-1]
    r1 ? File.join(prefix1, suffix2) : prefix1 + suffix2
  else
    r1 ? prefix1 : File.dirname(prefix1)
  end
end

#prepend_prefix(prefix, relpath) (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname_builtin.rb', line 324

def prepend_prefix(prefix, relpath) # :nodoc:
  if relpath.empty?
    File.dirname(prefix)
  elsif has_separator?(prefix)
    add_trailing_separator(File.dirname(prefix)) + relpath
  else
    prefix + relpath
  end
end

#read(length = nil, offset = 0, **opts) ⇒ String?

Reads and returns some or all of the content of the file whose path is self.to_s.

With no arguments given, reads in text mode and returns the entire content of the file:

Pathname.new('t.txt').read
# => "First line\nSecond line\n\nFourth line\nFifth line\n"
Pathname.new('t.ja').read
# => "こんにちは"
Pathname.new('t.dat').read
# => "\xFE\xFF\x99\x90\x99\x91\x99\x92\x99\x93\x99\x94"

On Windows, text mode can terminate reading and leave bytes in the file unread when encountering certain special bytes. Consider using #binread if all bytes in the file should be read.

With argument length given, returns length bytes if available:

Pathname.new('t.txt').read(7)
# => "First l"
Pathname.new('t.ja').read(7)
# => "\xE3\x81\x93\xE3\x82\x93\xE3"
Pathname.new('t.dat').read(7)
# => "\xFE\xFF\x99\x90\x99\x91\x99"

Returns all bytes if length is larger than the files size:

Pathname.new('t.txt').read(700)
# => "First line\r\nSecond line\r\n\r\nFourth line\r\nFifth line\r\n"
Pathname.new('t.ja').read(700)
# => "\xE3\x81\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1\xE3\x81\xAF"
Pathname.new('t.dat').read(700)
# => "\xFE\xFF\x99\x90\x99\x91\x99\x92\x99\x93\x99\x94"

With arguments length and offset given, returns length bytes if available, beginning at the given offset:

Pathname.new('t.txt').read(10, 2)
# => "rst line\r\n"
Pathname.new('t.ja').read(10, 2)
# => "\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1"
Pathname.new('t.dat').read(10, 2)
# => "\x99\x90\x99\x91\x99\x92\x99\x93\x99\x94"

Returns nil if offset is past the end of the file:

Pathname.new('t.txt').read(10, 200) # => nil

Optional keyword arguments opts specify:

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1004

def read(...) File.read(@path, ...) end

#readable?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1703

def readable?() FileTest.readable?(@path) end

#readable_real?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1709

def readable_real?() FileTest.readable_real?(@path) end

#readlines

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

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1015

def readlines(...) File.readlines(@path, ...) end

#realdirpath

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.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1543

def realdirpath(...) self.class.new(File.realdirpath(@path, ...)) end

#realpath

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.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1536

def realpath(...) self.class.new(File.realpath(@path, ...)) end

#relative_path_from(base_directory)

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.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 876

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

#rename(to)

See File.rename. Rename the file.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1383

def rename(to) File.rename(@path, to) end

#rmdir

See Dir.rmdir. Remove the referenced directory.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1870

def rmdir() Dir.rmdir(@path) end

#same_paths?(a, b) ⇒ Boolean (private)

This method is for internal use only.
[ GitHub ]

  
# File 'pathname.c', line 124

static VALUE
same_paths(VALUE self, VALUE a, VALUE b)
{
    check_strpath(a);
    check_strpath(b);
    if (CASEFOLD_FILESYSTEM)
        return RBOOL(rb_str_casecmp(a, b) == INT2FIX(0));
    else
        return rb_str_equal(a, b);
}

#setgid?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1715

def setgid?() FileTest.setgid?(@path) end

#setuid?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1712

def setuid?() FileTest.setuid?(@path) end

#size

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1718

def size() FileTest.size(@path) end

#size?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1721

def size?() FileTest.size?(@path) end

#socket?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1697

def socket?() FileTest.socket?(@path) end

#split

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

Raises:

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1525

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

#split_names(path) (private)

split_names(path) -> prefix, [name, ...]

[ GitHub ]

  
# File 'pathname.c', line 251

static VALUE
split_names(VALUE self, VALUE path)
{
    rb_encoding *enc = rb_enc_get(check_strpath(path));
    const char *beg = RSTRING_PTR(path), *ptr = beg;
    const char *end = RSTRING_END(path);
    const char *root = rb_enc_path_skip_prefix_root(ptr, end, enc);
    VALUE pre = rb_str_subseq(path, 0, root - ptr);
    VALUE names = rb_ary_new();
    while (ptr < end) {
        const char *next = rb_enc_path_next(ptr, end, enc);
        if (next > ptr) rb_ary_push(names, rb_str_subseq(path, ptr - beg, next - ptr));
        ptr = next;
        while (ptr < end && isdirsep(*ptr)) ++ptr;
    }
    return rb_assoc_new(pre, names);
}

#stat

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

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1386

def stat() File.stat(@path) end

#sticky?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1724

def sticky?() FileTest.sticky?(@path) end

#sub(*args)

Return a pathname which is substituted by String#sub.

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

  
# File 'pathname.c', line 109

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));
}

#sub_ext(repl)

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>
[ GitHub ]

  
# File 'pathname.c', line 210

static VALUE
path_sub_ext(VALUE self, VALUE repl)
{
    VALUE path = get_strpath(self);
    long len = RSTRING_LEN(path);
    const char *ptr = RSTRING_PTR(path);
    const char *ext = ruby_enc_find_extname(ptr, &len, rb_enc_get(path));
    if (len > 0) {
        RUBY_ASSERT(ext, "should point the last dot");
        path = rb_str_subseq(path, 0, ext - ptr);
    }
    else {
        /* no dot or dotted file */
        path = rb_str_dup(path);
    }
    path = rb_str_append(path, repl);
    return rb_class_new_instance(1, &path, rb_obj_class(self));
}

#symlink?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1727

def symlink?() FileTest.symlink?(@path) end

#sysopen

See File.sysopen.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1018

def sysopen(...) File.sysopen(@path, ...) end

#to_path

Alias for #to_s.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 290

alias to_path to_s

#to_s Also known as: #to_path

Return the path as a ::String.

[ GitHub ]

  
# File 'pathname_builtin.rb', line 285

def to_s
  @path.dup
end

#truncate(length)

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

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1395

def truncate(length) File.truncate(@path, length) end

#utime(atime, mtime)

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

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1398

def utime(atime, mtime) File.utime(atime, mtime, @path) end

#world_readable?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1706

def world_readable?() File.world_readable?(@path) end

#world_writable?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1733

def world_writable?() File.world_writable?(@path) end

#writable?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1730

def writable?() FileTest.writable?(@path) end

#writable_real?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1736

def writable_real?() FileTest.writable_real?(@path) end

#write(data, offset = 0, **opts) ⇒ nonnegative_integer

Opens the file at self.to_s, writes the given data to it, and closes the file; returns the number of bytes written.

With only argument data given, writes the given data to the file:

path = 't.tmp'
pn = Pathname.new(path)
pn.write('foo') # => 3
File.read(path) # => "foo"

If offset is zero (the default), the file is overwritten:

pn.write('bar')
File.read(path) # => "bar"

If offset in within the file content, the file is partly overwritten:

pn.write('foobarbaz')
pn.write('BAR', 3)
File.read(path) # => "fooBARbaz"

If offset is outside the file content, the file is padded with null characters "\u0000":

pn.write('bat', 12)
File.read(path) # => "fooBARbaz\u0000\u0000\u0000bat"

Optional keyword arguments opts specify:

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1055

def write(...) File.write(@path, ...) end

#zero?Boolean

[ GitHub ]

  
# File 'pathname_builtin.rb', line 1739

def zero?() FileTest.zero?(@path) end