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>

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 244



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



  

    .getwd  ⇒ Pathname     Also known as: .pwd
  



  

    

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



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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1347



def Pathname.getwd() self.new(Dir.getwd) end


  








  

    

      .glob(patterns, **kwargs) → array_of_pathnames)  
      .glob(patterns, **kwargs) {|pathname| ... } → nil)  
    

  



  

    

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.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1316



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


  








  

    .pwd  
  



  

    

Alias for .getwd.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1349



alias pwd getwd


  







Instance Attribute Details



  

    #absolute?  ⇒ Boolean  (readonly)  



  

    

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.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 672



def absolute?
  ABSOLUTE_PATH.match? @path
end


  








  

    #empty?  ⇒ Boolean  (readonly)
  



  

    

Tests the file is empty.



See Dir#empty? and FileTest#empty?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1199



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 638



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 225



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 687



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_builtin.rb', line 655



def root?
  chop_basename(@path) == nil && SEPARATOR_PAT.match?(@path)
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.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>


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 832



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 836



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


  



  [ GitHub ]


  

  


# File 'pathname.c', line 45



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.new('lib')
pn == Pathname.new('lib')   # => true
pn == Pathname.new('./lib') # => false



Returns false if other is not a pathname:



pn == 'lib'                 # => false


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 272



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


  








  

    #===(other)  
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 276



alias === ==


  








  

    #add_trailing_separator(path)   (private)
  

  

    This method is for internal use only.
  



  

    

add_trailing_separator(path) -> path


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 581



def add_trailing_separator(path) # :nodoc:
  if File.basename(path + 'a') == 'a'
    path
  else
    File.join(path, "") # xxx: Is File.join is appropriate to add separator?
  end
end


  








  

    

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

  



  

    

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.


  





  
Yields:


    
  
  • 
    (_self)
  
    • 



Yield Parameters:


    
  
  • 
    _self
    (Pathname)
—    
    

    the object that the method was called on
    

    
  
    • 





  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 760



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


  








  

    #atime  ⇒ Time   



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1079



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


  








  

    #basename  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1153



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


  








  

    #binread  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1049



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


  








  

    #binwrite  
  



  

    

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



See File.binwrite.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1063



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


  








  

    #birthtime  
  



  

    

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



See File.birthtime.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1085



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


  








  

    #blockdev?  ⇒ Boolean 
  



  

    

See FileTest#blockdev?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1191



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


  








  

    #chardev?  ⇒ Boolean 
  



  

    

See FileTest#chardev?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1194



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


  








  

    #children(with_directory = true)  
  



  

    

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.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 926



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)  
  



  

    

See File.chmod.  Changes permissions.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1094



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


  








  

    #chop_basename(path)   (private)
  

  

    This method is for internal use only.
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 397



def chop_basename(path) # :nodoc:
  base = File.basename(path)
  if /\A#{SEPARATOR_PAT}?\z/o.match?(base)
    return nil
  else
    return path[0, path.rindex(base)], base
  end
end


  








  

    #chown(owner, group)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1100



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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 531



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 543



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 SEPARATOR_PAT.match?(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 602



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 SEPARATOR_PAT.match?(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


  








  

    #ctime  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1088



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


  








  

    #del_trailing_separator(path)   (private)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 590



def del_trailing_separator(path) # :nodoc:
  if r = chop_basename(path)
    pre, basename = r
    pre + basename
  elsif /#{SEPARATOR_PAT}+\z/o =~ path
    $` + File.dirname(path)[/#{SEPARATOR_PAT}*\z/o]
  else
    path
  end
end


  








  

    #delete  
  



  

    

Alias for #unlink.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1385



alias delete unlink


  








  

    #descend  
  



  

    

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.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 736



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


  








  

    #directory?  ⇒ Boolean 
  



  

    

See FileTest#directory?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1220



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 1156



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


  








  

    #each_child(with_directory = true, &b)  
  



  

    

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 #children


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 976



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


  








  

    #each_entry(&block)  
  



  

    

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.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1360



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  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 704



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  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1039



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


  








  

    #entries  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1354



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


  








  

    #eql?(other)  
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 277



alias eql? ==


  








  

    #executable?  ⇒ Boolean 
  



  

    

See FileTest#executable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1208



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


  








  

    #executable_real?  ⇒ Boolean 
  



  

    

See FileTest#executable_real?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1211



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


  








  

    #exist?  ⇒ Boolean 
  



  

    

See FileTest#exist?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1214



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


  








  

    #expand_path  
  



  

    

See File.expand_path.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1162



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


  








  

    #extname  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1159



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


  








  

    #file?  ⇒ Boolean 
  



  

    

See FileTest#file?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1223



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 1107



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


  








  

    #fnmatch?(pattern)  ⇒ Boolean 
  



  

    

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


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1110



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


  








  

    #freeze  
  



  

    

Freze self.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 253



def freeze
  super
  @path.freeze
  self
end


  








  

    #ftype  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1114



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 1331



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 
  



  

    

See FileTest#grpowned?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1217



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


  








  

    #has_trailing_separator?(path)  ⇒ Boolean  (private)
  

  

    This method is for internal use only.
  



  

    

has_trailing_separator?(path) -> bool


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 570



def has_trailing_separator?(path) # :nodoc:
  if r = chop_basename(path)
    pre, basename = r
    pre.length + basename.length < path.length
  else
    false
  end
end


  








  

    #hash  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 287



def hash # :nodoc:
  @path.hash
end


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 299



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 893



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)  
  



  

    

See File.lchmod.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1097



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


  








  

    #lchown(owner, group)  
  



  

    

See File.lchown.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1103



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


  








  

    #lstat  
  



  

    

See File.lstat.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1134



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 1150



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


  












  

    #mkdir  
  



  

    

See Dir.mkdir.  Create the referenced directory.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1366



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 372



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


  








  

    #mtime  
  



  

    

See File.mtime.  Returns last modification time.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1091



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


  








  

    #open  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1120



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


  








  

    #opendir(&block)  
  



  

    

See Dir.open.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1372



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


  








  

    #owned?  ⇒ Boolean 
  



  

    

See FileTest#owned?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1232



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


  








  

    #parent  
  



  

    

Returns the parent directory.



This is same as self + '..'.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 633



def parent
  self + '..'
end


  








  

    #pipe?  ⇒ Boolean 
  



  

    

See FileTest#pipe?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1226



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 839



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 = SEPARATOR_PAT.match?(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 418



def prepend_prefix(prefix, relpath) # :nodoc:
  if relpath.empty?
    File.dirname(prefix)
  elsif SEPARATOR_PAT.match?(prefix)
    prefix = File.dirname(prefix)
    prefix = File.join(prefix, "") if File.basename(prefix + 'a') != 'a'
    prefix + relpath
  else
    prefix + relpath
  end
end


  








  

    #read  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1045



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


  








  

    #readable?  ⇒ Boolean 
  



  

    

See FileTest#readable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1235



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


  








  

    #readable_real?  ⇒ Boolean 
  



  

    

See FileTest#readable_real?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1241



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 1052



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 1184



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 1177



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 994



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 1128



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


  








  

    #rmdir  
  



  

    

See Dir.rmdir.  Remove the referenced directory.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1369



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


  








  

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

  

    This method is for internal use only.
  



  

    

Avoid #zero? here because #casecmp can return nil.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 222



private def same_paths?(a, b) a == b end


  








  

    #setgid?  ⇒ Boolean 
  



  

    

See FileTest#setgid?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1247



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


  








  

    #setuid?  ⇒ Boolean 
  



  

    

See FileTest#setuid?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1244



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


  








  

    #size  
  



  

    

See FileTest#size.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1250



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


  








  

    #size?  ⇒ Boolean 
  



  

    

See FileTest#size?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1253



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


  








  

    #socket?  ⇒ Boolean 
  



  

    

See FileTest#socket?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1229



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 1166



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)
  

  

    This method is for internal use only.
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 408



def split_names(path) # :nodoc:
  names = []
  while r = chop_basename(path)
    path, basename = r
    names.unshift basename
  end
  return path, names
end


  








  

    #stat  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1131



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


  








  

    #sticky?  ⇒ Boolean 
  



  

    

See FileTest#sticky?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1256



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


  








  

    #sub(pattern, *args, **kwargs, &block)  
  



  

    

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 86



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_builtin.rb', line 330



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


  








  

    #symlink?  ⇒ Boolean 
  



  

    

See FileTest#symlink?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1259



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


  








  

    #sysopen  
  



  

    

See File.sysopen.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1055



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


  








  

    #to_path  
  



  

    

Alias for #to_s.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 297



alias to_path to_s


  








  

    #to_s  
    Also known as: #to_path
  



  

    

Return the path as a ::String.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 292



def to_s
  @path.dup
end


  








  

    #truncate(length)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1140



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 1143



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


  








  

    #world_readable?  ⇒ Boolean 
  



  

    

See FileTest#world_readable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1238



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


  








  

    #world_writable?  ⇒ Boolean 
  



  

    

See FileTest#world_writable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1265



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


  








  

    #writable?  ⇒ Boolean 
  



  

    

See FileTest#writable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1262



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


  








  

    #writable_real?  ⇒ Boolean 
  



  

    

See FileTest#writable_real?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1268



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


  








  

    #write  
  



  

    

Writes contents to the file. See File.write.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1058



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


  








  

    #zero?  ⇒ Boolean 
  



  

    

See FileTest#zero?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1271



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