Class: Pathname

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

Overview

Pathname

Pathname represents a pathname which locates a file in a filesystem. The pathname depends on OS: Unix, Windows, etc. Pathname library works with pathnames of local OS. However non-Unix pathnames are supported experimentally.

It does not represent the file itself. 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 value 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. Except for #mountpoint?, #children, #each_child, #realdirpath and #realpath, they don’t access the filesystem.

  • +

  • #join

  • #parent

  • #root?

  • #absolute?

  • #relative?

  • #relative_path_from

  • #each_filename

  • #cleanpath

  • #realpath

  • #realdirpath

  • #children

  • #each_child

  • #mountpoint?

File status predicate methods

These methods are a facade for FileTest:

  • #blockdev?

  • #chardev?

  • #directory?

  • #executable?

  • #executable_real?

  • #exist?

  • #file?

  • #grpowned?

  • #owned?

  • #pipe?

  • #readable?

  • #world_readable?

  • #readable_real?

  • #setgid?

  • #setuid?

  • #size

  • #size?

  • #socket?

  • #sticky?

  • #symlink?

  • #writable?

  • #world_writable?

  • #writable_real?

  • #zero?

File property and manipulation methods

These methods are a facade for File:

  • #atime

  • #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)

  • #basename(*args)

  • #dirname

  • #extname

  • #expand_path(*args)

  • #split

Directory methods

These methods are a facade for Dir:

  • Pathname.glob(*args)

  • Pathname.getwd / Pathname.pwd

  • #rmdir

  • #entries

  • #each_entry(&block)

  • #mkdir(*args)

  • #opendir(*args)

IO

These methods are a facade for IO:

  • #each_line(*args, &block)

  • #read(*args)

  • #binread(*args)

  • #write(*args)

  • #binwrite(*args)

  • #readlines(*args)

  • #sysopen(*args)

Utilities

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

  • #find(&block)

  • #mkpath

  • #rmtree

  • #unlink / #delete

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 collapse

TO_PATH =

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

:to_path
SAME_PATHS = 
if File::FNM_SYSCASE.nonzero?
  proc {|a, b| a.casecmp(b).zero?}
else
  proc {|a, b| a == b}
end
SEPARATOR_LIST = 
"#{Regexp.quote File::SEPARATOR}"
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.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/rubysl/pathname/pathname.rb', line 228

def initialize(path)
  if path.respond_to? TO_PATH
    path = path.__send__(TO_PATH)
  elsif path.respond_to? :to_str
    path = path.__send__(:to_str)
  end

  @path = path.dup

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

  self.taint if @path.tainted?
end

Class Method Details

.birthtime(file) ⇒ Object 



220
221
222
 
# File 'lib/rubysl/pathname/pathname.rb', line 220

def self.birthtime(file)
  File.birthtime(file)
end

.getwd ⇒ Object Also known as: pwd

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



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

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

.glob(*args) ⇒ Object

See Dir.glob. Returns or yields Pathname objects.



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

def self.glob(*args) # :yield: pathname
  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 Also known as: /

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.



604
605
606
607
 
# File 'lib/rubysl/pathname/pathname.rb', line 604

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.



261
262
263
264
 
# File 'lib/rubysl/pathname/pathname.rb', line 261

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.



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

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) 


511
512
513
 
# File 'lib/rubysl/pathname/pathname.rb', line 511

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



584
585
586
587
588
589
590
591
592
 
# File 'lib/rubysl/pathname/pathname.rb', line 584

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.



815
 
# File 'lib/rubysl/pathname/pathname.rb', line 815

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

#basename(*args) ⇒ Object

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



876
 
# File 'lib/rubysl/pathname/pathname.rb', line 876

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

#binread(*args) ⇒ Object

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



800
 
# File 'lib/rubysl/pathname/pathname.rb', line 800

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

#binwrite(*args) ⇒ Object

See IO.binwrite. Returns the number of bytes written to the file.



806
 
# File 'lib/rubysl/pathname/pathname.rb', line 806

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

#birthtime ⇒ Object 



1038
1039
1040
 
# File 'lib/rubysl/pathname/pathname.rb', line 1038

def birthtime
  File.birthtime(@path)
end

#blockdev? ⇒ Boolean

See FileTest.blockdev?.

Returns:

  • (Boolean) 


892
 
# File 'lib/rubysl/pathname/pathname.rb', line 892

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

#chardev? ⇒ Boolean

See FileTest.chardev?.

Returns:

  • (Boolean) 


895
 
# File 'lib/rubysl/pathname/pathname.rb', line 895

def chardev?() FileTest.chardev?(@path) 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:

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

This method has existed since 1.8.1.



693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/rubysl/pathname/pathname.rb', line 693

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.



824
 
# File 'lib/rubysl/pathname/pathname.rb', line 824

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

#chown(owner, group) ⇒ Object

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



830
 
# File 'lib/rubysl/pathname/pathname.rb', line 830

def chown(owner, group) File.chown(owner, group, @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.



361
362
363
364
365
366
367
 
# File 'lib/rubysl/pathname/pathname.rb', line 361

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.



818
 
# File 'lib/rubysl/pathname/pathname.rb', line 818

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.



557
558
559
560
561
562
 
# File 'lib/rubysl/pathname/pathname.rb', line 557

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

#directory? ⇒ Boolean

See FileTest.directory?.

Returns:

  • (Boolean) 


910
 
# File 'lib/rubysl/pathname/pathname.rb', line 910

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

#dirname ⇒ Object

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



879
 
# File 'lib/rubysl/pathname/pathname.rb', line 879

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

#each_child(with_directory = true, &b) ⇒ Object

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>



733
734
735
 
# File 'lib/rubysl/pathname/pathname.rb', line 733

def each_child(with_directory=true, &b)
  children(with_directory).each(&b)
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.



971
972
973
 
# File 'lib/rubysl/pathname/pathname.rb', line 971

def each_entry(&block) # :yield: pathname
  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".



530
531
532
533
534
535
 
# File 'lib/rubysl/pathname/pathname.rb', line 530

def each_filename # :yield: filename
  return to_enum(__method__) unless block_given?
  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.



790
791
792
 
# File 'lib/rubysl/pathname/pathname.rb', line 790

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.



965
 
# File 'lib/rubysl/pathname/pathname.rb', line 965

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

#executable? ⇒ Boolean

See FileTest.executable?.

Returns:

  • (Boolean) 


898
 
# File 'lib/rubysl/pathname/pathname.rb', line 898

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

#executable_real? ⇒ Boolean

See FileTest.executable_real?.

Returns:

  • (Boolean) 


901
 
# File 'lib/rubysl/pathname/pathname.rb', line 901

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

#exist? ⇒ Boolean

See FileTest.exist?.

Returns:

  • (Boolean) 


904
 
# File 'lib/rubysl/pathname/pathname.rb', line 904

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

#expand_path(*args) ⇒ Object

See File.expand_path.



885
 
# File 'lib/rubysl/pathname/pathname.rb', line 885

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

#extname ⇒ Object

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



882
 
# File 'lib/rubysl/pathname/pathname.rb', line 882

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

#file? ⇒ Boolean

See FileTest.file?.

Returns:

  • (Boolean) 


913
 
# File 'lib/rubysl/pathname/pathname.rb', line 913

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.

Returns an Enumerator if no block is given.

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
1006
 
# File 'lib/rubysl/pathname/pathname.rb', line 998

def find(&block) # :yield: pathname
  return to_enum(__method__) unless block_given?
  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.



837
 
# File 'lib/rubysl/pathname/pathname.rb', line 837

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

#fnmatch?(pattern, *args) ⇒ Boolean

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

Returns:

  • (Boolean) 


840
 
# File 'lib/rubysl/pathname/pathname.rb', line 840

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

#freeze ⇒ Object 



244
 
# File 'lib/rubysl/pathname/pathname.rb', line 244

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

#ftype ⇒ Object

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



844
 
# File 'lib/rubysl/pathname/pathname.rb', line 844

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

#grpowned? ⇒ Boolean

See FileTest.grpowned?.

Returns:

  • (Boolean) 


907
 
# File 'lib/rubysl/pathname/pathname.rb', line 907

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

#hash ⇒ Object

:nodoc:



266
267
268
 
# File 'lib/rubysl/pathname/pathname.rb', line 266

def hash # :nodoc:
  @path.hash
end

#inspect ⇒ Object

:nodoc:



278
279
280
 
# File 'lib/rubysl/pathname/pathname.rb', line 278

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.



659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/rubysl/pathname/pathname.rb', line 659

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.



827
 
# File 'lib/rubysl/pathname/pathname.rb', line 827

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

#lchown(owner, group) ⇒ Object

See File.lchown.



833
 
# File 'lib/rubysl/pathname/pathname.rb', line 833

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

#lstat ⇒ Object

See File.lstat.



864
 
# File 'lib/rubysl/pathname/pathname.rb', line 864

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

#make_link(old) ⇒ Object

See File.link. Creates a hard link.



847
 
# File 'lib/rubysl/pathname/pathname.rb', line 847

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

#make_symlink(old) ⇒ Object

See File.symlink. Creates a symbolic link.



867
 
# File 'lib/rubysl/pathname/pathname.rb', line 867

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

#mkdir(*args) ⇒ Object

See Dir.mkdir. Create the referenced directory.



976
 
# File 'lib/rubysl/pathname/pathname.rb', line 976

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.



1010
1011
1012
1013
1014
 
# File 'lib/rubysl/pathname/pathname.rb', line 1010

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

#mountpoint? ⇒ Boolean

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

Returns:

  • (Boolean) 


487
488
489
490
491
492
493
494
495
496
 
# File 'lib/rubysl/pathname/pathname.rb', line 487

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.



821
 
# File 'lib/rubysl/pathname/pathname.rb', line 821

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

#open(*args, &block) ⇒ Object

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



850
851
852
 
# File 'lib/rubysl/pathname/pathname.rb', line 850

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

#opendir(&block) ⇒ Object

See Dir.open.



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

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

#owned? ⇒ Boolean

See FileTest.owned?.

Returns:

  • (Boolean) 


922
 
# File 'lib/rubysl/pathname/pathname.rb', line 922

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

#parent ⇒ Object

#parent returns the parent directory.

This is same as self + '..'.



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

def parent
  self + '..'
end

#pipe? ⇒ Boolean

See FileTest.pipe?.

Returns:

  • (Boolean) 


916
 
# File 'lib/rubysl/pathname/pathname.rb', line 916

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

#read(*args) ⇒ Object

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



796
 
# File 'lib/rubysl/pathname/pathname.rb', line 796

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

#readable? ⇒ Boolean

See FileTest.readable?.

Returns:

  • (Boolean) 


925
 
# File 'lib/rubysl/pathname/pathname.rb', line 925

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

#readable_real? ⇒ Boolean

See FileTest.readable_real?.

Returns:

  • (Boolean) 


931
 
# File 'lib/rubysl/pathname/pathname.rb', line 931

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

#readlines(*args) ⇒ Object

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



809
 
# File 'lib/rubysl/pathname/pathname.rb', line 809

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

#readlink ⇒ Object

See File.readlink. Read symbolic link.



855
 
# File 'lib/rubysl/pathname/pathname.rb', line 855

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

#realdirpath(basedir = nil) ⇒ Object

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

The last component of the real pathname can be nonexistent.



475
476
477
 
# File 'lib/rubysl/pathname/pathname.rb', line 475

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

#realpath(basedir = nil) ⇒ Object

Returns the real (absolute) pathname of self in the actual filesystem not containing symlinks or useless dots.

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



465
466
467
 
# File 'lib/rubysl/pathname/pathname.rb', line 465

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

#relative? ⇒ Boolean

The opposite of #absolute?

Returns:

  • (Boolean) 


516
517
518
519
520
521
522
 
# File 'lib/rubysl/pathname/pathname.rb', line 516

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.



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/rubysl/pathname/pathname.rb', line 748

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

See File.rename. Rename the file.



858
 
# File 'lib/rubysl/pathname/pathname.rb', line 858

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

#rmdir ⇒ Object

See Dir.rmdir. Remove the referenced directory.



979
 
# File 'lib/rubysl/pathname/pathname.rb', line 979

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

#rmtree ⇒ Object

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



1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/rubysl/pathname/pathname.rb', line 1017

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) 


505
506
507
 
# File 'lib/rubysl/pathname/pathname.rb', line 505

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

#setgid? ⇒ Boolean

See FileTest.setgid?.

Returns:

  • (Boolean) 


937
 
# File 'lib/rubysl/pathname/pathname.rb', line 937

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

#setuid? ⇒ Boolean

See FileTest.setuid?.

Returns:

  • (Boolean) 


934
 
# File 'lib/rubysl/pathname/pathname.rb', line 934

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

#size ⇒ Object

See FileTest.size.



940
 
# File 'lib/rubysl/pathname/pathname.rb', line 940

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

#size? ⇒ Boolean

See FileTest.size?.

Returns:

  • (Boolean) 


943
 
# File 'lib/rubysl/pathname/pathname.rb', line 943

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

#socket? ⇒ Boolean

See FileTest.socket?.

Returns:

  • (Boolean) 


919
 
# File 'lib/rubysl/pathname/pathname.rb', line 919

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

#split ⇒ Object

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



889
 
# File 'lib/rubysl/pathname/pathname.rb', line 889

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

#stat ⇒ Object

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



861
 
# File 'lib/rubysl/pathname/pathname.rb', line 861

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

#sticky? ⇒ Boolean

See FileTest.sticky?.

Returns:

  • (Boolean) 


946
 
# File 'lib/rubysl/pathname/pathname.rb', line 946

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

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

Return a pathname which is substituted by String#sub.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/rubysl/pathname/pathname.rb', line 283

def sub(pattern, *rest, &block)
  if block
    path = @path.sub(pattern, *rest) {|*args|
      begin
        old = Thread.current[:pathname_sub_matchdata]
        Thread.current[:pathname_sub_matchdata] = $~
        eval("$~ = Thread.current[:pathname_sub_matchdata]", block.binding)
      ensure
        Thread.current[:pathname_sub_matchdata] = old
      end
      yield(*args)
    }
  else
    path = @path.sub(pattern, *rest)
  end
  self.class.new(path)
end

#sub_ext(repl) ⇒ Object

Return a pathname which the extension of the basename is substituted by repl.

If self has no extension part, repl is appended.



313
314
315
316
 
# File 'lib/rubysl/pathname/pathname.rb', line 313

def sub_ext(repl)
  ext = File.extname(@path)
  self.class.new(@path.chomp(ext) + repl)
end

#symlink? ⇒ Boolean

See FileTest.symlink?.

Returns:

  • (Boolean) 


949
 
# File 'lib/rubysl/pathname/pathname.rb', line 949

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

#sysopen(*args) ⇒ Object

See IO.sysopen.



812
 
# File 'lib/rubysl/pathname/pathname.rb', line 812

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

#taint ⇒ Object 



245
 
# File 'lib/rubysl/pathname/pathname.rb', line 245

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

#to_s ⇒ Object

Return the path as a String.



271
272
273
 
# File 'lib/rubysl/pathname/pathname.rb', line 271

def to_s
  @path.dup
end

#truncate(length) ⇒ Object

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



870
 
# File 'lib/rubysl/pathname/pathname.rb', line 870

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.



1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/rubysl/pathname/pathname.rb', line 1027

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

#untaint ⇒ Object 



246
 
# File 'lib/rubysl/pathname/pathname.rb', line 246

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

#utime(atime, mtime) ⇒ Object

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



873
 
# File 'lib/rubysl/pathname/pathname.rb', line 873

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

#world_readable? ⇒ Boolean

See FileTest.world_readable?.

Returns:

  • (Boolean) 


928
 
# File 'lib/rubysl/pathname/pathname.rb', line 928

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

#world_writable? ⇒ Boolean

See FileTest.world_writable?.

Returns:

  • (Boolean) 


955
 
# File 'lib/rubysl/pathname/pathname.rb', line 955

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

#writable? ⇒ Boolean

See FileTest.writable?.

Returns:

  • (Boolean) 


952
 
# File 'lib/rubysl/pathname/pathname.rb', line 952

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

#writable_real? ⇒ Boolean

See FileTest.writable_real?.

Returns:

  • (Boolean) 


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

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

#write(*args) ⇒ Object

See IO.write. Returns the number of bytes written to the file.



803
 
# File 'lib/rubysl/pathname/pathname.rb', line 803

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

#zero? ⇒ Boolean

See FileTest.zero?.

Returns:

  • (Boolean) 


961
 
# File 'lib/rubysl/pathname/pathname.rb', line 961

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