Class: Pathname

Inherits:
Object
  • Object
show all
Defined in:
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb

Overview

  • mixed *

Constant Summary collapse

TO_PATH =

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

:to_path
SEPARATOR_PAT = 
/#{Regexp.quote File::SEPARATOR}/

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/pathname.rb', line 203

def initialize(path)
  path = path.__send__(TO_PATH) if path.respond_to? TO_PATH
  @path = path.dup

  if /\0/ =~ @path
    raise ArgumentError, "pathname contains \\0: #{@path.inspect}"
  end

  self.taint if @path.tainted?
end

Class Method Details

.getwd ⇒ Object Also known as: pwd

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



941
 
# File 'lib/pathname.rb', line 941

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

.glob(*args) ⇒ Object

See Dir.glob. Returns or yields Pathname objects.



932
933
934
935
936
937
938
 
# File 'lib/pathname.rb', line 932

def Pathname.glob(*args) # :yield: p
  if block_given?
    Dir.glob(*args) {|f| yield self.new(f) }
  else
    Dir.glob(*args).map {|f| self.new(f) }
  end
end

Instance Method Details

#+(other) ⇒ Object

Pathname#+ appends a pathname fragment to this one to produce a new Pathname object.

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

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



581
582
583
584
 
# File 'lib/pathname.rb', line 581

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

#<=>(other) ⇒ Object

Provides for comparing pathnames, case-sensitively.



231
232
233
234
 
# File 'lib/pathname.rb', line 231

def <=>(other)
  return nil unless Pathname === other
  @path.tr('/', "\0") <=> other.to_s.tr('/', "\0")
end

#==(other) ⇒ Object 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.



223
224
225
226
 
# File 'lib/pathname.rb', line 223

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

#absolute? ⇒ Boolean

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

Returns:

  • (Boolean) 


489
490
491
 
# File 'lib/pathname.rb', line 489

def absolute?
  !relative?
end

#ascend {|_self| ... } ⇒ Object

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

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

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

It doesn’t access actual filesystem.

This method is available since 1.8.5.

Yields:

  • (_self)

Yield Parameters:

  • _self (Pathname) —

    the object that the method was called on



561
562
563
564
565
566
567
568
569
 
# File 'lib/pathname.rb', line 561

def ascend
  path = @path
  yield self
  while r = chop_basename(path)
    path, name = r
    break if path.empty?
    yield self.class.new(del_trailing_separator(path))
  end
end

#atime ⇒ Object

See File.atime. Returns last access time.



762
 
# File 'lib/pathname.rb', line 762

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

#basename(*args) ⇒ Object

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



823
 
# File 'lib/pathname.rb', line 823

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

#blockdev? ⇒ Boolean

See FileTest.blockdev?.

Returns:

  • (Boolean) 


857
 
# File 'lib/pathname.rb', line 857

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

#chardev? ⇒ Boolean

See FileTest.chardev?.

Returns:

  • (Boolean) 


860
 
# File 'lib/pathname.rb', line 860

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

#chdir(&block) ⇒ Object

Pathname#chdir is obsoleted at 1.8.1.



945
946
947
948
 
# File 'lib/pathname.rb', line 945

def chdir(&block)
  warn "Pathname#chdir is obsoleted.  Use Dir.chdir."
  Dir.chdir(@path, &block)
end

#children(with_directory = true) ⇒ Object

Returns the children of the directory (files and subdirectories, not recursive) as an array of Pathname objects. By default, the returned pathnames will have enough information to access the files. If you set with_directory to false, then the returned pathnames will contain the filename only.

For example:

p = Pathname("/usr/lib/ruby/1.8")
p.children
    # -> [ Pathname:/usr/lib/ruby/1.8/English.rb,
           Pathname:/usr/lib/ruby/1.8/Env.rb,
           Pathname:/usr/lib/ruby/1.8/abbrev.rb, ... ]
p.children(false)
    # -> [ Pathname:English.rb, Pathname:Env.rb, Pathname:abbrev.rb, ... ]

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

This method has existed since 1.8.1.



668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/pathname.rb', line 668

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) ⇒ Object

See File.chmod. Changes permissions.



771
 
# File 'lib/pathname.rb', line 771

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

#chown(owner, group) ⇒ Object

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



777
 
# File 'lib/pathname.rb', line 777

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

#chroot ⇒ Object

Pathname#chroot is obsoleted at 1.8.1.



951
952
953
954
 
# File 'lib/pathname.rb', line 951

def chroot
  warn "Pathname#chroot is obsoleted.  Use Dir.chroot."
  Dir.chroot(@path)
end

#cleanpath(consider_symlink = false) ⇒ Object

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.



306
307
308
309
310
311
312
 
# File 'lib/pathname.rb', line 306

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

#ctime ⇒ Object

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



765
 
# File 'lib/pathname.rb', line 765

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

#descend ⇒ Object

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

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

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

It doesn’t access actual filesystem.

This method is available since 1.8.5.



534
535
536
537
538
539
 
# File 'lib/pathname.rb', line 534

def descend
  vs = []
  ascend {|v| vs << v }
  vs.reverse_each {|v| yield v }
  nil
end

#dir_foreach(*args, &block) ⇒ Object

Pathname#dir_foreach is obsoleted at 1.8.1.



969
970
971
972
 
# File 'lib/pathname.rb', line 969

def dir_foreach(*args, &block)
  warn "Pathname#dir_foreach is obsoleted.  Use Pathname#each_entry."
  each_entry(*args, &block)
end

#directory? ⇒ Boolean

See FileTest.directory?.

Returns:

  • (Boolean) 


875
 
# File 'lib/pathname.rb', line 875

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

#dirname ⇒ Object

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



826
 
# File 'lib/pathname.rb', line 826

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

#each_entry(&block) ⇒ Object

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.



964
965
966
 
# File 'lib/pathname.rb', line 964

def each_entry(&block) # :yield: p
  Dir.foreach(@path) {|f| yield self.class.new(f) }
end

#each_filename ⇒ Object

Iterates over each component of the path.

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



508
509
510
511
512
 
# File 'lib/pathname.rb', line 508

def each_filename # :yield: filename
  prefix, names = split_names(@path)
  names.each {|filename| yield filename }
  nil
end

#each_line(*args, &block) ⇒ Object

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



737
738
739
 
# File 'lib/pathname.rb', line 737

def each_line(*args, &block) # :yield: line
  IO.foreach(@path, *args, &block)
end

#entries ⇒ Object

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



958
 
# File 'lib/pathname.rb', line 958

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

#executable? ⇒ Boolean

See FileTest.executable?.

Returns:

  • (Boolean) 


863
 
# File 'lib/pathname.rb', line 863

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

#executable_real? ⇒ Boolean

See FileTest.executable_real?.

Returns:

  • (Boolean) 


866
 
# File 'lib/pathname.rb', line 866

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

#exist? ⇒ Boolean

See FileTest.exist?.

Returns:

  • (Boolean) 


869
 
# File 'lib/pathname.rb', line 869

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

#expand_path(*args) ⇒ Object

See File.expand_path.



832
 
# File 'lib/pathname.rb', line 832

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

#extname ⇒ Object

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



829
 
# File 'lib/pathname.rb', line 829

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

#file? ⇒ Boolean

See FileTest.file?.

Returns:

  • (Boolean) 


878
 
# File 'lib/pathname.rb', line 878

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

#find(&block) ⇒ Object

Pathname#find is an iterator to traverse a directory tree in a depth first manner. It yields a Pathname for each file under “this” directory.

Since it is implemented by find.rb, Find.prune can be used to control the traverse.

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



998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/pathname.rb', line 998

def find(&block) # :yield: p
  require 'find'
  if @path == '.'
    Find.find(@path) {|f| yield self.class.new(f.sub(%r{\A\./}, '')) }
  else
    Find.find(@path) {|f| yield self.class.new(f) }
  end
end

#fnmatch(pattern, *args) ⇒ Object

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



784
 
# File 'lib/pathname.rb', line 784

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

#fnmatch?(pattern, *args) ⇒ Boolean

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

Returns:

  • (Boolean) 


787
 
# File 'lib/pathname.rb', line 787

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

#foreach(*args, &block) ⇒ Object

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



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/pathname.rb', line 1042

def foreach(*args, &block)
  warn "Pathname#foreach is obsoleted.  Use each_line or each_entry."
  if FileTest.directory? @path
    # For polymorphism between Dir.foreach and IO.foreach,
    # Pathname#foreach doesn't yield Pathname object.
    Dir.foreach(@path, *args, &block)
  else
    IO.foreach(@path, *args, &block)
  end
end

#foreachline(*args, &block) ⇒ Object

Pathname#foreachline is obsoleted at 1.8.1. Use #each_line.



742
743
744
745
 
# File 'lib/pathname.rb', line 742

def foreachline(*args, &block)
  warn "Pathname#foreachline is obsoleted.  Use Pathname#each_line."
  each_line(*args, &block)
end

#freeze ⇒ Object 



214
 
# File 'lib/pathname.rb', line 214

def freeze() super; @path.freeze; self end

#ftype ⇒ Object

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



791
 
# File 'lib/pathname.rb', line 791

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

#grpowned? ⇒ Boolean

See FileTest.grpowned?.

Returns:

  • (Boolean) 


872
 
# File 'lib/pathname.rb', line 872

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

#hash ⇒ Object

:nodoc:



236
237
238
 
# File 'lib/pathname.rb', line 236

def hash # :nodoc:
  @path.hash
end

#inspect ⇒ Object

:nodoc:



248
249
250
 
# File 'lib/pathname.rb', line 248

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

#join(*args) ⇒ Object

Pathname#join joins pathnames.

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



634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/pathname.rb', line 634

def join(*args)
  args.unshift self
  result = args.pop
  result = Pathname.new(result) unless Pathname === result
  return result if result.absolute?
  args.reverse_each {|arg|
    arg = Pathname.new(arg) unless Pathname === arg
    result = arg + result
    return result if result.absolute?
  }
  result
end

#lchmod(mode) ⇒ Object

See File.lchmod.



774
 
# File 'lib/pathname.rb', line 774

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

#lchown(owner, group) ⇒ Object

See File.lchown.



780
 
# File 'lib/pathname.rb', line 780

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

#link(old) ⇒ Object

Pathname#link is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.



840
841
842
843
 
# File 'lib/pathname.rb', line 840

def link(old)
  warn 'Pathname#link is obsoleted.  Use Pathname#make_link.'
  File.link(old, @path)
end

#lstat ⇒ Object

See File.lstat.



811
 
# File 'lib/pathname.rb', line 811

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

#make_link(old) ⇒ Object

See File.link. Creates a hard link.



794
 
# File 'lib/pathname.rb', line 794

def make_link(old) File.link(old, @path) end

#make_symlink(old) ⇒ Object

See File.symlink. Creates a symbolic link.



814
 
# File 'lib/pathname.rb', line 814

def make_symlink(old) File.symlink(old, @path) end

#mkdir(*args) ⇒ Object

See Dir.mkdir. Create the referenced directory.



975
 
# File 'lib/pathname.rb', line 975

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

#mkpath ⇒ Object

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



1012
1013
1014
1015
1016
 
# File 'lib/pathname.rb', line 1012

def mkpath
  require 'fileutils'
  FileUtils.mkpath(@path)
  nil
end

#mountpoint? ⇒ Boolean

#mountpoint? returns true if self points to a mountpoint.

Returns:

  • (Boolean) 


465
466
467
468
469
470
471
472
473
474
 
# File 'lib/pathname.rb', line 465

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

#mtime ⇒ Object

See File.mtime. Returns last modification time.



768
 
# File 'lib/pathname.rb', line 768

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

#open(*args, &block) ⇒ Object

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



797
798
799
 
# File 'lib/pathname.rb', line 797

def open(*args, &block) # :yield: file
  File.open(@path, *args, &block)
end

#opendir(&block) ⇒ Object

See Dir.open.



981
982
983
 
# File 'lib/pathname.rb', line 981

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

#owned? ⇒ Boolean

See FileTest.owned?.

Returns:

  • (Boolean) 


887
 
# File 'lib/pathname.rb', line 887

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

#parent ⇒ Object

#parent returns the parent directory.

This is same as self + '..'.



460
461
462
 
# File 'lib/pathname.rb', line 460

def parent
  self + '..'
end

#pipe? ⇒ Boolean

See FileTest.pipe?.

Returns:

  • (Boolean) 


881
 
# File 'lib/pathname.rb', line 881

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

#read(*args) ⇒ Object

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



749
 
# File 'lib/pathname.rb', line 749

def read(*args) IO.read(@path, *args) end

#readable? ⇒ Boolean

See FileTest.readable?.

Returns:

  • (Boolean) 


890
 
# File 'lib/pathname.rb', line 890

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

#readable_real? ⇒ Boolean

See FileTest.readable_real?.

Returns:

  • (Boolean) 


896
 
# File 'lib/pathname.rb', line 896

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

#readlines(*args) ⇒ Object

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



752
 
# File 'lib/pathname.rb', line 752

def readlines(*args) IO.readlines(@path, *args) end

#readlink ⇒ Object

See File.readlink. Read symbolic link.



802
 
# File 'lib/pathname.rb', line 802

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

#realpath ⇒ Object

Returns a real (absolute) pathname of self in the actual filesystem. The real pathname doesn’t contain symlinks or useless dots.

No arguments should be given; the old behaviour is obsoleted.



446
447
448
449
450
451
452
453
454
455
 
# File 'lib/pathname.rb', line 446

def realpath
  path = @path
  prefix, names = split_names(path)
  if prefix == ''
    prefix, names2 = split_names(Dir.pwd)
    names = names2 + names
  end
  prefix, *names = realpath_rec(prefix, names, {})
  self.class.new(prepend_prefix(prefix, File.join(*names)))
end

#relative? ⇒ Boolean

The opposite of #absolute?

Returns:

  • (Boolean) 


494
495
496
497
498
499
500
 
# File 'lib/pathname.rb', line 494

def relative?
  path = @path
  while r = chop_basename(path)
    path, basename = r
  end
  path == ''
end

#relative_path_from(base_directory) ⇒ Object

#relative_path_from returns a relative path from the argument to the receiver. If self is absolute, the argument must be absolute too. If self is relative, the argument must be relative too.

#relative_path_from doesn’t access the filesystem. It assumes no symlinks.

ArgumentError is raised when it cannot find a relative path.

This method has existed since 1.8.1.



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/pathname.rb', line 693

def relative_path_from(base_directory)
  dest_directory = self.cleanpath.to_s
  base_directory = base_directory.cleanpath.to_s
  dest_prefix = dest_directory
  dest_names = []
  while r = chop_basename(dest_prefix)
    dest_prefix, basename = r
    dest_names.unshift basename if basename != '.'
  end
  base_prefix = base_directory
  base_names = []
  while r = chop_basename(base_prefix)
    base_prefix, basename = r
    base_names.unshift basename if basename != '.'
  end
  if dest_prefix != base_prefix
    raise ArgumentError, "different prefix: #{dest_prefix.inspect} and #{base_directory.inspect}"
  end
  while !dest_names.empty? &&
        !base_names.empty? &&
        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) ⇒ Object

See File.rename. Rename the file.



805
 
# File 'lib/pathname.rb', line 805

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

#rmdir ⇒ Object

See Dir.rmdir. Remove the referenced directory.



978
 
# File 'lib/pathname.rb', line 978

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

#rmtree ⇒ Object

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



1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/pathname.rb', line 1019

def rmtree
  # The name "rmtree" is borrowed from File::Path of Perl.
  # File::Path provides "mkpath" and "rmtree".
  require 'fileutils'
  FileUtils.rm_r(@path)
  nil
end

#root? ⇒ Boolean

#root? is a predicate for root directories. I.e. it returns true if the pathname consists of consecutive slashes.

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

Returns:

  • (Boolean) 


483
484
485
 
# File 'lib/pathname.rb', line 483

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

#setgid? ⇒ Boolean

See FileTest.setgid?.

Returns:

  • (Boolean) 


902
 
# File 'lib/pathname.rb', line 902

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

#setuid? ⇒ Boolean

See FileTest.setuid?.

Returns:

  • (Boolean) 


899
 
# File 'lib/pathname.rb', line 899

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

#size ⇒ Object

See FileTest.size.



905
 
# File 'lib/pathname.rb', line 905

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

#size? ⇒ Boolean

See FileTest.size?.

Returns:

  • (Boolean) 


908
 
# File 'lib/pathname.rb', line 908

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

#socket? ⇒ Boolean

See FileTest.socket?.

Returns:

  • (Boolean) 


884
 
# File 'lib/pathname.rb', line 884

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

#split ⇒ Object

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



836
 
# File 'lib/pathname.rb', line 836

def split() File.split(@path).map {|f| self.class.new(f) } end

#stat ⇒ Object

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



808
 
# File 'lib/pathname.rb', line 808

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

#sticky? ⇒ Boolean

See FileTest.sticky?.

Returns:

  • (Boolean) 


911
 
# File 'lib/pathname.rb', line 911

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

#sub(pattern, *rest, &block) ⇒ Object

Return a pathname which is substituted by String#sub.



253
254
255
 
# File 'lib/pathname.rb', line 253

def sub(pattern, *rest, &block)
  self.class.new(@path.sub(pattern, *rest, &block))
end

#symlink(old) ⇒ Object

Pathname#symlink is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.



847
848
849
850
 
# File 'lib/pathname.rb', line 847

def symlink(old)
  warn 'Pathname#symlink is obsoleted.  Use Pathname#make_symlink.'
  File.symlink(old, @path)
end

#symlink? ⇒ Boolean

See FileTest.symlink?.

Returns:

  • (Boolean) 


914
 
# File 'lib/pathname.rb', line 914

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

#sysopen(*args) ⇒ Object

See IO.sysopen.



755
 
# File 'lib/pathname.rb', line 755

def sysopen(*args) IO.sysopen(@path, *args) end

#taint ⇒ Object 



215
 
# File 'lib/pathname.rb', line 215

def taint() super; @path.taint; self end

#to_s ⇒ Object

Return the path as a String.



241
242
243
 
# File 'lib/pathname.rb', line 241

def to_s
  @path.dup
end

#truncate(length) ⇒ Object

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



817
 
# File 'lib/pathname.rb', line 817

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

#unlink ⇒ Object Also known as: delete

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



1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/pathname.rb', line 1032

def unlink()
  begin
    Dir.unlink @path
  rescue Errno::ENOTDIR
    File.unlink @path
  end
end

#untaint ⇒ Object 



216
 
# File 'lib/pathname.rb', line 216

def untaint() super; @path.untaint; self end

#utime(atime, mtime) ⇒ Object

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



820
 
# File 'lib/pathname.rb', line 820

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

#world_readable? ⇒ Boolean

See FileTest.world_readable?.

Returns:

  • (Boolean) 


893
 
# File 'lib/pathname.rb', line 893

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

#world_writable? ⇒ Boolean

See FileTest.world_writable?.

Returns:

  • (Boolean) 


920
 
# File 'lib/pathname.rb', line 920

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

#writable? ⇒ Boolean

See FileTest.writable?.

Returns:

  • (Boolean) 


917
 
# File 'lib/pathname.rb', line 917

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

#writable_real? ⇒ Boolean

See FileTest.writable_real?.

Returns:

  • (Boolean) 


923
 
# File 'lib/pathname.rb', line 923

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

#zero? ⇒ Boolean

See FileTest.zero?.

Returns:

  • (Boolean) 


926
 
# File 'lib/pathname.rb', line 926

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