123456789_123456789_123456789_123456789_123456789_

Class: Pathname

Overview

Pathname represents the name of a file or directory on the filesystem, but not the file itself.

The pathname depends on the Operating System: Unix, Windows, etc. This library works with pathnames of local OS, however non-Unix pathnames are supported experimentally.

A Pathname can be relative or absolute. It’s not until you try to reference the file that it even matters whether the file exists or not.

Pathname is immutable. It has no method for destructive update.

The goal of this class is to manipulate file path information in a neater way than standard ::Ruby provides. The examples below demonstrate the difference.

All functionality from ::File, ::FileTest, and some from ::Dir and FileUtils is included, in an unsurprising way. It is essentially a facade for all of these, and more.

Examples

Example 1: Using Pathname

require 'pathname'
pn = Pathname.new("/usr/bin/ruby")
size = pn.size              # 27662
isdir = pn.directory?       # false
dir  = pn.dirname           # Pathname:/usr/bin
base = pn.basename          # Pathname:ruby
dir, base = pn.split        # [Pathname:/usr/bin, Pathname:ruby]
data = pn.read
pn.open { |f| _ }
pn.each_line { |line| _ }

Example 2: Using standard Ruby

pn = "/usr/bin/ruby"
size = File.size(pn)        # 27662
isdir = File.directory?(pn) # false
dir  = File.dirname(pn)     # "/usr/bin"
base = File.basename(pn)    # "ruby"
dir, base = File.split(pn)  # ["/usr/bin", "ruby"]
data = File.read(pn)
File.open(pn) { |f| _ }
File.foreach(pn) { |line| _ }

Example 3: Special features

p1 = Pathname.new("/usr/lib")   # Pathname:/usr/lib
p2 = p1 + "ruby/1.8"            # Pathname:/usr/lib/ruby/1.8
p3 = p1.parent                  # Pathname:/usr
p4 = p2.relative_path_from(p3)  # Pathname:lib/ruby/1.8
pwd = Pathname.pwd              # Pathname:/home/gavin
pwd.absolute?                   # true
p5 = Pathname.new "."           # Pathname:.
p5 = p5 + "music/../articles"   # Pathname:music/../articles
p5.cleanpath                    # Pathname:articles
p5.realpath                     # Pathname:/home/gavin/articles
p5.children                     # [Pathname:/home/gavin/articles/linux, ...]

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:

  • #each_line(*args, &block)

  • #read(*args)

  • #binread(*args)

  • #readlines(*args)

  • #sysopen(*args)

  • #write(*args)

  • #binwrite(*args)

  • #atime

  • #birthtime

  • #ctime

  • #mtime

  • #chmod(mode)

  • #lchmod(mode)

  • #chown(owner, group)

  • #lchown(owner, group)

  • #fnmatch(pattern, *args)

  • #fnmatch?(pattern, *args)

  • #ftype

  • #make_link(old)

  • #open(*args, &block)

  • #readlink

  • #rename(to)

  • #stat

  • #lstat

  • #make_symlink(old)

  • #truncate(length)

  • #utime(atime, mtime)

  • #lutime(atime, mtime)

  • #basename(*args)

  • #dirname

  • #extname

  • #expand_path(*args)

  • #split

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

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

[ GitHub ] 

  


# File 'pathname_builtin.rb', line 217



def initialize(path)
  unless String === path
    path = path.to_path if path.respond_to? :to_path
    raise TypeError unless String === path
  end

  if path.include?("\0")
    raise ArgumentError, "pathname contains \\0: #{path.inspect}"
  end

  @path = path.dup
end


  







Class Method Details



  

    .getwd  
    Also known as: .pwd
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1123



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


  








  

    .glob(*args, **kwargs)  
  



  

    

See Dir.glob.  Returns or yields Pathname objects.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1099



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 1125



alias pwd getwd


  







Instance Attribute Details



  

    #absolute?  ⇒ Boolean  (readonly)
  



  

    

Predicate method for testing whether a path is absolute.



It returns true if the pathname begins with a slash.



p = Pathname.new('/im/sure')
p.absolute?
    #=> true

p = Pathname.new('not/so/sure')
p.absolute?
    #=> false


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 545



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 1021



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 513



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 208



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 560



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 530



def root?
  chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o.match?(@path)
end


  







Instance Method Details



  

    #+(other)  
    Also known as: #/
  



  

    

Appends a pathname fragment to self to produce a new Pathname object. Since other is considered as a path relative to self, if other is an absolute path, the new Pathname object is created from just other.



p1 = Pathname.new("/usr")      # Pathname:/usr
p2 = p1 + "bin/ruby"           # Pathname:/usr/bin/ruby
p3 = p1 + "/etc/passwd"        # Pathname:/etc/passwd

# / is aliased to +.
p4 = p1 / "bin/ruby"           # Pathname:/usr/bin/ruby
p5 = p1 / "/etc/passwd"        # Pathname:/etc/passwd



This method doesn’t access the file system; it is pure string manipulation.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 668



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 672



alias / +


  








  

    #<=>(other)  
  



  

    

Provides a case-sensitive comparison operator for pathnames.



Pathname.new('/usr') <=> Pathname.new('/usr/bin')
    #=> -1
Pathname.new('/usr/bin') <=> Pathname.new('/usr/bin')
    #=> 0
Pathname.new('/usr/bin') <=> Pathname.new('/USR/BIN')
    #=> 1



It will return -1, 0 or 1 depending on the value of the left argument relative to the right argument. Or it will return nil if the arguments are not comparable.


  



  [ GitHub ]


  

  


# File 'pathname.c', line 31



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)  
    Also known as: #===, #eql?
  



  

    

Compare this pathname with other.  The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 241



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


  








  

    #===(other)  
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 245



alias === ==


  








  

    #add_trailing_separator(path)   (private)
  

  

    This method is for internal use only.
  



  

    

add_trailing_separator(path) -> path


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 456



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 {|_self| ... } 
  



  

    

Iterates over and yields a new Pathname object for each element in the given path in ascending order.



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

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



Returns an ::Enumerator if no block was given.



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



It doesn’t access the filesystem.


  





  
Yields:


    
  
  • 
    (_self)
  
    • 



Yield Parameters:


    
  
  • 
    _self
    (Pathname)
—    
    

    the object that the method was called on
    

    
  
    • 





  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 642



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  
  



  

    

See File.atime.  Returns last access time.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 901



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


  








  

    #basename  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 975



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 884



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 898



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 907



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


  








  

    #blockdev?  ⇒ Boolean 
  



  

    

See FileTest#blockdev?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1013



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


  








  

    #chardev?  ⇒ Boolean 
  



  

    

See FileTest#chardev?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1016



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 761



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 916



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 362



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 922



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


  








  

    #cleanpath(consider_symlink = false)  
  



  

    

Returns clean pathname of self with consecutive slashes and useless dots removed.  The filesystem is not accessed.



If consider_symlink is true, then a more conservative algorithm is used to avoid breaking symbolic linkages.  This may retain more .. entries than absolutely necessary, but without accessing the filesystem, this can’t be avoided.



See #realpath.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 406



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 418



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}/o.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 477



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}/o.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 910



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


  








  

    #del_trailing_separator(path)   (private)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 465



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 1161



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 609



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 1042



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 978



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 811



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 1136



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 577



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 874



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 1130



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


  








  

    #eql?(other)  
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 246



alias eql? ==


  








  

    #executable?  ⇒ Boolean 
  



  

    

See FileTest#executable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1030



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


  








  

    #executable_real?  ⇒ Boolean 
  



  

    

See FileTest#executable_real?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1033



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


  








  

    #exist?  ⇒ Boolean 
  



  

    

See FileTest#exist?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1036



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


  








  

    #expand_path  
  



  

    

See File.expand_path.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 984



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 981



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


  








  

    #file?  ⇒ Boolean 
  



  

    

See FileTest#file?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1045



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 929



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


  








  

    #fnmatch?(pattern)  ⇒ Boolean 
  



  

    

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


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 932



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


  








  

    #freeze  
  

  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 230



def freeze
  super
  @path.freeze
  self
end


  








  

    #ftype  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 936



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 1114



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 1039



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 445



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 256



def hash # :nodoc:
  @path.hash
end


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 268



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 728



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 919



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


  








  

    #lchown(owner, group)  
  



  

    

See File.lchown.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 925



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


  








  

    #lstat  
  



  

    

See File.lstat.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 956



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 972



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


  












  

    #mkdir  
  



  

    

See Dir.mkdir.  Create the referenced directory.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1142



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 337



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 913



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


  








  

    #open  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 942



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


  








  

    #opendir(&block)  
  



  

    

See Dir.open.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1148



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


  








  

    #owned?  ⇒ Boolean 
  



  

    

See FileTest#owned?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1054



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


  








  

    #parent  
  



  

    

Returns the parent directory.



This is same as self + '..'.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 508



def parent
  self + '..'
end


  








  

    #pipe?  ⇒ Boolean 
  



  

    

See FileTest#pipe?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1048



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


  








  

    #plus(path1, path2)   (private)
  

  

    This method is for internal use only.
  



  

    

-> path # :nodoc:


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 674



def plus(path1, path2) # -> path # :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}/o.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 383



def prepend_prefix(prefix, relpath) # :nodoc:
  if relpath.empty?
    File.dirname(prefix)
  elsif /#{SEPARATOR_PAT}/o.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 880



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


  








  

    #readable?  ⇒ Boolean 
  



  

    

See FileTest#readable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1057



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


  








  

    #readable_real?  ⇒ Boolean 
  



  

    

See FileTest#readable_real?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1063



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 887



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 1006



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 999



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 829



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 950



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


  








  

    #rmdir  
  



  

    

See Dir.rmdir.  Remove the referenced directory.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1145



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


  








  

    #setgid?  ⇒ Boolean 
  



  

    

See FileTest#setgid?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1069



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


  








  

    #setuid?  ⇒ Boolean 
  



  

    

See FileTest#setuid?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1066



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


  








  

    #size  
  



  

    

See FileTest#size.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1072



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


  








  

    #size?  ⇒ Boolean 
  



  

    

See FileTest#size?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1075



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


  








  

    #socket?  ⇒ Boolean 
  



  

    

See FileTest#socket?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1051



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 988



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 373



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 953



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


  








  

    #sticky?  ⇒ Boolean 
  



  

    

See FileTest#sticky?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1078



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 72



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 299



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 1081



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


  








  

    #sysopen  
  



  

    

See File.sysopen.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 890



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


  








  

    #to_s  
  



  

    

Return the path as a ::String.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 261



def to_s
  @path.dup
end


  








  

    #truncate(length)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 962



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 965



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


  








  

    #world_readable?  ⇒ Boolean 
  



  

    

See FileTest#world_readable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1060



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


  








  

    #world_writable?  ⇒ Boolean 
  



  

    

See FileTest#world_writable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1087



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


  








  

    #writable?  ⇒ Boolean 
  



  

    

See FileTest#writable?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1084



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


  








  

    #writable_real?  ⇒ Boolean 
  



  

    

See FileTest#writable_real?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1090



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


  








  

    #write  
  



  

    

Writes contents to the file. See File.write.


  



  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 893



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


  








  

    #zero?  ⇒ Boolean 
  



  

    

See FileTest#zero?.


  





  


  [ GitHub ]


  

  


# File 'pathname_builtin.rb', line 1093



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