diff --git a/lib/pathname.rb b/lib/pathname.rb index cede33d..defd470 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -1,1053 +1,573 @@ -# -# = pathname.rb -# -# Object-Oriented Pathname Class -# -# Author:: Tanaka Akira -# Documentation:: Author and Gavin Sinclair -# -# For documentation, see class Pathname. -# -# pathname.rb is distributed with Ruby since 1.8.0. -# +require 'fileutils' +require 'find' # -# == 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 +# Pathname represents a path to a file on a filesystem. It can be relative or +# absolute. It exists to provide a more instance-oriented approach to managing +# paths than the class-level methods on File, FileTest, Dir, and Find. # -# === 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) -# - #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. -# -class Pathname - - # :stopdoc: - if RUBY_VERSION < "1.9" - TO_PATH = :to_str - else - # to_path is implemented so Pathname objects are usable with File.open, etc. - TO_PATH = :to_path - end - - SAME_PATHS = if File::FNM_SYSCASE.nonzero? - proc {|a, b| a.casecmp(b).zero?} - else - proc {|a, b| a == b} - end - - # :startdoc: - +class Pathname < String + SYMLOOP_MAX = 8 # deepest symlink traversal + + ROOT = '/'.freeze + DOT = '.'.freeze + DOT_DOT = '..'.freeze + # - # Create a Pathname object from the given String (or String-like object). - # If +path+ contains a NUL character (\0), an ArgumentError is raised. + # Creates a new Pathname. Any path with a null is rejected. # 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}" + if path =~ %r{\0} + raise ArgumentError, "path cannot contain ASCII NULLs" end - - self.taint if @path.tainted? + + super(path) end - - def freeze() super; @path.freeze; self end - def taint() super; @path.taint; self end - def untaint() super; @path.untaint; self end - + # - # 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. + # Compares pathnames, case-sensitively. Sorts directories higher than other + # files named similarly. # - def ==(other) - return false unless Pathname === other - other.to_s == @path - end - alias === == - alias eql? == - - # Provides for comparing pathnames, case-sensitively. def <=>(other) - return nil unless Pathname === other - @path.tr('/', "\0") <=> other.to_s.tr('/', "\0") - end - - def hash # :nodoc: - @path.hash - end - - # Return the path as a String. - def to_s - @path.dup - end - - # to_path is implemented so Pathname objects are usable with File.open, etc. - alias_method TO_PATH, :to_s - - def inspect # :nodoc: - "#<#{self.class}:#{@path}>" - end - - # Return a pathname which is substituted by String#sub. - 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 - - if File::ALT_SEPARATOR - SEPARATOR_LIST = "#{Regexp.quote File::ALT_SEPARATOR}#{Regexp.quote File::SEPARATOR}" - SEPARATOR_PAT = /[#{SEPARATOR_LIST}]/ - else - SEPARATOR_LIST = "#{Regexp.quote File::SEPARATOR}" - SEPARATOR_PAT = /#{Regexp.quote File::SEPARATOR}/ - end - - # Return a pathname which the extension of the basename is substituted by - # repl. - # - # If self has no extension part, repl is appended. - def sub_ext(repl) - ext = File.extname(@path) - self.class.new(@path.chomp(ext) + repl) - end - - # chop_basename(path) -> [pre-basename, basename] or nil - def chop_basename(path) - base = File.basename(path) - if /\A#{SEPARATOR_PAT}?\z/o =~ base - return nil - else - return path[0, path.rindex(base)], base - end - end - private :chop_basename - - # split_names(path) -> prefix, [name, ...] - def split_names(path) - names = [] - while r = chop_basename(path) - path, basename = r - names.unshift basename - end - return path, names - end - private :split_names - - def prepend_prefix(prefix, relpath) - if relpath.empty? - File.dirname(prefix) - elsif /#{SEPARATOR_PAT}/o =~ prefix - prefix = File.dirname(prefix) - prefix = File.join(prefix, "") if File.basename(prefix + 'a') != 'a' - prefix + relpath - else - prefix + relpath - end + self.tr('/', "\0").to_s <=> other.to_str.tr('/', "\0") + rescue NoMethodError # doesn't respond to to_str + nil end - private :prepend_prefix - - # 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. + # Compares two pathnames for equality. Considers pathnames equal if they + # both point to the same location, and are both absolute or both relative. # - def cleanpath(consider_symlink=false) - if consider_symlink - cleanpath_conservative - else - cleanpath_aggressive - end + def ==(other) + left = self.cleanpath.tr('/', "\0").to_s + right = other.to_str.to_path.cleanpath.tr('/', "\0").to_s + + left == right + rescue NoMethodError # doesn't implement to_str + false end - + # - # Clean the path simply by resolving and removing excess "." and ".." entries. - # Nothing more, nothing less. + # Appends a component of a path to self. Returns a Pathname to the combined + # path. Cleans any redundant components of the path. # - def cleanpath_aggressive - 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 - if /#{SEPARATOR_PAT}/o =~ File.basename(pre) - names.shift while names[0] == '..' - end - self.class.new(prepend_prefix(pre, File.join(*names))) - end - private :cleanpath_aggressive - - # has_trailing_separator?(path) -> bool - def has_trailing_separator?(path) - if r = chop_basename(path) - pre, basename = r - pre.length + basename.length < path.length - else - false - end + def +(path) + dup << path end - private :has_trailing_separator? - - # add_trailing_separator(path) -> path - def add_trailing_separator(path) - if File.basename(path + 'a') == 'a' - path - else - File.join(path, "") # xxx: Is File.join is appropriate to add separator? - end - end - private :add_trailing_separator - - def del_trailing_separator(path) - 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 - private :del_trailing_separator - - def cleanpath_conservative - path = @path - names = [] - pre = path - while r = chop_basename(pre) - pre, base = r - names.unshift base if base != '.' - end - if /#{SEPARATOR_PAT}/o =~ 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 - private :cleanpath_conservative - + # - # Returns the real (absolute) pathname of +self+ in the actual - # filesystem not containing symlinks or useless dots. + # Appends (destructively) a component of a path to self. Replaces the + # contents of the current Pathname with the new, combined path. Cleans any + # redundant components of the path. # - # All components of the pathname must exist when this method is - # called. - # - def realpath(basedir=nil) - self.class.new(File.realpath(@path, basedir)) + def <<(path) + replace( join(path).cleanpath! ) end - - # - # 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. + # Returns true if this is an absolute path. # - def realdirpath(basedir=nil) - self.class.new(File.realdirpath(@path, basedir)) + def absolute? + self[0, 1].to_s == ROOT end - - # #parent returns the parent directory. + # - # This is same as self + '..'. - def parent - self + '..' - end - - # #mountpoint? returns +true+ if self points to a mountpoint. - 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 - + # Yields to each component of the path, going up to the root. # - # #root? is a predicate for root directories. I.e. it returns +true+ if the - # pathname consists of consecutive slashes. + # Pathname.new('/path/to/some/file').ascend {|path| p path } + # "/path/to/some/file" + # "/path/to/some" + # "/path/to" + # "/path" + # "/" # - # It doesn't access actual filesystem. So it may return +false+ for some - # pathnames which points to roots such as /usr/... + # Pathname.new('a/relative/path').ascend {|path| p path } + # "a/relative/path" + # "a/relative" + # "a" # - def root? - !!(chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o =~ @path) - end - - # Predicate method for testing whether a path is absolute. - # It returns +true+ if the pathname begins with a slash. - def absolute? - !relative? + # Does not actually access the filesystem. + # + def ascend + parts = to_a + parts.length.downto(1) do |i| + yield self.class.join(parts[0, i]) + end end - - # The opposite of #absolute? - def relative? - path = @path - while r = chop_basename(path) - path, basename = r + + # + # Returns all children of this path. "." and ".." are not included, since + # they aren't under the current path. + # + def children + entries[2..-1] + end + + # + # Cleans the path by removing consecutive slashes, and useless dots. + # Replaces the contents of the current Pathname. + # + def cleanpath! + parts = to_a + final = [] + + parts.each do |part| + case part + when DOT then next + when DOT_DOT then + case final.last + when ROOT then next + when DOT_DOT then final.push(DOT_DOT) + when nil then final.push(DOT_DOT) + else final.pop + end + else final.push(part) + end end - path == '' + + replace(final.empty? ? DOT : self.class.join(*final)) end - + # - # Iterates over each component of the path. + # Cleans the path by removing consecutive slashes, and useless dots. # - # Pathname.new("/usr/bin/ruby").each_filename {|filename| ... } - # # yields "usr", "bin", and "ruby". - # - def each_filename # :yield: filename - return to_enum(__method__) unless block_given? - prefix, names = split_names(@path) - names.each {|filename| yield filename } - nil + def cleanpath + dup.cleanpath! end - - # 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} - # # - # # - # # - # # - # # + # Yields to each component of the path, going down from the root. # - # Pathname.new('path/to/some/file.rb').descend {|v| p v} - # # - # # - # # - # # + # Pathname.new('/path/to/some/file').ascend {|path| p path } + # "/" + # "/path" + # "/path/to" + # "/path/to/some" + # "/path/to/some/file" # - # It doesn't access actual filesystem. + # Pathname.new('a/relative/path').ascend {|path| p path } + # "a" + # "a/relative" + # "a/relative/path" # - # This method is available since 1.8.5. + # Does not actually access the filesystem. # def descend - vs = [] - ascend {|v| vs << v } - vs.reverse_each {|v| yield v } - nil + parts = to_a + 1.upto(parts.length) do |i| + yield self.class.join(parts[0, i]) + end end - - # 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} - # # - # # - # # - # # - # # + # Returns true if this path is simply a '.'. # - # Pathname.new('path/to/some/file.rb').ascend {|v| p v} - # # - # # - # # - # # - # - # It doesn't access actual filesystem. + def dot? + self == DOT + end + # - # This method is available since 1.8.5. + # Returns true if this path is simply a '..'. # - 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 + def dot_dot? + self == DOT_DOT end - + # - # Pathname#+ appends a pathname fragment to this one to produce a new Pathname - # object. + # Iterates over every component of the path. # - # p1 = Pathname.new("/usr") # Pathname:/usr - # p2 = p1 + "bin/ruby" # Pathname:/usr/bin/ruby - # p3 = p1 + "/etc/passwd" # Pathname:/etc/passwd + # Pathname.new('/path/to/some/file').ascend {|path| p path } + # "/" + # "path" + # "to" + # "some" + # "file" # - # This method doesn't access the file system; it is pure string manipulation. + # Pathname.new('a/relative/path').each_filename {|part| p part } + # "a" + # "relative" + # "path" # - def +(other) - other = Pathname.new(other) unless Pathname === other - Pathname.new(plus(@path, other.to_s)) - end - - def plus(path1, path2) # -> path - 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 && /#{SEPARATOR_PAT}/o =~ 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 + def each_filename(&blk) + to_a.each(&blk) end - private :plus - + # - # Pathname#join joins pathnames. + # Returns true if the path is a mountpoint. # - # path0.join(path1, ..., pathN) is the same as - # path0 + path1 + ... + pathN. - # - 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 + def mountpoint? + stat1 = self.lstat + stat2 = self.parent.lstat + + stat1.dev != stat2.dev || stat1.ino == stat2.ino + rescue Errno::ENOENT + false end - - # - # 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. + # Returns a path to the parent directory. Simply appends a "..". # - 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 + def parent + self + '..' end - - # 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").each_child(false) {|f| p f } - # #=> # - # # # - # # # - # # # - # # # - # # # - # # # - # # # + # Resolves a path to locate a real location on the filesystem. Resolves + # symlinks up to a deptho of SYMLOOP_MAX. # - def each_child(with_directory=true, &b) - children(with_directory).each(&b) + def realpath + path = self + + SYMLOOP_MAX.times do + link = path.readlink + link = path.dirname + link if link.relative? + path = link + end + + raise Errno::ELOOP, self + rescue Errno::EINVAL + path.expand_path end - + # - # #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. + # Returns true if this is a relative path. # - # #relative_path_from doesn't access the filesystem. It assumes no symlinks. + def relative? + !absolute? + end + # - # ArgumentError is raised when it cannot find a relative path. + # Returns this path as a relative location from +base+. The path and +base+ + # must both be relative or both be absolute. An ArgumentError is raised if + # a relative path can't be generated between the two locations. # - # This method has existed since 1.8.1. + # Does not access the filesystem. # - 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 != '.' + def relative_path_from(base) + base = base.to_path + + # both must be relative, or both must be absolute + if self.absolute? != base.absolute? + raise ArgumentError, 'no relative path between a relative and absolute' end - base_prefix = base_directory - base_names = [] - while r = chop_basename(base_prefix) - base_prefix, basename = r - base_names.unshift basename if basename != '.' + + return self if base.dot? + return DOT.to_path if self == base + + base = base.cleanpath.to_a + dest = self.cleanpath.to_a + + while !dest.empty? && !base.empty? && dest[0] == base[0] + base.shift + dest.shift 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)) + + base.shift if base[0] == DOT + dest.shift if dest[0] == DOT + + if base.include?(DOT_DOT) + raise ArgumentError, "base directory may not contain '#{DOT_DOT}'" end + + path = base.fill(DOT_DOT) + dest + path = self.class.join(*path) + path = DOT.to_path if path.empty? + + path end -end - -class Pathname # * IO * + # - # #each_line iterates over the line in the file. It yields a String object - # for each line. + # Returns true if this path points to the root of the filesystem. # - # This method has existed since 1.8.1. + def root? + !!(self =~ %r{^#{ROOT}+$}) + end + # - def each_line(*args, &block) # :yield: line - IO.foreach(@path, *args, &block) + # Splits the path into an array of its components. + # + def to_a + array = to_s.split(File::SEPARATOR) + array.delete('') + array.insert(0, ROOT) if absolute? + array end - - # See IO.read. Returns all data from the file, or the first +N+ bytes - # if specified. - def read(*args) IO.read(@path, *args) end - - # See IO.binread. Returns all the bytes from the file, or the first +N+ - # if specified. - def binread(*args) IO.binread(@path, *args) end - - # See IO.readlines. Returns all the lines from the file. - def readlines(*args) IO.readlines(@path, *args) end - - # See IO.sysopen. - def sysopen(*args) IO.sysopen(@path, *args) end -end - - -class Pathname # * File * - - # See File.atime. Returns last access time. - def atime() File.atime(@path) end - - # See File.ctime. Returns last (directory entry, not file) change time. - def ctime() File.ctime(@path) end - - # See File.mtime. Returns last modification time. - def mtime() File.mtime(@path) end - - # See File.chmod. Changes permissions. - def chmod(mode) File.chmod(mode, @path) end - - # See File.lchmod. - def lchmod(mode) File.lchmod(mode, @path) end - - # See File.chown. Change owner and group of file. - def chown(owner, group) File.chown(owner, group, @path) end - - # See File.lchown. - def lchown(owner, group) File.lchown(owner, group, @path) end - - # See File.fnmatch. Return +true+ if the receiver matches the given - # pattern. - def fnmatch(pattern, *args) File.fnmatch(pattern, @path, *args) end - - # See File.fnmatch? (same as #fnmatch). - def fnmatch?(pattern, *args) File.fnmatch?(pattern, @path, *args) end - - # See File.ftype. Returns "type" of file ("file", "directory", - # etc). - def ftype() File.ftype(@path) end - - # See File.link. Creates a hard link. - def make_link(old) File.link(old, @path) end - - # See File.open. Opens the file for reading or writing. - def open(*args, &block) # :yield: file - File.open(@path, *args, &block) + + # + # Returns self. + # + def to_path + self + end + + # + # Unlinks the file or directory at the path. + # + def unlink + Dir.unlink(self) + true + rescue Errno::ENOTDIR + File.unlink(self) + true end - - # See File.readlink. Read symbolic link. - def readlink() self.class.new(File.readlink(@path)) end - - # See File.rename. Rename the file. - def rename(to) File.rename(@path, to) end - - # See File.stat. Returns a File::Stat object. - def stat() File.stat(@path) end - - # See File.lstat. - def lstat() File.lstat(@path) end - - # See File.symlink. Creates a symbolic link. - def make_symlink(old) File.symlink(old, @path) end - - # See File.truncate. Truncate the file to +length+ bytes. - def truncate(length) File.truncate(@path, length) end - - # See File.utime. Update the access and modification times. - def utime(atime, mtime) File.utime(atime, mtime, @path) end - - # See File.basename. Returns the last component of the path. - def basename(*args) self.class.new(File.basename(@path, *args)) end - - # See File.dirname. Returns all but the last component of the path. - def dirname() self.class.new(File.dirname(@path)) end - - # See File.extname. Returns the file's extension. - def extname() File.extname(@path) end - - # See File.expand_path. - def expand_path(*args) self.class.new(File.expand_path(@path, *args)) end - - # See File.split. Returns the #dirname and the #basename in an - # Array. - def split() File.split(@path).map {|f| self.class.new(f) } end -end - - -class Pathname # * FileTest * - - # See FileTest.blockdev?. - def blockdev?() FileTest.blockdev?(@path) end - - # See FileTest.chardev?. - def chardev?() FileTest.chardev?(@path) end - - # See FileTest.executable?. - def executable?() FileTest.executable?(@path) end - - # See FileTest.executable_real?. - def executable_real?() FileTest.executable_real?(@path) end - - # See FileTest.exist?. - def exist?() FileTest.exist?(@path) end - - # See FileTest.grpowned?. - def grpowned?() FileTest.grpowned?(@path) end - - # See FileTest.directory?. - def directory?() FileTest.directory?(@path) end - - # See FileTest.file?. - def file?() FileTest.file?(@path) end - - # See FileTest.pipe?. - def pipe?() FileTest.pipe?(@path) end - - # See FileTest.socket?. - def socket?() FileTest.socket?(@path) end - - # See FileTest.owned?. - def owned?() FileTest.owned?(@path) end - - # See FileTest.readable?. - def readable?() FileTest.readable?(@path) end - - # See FileTest.world_readable?. - def world_readable?() FileTest.world_readable?(@path) end - - # See FileTest.readable_real?. - def readable_real?() FileTest.readable_real?(@path) end - - # See FileTest.setuid?. - def setuid?() FileTest.setuid?(@path) end - - # See FileTest.setgid?. - def setgid?() FileTest.setgid?(@path) end - - # See FileTest.size. - def size() FileTest.size(@path) end - - # See FileTest.size?. - def size?() FileTest.size?(@path) end - - # See FileTest.sticky?. - def sticky?() FileTest.sticky?(@path) end - - # See FileTest.symlink?. - def symlink?() FileTest.symlink?(@path) end - - # See FileTest.writable?. - def writable?() FileTest.writable?(@path) end - - # See FileTest.world_writable?. - def world_writable?() FileTest.world_writable?(@path) end - - # See FileTest.writable_real?. - def writable_real?() FileTest.writable_real?(@path) end - - # See FileTest.zero?. - def zero?() FileTest.zero?(@path) end end - -class Pathname # * Dir * - # See Dir.glob. Returns or yields Pathname objects. - def Pathname.glob(*args) # :yield: pathname +class Pathname + # See Dir::[] + def self.[](pattern); Dir[pattern].map! {|d| d.to_path }; end + + # See Dir::pwd + def self.pwd; Dir.pwd.to_path; end + + # See Dir::entries + def entries; Dir.entries(self).map! {|e| e.to_path }; end + + # See Dir::mkdir + def mkdir(mode = 0777); Dir.mkdir(self, mode); end + + # See Dir::open + def opendir(&blk); Dir.open(self, &blk); end + + # See Dir::rmdir + def rmdir; Dir.rmdir(self); end + + # See Dir::glob + def self.glob(pattern, flags = 0) + dirs = Dir.glob(pattern, flags) + dirs.map! {|path| path.to_path } + if block_given? - Dir.glob(*args) {|f| yield self.new(f) } + dirs.each {|dir| yield dir } + nil else - Dir.glob(*args).map {|f| self.new(f) } + dirs end end - - # See Dir.getwd. Returns the current working directory as a Pathname. - def Pathname.getwd() self.new(Dir.getwd) end - class << self; alias pwd getwd end - - # Return the entries (files and subdirectories) in the directory, each as a - # Pathname object. - def entries() Dir.entries(@path).map {|f| self.class.new(f) } end - - # 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. - def each_entry(&block) # :yield: pathname - Dir.foreach(@path) {|f| yield self.class.new(f) } + + # See Dir::glob + def glob(pattern, flags = 0, &block) + patterns = [pattern].flatten + patterns.map! {|p| self.class.glob(self.to_s + p, flags, &block) } + patterns.flatten end - - # See Dir.mkdir. Create the referenced directory. - def mkdir(*args) Dir.mkdir(@path, *args) end - - # See Dir.rmdir. Remove the referenced directory. - def rmdir() Dir.rmdir(@path) end - - # See Dir.open. - def opendir(&block) # :yield: dir - Dir.open(@path, &block) + + # See Dir::chdir + def chdir + blk = lambda { yield self } if block_given? + Dir.chdir(self, &blk) end end - -class Pathname # * Find * - # - # 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 ./. - # - 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 +class Pathname + # See FileTest::blockdev? + def blockdev?; FileTest.blockdev?(self); end + + # See FileTest::chardev? + def chardev?; FileTest.chardev?(self); end + + # See FileTest::directory? + def directory?; FileTest.directory?(self); end + + # See FileTest::executable? + def executable?; FileTest.executable?(self); end + + # See FileTest::executable_real? + def executable_real?; FileTest.executable_real?(self); end + + # See FileTest::exists? + def exists?; FileTest.exists?(self); end + + # See FileTest::file? + def file?; FileTest.file?(self); end + + # See FileTest::grpowned? + def grpowned?; FileTest.grpowned?(self); end + + # See FileTest::owned? + def owned?; FileTest.owned?(self); end + + # See FileTest::pipe? + def pipe?; FileTest.pipe?(self); end + + # See FileTest::readable? + def readable?; FileTest.readable?(self); end + + # See FileTest::readable_real? + def readable_real?; FileTest.readable_real?(self); end + + # See FileTest::setgid? + def setgid?; FileTest.setgit?(self); end + + # See FileTest::setuid? + def setuid?; FileTest.setuid?(self); end + + # See FileTest::socket? + def socket?; FileTest.socket?(self); end + + # See FileTest::sticky? + def sticky?; FileTest.sticky?(self); end + + # See FileTest::symlink? + def symlink?; FileTest.symlink?(self); end + + # See FileTest::world_readable? + def world_readable?; FileTest.world_readable?(self); end + + # See FileTest::world_writable? + def world_writable?; FileTest.world_writable?(self); end + + # See FileTest::writable? + def writable?; FileTest.writable?(self); end + + # See FileTest::writable_real? + def writable_real?; FileTest.writable_real?(self); end + + # See FileTest::zero? + def zero?; FileTest.zero?(self); end end +class Pathname + # See File::atime + def atime; File.atime(self); end + + # See File::ctime + def ctime; File.ctime(self); end + + # See File::ftype + def ftype; File.ftype(self); end + + # See File::lstat + def lstat; File.lstat(self); end + + # See File::mtime + def mtime; File.mtime(self); end + + # See File::stat + def stat; File.stat(self); end + + # See File::utime + def utime(atime, mtime); File.utime(self, atime, mtime); end +end -class Pathname # * FileUtils * - # See FileUtils.mkpath. Creates a full path, including any - # intermediate directories that don't yet exist. - def mkpath - require 'fileutils' - FileUtils.mkpath(@path) - nil - end +class Pathname + # See File::join + def self.join(*parts); File.join(*parts.reject {|p| p.empty? }).to_path; end + + # See File::basename + def basename; File.basename(self).to_path; end + + # See File::chmod + def chmod(mode); File.chmod(mode, self); end + + # See File::chown + def chown(owner, group); File.chown(owner, group, self); end + + # See File::dirname + def dirname; File.dirname(self).to_path; end + + # See File::expand_path + def expand_path(from = nil); File.expand_path(self, from).to_path; end + + # See File::extname + def extname; File.extname(self); end + + # See File::fnmatch + def fnmatch?(pat, flags = 0); File.fnmatch(pat, self, flags); end + + # See File::join + def join(*parts); self.class.join(self, *parts); end + + # See File::lchmod + def lchmod(mode); File.lchmod(mode, self); end + + # See File::lchown + def lchown(owner, group); File.lchown(owner, group, self); end + + # See File::link + def link(to); File.link(self, to); end + + # See File::open + def open(mode = 'r', perm = nil, &blk); File.open(self, mode, perm, &blk); end + + # See File::readlink + def readlink; File.readlink(self).to_path; end + + # See File::rename + def rename(to); File.rename(self, to); replace(to); end + + # See File::size + def size; File.size(self); end + + # See File::size? + def size?; File.size?(self); end + + # See File::split + def split; File.split(self).map {|part| part.to_path }; end + + # See File::symlink + def symlink(to); File.symlink(self, to); end + + # See File::truncate + def truncate; File.truncate(self); end +end - # See FileUtils.rm_r. Deletes a directory and all beneath it. - 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 +class Pathname + # See FileUtils::mkpath + def mkpath; FileUtils.mkpath(self).to_path; end + + # See FileUtils::rmtree + def rmtree; FileUtils.rmtree(self).first.to_path; end + + # See FileUtils::touch + def touch; FileUtils.touch(self).first.to_path; end end +class Pathname + # See IO::each_line + def each_line(sep = $/, &blk); IO.foreach(self, sep, &blk); end + + # See IO::read + def read(len = nil, off = 0); IO.read(self, len, off); end + + # See IO::readlines + def readlines(sep = $/); IO.readlines(self, sep); end + + # See IO::sysopen + def sysopen(mode = 'r', perm = nil); IO.sysopen(self, mode, perm); end +end -class Pathname # * mixed * - # Removes a file or directory, using File.unlink or - # Dir.unlink as necessary. - def unlink() - begin - Dir.unlink @path - rescue Errno::ENOTDIR - File.unlink @path - end - end - alias delete unlink +class Pathname + # See Find::find + def find; Find.find(self) {|path| yield path.to_path }; end end class Pathname - undef =~ + class << self + alias getwd pwd + end + + alias absolute expand_path + alias delete unlink + alias exist? exists? + alias fnmatch fnmatch? +end + +class String + # + # Converts the string directly to a pathname. + # + def to_path + Pathname.new(self) + end end module Kernel - # create a pathname object. # - # This method is available since 1.8.5. - def Pathname(path) # :doc: + # Allows construction of a Pathname by using the class name as a method. + # + # This really ought to be deprecated due to String#to_path. + # + def Pathname(path) Pathname.new(path) end - private :Pathname end