Class: Pathname
- Inherits:
-
Object
- Object
- Pathname
- Defined in:
- lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb,
lib/rubysl/pathname/pathname.rb
Overview
-
mixed *
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
-
.getwd ⇒ Object
(also: pwd)
See
Dir.getwd
. -
.glob(*args) ⇒ Object
See
Dir.glob
.
Instance Method Summary collapse
-
#+(other) ⇒ Object
Pathname#+ appends a pathname fragment to this one to produce a new Pathname object.
-
#<=>(other) ⇒ Object
Provides for comparing pathnames, case-sensitively.
-
#==(other) ⇒ Object
(also: #===, #eql?)
Compare this pathname with
other
. -
#absolute? ⇒ Boolean
Predicate method for testing whether a path is absolute.
-
#ascend {|_self| ... } ⇒ Object
Iterates over and yields a new Pathname object for each element in the given path in ascending order.
-
#atime ⇒ Object
See
File.atime
. -
#basename(*args) ⇒ Object
See
File.basename
. -
#binread(*args) ⇒ Object
See
IO.binread
. -
#binwrite(*args) ⇒ Object
See
IO.binwrite
. -
#blockdev? ⇒ Boolean
See
FileTest.blockdev?
. -
#chardev? ⇒ Boolean
See
FileTest.chardev?
. -
#children(with_directory = true) ⇒ Object
Returns the children of the directory (files and subdirectories, not recursive) as an array of Pathname objects.
-
#chmod(mode) ⇒ Object
See
File.chmod
. -
#chown(owner, group) ⇒ Object
See
File.chown
. -
#cleanpath(consider_symlink = false) ⇒ Object
Returns clean pathname of
self
with consecutive slashes and useless dots removed. -
#ctime ⇒ Object
See
File.ctime
. -
#descend ⇒ Object
Iterates over and yields a new Pathname object for each element in the given path in descending order.
-
#directory? ⇒ Boolean
See
FileTest.directory?
. -
#dirname ⇒ Object
See
File.dirname
. -
#each_child(with_directory = true, &b) ⇒ Object
Iterates over the children of the directory (files and subdirectories, not recursive).
-
#each_entry(&block) ⇒ Object
Iterates over the entries (files and subdirectories) in the directory.
-
#each_filename ⇒ Object
Iterates over each component of the path.
-
#each_line(*args, &block) ⇒ Object
#each_line iterates over the line in the file.
-
#entries ⇒ Object
Return the entries (files and subdirectories) in the directory, each as a Pathname object.
-
#executable? ⇒ Boolean
See
FileTest.executable?
. -
#executable_real? ⇒ Boolean
See
FileTest.executable_real?
. -
#exist? ⇒ Boolean
See
FileTest.exist?
. -
#expand_path(*args) ⇒ Object
See
File.expand_path
. -
#extname ⇒ Object
See
File.extname
. -
#file? ⇒ Boolean
See
FileTest.file?
. -
#find(&block) ⇒ Object
Pathname#find is an iterator to traverse a directory tree in a depth first manner.
-
#fnmatch(pattern, *args) ⇒ Object
See
File.fnmatch
. -
#fnmatch?(pattern, *args) ⇒ Boolean
See
File.fnmatch?
(same as #fnmatch). - #freeze ⇒ Object
-
#ftype ⇒ Object
See
File.ftype
. -
#grpowned? ⇒ Boolean
See
FileTest.grpowned?
. -
#hash ⇒ Object
:nodoc:.
-
#initialize(path) ⇒ Pathname
constructor
Create a Pathname object from the given String (or String-like object).
-
#inspect ⇒ Object
:nodoc:.
-
#join(*args) ⇒ Object
Pathname#join joins pathnames.
-
#lchmod(mode) ⇒ Object
See
File.lchmod
. -
#lchown(owner, group) ⇒ Object
See
File.lchown
. -
#lstat ⇒ Object
See
File.lstat
. -
#make_link(old) ⇒ Object
See
File.link
. -
#make_symlink(old) ⇒ Object
See
File.symlink
. -
#mkdir(*args) ⇒ Object
See
Dir.mkdir
. -
#mkpath ⇒ Object
See
FileUtils.mkpath
. -
#mountpoint? ⇒ Boolean
#mountpoint? returns
true
ifself
points to a mountpoint. -
#mtime ⇒ Object
See
File.mtime
. -
#open(*args, &block) ⇒ Object
See
File.open
. -
#opendir(&block) ⇒ Object
See
Dir.open
. -
#owned? ⇒ Boolean
See
FileTest.owned?
. -
#parent ⇒ Object
#parent returns the parent directory.
-
#pipe? ⇒ Boolean
See
FileTest.pipe?
. -
#read(*args) ⇒ Object
See
IO.read
. -
#readable? ⇒ Boolean
See
FileTest.readable?
. -
#readable_real? ⇒ Boolean
See
FileTest.readable_real?
. -
#readlines(*args) ⇒ Object
See
IO.readlines
. -
#readlink ⇒ Object
See
File.readlink
. -
#realdirpath(basedir = nil) ⇒ Object
Returns the real (absolute) pathname of
self
in the actual filesystem. -
#realpath(basedir = nil) ⇒ Object
Returns the real (absolute) pathname of
self
in the actual filesystem not containing symlinks or useless dots. -
#relative? ⇒ Boolean
The opposite of #absolute?.
-
#relative_path_from(base_directory) ⇒ Object
#relative_path_from returns a relative path from the argument to the receiver.
-
#rename(to) ⇒ Object
See
File.rename
. -
#rmdir ⇒ Object
See
Dir.rmdir
. -
#rmtree ⇒ Object
See
FileUtils.rm_r
. -
#root? ⇒ Boolean
#root? is a predicate for root directories.
-
#setgid? ⇒ Boolean
See
FileTest.setgid?
. -
#setuid? ⇒ Boolean
See
FileTest.setuid?
. -
#size ⇒ Object
See
FileTest.size
. -
#size? ⇒ Boolean
See
FileTest.size?
. -
#socket? ⇒ Boolean
See
FileTest.socket?
. -
#split ⇒ Object
See
File.split
. -
#stat ⇒ Object
See
File.stat
. -
#sticky? ⇒ Boolean
See
FileTest.sticky?
. -
#sub(pattern, *rest, &block) ⇒ Object
Return a pathname which is substituted by String#sub.
-
#sub_ext(repl) ⇒ Object
Return a pathname which the extension of the basename is substituted by repl.
-
#symlink? ⇒ Boolean
See
FileTest.symlink?
. -
#sysopen(*args) ⇒ Object
See
IO.sysopen
. - #taint ⇒ Object
-
#to_s ⇒ Object
Return the path as a String.
-
#truncate(length) ⇒ Object
See
File.truncate
. -
#unlink ⇒ Object
(also: #delete)
Removes a file or directory, using
File.unlink
orDir.unlink
as necessary. - #untaint ⇒ Object
-
#utime(atime, mtime) ⇒ Object
See
File.utime
. -
#world_readable? ⇒ Boolean
See
FileTest.world_readable?
. -
#world_writable? ⇒ Boolean
See
FileTest.world_writable?
. -
#writable? ⇒ Boolean
See
FileTest.writable?
. -
#writable_real? ⇒ Boolean
See
FileTest.writable_real?
. -
#write(*args) ⇒ Object
See
IO.write
. -
#zero? ⇒ Boolean
See
FileTest.zero?
.
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.
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/rubysl/pathname/pathname.rb', line 215 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
.getwd ⇒ Object Also known as: pwd
See Dir.getwd
. Returns the current working directory as a Pathname.
971 |
# File 'lib/rubysl/pathname/pathname.rb', line 971 def Pathname.getwd() self.new(Dir.getwd) end |
.glob(*args) ⇒ Object
See Dir.glob
. Returns or yields Pathname objects.
962 963 964 965 966 967 968 |
# File 'lib/rubysl/pathname/pathname.rb', line 962 def Pathname.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
591 592 593 594 |
# File 'lib/rubysl/pathname/pathname.rb', line 591 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.
248 249 250 251 |
# File 'lib/rubysl/pathname/pathname.rb', line 248 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.
240 241 242 243 |
# File 'lib/rubysl/pathname/pathname.rb', line 240 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.
498 499 500 |
# File 'lib/rubysl/pathname/pathname.rb', line 498 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.
571 572 573 574 575 576 577 578 579 |
# File 'lib/rubysl/pathname/pathname.rb', line 571 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.
806 |
# File 'lib/rubysl/pathname/pathname.rb', line 806 def atime() File.atime(@path) end |
#basename(*args) ⇒ Object
See File.basename
. Returns the last component of the path.
867 |
# File 'lib/rubysl/pathname/pathname.rb', line 867 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.
787 |
# File 'lib/rubysl/pathname/pathname.rb', line 787 def binread(*args) IO.binread(@path, *args) end |
#binwrite(*args) ⇒ Object
See IO.binwrite
. Returns the number of bytes written to the file.
793 |
# File 'lib/rubysl/pathname/pathname.rb', line 793 def binwrite(*args) IO.binwrite(@path, *args) end |
#blockdev? ⇒ Boolean
See FileTest.blockdev?
.
887 |
# File 'lib/rubysl/pathname/pathname.rb', line 887 def blockdev?() FileTest.blockdev?(@path) end |
#chardev? ⇒ Boolean
See FileTest.chardev?
.
890 |
# File 'lib/rubysl/pathname/pathname.rb', line 890 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.
678 679 680 681 682 683 684 685 686 687 688 689 690 |
# File 'lib/rubysl/pathname/pathname.rb', line 678 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.
815 |
# File 'lib/rubysl/pathname/pathname.rb', line 815 def chmod(mode) File.chmod(mode, @path) end |
#chown(owner, group) ⇒ Object
See File.chown
. Change owner and group of file.
821 |
# File 'lib/rubysl/pathname/pathname.rb', line 821 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.
348 349 350 351 352 353 354 |
# File 'lib/rubysl/pathname/pathname.rb', line 348 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.
809 |
# File 'lib/rubysl/pathname/pathname.rb', line 809 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.
544 545 546 547 548 549 |
# File 'lib/rubysl/pathname/pathname.rb', line 544 def descend vs = [] ascend {|v| vs << v } vs.reverse_each {|v| yield v } nil end |
#directory? ⇒ Boolean
See FileTest.directory?
.
905 |
# File 'lib/rubysl/pathname/pathname.rb', line 905 def directory?() FileTest.directory?(@path) end |
#dirname ⇒ Object
See File.dirname
. Returns all but the last component of the path.
870 |
# File 'lib/rubysl/pathname/pathname.rb', line 870 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>
718 719 720 |
# File 'lib/rubysl/pathname/pathname.rb', line 718 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.
982 983 984 |
# File 'lib/rubysl/pathname/pathname.rb', line 982 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".
517 518 519 520 521 522 |
# File 'lib/rubysl/pathname/pathname.rb', line 517 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.
777 778 779 |
# File 'lib/rubysl/pathname/pathname.rb', line 777 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.
976 |
# File 'lib/rubysl/pathname/pathname.rb', line 976 def entries() Dir.entries(@path).map {|f| self.class.new(f) } end |
#executable? ⇒ Boolean
See FileTest.executable?
.
893 |
# File 'lib/rubysl/pathname/pathname.rb', line 893 def executable?() FileTest.executable?(@path) end |
#executable_real? ⇒ Boolean
See FileTest.executable_real?
.
896 |
# File 'lib/rubysl/pathname/pathname.rb', line 896 def executable_real?() FileTest.executable_real?(@path) end |
#exist? ⇒ Boolean
See FileTest.exist?
.
899 |
# File 'lib/rubysl/pathname/pathname.rb', line 899 def exist?() FileTest.exist?(@path) end |
#expand_path(*args) ⇒ Object
See File.expand_path
.
876 |
# File 'lib/rubysl/pathname/pathname.rb', line 876 def (*args) self.class.new(File.(@path, *args)) end |
#extname ⇒ Object
See File.extname
. Returns the file’s extension.
873 |
# File 'lib/rubysl/pathname/pathname.rb', line 873 def extname() File.extname(@path) end |
#file? ⇒ Boolean
See FileTest.file?
.
908 |
# File 'lib/rubysl/pathname/pathname.rb', line 908 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 ./
.
1010 1011 1012 1013 1014 1015 1016 1017 |
# File 'lib/rubysl/pathname/pathname.rb', line 1010 def find(&block) # :yield: pathname 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.
828 |
# File 'lib/rubysl/pathname/pathname.rb', line 828 def fnmatch(pattern, *args) File.fnmatch(pattern, @path, *args) end |
#fnmatch?(pattern, *args) ⇒ Boolean
See File.fnmatch?
(same as #fnmatch).
831 |
# File 'lib/rubysl/pathname/pathname.rb', line 831 def fnmatch?(pattern, *args) File.fnmatch?(pattern, @path, *args) end |
#freeze ⇒ Object
231 |
# File 'lib/rubysl/pathname/pathname.rb', line 231 def freeze() super; @path.freeze; self end |
#ftype ⇒ Object
See File.ftype
. Returns “type” of file (“file”, “directory”, etc).
835 |
# File 'lib/rubysl/pathname/pathname.rb', line 835 def ftype() File.ftype(@path) end |
#grpowned? ⇒ Boolean
See FileTest.grpowned?
.
902 |
# File 'lib/rubysl/pathname/pathname.rb', line 902 def grpowned?() FileTest.grpowned?(@path) end |
#hash ⇒ Object
:nodoc:
253 254 255 |
# File 'lib/rubysl/pathname/pathname.rb', line 253 def hash # :nodoc: @path.hash end |
#inspect ⇒ Object
:nodoc:
265 266 267 |
# File 'lib/rubysl/pathname/pathname.rb', line 265 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
.
644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'lib/rubysl/pathname/pathname.rb', line 644 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
.
818 |
# File 'lib/rubysl/pathname/pathname.rb', line 818 def lchmod(mode) File.lchmod(mode, @path) end |
#lchown(owner, group) ⇒ Object
See File.lchown
.
824 |
# File 'lib/rubysl/pathname/pathname.rb', line 824 def lchown(owner, group) File.lchown(owner, group, @path) end |
#lstat ⇒ Object
See File.lstat
.
855 |
# File 'lib/rubysl/pathname/pathname.rb', line 855 def lstat() File.lstat(@path) end |
#make_link(old) ⇒ Object
See File.link
. Creates a hard link.
838 |
# File 'lib/rubysl/pathname/pathname.rb', line 838 def make_link(old) File.link(old, @path) end |
#make_symlink(old) ⇒ Object
See File.symlink
. Creates a symbolic link.
858 |
# File 'lib/rubysl/pathname/pathname.rb', line 858 def make_symlink(old) File.symlink(old, @path) end |
#mkdir(*args) ⇒ Object
See Dir.mkdir
. Create the referenced directory.
987 |
# File 'lib/rubysl/pathname/pathname.rb', line 987 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.
1024 1025 1026 1027 1028 |
# File 'lib/rubysl/pathname/pathname.rb', line 1024 def mkpath require 'fileutils' FileUtils.mkpath(@path) nil end |
#mountpoint? ⇒ Boolean
#mountpoint? returns true
if self
points to a mountpoint.
474 475 476 477 478 479 480 481 482 483 |
# File 'lib/rubysl/pathname/pathname.rb', line 474 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.
812 |
# File 'lib/rubysl/pathname/pathname.rb', line 812 def mtime() File.mtime(@path) end |
#open(*args, &block) ⇒ Object
See File.open
. Opens the file for reading or writing.
841 842 843 |
# File 'lib/rubysl/pathname/pathname.rb', line 841 def open(*args, &block) # :yield: file File.open(@path, *args, &block) end |
#opendir(&block) ⇒ Object
See Dir.open
.
993 994 995 |
# File 'lib/rubysl/pathname/pathname.rb', line 993 def opendir(&block) # :yield: dir Dir.open(@path, &block) end |
#owned? ⇒ Boolean
See FileTest.owned?
.
917 |
# File 'lib/rubysl/pathname/pathname.rb', line 917 def owned?() FileTest.owned?(@path) end |
#parent ⇒ Object
#parent returns the parent directory.
This is same as self + '..'
.
469 470 471 |
# File 'lib/rubysl/pathname/pathname.rb', line 469 def parent self + '..' end |
#pipe? ⇒ Boolean
See FileTest.pipe?
.
911 |
# File 'lib/rubysl/pathname/pathname.rb', line 911 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.
783 |
# File 'lib/rubysl/pathname/pathname.rb', line 783 def read(*args) IO.read(@path, *args) end |
#readable? ⇒ Boolean
See FileTest.readable?
.
920 |
# File 'lib/rubysl/pathname/pathname.rb', line 920 def readable?() FileTest.readable?(@path) end |
#readable_real? ⇒ Boolean
See FileTest.readable_real?
.
926 |
# File 'lib/rubysl/pathname/pathname.rb', line 926 def readable_real?() FileTest.readable_real?(@path) end |
#readlines(*args) ⇒ Object
See IO.readlines
. Returns all the lines from the file.
796 |
# File 'lib/rubysl/pathname/pathname.rb', line 796 def readlines(*args) IO.readlines(@path, *args) end |
#readlink ⇒ Object
See File.readlink
. Read symbolic link.
846 |
# File 'lib/rubysl/pathname/pathname.rb', line 846 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.
462 463 464 |
# File 'lib/rubysl/pathname/pathname.rb', line 462 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.
452 453 454 |
# File 'lib/rubysl/pathname/pathname.rb', line 452 def realpath(basedir=nil) self.class.new(File.realpath(@path, basedir)) end |
#relative? ⇒ Boolean
The opposite of #absolute?
503 504 505 506 507 508 509 |
# File 'lib/rubysl/pathname/pathname.rb', line 503 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.
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 |
# File 'lib/rubysl/pathname/pathname.rb', line 733 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.
849 |
# File 'lib/rubysl/pathname/pathname.rb', line 849 def rename(to) File.rename(@path, to) end |
#rmdir ⇒ Object
See Dir.rmdir
. Remove the referenced directory.
990 |
# File 'lib/rubysl/pathname/pathname.rb', line 990 def rmdir() Dir.rmdir(@path) end |
#rmtree ⇒ Object
See FileUtils.rm_r
. Deletes a directory and all beneath it.
1031 1032 1033 1034 1035 1036 1037 |
# File 'lib/rubysl/pathname/pathname.rb', line 1031 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/..
.
492 493 494 |
# File 'lib/rubysl/pathname/pathname.rb', line 492 def root? !!(chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o =~ @path) end |
#setgid? ⇒ Boolean
See FileTest.setgid?
.
932 |
# File 'lib/rubysl/pathname/pathname.rb', line 932 def setgid?() FileTest.setgid?(@path) end |
#setuid? ⇒ Boolean
See FileTest.setuid?
.
929 |
# File 'lib/rubysl/pathname/pathname.rb', line 929 def setuid?() FileTest.setuid?(@path) end |
#size ⇒ Object
See FileTest.size
.
935 |
# File 'lib/rubysl/pathname/pathname.rb', line 935 def size() FileTest.size(@path) end |
#size? ⇒ Boolean
See FileTest.size?
.
938 |
# File 'lib/rubysl/pathname/pathname.rb', line 938 def size?() FileTest.size?(@path) end |
#socket? ⇒ Boolean
See FileTest.socket?
.
914 |
# File 'lib/rubysl/pathname/pathname.rb', line 914 def socket?() FileTest.socket?(@path) end |
#split ⇒ Object
See File.split
. Returns the #dirname and the #basename in an Array.
880 |
# File 'lib/rubysl/pathname/pathname.rb', line 880 def split() File.split(@path).map {|f| self.class.new(f) } end |
#stat ⇒ Object
See File.stat
. Returns a File::Stat
object.
852 |
# File 'lib/rubysl/pathname/pathname.rb', line 852 def stat() File.stat(@path) end |
#sticky? ⇒ Boolean
See FileTest.sticky?
.
941 |
# File 'lib/rubysl/pathname/pathname.rb', line 941 def sticky?() FileTest.sticky?(@path) end |
#sub(pattern, *rest, &block) ⇒ Object
Return a pathname which is substituted by String#sub.
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/rubysl/pathname/pathname.rb', line 270 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.
300 301 302 303 |
# File 'lib/rubysl/pathname/pathname.rb', line 300 def sub_ext(repl) ext = File.extname(@path) self.class.new(@path.chomp(ext) + repl) end |
#symlink? ⇒ Boolean
See FileTest.symlink?
.
944 |
# File 'lib/rubysl/pathname/pathname.rb', line 944 def symlink?() FileTest.symlink?(@path) end |
#sysopen(*args) ⇒ Object
See IO.sysopen
.
799 |
# File 'lib/rubysl/pathname/pathname.rb', line 799 def sysopen(*args) IO.sysopen(@path, *args) end |
#taint ⇒ Object
232 |
# File 'lib/rubysl/pathname/pathname.rb', line 232 def taint() super; @path.taint; self end |
#to_s ⇒ Object
Return the path as a String.
258 259 260 |
# File 'lib/rubysl/pathname/pathname.rb', line 258 def to_s @path.dup end |
#truncate(length) ⇒ Object
See File.truncate
. Truncate the file to length
bytes.
861 |
# File 'lib/rubysl/pathname/pathname.rb', line 861 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.
1044 1045 1046 1047 1048 1049 1050 |
# File 'lib/rubysl/pathname/pathname.rb', line 1044 def unlink() begin Dir.unlink @path rescue Errno::ENOTDIR File.unlink @path end end |
#untaint ⇒ Object
233 |
# File 'lib/rubysl/pathname/pathname.rb', line 233 def untaint() super; @path.untaint; self end |
#utime(atime, mtime) ⇒ Object
See File.utime
. Update the access and modification times.
864 |
# File 'lib/rubysl/pathname/pathname.rb', line 864 def utime(atime, mtime) File.utime(atime, mtime, @path) end |
#world_readable? ⇒ Boolean
See FileTest.world_readable?
.
923 |
# File 'lib/rubysl/pathname/pathname.rb', line 923 def world_readable?() FileTest.world_readable?(@path) end |
#world_writable? ⇒ Boolean
See FileTest.world_writable?
.
950 |
# File 'lib/rubysl/pathname/pathname.rb', line 950 def world_writable?() FileTest.world_writable?(@path) end |
#writable? ⇒ Boolean
See FileTest.writable?
.
947 |
# File 'lib/rubysl/pathname/pathname.rb', line 947 def writable?() FileTest.writable?(@path) end |
#writable_real? ⇒ Boolean
See FileTest.writable_real?
.
953 |
# File 'lib/rubysl/pathname/pathname.rb', line 953 def writable_real?() FileTest.writable_real?(@path) end |
#write(*args) ⇒ Object
See IO.write
. Returns the number of bytes written to the file.
790 |
# File 'lib/rubysl/pathname/pathname.rb', line 790 def write(*args) IO.write(@path, *args) end |
#zero? ⇒ Boolean
See FileTest.zero?
.
956 |
# File 'lib/rubysl/pathname/pathname.rb', line 956 def zero?() FileTest.zero?(@path) end |