From 16e97a529cfa550cbaee006f459913190929fade Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 22:07:53 +0200 Subject: [PATCH 01/11] Restore lib/pathname.rb from ext/pathname/lib/pathname.rb at ed9270abe75b047ffbec09b3aa2b959643c480e1 * This is just before methods started to be moved from Ruby code to the C extension. * BTW, in the ruby/pathname repository there was no pathname.rb before that commit. --- lib/pathname.rb | 782 +++++++++++++++++++++++++++++++++++++----------- 1 file changed, 608 insertions(+), 174 deletions(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index eca3825..ce58bd0 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -1,4 +1,3 @@ -# frozen_string_literal: true # # = pathname.rb # @@ -9,6 +8,8 @@ # # For documentation, see class Pathname. # +# pathname.rb is distributed with Ruby since 1.8.0. +# if defined?(::Pathname) # Clear builtin Pathname # :stopdoc: @@ -30,22 +31,272 @@ module ::Kernel require 'pathname.so' +# +# == 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) +# - #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 - VERSION = "0.4.0" - # :stopdoc: - - # to_path is implemented so Pathname objects are usable with File.open, etc. - TO_PATH = :to_path + 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? - # Avoid #zero? here because #casecmp can return nil. - proc {|a, b| a.casecmp(b) == 0} + proc {|a, b| a.casecmp(b).zero?} else proc {|a, b| a == b} end + # :startdoc: + + # + # Create a Pathname object from the given String (or String-like object). + # If +path+ contains a NUL character (\0), an ArgumentError is raised. + # + def initialize(path) + path = path.__send__(TO_PATH) if path.respond_to? TO_PATH + @path = path.dup + + if /\0/ =~ @path + raise ArgumentError, "pathname contains \\0: #{@path.inspect}" + end + + self.taint if @path.tainted? + end + + 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. + # + 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}" @@ -55,19 +306,19 @@ class Pathname SEPARATOR_PAT = /#{Regexp.quote File::SEPARATOR}/ end - if File.dirname('A:') == 'A:.' # DOSish drive letter - ABSOLUTE_PATH = /\A(?:[A-Za-z]:|#{SEPARATOR_PAT})/o - else - ABSOLUTE_PATH = /\A#{SEPARATOR_PAT}/o + # 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 - private_constant :ABSOLUTE_PATH - - # :startdoc: # chop_basename(path) -> [pre-basename, basename] or nil - def chop_basename(path) # :nodoc: + def chop_basename(path) base = File.basename(path) - if /\A#{SEPARATOR_PAT}?\z/o.match?(base) + if /\A#{SEPARATOR_PAT}?\z/o =~ base return nil else return path[0, path.rindex(base)], base @@ -76,7 +327,7 @@ def chop_basename(path) # :nodoc: private :chop_basename # split_names(path) -> prefix, [name, ...] - def split_names(path) # :nodoc: + def split_names(path) names = [] while r = chop_basename(path) path, basename = r @@ -86,10 +337,10 @@ def split_names(path) # :nodoc: end private :split_names - def prepend_prefix(prefix, relpath) # :nodoc: + def prepend_prefix(prefix, relpath) if relpath.empty? File.dirname(prefix) - elsif /#{SEPARATOR_PAT}/o.match?(prefix) + elsif /#{SEPARATOR_PAT}/o =~ prefix prefix = File.dirname(prefix) prefix = File.join(prefix, "") if File.basename(prefix + 'a') != 'a' prefix + relpath @@ -103,11 +354,9 @@ def prepend_prefix(prefix, relpath) # :nodoc: # 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 +..+ + # to avoid breaking symbolic linkages. This may retain more .. # entries than absolutely necessary, but without accessing the filesystem, - # this can't be avoided. - # - # See Pathname#realpath. + # this can't be avoided. See #realpath. # def cleanpath(consider_symlink=false) if consider_symlink @@ -118,10 +367,10 @@ def cleanpath(consider_symlink=false) end # - # Clean the path simply by resolving and removing excess +.+ and +..+ entries. + # Clean the path simply by resolving and removing excess "." and ".." entries. # Nothing more, nothing less. # - def cleanpath_aggressive # :nodoc: + def cleanpath_aggressive path = @path names = [] pre = path @@ -139,8 +388,7 @@ def cleanpath_aggressive # :nodoc: end end end - pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR - if /#{SEPARATOR_PAT}/o.match?(File.basename(pre)) + if /#{SEPARATOR_PAT}/o =~ File.basename(pre) names.shift while names[0] == '..' end self.class.new(prepend_prefix(pre, File.join(*names))) @@ -148,7 +396,7 @@ def cleanpath_aggressive # :nodoc: private :cleanpath_aggressive # has_trailing_separator?(path) -> bool - def has_trailing_separator?(path) # :nodoc: + def has_trailing_separator?(path) if r = chop_basename(path) pre, basename = r pre.length + basename.length < path.length @@ -159,7 +407,7 @@ def has_trailing_separator?(path) # :nodoc: private :has_trailing_separator? # add_trailing_separator(path) -> path - def add_trailing_separator(path) # :nodoc: + def add_trailing_separator(path) if File.basename(path + 'a') == 'a' path else @@ -168,7 +416,7 @@ def add_trailing_separator(path) # :nodoc: end private :add_trailing_separator - def del_trailing_separator(path) # :nodoc: + def del_trailing_separator(path) if r = chop_basename(path) pre, basename = r pre + basename @@ -180,7 +428,7 @@ def del_trailing_separator(path) # :nodoc: end private :del_trailing_separator - def cleanpath_conservative # :nodoc: + def cleanpath_conservative path = @path names = [] pre = path @@ -188,8 +436,7 @@ def cleanpath_conservative # :nodoc: pre, base = r names.unshift base if base != '.' end - pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR - if /#{SEPARATOR_PAT}/o.match?(File.basename(pre)) + if /#{SEPARATOR_PAT}/o =~ File.basename(pre) names.shift while names[0] == '..' end if names.empty? @@ -208,63 +455,70 @@ def cleanpath_conservative # :nodoc: end private :cleanpath_conservative - # Returns the parent directory. # - # This is same as self + '..'. + # 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. + # + def realpath(basedir=nil) + self.class.new(File.realpath(@path, basedir)) + 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. + # + def realdirpath(basedir=nil) + self.class.new(File.realdirpath(@path, basedir)) + end + + # #parent returns the parent directory. + # + # This is same as self + '..'. def parent self + '..' end - # Returns +true+ if +self+ points to a mountpoint. + # #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 && stat1.ino == stat2.ino || + stat1.dev != stat2.dev rescue Errno::ENOENT false end end # - # Predicate method for root directories. Returns +true+ if the + # #root? is a predicate for root directories. I.e. it returns +true+ if the # pathname consists of consecutive slashes. # - # It doesn't access the filesystem. So it may return +false+ for some + # It doesn't access actual filesystem. So it may return +false+ for some # pathnames which points to roots such as /usr/... # def root? - chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o.match?(@path) + !!(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. - # - # p = Pathname.new('/im/sure') - # p.absolute? - # #=> true - # - # p = Pathname.new('not/so/sure') - # p.absolute? - # #=> false def absolute? - ABSOLUTE_PATH.match? @path + !relative? end - # The opposite of Pathname#absolute? - # - # It returns +false+ if the pathname begins with a slash. - # - # p = Pathname.new('/im/sure') - # p.relative? - # #=> false - # - # p = Pathname.new('not/so/sure') - # p.relative? - # #=> true + # The opposite of #absolute? def relative? - !absolute? + path = @path + while r = chop_basename(path) + path, = r + end + path == '' end # @@ -273,13 +527,6 @@ def relative? # Pathname.new("/usr/bin/ruby").each_filename {|filename| ... } # # yields "usr", "bin", and "ruby". # - # Returns an Enumerator if no block was given. - # - # enum = Pathname.new("/usr/bin/ruby").each_filename - # # ... do stuff ... - # enum.each { |e| ... } - # # yields "usr", "bin", and "ruby". - # def each_filename # :yield: filename return to_enum(__method__) unless block_given? _, names = split_names(@path) @@ -303,17 +550,11 @@ def each_filename # :yield: filename # # # # # - # Returns an Enumerator if no block was given. - # - # enum = Pathname.new("/usr/bin/ruby").descend - # # ... do stuff ... - # enum.each { |e| ... } - # # yields Pathnames /, /usr, /usr/bin, and /usr/bin/ruby. + # It doesn't access actual filesystem. # - # It doesn't access the filesystem. + # This method is available since 1.8.5. # def descend - return to_enum(__method__) unless block_given? vs = [] ascend {|v| vs << v } vs.reverse_each {|v| yield v } @@ -336,17 +577,11 @@ def descend # # # # # - # Returns an Enumerator if no block was given. - # - # enum = Pathname.new("/usr/bin/ruby").ascend - # # ... do stuff ... - # enum.each { |e| ... } - # # yields Pathnames /usr/bin/ruby, /usr/bin, /usr, and /. + # It doesn't access actual filesystem. # - # It doesn't access the filesystem. + # This method is available since 1.8.5. # def ascend - return to_enum(__method__) unless block_given? path = @path yield self while r = chop_basename(path) @@ -357,27 +592,21 @@ def ascend end # - # Appends a pathname fragment to +self+ to produce a new Pathname object. - # Since +other+ is considered as a path relative to +self+, if +other+ is - # an absolute path, the new Pathname object is created from just +other+. + # 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 # - # # / is aliased to +. - # p4 = p1 / "bin/ruby" # Pathname:/usr/bin/ruby - # p5 = p1 / "/etc/passwd" # Pathname:/etc/passwd - # # This method doesn't access the file system; it is pure string manipulation. # def +(other) other = Pathname.new(other) unless Pathname === other Pathname.new(plus(@path, other.to_s)) end - alias / + - def plus(path1, path2) # -> path # :nodoc: + def plus(path1, path2) # -> path prefix2 = path2 index_list2 = [] basename_list2 = [] @@ -404,7 +633,7 @@ def plus(path1, path2) # -> path # :nodoc: basename_list2.shift end r1 = chop_basename(prefix1) - if !r1 && (r1 = /#{SEPARATOR_PAT}/o.match?(File.basename(prefix1))) + if !r1 && /#{SEPARATOR_PAT}/o =~ File.basename(prefix1) while !basename_list2.empty? && basename_list2.first == '..' index_list2.shift basename_list2.shift @@ -420,19 +649,13 @@ def plus(path1, path2) # -> path # :nodoc: private :plus # - # Joins the given pathnames onto +self+ to create a new Pathname object. - # This is effectively the same as using Pathname#+ to append +self+ and - # all arguments sequentially. + # Pathname#join joins pathnames. # - # path0 = Pathname.new("/usr") # Pathname:/usr - # path0 = path0.join("bin/ruby") # Pathname:/usr/bin/ruby - # # is the same as - # path1 = Pathname.new("/usr") + "bin/ruby" # Pathname:/usr/bin/ruby - # path0 == path1 - # #=> true + # path0.join(path1, ..., pathN) is the same as + # path0 + path1 + ... + pathN. # def join(*args) - return self if args.empty? + args.unshift self result = args.pop result = Pathname.new(result) unless Pathname === result return result if result.absolute? @@ -441,16 +664,15 @@ def join(*args) result = arg + result return result if result.absolute? } - self + result + result 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. + # 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") @@ -461,9 +683,11 @@ def join(*args) # pn.children(false) # # -> [ Pathname:English.rb, Pathname:Env.rb, Pathname:abbrev.rb, ... ] # - # Note that the results never contain the entries +.+ and +..+ in + # 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. + # def children(with_directory=true) with_directory = false if @path == '.' result = [] @@ -480,14 +704,9 @@ def children(with_directory=true) # 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. + # 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 } # #=> # @@ -509,31 +728,22 @@ def children(with_directory=true) # # # # # # # - # Note that the results never contain the entries +.+ and +..+ in - # the directory because they are not children. - # - # See Pathname#children - # def each_child(with_directory=true, &b) children(with_directory).each(&b) end # - # Returns a relative path from the given +base_directory+ to the receiver. - # - # If +self+ is absolute, then +base_directory+ must be absolute too. - # - # If +self+ is relative, then +base_directory+ must be relative too. + # #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. # - # This method doesn't access the filesystem. It assumes no symlinks. + # #relative_path_from doesn't access the filesystem. It assumes no symlinks. # # ArgumentError is raised when it cannot find a relative path. # - # Note that this method does not handle situations where the case sensitivity - # of the filesystem in use differs from the operating system default. + # This method has existed since 1.8.1. # def relative_path_from(base_directory) - base_directory = Pathname.new(base_directory) unless base_directory.is_a? Pathname dest_directory = self.cleanpath.to_s base_directory = base_directory.cleanpath.to_s dest_prefix = dest_directory @@ -570,70 +780,294 @@ def relative_path_from(base_directory) end end - -class Pathname # * Find * +class Pathname # * IO * + # + # #each_line iterates over the line in the file. It yields a String object + # for each line. # - # Iterates over the directory tree in a depth first manner, yielding a - # Pathname for each file under "this" directory. + # This method has existed since 1.8.1. + # + def each_line(*args, &block) # :yield: line + IO.foreach(@path, *args, &block) + 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) + 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 + if block_given? + Dir.glob(*args) {|f| yield self.new(f) } + else + Dir.glob(*args).map {|f| self.new(f) } + 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. # - # Returns an Enumerator if no block is given. + # This method has existed since 1.8.1. + def each_entry(&block) # :yield: pathname + Dir.foreach(@path) {|f| yield self.class.new(f) } + 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) + end +end + + +class Pathname # * Find * # - # Since it is implemented by the standard library module Find, Find.prune can - # be used to control the traversal. + # 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. # - # If +self+ is +.+, yielded pathnames begin with a filename in the - # current directory, not +./+. + # Since it is implemented by find.rb, Find.prune can be used + # to control the traverse. # - # See Find.find + # If +self+ is ., yielded pathnames begin with a filename in the + # current directory, not ./. # - def find(ignore_error: true) # :yield: pathname - return to_enum(__method__, ignore_error: ignore_error) unless block_given? + def find(&block) # :yield: pathname require 'find' if @path == '.' - Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f.delete_prefix('./')) } + Find.find(@path) {|f| yield self.class.new(f.sub(%r{\A\./}, '')) } else - Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f) } + Find.find(@path) {|f| yield self.class.new(f) } end end end class Pathname # * FileUtils * - # Creates a full path, including any intermediate directories that don't yet - # exist. - # - # See FileUtils.mkpath and FileUtils.mkdir_p - def mkpath(mode: nil) + # See FileUtils.mkpath. Creates a full path, including any + # intermediate directories that don't yet exist. + def mkpath require 'fileutils' - FileUtils.mkpath(@path, mode: mode) - self + FileUtils.mkpath(@path) + nil end - # Recursively deletes a directory, including all directories beneath it. - # - # See FileUtils.rm_rf - def rmtree(noop: nil, verbose: nil, secure: nil) + # 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_rf(@path, noop: noop, verbose: verbose, secure: secure) - self + FileUtils.rm_r(@path) + nil end end -class Pathname # * tmpdir * - # Creates a tmp directory and wraps the returned path in a Pathname object. - # - # See Dir.mktmpdir - def self.mktmpdir - require 'tmpdir' unless defined?(Dir.mktmpdir) - if block_given? - Dir.mktmpdir do |dir| - dir = self.new(dir) - yield dir - end - else - self.new(Dir.mktmpdir) + +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 +end + +class Pathname + undef =~ +end + +module Kernel + # create a pathname object. + # + # This method is available since 1.8.5. + def Pathname(path) # :doc: + Pathname.new(path) + end + private :Pathname end From 3736eab91f783cb087f873b99c25ffb7633ed041 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 22:11:24 +0200 Subject: [PATCH 02/11] Restore newer changes in lib/pathname.rb * This means it's only additions in lib/pathname.rb and zero removals. --- lib/pathname.rb | 289 +++++++++++++++++++++++++++++------------------- 1 file changed, 177 insertions(+), 112 deletions(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index ce58bd0..04e1a3c 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # # = pathname.rb # @@ -8,8 +9,6 @@ # # For documentation, see class Pathname. # -# pathname.rb is distributed with Ruby since 1.8.0. -# if defined?(::Pathname) # Clear builtin Pathname # :stopdoc: @@ -210,16 +209,16 @@ module ::Kernel # class Pathname + VERSION = "0.4.0" + # :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 + + # to_path is implemented so Pathname objects are usable with File.open, etc. + TO_PATH = :to_path SAME_PATHS = if File::FNM_SYSCASE.nonzero? - proc {|a, b| a.casecmp(b).zero?} + # Avoid #zero? here because #casecmp can return nil. + proc {|a, b| a.casecmp(b) == 0} else proc {|a, b| a == b} end @@ -306,19 +305,19 @@ def sub(pattern, *rest, &block) 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) + if File.dirname('A:') == 'A:.' # DOSish drive letter + ABSOLUTE_PATH = /\A(?:[A-Za-z]:|#{SEPARATOR_PAT})/o + else + ABSOLUTE_PATH = /\A#{SEPARATOR_PAT}/o end + private_constant :ABSOLUTE_PATH + + # :startdoc: # chop_basename(path) -> [pre-basename, basename] or nil - def chop_basename(path) + def chop_basename(path) # :nodoc: base = File.basename(path) - if /\A#{SEPARATOR_PAT}?\z/o =~ base + if /\A#{SEPARATOR_PAT}?\z/o.match?(base) return nil else return path[0, path.rindex(base)], base @@ -327,7 +326,7 @@ def chop_basename(path) private :chop_basename # split_names(path) -> prefix, [name, ...] - def split_names(path) + def split_names(path) # :nodoc: names = [] while r = chop_basename(path) path, basename = r @@ -337,10 +336,10 @@ def split_names(path) end private :split_names - def prepend_prefix(prefix, relpath) + def prepend_prefix(prefix, relpath) # :nodoc: if relpath.empty? File.dirname(prefix) - elsif /#{SEPARATOR_PAT}/o =~ prefix + elsif /#{SEPARATOR_PAT}/o.match?(prefix) prefix = File.dirname(prefix) prefix = File.join(prefix, "") if File.basename(prefix + 'a') != 'a' prefix + relpath @@ -354,9 +353,11 @@ def prepend_prefix(prefix, relpath) # 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 .. + # 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. + # this can't be avoided. + # + # See Pathname#realpath. # def cleanpath(consider_symlink=false) if consider_symlink @@ -367,10 +368,10 @@ def cleanpath(consider_symlink=false) end # - # Clean the path simply by resolving and removing excess "." and ".." entries. + # Clean the path simply by resolving and removing excess +.+ and +..+ entries. # Nothing more, nothing less. # - def cleanpath_aggressive + def cleanpath_aggressive # :nodoc: path = @path names = [] pre = path @@ -388,7 +389,8 @@ def cleanpath_aggressive end end end - if /#{SEPARATOR_PAT}/o =~ File.basename(pre) + pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR + if /#{SEPARATOR_PAT}/o.match?(File.basename(pre)) names.shift while names[0] == '..' end self.class.new(prepend_prefix(pre, File.join(*names))) @@ -396,7 +398,7 @@ def cleanpath_aggressive private :cleanpath_aggressive # has_trailing_separator?(path) -> bool - def has_trailing_separator?(path) + def has_trailing_separator?(path) # :nodoc: if r = chop_basename(path) pre, basename = r pre.length + basename.length < path.length @@ -407,7 +409,7 @@ def has_trailing_separator?(path) private :has_trailing_separator? # add_trailing_separator(path) -> path - def add_trailing_separator(path) + def add_trailing_separator(path) # :nodoc: if File.basename(path + 'a') == 'a' path else @@ -416,7 +418,7 @@ def add_trailing_separator(path) end private :add_trailing_separator - def del_trailing_separator(path) + def del_trailing_separator(path) # :nodoc: if r = chop_basename(path) pre, basename = r pre + basename @@ -428,7 +430,7 @@ def del_trailing_separator(path) end private :del_trailing_separator - def cleanpath_conservative + def cleanpath_conservative # :nodoc: path = @path names = [] pre = path @@ -436,7 +438,8 @@ def cleanpath_conservative pre, base = r names.unshift base if base != '.' end - if /#{SEPARATOR_PAT}/o =~ File.basename(pre) + pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR + if /#{SEPARATOR_PAT}/o.match?(File.basename(pre)) names.shift while names[0] == '..' end if names.empty? @@ -455,70 +458,63 @@ def cleanpath_conservative end private :cleanpath_conservative + # Returns the parent directory. # - # 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. - # - def realpath(basedir=nil) - self.class.new(File.realpath(@path, basedir)) - 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. - # - def realdirpath(basedir=nil) - self.class.new(File.realdirpath(@path, basedir)) - end - - # #parent returns the parent directory. - # - # This is same as self + '..'. + # This is same as self + '..'. def parent self + '..' end - # #mountpoint? returns +true+ if self points to a 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 + stat1.dev != stat2.dev || stat1.ino == stat2.ino rescue Errno::ENOENT false end end # - # #root? is a predicate for root directories. I.e. it returns +true+ if the + # Predicate method for root directories. Returns +true+ if the # pathname consists of consecutive slashes. # - # It doesn't access actual filesystem. So it may return +false+ for some + # It doesn't access the filesystem. So it may return +false+ for some # pathnames which points to roots such as /usr/... # def root? - !!(chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o =~ @path) + chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o.match?(@path) end # Predicate method for testing whether a path is absolute. + # # It returns +true+ if the pathname begins with a slash. + # + # p = Pathname.new('/im/sure') + # p.absolute? + # #=> true + # + # p = Pathname.new('not/so/sure') + # p.absolute? + # #=> false def absolute? - !relative? + ABSOLUTE_PATH.match? @path end - # The opposite of #absolute? + # The opposite of Pathname#absolute? + # + # It returns +false+ if the pathname begins with a slash. + # + # p = Pathname.new('/im/sure') + # p.relative? + # #=> false + # + # p = Pathname.new('not/so/sure') + # p.relative? + # #=> true def relative? - path = @path - while r = chop_basename(path) - path, = r - end - path == '' + !absolute? end # @@ -527,6 +523,13 @@ def relative? # Pathname.new("/usr/bin/ruby").each_filename {|filename| ... } # # yields "usr", "bin", and "ruby". # + # Returns an Enumerator if no block was given. + # + # enum = Pathname.new("/usr/bin/ruby").each_filename + # # ... do stuff ... + # enum.each { |e| ... } + # # yields "usr", "bin", and "ruby". + # def each_filename # :yield: filename return to_enum(__method__) unless block_given? _, names = split_names(@path) @@ -550,11 +553,17 @@ def each_filename # :yield: filename # # # # # - # It doesn't access actual filesystem. + # Returns an Enumerator if no block was given. # - # This method is available since 1.8.5. + # enum = Pathname.new("/usr/bin/ruby").descend + # # ... do stuff ... + # enum.each { |e| ... } + # # yields Pathnames /, /usr, /usr/bin, and /usr/bin/ruby. + # + # It doesn't access the filesystem. # def descend + return to_enum(__method__) unless block_given? vs = [] ascend {|v| vs << v } vs.reverse_each {|v| yield v } @@ -577,11 +586,17 @@ def descend # # # # # - # It doesn't access actual filesystem. + # Returns an Enumerator if no block was given. # - # This method is available since 1.8.5. + # enum = Pathname.new("/usr/bin/ruby").ascend + # # ... do stuff ... + # enum.each { |e| ... } + # # yields Pathnames /usr/bin/ruby, /usr/bin, /usr, and /. + # + # It doesn't access the filesystem. # def ascend + return to_enum(__method__) unless block_given? path = @path yield self while r = chop_basename(path) @@ -592,21 +607,27 @@ def ascend end # - # Pathname#+ appends a pathname fragment to this one to produce a new Pathname - # object. + # Appends a pathname fragment to +self+ to produce a new Pathname object. + # Since +other+ is considered as a path relative to +self+, if +other+ is + # an absolute path, the new Pathname object is created from just +other+. # # p1 = Pathname.new("/usr") # Pathname:/usr # p2 = p1 + "bin/ruby" # Pathname:/usr/bin/ruby # p3 = p1 + "/etc/passwd" # Pathname:/etc/passwd # + # # / is aliased to +. + # p4 = p1 / "bin/ruby" # Pathname:/usr/bin/ruby + # p5 = p1 / "/etc/passwd" # Pathname:/etc/passwd + # # This method doesn't access the file system; it is pure string manipulation. # def +(other) other = Pathname.new(other) unless Pathname === other Pathname.new(plus(@path, other.to_s)) end + alias / + - def plus(path1, path2) # -> path + def plus(path1, path2) # -> path # :nodoc: prefix2 = path2 index_list2 = [] basename_list2 = [] @@ -633,7 +654,7 @@ def plus(path1, path2) # -> path basename_list2.shift end r1 = chop_basename(prefix1) - if !r1 && /#{SEPARATOR_PAT}/o =~ File.basename(prefix1) + if !r1 && (r1 = /#{SEPARATOR_PAT}/o.match?(File.basename(prefix1))) while !basename_list2.empty? && basename_list2.first == '..' index_list2.shift basename_list2.shift @@ -649,13 +670,19 @@ def plus(path1, path2) # -> path private :plus # - # Pathname#join joins pathnames. + # Joins the given pathnames onto +self+ to create a new Pathname object. + # This is effectively the same as using Pathname#+ to append +self+ and + # all arguments sequentially. # - # path0.join(path1, ..., pathN) is the same as - # path0 + path1 + ... + pathN. + # path0 = Pathname.new("/usr") # Pathname:/usr + # path0 = path0.join("bin/ruby") # Pathname:/usr/bin/ruby + # # is the same as + # path1 = Pathname.new("/usr") + "bin/ruby" # Pathname:/usr/bin/ruby + # path0 == path1 + # #=> true # def join(*args) - args.unshift self + return self if args.empty? result = args.pop result = Pathname.new(result) unless Pathname === result return result if result.absolute? @@ -664,15 +691,16 @@ def join(*args) result = arg + result return result if result.absolute? } - result + self + result 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. + # 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") @@ -683,11 +711,9 @@ def join(*args) # pn.children(false) # # -> [ Pathname:English.rb, Pathname:Env.rb, Pathname:abbrev.rb, ... ] # - # Note that the result never contain the entries . and .. in + # Note that the results never contain the entries +.+ and +..+ in # the directory because they are not children. # - # This method has existed since 1.8.1. - # def children(with_directory=true) with_directory = false if @path == '.' result = [] @@ -704,9 +730,14 @@ def children(with_directory=true) # 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. + # + # 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 } # #=> # @@ -728,22 +759,31 @@ def children(with_directory=true) # # # # # # # + # Note that the results never contain the entries +.+ and +..+ in + # the directory because they are not children. + # + # See Pathname#children + # def each_child(with_directory=true, &b) children(with_directory).each(&b) 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 a relative path from the given +base_directory+ to the receiver. # - # #relative_path_from doesn't access the filesystem. It assumes no symlinks. + # If +self+ is absolute, then +base_directory+ must be absolute too. + # + # If +self+ is relative, then +base_directory+ must be relative too. + # + # This method doesn't access the filesystem. It assumes no symlinks. # # ArgumentError is raised when it cannot find a relative path. # - # This method has existed since 1.8.1. + # Note that this method does not handle situations where the case sensitivity + # of the filesystem in use differs from the operating system default. # def relative_path_from(base_directory) + base_directory = Pathname.new(base_directory) unless base_directory.is_a? Pathname dest_directory = self.cleanpath.to_s base_directory = base_directory.cleanpath.to_s dest_prefix = dest_directory @@ -1005,45 +1045,70 @@ def opendir(&block) # :yield: dir 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. + # Iterates over the directory tree in a depth first manner, yielding 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. + # Since it is implemented by the standard library module Find, Find.prune can + # be used to control the traversal. # - # If +self+ is ., yielded pathnames begin with a filename in the - # current directory, not ./. + # If +self+ is +.+, yielded pathnames begin with a filename in the + # current directory, not +./+. # - def find(&block) # :yield: pathname + # See Find.find + # + def find(ignore_error: true) # :yield: pathname + return to_enum(__method__, ignore_error: ignore_error) unless block_given? require 'find' if @path == '.' - Find.find(@path) {|f| yield self.class.new(f.sub(%r{\A\./}, '')) } + Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f.delete_prefix('./')) } else - Find.find(@path) {|f| yield self.class.new(f) } + Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f) } end end end class Pathname # * FileUtils * - # See FileUtils.mkpath. Creates a full path, including any - # intermediate directories that don't yet exist. - def mkpath + # Creates a full path, including any intermediate directories that don't yet + # exist. + # + # See FileUtils.mkpath and FileUtils.mkdir_p + def mkpath(mode: nil) require 'fileutils' - FileUtils.mkpath(@path) - nil + FileUtils.mkpath(@path, mode: mode) + self end - # See FileUtils.rm_r. Deletes a directory and all beneath it. - def rmtree + # Recursively deletes a directory, including all directories beneath it. + # + # See FileUtils.rm_rf + def rmtree(noop: nil, verbose: nil, secure: nil) # The name "rmtree" is borrowed from File::Path of Perl. # File::Path provides "mkpath" and "rmtree". require 'fileutils' - FileUtils.rm_r(@path) - nil + FileUtils.rm_rf(@path, noop: noop, verbose: verbose, secure: secure) + self end end +class Pathname # * tmpdir * + # Creates a tmp directory and wraps the returned path in a Pathname object. + # + # See Dir.mktmpdir + def self.mktmpdir + require 'tmpdir' unless defined?(Dir.mktmpdir) + if block_given? + Dir.mktmpdir do |dir| + dir = self.new(dir) + yield dir + end + else + self.new(Dir.mktmpdir) + end + end +end class Pathname # * mixed * # Removes a file or directory, using File.unlink or From 955186cddb026fd091b2cfaabb2bf35db6a78883 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 22:20:59 +0200 Subject: [PATCH 03/11] Fixes to pass the test suite --- lib/pathname.rb | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index 04e1a3c..9024d21 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -236,13 +236,9 @@ def initialize(path) if /\0/ =~ @path raise ArgumentError, "pathname contains \\0: #{@path.inspect}" end - - self.taint if @path.tainted? 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. @@ -827,8 +823,8 @@ class Pathname # * IO * # # This method has existed since 1.8.1. # - def each_line(*args, &block) # :yield: line - IO.foreach(@path, *args, &block) + def each_line(...) # :yield: line + IO.foreach(@path, ...) end # See IO.read. Returns all data from the file, or the first +N+ bytes @@ -840,7 +836,7 @@ def read(*args) IO.read(@path, *args) end 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 + def readlines(...) IO.readlines(@path, ...) end # See IO.sysopen. def sysopen(*args) IO.sysopen(@path, *args) end @@ -885,8 +881,8 @@ def ftype() File.ftype(@path) end 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) + def open(...) # :yield: file + File.open(@path, ...) end # See File.readlink. Read symbolic link. @@ -924,7 +920,11 @@ 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 + def split() + array = File.split(@path) + raise TypeError, 'wrong argument type nil (expected Array)' unless Array === array + array.map {|f| self.class.new(f) } + end end @@ -1006,11 +1006,11 @@ def zero?() FileTest.zero?(@path) end class Pathname # * Dir * # See Dir.glob. Returns or yields Pathname objects. - def Pathname.glob(*args) # :yield: pathname + def Pathname.glob(*args, **kwargs) # :yield: pathname if block_given? - Dir.glob(*args) {|f| yield self.new(f) } + Dir.glob(*args, **kwargs) {|f| yield self.new(f) } else - Dir.glob(*args).map {|f| self.new(f) } + Dir.glob(*args, **kwargs).map {|f| self.new(f) } end end @@ -1027,6 +1027,7 @@ def entries() Dir.entries(@path).map {|f| self.class.new(f) } end # # This method has existed since 1.8.1. def each_entry(&block) # :yield: pathname + return to_enum(__method__) unless block_given? Dir.foreach(@path) {|f| yield self.class.new(f) } end @@ -1124,7 +1125,7 @@ def unlink() end class Pathname - undef =~ + undef =~ if Kernel.method_defined?(:=~) end module Kernel @@ -1132,6 +1133,7 @@ module Kernel # # This method is available since 1.8.5. def Pathname(path) # :doc: + return path if Pathname === path Pathname.new(path) end private :Pathname From c8c22106c87c745bacaf40911dd0e45200fc2670 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 22:38:31 +0200 Subject: [PATCH 04/11] Remove all duplicate definitions in pathname.c except <=> * The <=> implementation in the extension is much faster, so is kept. * The other methods are actually faster in Ruby than in C, because rb_funcall() and rb_ivar_get() in C code have no inline cache, but method calls and `@path` have inline caches in Ruby code. https://railsatscale.com/2023-08-29-ruby-outperforms-c/ is an explanation of that (though it was known well before that). --- ext/pathname/pathname.c | 1588 +-------------------------------------- 1 file changed, 1 insertion(+), 1587 deletions(-) diff --git a/ext/pathname/pathname.c b/ext/pathname/pathname.c index f329559..c263921 100644 --- a/ext/pathname/pathname.c +++ b/ext/pathname/pathname.c @@ -1,77 +1,7 @@ #include "ruby.h" -#include "ruby/encoding.h" static VALUE rb_cPathname; -static ID id_ENOTDIR; static ID id_at_path; -static ID id_atime; -static ID id_base; -static ID id_basename; -static ID id_binread; -static ID id_binwrite; -static ID id_birthtime; -static ID id_blockdev_p; -static ID id_chardev_p; -static ID id_chmod; -static ID id_chown; -static ID id_ctime; -static ID id_directory_p; -static ID id_dirname; -static ID id_empty_p; -static ID id_entries; -static ID id_executable_p; -static ID id_executable_real_p; -static ID id_exist_p; -static ID id_expand_path; -static ID id_extname; -static ID id_file_p; -static ID id_fnmatch; -static ID id_foreach; -static ID id_ftype; -static ID id_getwd; -static ID id_glob; -static ID id_grpowned_p; -static ID id_lchmod; -static ID id_lchown; -static ID id_link; -static ID id_lstat; -static ID id_lutime; -static ID id_mkdir; -static ID id_mtime; -static ID id_open; -static ID id_owned_p; -static ID id_pipe_p; -static ID id_read; -static ID id_readable_p; -static ID id_readable_real_p; -static ID id_readlines; -static ID id_readlink; -static ID id_realdirpath; -static ID id_realpath; -static ID id_rename; -static ID id_rmdir; -static ID id_setgid_p; -static ID id_setuid_p; -static ID id_size; -static ID id_size_p; -static ID id_socket_p; -static ID id_split; -static ID id_stat; -static ID id_sticky_p; -static ID id_sub; -static ID id_symlink; -static ID id_symlink_p; -static ID id_sysopen; -static ID id_to_path; -static ID id_truncate; -static ID id_unlink; -static ID id_utime; -static ID id_world_readable_p; -static ID id_world_writable_p; -static ID id_writable_p; -static ID id_writable_real_p; -static ID id_write; -static ID id_zero_p; static VALUE get_strpath(VALUE obj) @@ -83,66 +13,6 @@ get_strpath(VALUE obj) return strpath; } -static void -set_strpath(VALUE obj, VALUE val) -{ - rb_ivar_set(obj, id_at_path, val); -} - -/* - * Create a Pathname object from the given String (or String-like object). - * If +path+ contains a NULL character (\0), an ArgumentError is raised. - */ -static VALUE -path_initialize(VALUE self, VALUE arg) -{ - VALUE str; - if (RB_TYPE_P(arg, T_STRING)) { - str = arg; - } - else { - str = rb_check_funcall(arg, id_to_path, 0, NULL); - if (str == Qundef) - str = arg; - StringValue(str); - } - if (memchr(RSTRING_PTR(str), '\0', RSTRING_LEN(str))) - rb_raise(rb_eArgError, "pathname contains null byte"); - str = rb_obj_dup(str); - - set_strpath(self, str); - return self; -} - -/* - * call-seq: - * pathname.freeze -> obj - * - * Freezes this Pathname. - * - * See Object.freeze. - */ -static VALUE -path_freeze(VALUE self) -{ - rb_call_super(0, 0); - rb_str_freeze(get_strpath(self)); - return self; -} - -/* - * 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. - */ -static VALUE -path_eq(VALUE self, VALUE other) -{ - if (!rb_obj_is_kind_of(other, rb_cPathname)) - return Qfalse; - return rb_str_equal(get_strpath(self), get_strpath(other)); -} - /* * Provides a case-sensitive comparison operator for pathnames. * @@ -191,1311 +61,8 @@ path_cmp(VALUE self, VALUE other) return INT2FIX(0); } -#ifndef ST2FIX -#define ST2FIX(h) LONG2FIX((long)(h)) -#endif - -/* :nodoc: */ -static VALUE -path_hash(VALUE self) -{ - return ST2FIX(rb_str_hash(get_strpath(self))); -} - -/* - * call-seq: - * pathname.to_s -> string - * pathname.to_path -> string - * - * Return the path as a String. - * - * to_path is implemented so Pathname objects are usable with File.open, etc. - */ -static VALUE -path_to_s(VALUE self) -{ - return rb_obj_dup(get_strpath(self)); -} - -/* :nodoc: */ -static VALUE -path_inspect(VALUE self) -{ - const char *c = rb_obj_classname(self); - VALUE str = get_strpath(self); - return rb_sprintf("#<%s:%"PRIsVALUE">", c, str); -} - -/* - * Return a pathname which is substituted by String#sub. - * - * path1 = Pathname.new('/usr/bin/perl') - * path1.sub('perl', 'ruby') - * #=> # - */ -static VALUE -path_sub(int argc, VALUE *argv, VALUE self) -{ - VALUE str = get_strpath(self); - - if (rb_block_given_p()) { - str = rb_block_call(str, id_sub, argc, argv, 0, 0); - } - else { - str = rb_funcallv(str, id_sub, argc, argv); - } - return rb_class_new_instance(1, &str, rb_obj_class(self)); -} - -/* - * Return a pathname with +repl+ added as a suffix to the basename. - * - * If self has no extension part, +repl+ is appended. - * - * Pathname.new('/usr/bin/shutdown').sub_ext('.rb') - * #=> # - */ -static VALUE -path_sub_ext(VALUE self, VALUE repl) -{ - VALUE str = get_strpath(self); - VALUE str2; - long extlen; - const char *ext; - const char *p; - - StringValue(repl); - p = RSTRING_PTR(str); - extlen = RSTRING_LEN(str); - ext = ruby_enc_find_extname(p, &extlen, rb_enc_get(str)); - if (ext == NULL) { - ext = p + RSTRING_LEN(str); - } - else if (extlen <= 1) { - ext += extlen; - } - str2 = rb_str_subseq(str, 0, ext-p); - rb_str_append(str2, repl); - return rb_class_new_instance(1, &str2, rb_obj_class(self)); -} - -/* Facade for File */ - -/* - * Returns the real (absolute) pathname for +self+ in the actual - * filesystem. - * - * Does not contain symlinks or useless dots, +..+ and +.+. - * - * All components of the pathname must exist when this method is - * called. - * - */ -static VALUE -path_realpath(int argc, VALUE *argv, VALUE self) -{ - VALUE basedir, str; - rb_scan_args(argc, argv, "01", &basedir); - str = rb_funcall(rb_cFile, id_realpath, 2, get_strpath(self), basedir); - return rb_class_new_instance(1, &str, rb_obj_class(self)); -} - -/* - * Returns the real (absolute) pathname of +self+ in the actual filesystem. - * - * Does not contain symlinks or useless dots, +..+ and +.+. - * - * The last component of the real pathname can be nonexistent. - */ -static VALUE -path_realdirpath(int argc, VALUE *argv, VALUE self) -{ - VALUE basedir, str; - rb_scan_args(argc, argv, "01", &basedir); - str = rb_funcall(rb_cFile, id_realdirpath, 2, get_strpath(self), basedir); - return rb_class_new_instance(1, &str, rb_obj_class(self)); -} - -/* - * call-seq: - * pathname.each_line {|line| ... } - * pathname.each_line(sep=$/ [, open_args]) {|line| block } -> nil - * pathname.each_line(limit [, open_args]) {|line| block } -> nil - * pathname.each_line(sep, limit [, open_args]) {|line| block } -> nil - * pathname.each_line(...) -> an_enumerator - * - * Iterates over each line in the file and yields a String object for each. - */ -static VALUE -path_each_line(int argc, VALUE *argv, VALUE self) -{ - VALUE args[4]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); - if (rb_block_given_p()) { - return rb_block_call_kw(rb_cFile, id_foreach, 1+n, args, 0, 0, RB_PASS_CALLED_KEYWORDS); - } - else { - return rb_funcallv_kw(rb_cFile, id_foreach, 1+n, args, RB_PASS_CALLED_KEYWORDS); - } -} - -/* - * call-seq: - * pathname.read([length [, offset]]) -> string - * pathname.read([length [, offset]], open_args) -> string - * - * Returns all data from the file, or the first +N+ bytes if specified. - * - * See File.read. - * - */ -static VALUE -path_read(int argc, VALUE *argv, VALUE self) -{ - VALUE args[4]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); - return rb_funcallv_kw(rb_cFile, id_read, 1+n, args, RB_PASS_CALLED_KEYWORDS); -} - -/* - * call-seq: - * pathname.binread([length [, offset]]) -> string - * - * Returns all the bytes from the file, or the first +N+ if specified. - * - * See File.binread. - * - */ -static VALUE -path_binread(int argc, VALUE *argv, VALUE self) -{ - VALUE args[3]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "02", &args[1], &args[2]); - return rb_funcallv(rb_cFile, id_binread, 1+n, args); -} - -/* - * call-seq: - * pathname.write(string, [offset] ) => fixnum - * pathname.write(string, [offset], open_args ) => fixnum - * - * Writes +contents+ to the file. - * - * See File.write. - * - */ -static VALUE -path_write(int argc, VALUE *argv, VALUE self) -{ - VALUE args[4]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); - return rb_funcallv_kw(rb_cFile, id_write, 1+n, args, RB_PASS_CALLED_KEYWORDS); -} - -/* - * call-seq: - * pathname.binwrite(string, [offset] ) => fixnum - * pathname.binwrite(string, [offset], open_args ) => fixnum - * - * Writes +contents+ to the file, opening it in binary mode. - * - * See File.binwrite. - * - */ -static VALUE -path_binwrite(int argc, VALUE *argv, VALUE self) -{ - VALUE args[4]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); - return rb_funcallv_kw(rb_cFile, id_binwrite, 1+n, args, RB_PASS_CALLED_KEYWORDS); -} - -/* - * call-seq: - * pathname.readlines(sep=$/ [, open_args]) -> array - * pathname.readlines(limit [, open_args]) -> array - * pathname.readlines(sep, limit [, open_args]) -> array - * - * Returns all the lines from the file. - * - * See File.readlines. - * - */ -static VALUE -path_readlines(int argc, VALUE *argv, VALUE self) -{ - VALUE args[4]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); - return rb_funcallv_kw(rb_cFile, id_readlines, 1+n, args, RB_PASS_CALLED_KEYWORDS); -} - -/* - * call-seq: - * pathname.sysopen([mode, [perm]]) -> fixnum - * - * See IO.sysopen. - * - */ -static VALUE -path_sysopen(int argc, VALUE *argv, VALUE self) -{ - VALUE args[3]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "02", &args[1], &args[2]); - return rb_funcallv(rb_cIO, id_sysopen, 1+n, args); -} - -/* - * call-seq: - * pathname.atime -> time - * - * Returns the last access time for the file. - * - * See File.atime. - */ -static VALUE -path_atime(VALUE self) -{ - return rb_funcall(rb_cFile, id_atime, 1, get_strpath(self)); -} - -/* - * call-seq: - * pathname.birthtime -> time - * - * Returns the birth time for the file. - * If the platform doesn't have birthtime, raises NotImplementedError. - * - * See File.birthtime. - */ -static VALUE -path_birthtime(VALUE self) -{ - return rb_funcall(rb_cFile, id_birthtime, 1, get_strpath(self)); -} - -/* - * call-seq: - * pathname.ctime -> time - * - * Returns the last change time, using directory information, not the file itself. - * - * See File.ctime. - */ -static VALUE -path_ctime(VALUE self) -{ - return rb_funcall(rb_cFile, id_ctime, 1, get_strpath(self)); -} - -/* - * call-seq: - * pathname.mtime -> time - * - * Returns the last modified time of the file. - * - * See File.mtime. - */ -static VALUE -path_mtime(VALUE self) -{ - return rb_funcall(rb_cFile, id_mtime, 1, get_strpath(self)); -} - -/* - * call-seq: - * pathname.chmod(mode_int) -> integer - * - * Changes file permissions. - * - * See File.chmod. - */ -static VALUE -path_chmod(VALUE self, VALUE mode) -{ - return rb_funcall(rb_cFile, id_chmod, 2, mode, get_strpath(self)); -} - -/* - * call-seq: - * pathname.lchmod(mode_int) -> integer - * - * Same as Pathname.chmod, but does not follow symbolic links. - * - * See File.lchmod. - */ -static VALUE -path_lchmod(VALUE self, VALUE mode) -{ - return rb_funcall(rb_cFile, id_lchmod, 2, mode, get_strpath(self)); -} - -/* - * call-seq: - * pathname.chown(owner_int, group_int) -> integer - * - * Change owner and group of the file. - * - * See File.chown. - */ -static VALUE -path_chown(VALUE self, VALUE owner, VALUE group) -{ - return rb_funcall(rb_cFile, id_chown, 3, owner, group, get_strpath(self)); -} - -/* - * call-seq: - * pathname.lchown(owner_int, group_int) -> integer - * - * Same as Pathname.chown, but does not follow symbolic links. - * - * See File.lchown. - */ -static VALUE -path_lchown(VALUE self, VALUE owner, VALUE group) -{ - return rb_funcall(rb_cFile, id_lchown, 3, owner, group, get_strpath(self)); -} - -/* - * call-seq: - * pathname.fnmatch(pattern, [flags]) -> true or false - * pathname.fnmatch?(pattern, [flags]) -> true or false - * - * Return +true+ if the receiver matches the given pattern. - * - * See File.fnmatch. - */ -static VALUE -path_fnmatch(int argc, VALUE *argv, VALUE self) -{ - VALUE str = get_strpath(self); - VALUE pattern, flags; - if (rb_scan_args(argc, argv, "11", &pattern, &flags) == 1) - return rb_funcall(rb_cFile, id_fnmatch, 2, pattern, str); - else - return rb_funcall(rb_cFile, id_fnmatch, 3, pattern, str, flags); -} - -/* - * call-seq: - * pathname.ftype -> string - * - * Returns "type" of file ("file", "directory", etc). - * - * See File.ftype. - */ -static VALUE -path_ftype(VALUE self) -{ - return rb_funcall(rb_cFile, id_ftype, 1, get_strpath(self)); -} - -/* - * call-seq: - * pathname.make_link(old) - * - * Creates a hard link at _pathname_. - * - * See File.link. - */ -static VALUE -path_make_link(VALUE self, VALUE old) -{ - return rb_funcall(rb_cFile, id_link, 2, old, get_strpath(self)); -} - -/* - * call-seq: - * pathname.open() - * pathname.open(mode="r" [, opt]) -> file - * pathname.open([mode [, perm]] [, opt]) -> file - * pathname.open(mode="r" [, opt]) {|file| block } -> obj - * pathname.open([mode [, perm]] [, opt]) {|file| block } -> obj - * - * Opens the file for reading or writing. - * - * See File.open. - */ -static VALUE -path_open(int argc, VALUE *argv, VALUE self) -{ - VALUE args[4]; - int n; - - args[0] = get_strpath(self); - n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]); - if (rb_block_given_p()) { - return rb_block_call_kw(rb_cFile, id_open, 1+n, args, 0, 0, RB_PASS_CALLED_KEYWORDS); - } - else { - return rb_funcallv_kw(rb_cFile, id_open, 1+n, args, RB_PASS_CALLED_KEYWORDS); - } -} +static void init_ids(void); -/* - * Read symbolic link. - * - * See File.readlink. - */ -static VALUE -path_readlink(VALUE self) -{ - VALUE str; - str = rb_funcall(rb_cFile, id_readlink, 1, get_strpath(self)); - return rb_class_new_instance(1, &str, rb_obj_class(self)); -} - -/* - * Rename the file. - * - * See File.rename. - */ -static VALUE -path_rename(VALUE self, VALUE to) -{ - return rb_funcall(rb_cFile, id_rename, 2, get_strpath(self), to); -} - -/* - * Returns a File::Stat object. - * - * See File.stat. - */ -static VALUE -path_stat(VALUE self) -{ - return rb_funcall(rb_cFile, id_stat, 1, get_strpath(self)); -} - -/* - * See File.lstat. - */ -static VALUE -path_lstat(VALUE self) -{ - return rb_funcall(rb_cFile, id_lstat, 1, get_strpath(self)); -} - -/* - * call-seq: - * pathname.make_symlink(old) - * - * Creates a symbolic link. - * - * See File.symlink. - */ -static VALUE -path_make_symlink(VALUE self, VALUE old) -{ - return rb_funcall(rb_cFile, id_symlink, 2, old, get_strpath(self)); -} - -/* - * Truncates the file to +length+ bytes. - * - * See File.truncate. - */ -static VALUE -path_truncate(VALUE self, VALUE length) -{ - return rb_funcall(rb_cFile, id_truncate, 2, get_strpath(self), length); -} - -/* - * Update the access and modification times of the file. - * - * See File.utime. - */ -static VALUE -path_utime(VALUE self, VALUE atime, VALUE mtime) -{ - return rb_funcall(rb_cFile, id_utime, 3, atime, mtime, get_strpath(self)); -} - -/* - * Update the access and modification times of the file. - * - * Same as Pathname#utime, but does not follow symbolic links. - * - * See File.lutime. - */ -static VALUE -path_lutime(VALUE self, VALUE atime, VALUE mtime) -{ - return rb_funcall(rb_cFile, id_lutime, 3, atime, mtime, get_strpath(self)); -} - -/* - * Returns the last component of the path. - * - * See File.basename. - */ -static VALUE -path_basename(int argc, VALUE *argv, VALUE self) -{ - VALUE str = get_strpath(self); - VALUE fext; - if (rb_scan_args(argc, argv, "01", &fext) == 0) - str = rb_funcall(rb_cFile, id_basename, 1, str); - else - str = rb_funcall(rb_cFile, id_basename, 2, str, fext); - return rb_class_new_instance(1, &str, rb_obj_class(self)); -} - -/* - * Returns all but the last component of the path. - * - * See File.dirname. - */ -static VALUE -path_dirname(VALUE self) -{ - VALUE str = get_strpath(self); - str = rb_funcall(rb_cFile, id_dirname, 1, str); - return rb_class_new_instance(1, &str, rb_obj_class(self)); -} - -/* - * Returns the file's extension. - * - * See File.extname. - */ -static VALUE -path_extname(VALUE self) -{ - VALUE str = get_strpath(self); - return rb_funcall(rb_cFile, id_extname, 1, str); -} - -/* - * Returns the absolute path for the file. - * - * See File.expand_path. - */ -static VALUE -path_expand_path(int argc, VALUE *argv, VALUE self) -{ - VALUE str = get_strpath(self); - VALUE dname; - if (rb_scan_args(argc, argv, "01", &dname) == 0) - str = rb_funcall(rb_cFile, id_expand_path, 1, str); - else - str = rb_funcall(rb_cFile, id_expand_path, 2, str, dname); - return rb_class_new_instance(1, &str, rb_obj_class(self)); -} - -/* - * Returns the #dirname and the #basename in an Array. - * - * See File.split. - */ -static VALUE -path_split(VALUE self) -{ - VALUE str = get_strpath(self); - VALUE ary, dirname, basename; - ary = rb_funcall(rb_cFile, id_split, 1, str); - Check_Type(ary, T_ARRAY); - dirname = rb_ary_entry(ary, 0); - basename = rb_ary_entry(ary, 1); - dirname = rb_class_new_instance(1, &dirname, rb_obj_class(self)); - basename = rb_class_new_instance(1, &basename, rb_obj_class(self)); - return rb_ary_new3(2, dirname, basename); -} - -/* - * See FileTest.blockdev?. - */ -static VALUE -path_blockdev_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_blockdev_p, 1, get_strpath(self)); -} - -/* - * See FileTest.chardev?. - */ -static VALUE -path_chardev_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_chardev_p, 1, get_strpath(self)); -} - -/* - * See FileTest.executable?. - */ -static VALUE -path_executable_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_executable_p, 1, get_strpath(self)); -} - -/* - * See FileTest.executable_real?. - */ -static VALUE -path_executable_real_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_executable_real_p, 1, get_strpath(self)); -} - -/* - * See FileTest.exist?. - */ -static VALUE -path_exist_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_exist_p, 1, get_strpath(self)); -} - -/* - * See FileTest.grpowned?. - */ -static VALUE -path_grpowned_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_grpowned_p, 1, get_strpath(self)); -} - -/* - * See FileTest.directory?. - */ -static VALUE -path_directory_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_directory_p, 1, get_strpath(self)); -} - -/* - * See FileTest.file?. - */ -static VALUE -path_file_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_file_p, 1, get_strpath(self)); -} - -/* - * See FileTest.pipe?. - */ -static VALUE -path_pipe_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_pipe_p, 1, get_strpath(self)); -} - -/* - * See FileTest.socket?. - */ -static VALUE -path_socket_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_socket_p, 1, get_strpath(self)); -} - -/* - * See FileTest.owned?. - */ -static VALUE -path_owned_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_owned_p, 1, get_strpath(self)); -} - -/* - * See FileTest.readable?. - */ -static VALUE -path_readable_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_readable_p, 1, get_strpath(self)); -} - -/* - * See FileTest.world_readable?. - */ -static VALUE -path_world_readable_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_world_readable_p, 1, get_strpath(self)); -} - -/* - * See FileTest.readable_real?. - */ -static VALUE -path_readable_real_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_readable_real_p, 1, get_strpath(self)); -} - -/* - * See FileTest.setuid?. - */ -static VALUE -path_setuid_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_setuid_p, 1, get_strpath(self)); -} - -/* - * See FileTest.setgid?. - */ -static VALUE -path_setgid_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_setgid_p, 1, get_strpath(self)); -} - -/* - * See FileTest.size. - */ -static VALUE -path_size(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_size, 1, get_strpath(self)); -} - -/* - * See FileTest.size?. - */ -static VALUE -path_size_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_size_p, 1, get_strpath(self)); -} - -/* - * See FileTest.sticky?. - */ -static VALUE -path_sticky_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_sticky_p, 1, get_strpath(self)); -} - -/* - * See FileTest.symlink?. - */ -static VALUE -path_symlink_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_symlink_p, 1, get_strpath(self)); -} - -/* - * See FileTest.writable?. - */ -static VALUE -path_writable_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_writable_p, 1, get_strpath(self)); -} - -/* - * See FileTest.world_writable?. - */ -static VALUE -path_world_writable_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_world_writable_p, 1, get_strpath(self)); -} - -/* - * See FileTest.writable_real?. - */ -static VALUE -path_writable_real_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_writable_real_p, 1, get_strpath(self)); -} - -/* - * See FileTest.zero?. - */ -static VALUE -path_zero_p(VALUE self) -{ - return rb_funcall(rb_mFileTest, id_zero_p, 1, get_strpath(self)); -} - -/* - * Tests the file is empty. - * - * See Dir#empty? and FileTest.empty?. - */ -static VALUE -path_empty_p(VALUE self) -{ - - VALUE path = get_strpath(self); - if (RTEST(rb_funcall(rb_mFileTest, id_directory_p, 1, path))) - return rb_funcall(rb_cDir, id_empty_p, 1, path); - else - return rb_funcall(rb_mFileTest, id_empty_p, 1, path); -} - -static VALUE -s_glob_i(RB_BLOCK_CALL_FUNC_ARGLIST(elt, klass)) -{ - return rb_yield(rb_class_new_instance(1, &elt, klass)); -} - -/* - * Returns or yields Pathname objects. - * - * Pathname.glob("lib/i*.rb") - * #=> [#, #] - * - * See Dir.glob. - */ -static VALUE -path_s_glob(int argc, VALUE *argv, VALUE klass) -{ - VALUE args[3]; - int n; - - n = rb_scan_args(argc, argv, "12", &args[0], &args[1], &args[2]); - if (rb_block_given_p()) { - return rb_block_call_kw(rb_cDir, id_glob, n, args, s_glob_i, klass, RB_PASS_CALLED_KEYWORDS); - } - else { - VALUE ary; - long i; - ary = rb_funcallv_kw(rb_cDir, id_glob, n, args, RB_PASS_CALLED_KEYWORDS); - ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary"); - for (i = 0; i < RARRAY_LEN(ary); i++) { - VALUE elt = RARRAY_AREF(ary, i); - elt = rb_class_new_instance(1, &elt, klass); - rb_ary_store(ary, i, elt); - } - return ary; - } -} - -static VALUE -glob_i(RB_BLOCK_CALL_FUNC_ARGLIST(elt, self)) -{ - elt = rb_funcall(self, '+', 1, elt); - return rb_yield(elt); -} - -/* - * Returns or yields Pathname objects. - * - * Pathname("ruby-2.4.2").glob("R*.md") - * #=> [#, #] - * - * See Dir.glob. - * This method uses the +base+ keyword argument of Dir.glob. - */ -static VALUE -path_glob(int argc, VALUE *argv, VALUE self) -{ - VALUE args[3]; - int n; - - n = rb_scan_args(argc, argv, "11", &args[0], &args[1]); - if (n == 1) - args[1] = INT2FIX(0); - - args[2] = rb_hash_new(); - rb_hash_aset(args[2], ID2SYM(id_base), get_strpath(self)); - - n = 3; - - if (rb_block_given_p()) { - return rb_block_call_kw(rb_cDir, id_glob, n, args, glob_i, self, RB_PASS_KEYWORDS); - } - else { - VALUE ary; - long i; - ary = rb_funcallv_kw(rb_cDir, id_glob, n, args, RB_PASS_KEYWORDS); - ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary"); - for (i = 0; i < RARRAY_LEN(ary); i++) { - VALUE elt = RARRAY_AREF(ary, i); - elt = rb_funcall(self, '+', 1, elt); - rb_ary_store(ary, i, elt); - } - return ary; - } -} - -/* - * Returns the current working directory as a Pathname. - * - * Pathname.getwd - * #=> # - * - * See Dir.getwd. - */ -static VALUE -path_s_getwd(VALUE klass) -{ - VALUE str; - str = rb_funcall(rb_cDir, id_getwd, 0); - return rb_class_new_instance(1, &str, klass); -} - -/* - * Return the entries (files and subdirectories) in the directory, each as a - * Pathname object. - * - * The results contains just the names in the directory, without any trailing - * slashes or recursive look-up. - * - * pp Pathname.new('/usr/local').entries - * #=> [#, - * # #, - * # #, - * # #, - * # #, - * # #, - * # #, - * # #, - * # #, - * # #, - * # #] - * - * The result may contain the current directory # and - * the parent directory #. - * - * If you don't want +.+ and +..+ and - * want directories, consider Pathname#children. - */ -static VALUE -path_entries(VALUE self) -{ - VALUE klass, str, ary; - long i; - klass = rb_obj_class(self); - str = get_strpath(self); - ary = rb_funcall(rb_cDir, id_entries, 1, str); - ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary"); - for (i = 0; i < RARRAY_LEN(ary); i++) { - VALUE elt = RARRAY_AREF(ary, i); - elt = rb_class_new_instance(1, &elt, klass); - rb_ary_store(ary, i, elt); - } - return ary; -} - -/* - * Create the referenced directory. - * - * See Dir.mkdir. - */ -static VALUE -path_mkdir(int argc, VALUE *argv, VALUE self) -{ - VALUE str = get_strpath(self); - VALUE vmode; - if (rb_scan_args(argc, argv, "01", &vmode) == 0) - return rb_funcall(rb_cDir, id_mkdir, 1, str); - else - return rb_funcall(rb_cDir, id_mkdir, 2, str, vmode); -} - -/* - * Remove the referenced directory. - * - * See Dir.rmdir. - */ -static VALUE -path_rmdir(VALUE self) -{ - return rb_funcall(rb_cDir, id_rmdir, 1, get_strpath(self)); -} - -/* - * Opens the referenced directory. - * - * See Dir.open. - */ -static VALUE -path_opendir(VALUE self) -{ - VALUE args[1]; - - args[0] = get_strpath(self); - return rb_block_call(rb_cDir, id_open, 1, args, 0, 0); -} - -static VALUE -each_entry_i(RB_BLOCK_CALL_FUNC_ARGLIST(elt, klass)) -{ - return rb_yield(rb_class_new_instance(1, &elt, klass)); -} - -/* - * Iterates over the entries (files and subdirectories) in the directory, - * yielding a Pathname object for each entry. - */ -static VALUE -path_each_entry(VALUE self) -{ - VALUE args[1]; - RETURN_ENUMERATOR(self, 0, 0); - - args[0] = get_strpath(self); - return rb_block_call(rb_cDir, id_foreach, 1, args, each_entry_i, rb_obj_class(self)); -} - -static VALUE -unlink_body(VALUE str) -{ - return rb_funcall(rb_cDir, id_unlink, 1, str); -} - -static VALUE -unlink_rescue(VALUE str, VALUE errinfo) -{ - return rb_funcall(rb_cFile, id_unlink, 1, str); -} - -/* - * Removes a file or directory, using File.unlink if +self+ is a file, or - * Dir.unlink as necessary. - */ -static VALUE -path_unlink(VALUE self) -{ - VALUE eENOTDIR = rb_const_get_at(rb_mErrno, id_ENOTDIR); - VALUE str = get_strpath(self); - return rb_rescue2(unlink_body, str, unlink_rescue, str, eENOTDIR, (VALUE)0); -} - -/* - * :call-seq: - * Pathname(path) -> pathname - * - * Creates a new Pathname object from the given string, +path+, and returns - * pathname object. - * - * In order to use this constructor, you must first require the Pathname - * standard library extension. - * - * require 'pathname' - * Pathname("/home/zzak") - * #=> # - * - * See also Pathname::new for more information. - */ -static VALUE -path_f_pathname(VALUE self, VALUE str) -{ - if (CLASS_OF(str) == rb_cPathname) - return str; - return rb_class_new_instance(1, &str, rb_cPathname); -} - -static void init_ids(void); - -/* - * - * Pathname represents the name of a file or directory on the filesystem, - * but not the file itself. - * - * The pathname depends on the Operating System: Unix, Windows, etc. - * This library works with pathnames of local OS, however non-Unix pathnames - * are supported experimentally. - * - * A Pathname can be relative or absolute. It's not until you try to - * reference the file that it even matters whether the file exists or not. - * - * Pathname is immutable. It has no method for destructive update. - * - * The goal of this class is to manipulate file path information in a neater - * way than standard Ruby provides. The examples below demonstrate the - * difference. - * - * *All* functionality from File, FileTest, and some from Dir and FileUtils is - * included, in an unsurprising way. It is essentially a facade for all of - * these, and more. - * - * == Examples - * - * === Example 1: Using Pathname - * - * require 'pathname' - * pn = Pathname.new("/usr/bin/ruby") - * size = pn.size # 27662 - * isdir = pn.directory? # false - * dir = pn.dirname # Pathname:/usr/bin - * base = pn.basename # Pathname:ruby - * dir, base = pn.split # [Pathname:/usr/bin, Pathname:ruby] - * data = pn.read - * pn.open { |f| _ } - * pn.each_line { |line| _ } - * - * === Example 2: Using standard Ruby - * - * pn = "/usr/bin/ruby" - * size = File.size(pn) # 27662 - * isdir = File.directory?(pn) # false - * dir = File.dirname(pn) # "/usr/bin" - * base = File.basename(pn) # "ruby" - * dir, base = File.split(pn) # ["/usr/bin", "ruby"] - * data = File.read(pn) - * File.open(pn) { |f| _ } - * File.foreach(pn) { |line| _ } - * - * === Example 3: Special features - * - * p1 = Pathname.new("/usr/lib") # Pathname:/usr/lib - * p2 = p1 + "ruby/1.8" # Pathname:/usr/lib/ruby/1.8 - * p3 = p1.parent # Pathname:/usr - * p4 = p2.relative_path_from(p3) # Pathname:lib/ruby/1.8 - * pwd = Pathname.pwd # Pathname:/home/gavin - * pwd.absolute? # true - * p5 = Pathname.new "." # Pathname:. - * p5 = p5 + "music/../articles" # Pathname:music/../articles - * p5.cleanpath # Pathname:articles - * p5.realpath # Pathname:/home/gavin/articles - * p5.children # [Pathname:/home/gavin/articles/linux, ...] - * - * == Breakdown of functionality - * - * === Core methods - * - * These methods are effectively manipulating a String, because that's - * all a path is. None of these access the file system except for - * #mountpoint?, #children, #each_child, #realdirpath and #realpath. - * - * - + - * - #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 - * - #birthtime - * - #ctime - * - #mtime - * - #chmod(mode) - * - #lchmod(mode) - * - #chown(owner, group) - * - #lchown(owner, group) - * - #fnmatch(pattern, *args) - * - #fnmatch?(pattern, *args) - * - #ftype - * - #make_link(old) - * - #open(*args, &block) - * - #readlink - * - #rename(to) - * - #stat - * - #lstat - * - #make_symlink(old) - * - #truncate(length) - * - #utime(atime, mtime) - * - #lutime(atime, mtime) - * - #basename(*args) - * - #dirname - * - #extname - * - #expand_path(*args) - * - #split - * - * === Directory methods - * - * These methods are a facade for Dir: - * - 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) - * - #write(*args) - * - #binwrite(*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. - */ void Init_pathname(void) { @@ -1511,91 +78,7 @@ void InitVM_pathname(void) { rb_cPathname = rb_define_class("Pathname", rb_cObject); - rb_define_method(rb_cPathname, "initialize", path_initialize, 1); - rb_define_method(rb_cPathname, "freeze", path_freeze, 0); - rb_define_method(rb_cPathname, "==", path_eq, 1); - rb_define_method(rb_cPathname, "===", path_eq, 1); - rb_define_method(rb_cPathname, "eql?", path_eq, 1); rb_define_method(rb_cPathname, "<=>", path_cmp, 1); - rb_define_method(rb_cPathname, "hash", path_hash, 0); - rb_define_method(rb_cPathname, "to_s", path_to_s, 0); - rb_define_method(rb_cPathname, "to_path", path_to_s, 0); - rb_define_method(rb_cPathname, "inspect", path_inspect, 0); - rb_define_method(rb_cPathname, "sub", path_sub, -1); - rb_define_method(rb_cPathname, "sub_ext", path_sub_ext, 1); - rb_define_method(rb_cPathname, "realpath", path_realpath, -1); - rb_define_method(rb_cPathname, "realdirpath", path_realdirpath, -1); - rb_define_method(rb_cPathname, "each_line", path_each_line, -1); - rb_define_method(rb_cPathname, "read", path_read, -1); - rb_define_method(rb_cPathname, "binread", path_binread, -1); - rb_define_method(rb_cPathname, "readlines", path_readlines, -1); - rb_define_method(rb_cPathname, "write", path_write, -1); - rb_define_method(rb_cPathname, "binwrite", path_binwrite, -1); - rb_define_method(rb_cPathname, "sysopen", path_sysopen, -1); - rb_define_method(rb_cPathname, "atime", path_atime, 0); - rb_define_method(rb_cPathname, "birthtime", path_birthtime, 0); - rb_define_method(rb_cPathname, "ctime", path_ctime, 0); - rb_define_method(rb_cPathname, "mtime", path_mtime, 0); - rb_define_method(rb_cPathname, "chmod", path_chmod, 1); - rb_define_method(rb_cPathname, "lchmod", path_lchmod, 1); - rb_define_method(rb_cPathname, "chown", path_chown, 2); - rb_define_method(rb_cPathname, "lchown", path_lchown, 2); - rb_define_method(rb_cPathname, "fnmatch", path_fnmatch, -1); - rb_define_method(rb_cPathname, "fnmatch?", path_fnmatch, -1); - rb_define_method(rb_cPathname, "ftype", path_ftype, 0); - rb_define_method(rb_cPathname, "make_link", path_make_link, 1); - rb_define_method(rb_cPathname, "open", path_open, -1); - rb_define_method(rb_cPathname, "readlink", path_readlink, 0); - rb_define_method(rb_cPathname, "rename", path_rename, 1); - rb_define_method(rb_cPathname, "stat", path_stat, 0); - rb_define_method(rb_cPathname, "lstat", path_lstat, 0); - rb_define_method(rb_cPathname, "make_symlink", path_make_symlink, 1); - rb_define_method(rb_cPathname, "truncate", path_truncate, 1); - rb_define_method(rb_cPathname, "utime", path_utime, 2); - rb_define_method(rb_cPathname, "lutime", path_lutime, 2); - rb_define_method(rb_cPathname, "basename", path_basename, -1); - rb_define_method(rb_cPathname, "dirname", path_dirname, 0); - rb_define_method(rb_cPathname, "extname", path_extname, 0); - rb_define_method(rb_cPathname, "expand_path", path_expand_path, -1); - rb_define_method(rb_cPathname, "split", path_split, 0); - rb_define_method(rb_cPathname, "blockdev?", path_blockdev_p, 0); - rb_define_method(rb_cPathname, "chardev?", path_chardev_p, 0); - rb_define_method(rb_cPathname, "executable?", path_executable_p, 0); - rb_define_method(rb_cPathname, "executable_real?", path_executable_real_p, 0); - rb_define_method(rb_cPathname, "exist?", path_exist_p, 0); - rb_define_method(rb_cPathname, "grpowned?", path_grpowned_p, 0); - rb_define_method(rb_cPathname, "directory?", path_directory_p, 0); - rb_define_method(rb_cPathname, "file?", path_file_p, 0); - rb_define_method(rb_cPathname, "pipe?", path_pipe_p, 0); - rb_define_method(rb_cPathname, "socket?", path_socket_p, 0); - rb_define_method(rb_cPathname, "owned?", path_owned_p, 0); - rb_define_method(rb_cPathname, "readable?", path_readable_p, 0); - rb_define_method(rb_cPathname, "world_readable?", path_world_readable_p, 0); - rb_define_method(rb_cPathname, "readable_real?", path_readable_real_p, 0); - rb_define_method(rb_cPathname, "setuid?", path_setuid_p, 0); - rb_define_method(rb_cPathname, "setgid?", path_setgid_p, 0); - rb_define_method(rb_cPathname, "size", path_size, 0); - rb_define_method(rb_cPathname, "size?", path_size_p, 0); - rb_define_method(rb_cPathname, "sticky?", path_sticky_p, 0); - rb_define_method(rb_cPathname, "symlink?", path_symlink_p, 0); - rb_define_method(rb_cPathname, "writable?", path_writable_p, 0); - rb_define_method(rb_cPathname, "world_writable?", path_world_writable_p, 0); - rb_define_method(rb_cPathname, "writable_real?", path_writable_real_p, 0); - rb_define_method(rb_cPathname, "zero?", path_zero_p, 0); - rb_define_method(rb_cPathname, "empty?", path_empty_p, 0); - rb_define_singleton_method(rb_cPathname, "glob", path_s_glob, -1); - rb_define_singleton_method(rb_cPathname, "getwd", path_s_getwd, 0); - rb_define_singleton_method(rb_cPathname, "pwd", path_s_getwd, 0); - rb_define_method(rb_cPathname, "glob", path_glob, -1); - rb_define_method(rb_cPathname, "entries", path_entries, 0); - rb_define_method(rb_cPathname, "mkdir", path_mkdir, -1); - rb_define_method(rb_cPathname, "rmdir", path_rmdir, 0); - rb_define_method(rb_cPathname, "opendir", path_opendir, 0); - rb_define_method(rb_cPathname, "each_entry", path_each_entry, 0); - rb_define_method(rb_cPathname, "unlink", path_unlink, 0); - rb_define_method(rb_cPathname, "delete", path_unlink, 0); - rb_undef_method(rb_cPathname, "=~"); - rb_define_global_function("Pathname", path_f_pathname, 1); } void @@ -1603,73 +86,4 @@ init_ids(void) { #undef rb_intern id_at_path = rb_intern("@path"); - id_to_path = rb_intern("to_path"); - id_ENOTDIR = rb_intern("ENOTDIR"); - id_atime = rb_intern("atime"); - id_basename = rb_intern("basename"); - id_base = rb_intern("base"); - id_binread = rb_intern("binread"); - id_binwrite = rb_intern("binwrite"); - id_birthtime = rb_intern("birthtime"); - id_blockdev_p = rb_intern("blockdev?"); - id_chardev_p = rb_intern("chardev?"); - id_chmod = rb_intern("chmod"); - id_chown = rb_intern("chown"); - id_ctime = rb_intern("ctime"); - id_directory_p = rb_intern("directory?"); - id_dirname = rb_intern("dirname"); - id_empty_p = rb_intern("empty?"); - id_entries = rb_intern("entries"); - id_executable_p = rb_intern("executable?"); - id_executable_real_p = rb_intern("executable_real?"); - id_exist_p = rb_intern("exist?"); - id_expand_path = rb_intern("expand_path"); - id_extname = rb_intern("extname"); - id_file_p = rb_intern("file?"); - id_fnmatch = rb_intern("fnmatch"); - id_foreach = rb_intern("foreach"); - id_ftype = rb_intern("ftype"); - id_getwd = rb_intern("getwd"); - id_glob = rb_intern("glob"); - id_grpowned_p = rb_intern("grpowned?"); - id_lchmod = rb_intern("lchmod"); - id_lchown = rb_intern("lchown"); - id_link = rb_intern("link"); - id_lstat = rb_intern("lstat"); - id_lutime = rb_intern("lutime"); - id_mkdir = rb_intern("mkdir"); - id_mtime = rb_intern("mtime"); - id_open = rb_intern("open"); - id_owned_p = rb_intern("owned?"); - id_pipe_p = rb_intern("pipe?"); - id_read = rb_intern("read"); - id_readable_p = rb_intern("readable?"); - id_readable_real_p = rb_intern("readable_real?"); - id_readlines = rb_intern("readlines"); - id_readlink = rb_intern("readlink"); - id_realdirpath = rb_intern("realdirpath"); - id_realpath = rb_intern("realpath"); - id_rename = rb_intern("rename"); - id_rmdir = rb_intern("rmdir"); - id_setgid_p = rb_intern("setgid?"); - id_setuid_p = rb_intern("setuid?"); - id_size = rb_intern("size"); - id_size_p = rb_intern("size?"); - id_socket_p = rb_intern("socket?"); - id_split = rb_intern("split"); - id_stat = rb_intern("stat"); - id_sticky_p = rb_intern("sticky?"); - id_sub = rb_intern("sub"); - id_symlink = rb_intern("symlink"); - id_symlink_p = rb_intern("symlink?"); - id_sysopen = rb_intern("sysopen"); - id_truncate = rb_intern("truncate"); - id_unlink = rb_intern("unlink"); - id_utime = rb_intern("utime"); - id_world_readable_p = rb_intern("world_readable?"); - id_world_writable_p = rb_intern("world_writable?"); - id_writable_p = rb_intern("writable?"); - id_writable_real_p = rb_intern("writable_real?"); - id_write = rb_intern("write"); - id_zero_p = rb_intern("zero?"); } From a15c1f5bc9c37e9ac7fd44872e2f96f4cb431237 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 22:57:05 +0200 Subject: [PATCH 05/11] Define Pathname#<=> only if the C extension is not loaded --- lib/pathname.rb | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index 9024d21..cab2a51 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -252,10 +252,12 @@ def ==(other) alias === == alias eql? == - # Provides for comparing pathnames, case-sensitively. - def <=>(other) - return nil unless Pathname === other - @path.tr('/', "\0") <=> other.to_s.tr('/', "\0") + unless method_defined?(:<=>) + # Provides for comparing pathnames, case-sensitively. + def <=>(other) + return nil unless Pathname === other + @path.tr('/', "\0") <=> other.to_s.tr('/', "\0") + end end def hash # :nodoc: From fe027aef45f9b034ff150cc4594d4872cff46be4 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 22:53:44 +0200 Subject: [PATCH 06/11] Add methods from the C extension which did not exist in pathname.rb --- lib/pathname.rb | 58 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/lib/pathname.rb b/lib/pathname.rb index cab2a51..69a95e5 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -295,6 +295,17 @@ def sub(pattern, *rest, &block) self.class.new(path) end + # Return a pathname with +repl+ added as a suffix to the basename. + # + # If self has no extension part, +repl+ is appended. + # + # Pathname.new('/usr/bin/shutdown').sub_ext('.rb') + # #=> # + def sub_ext(repl) + ext = File.extname(@path) + self.class.new(@path.chomp(ext) + repl) + end + if File::ALT_SEPARATOR SEPARATOR_LIST = "#{Regexp.quote File::ALT_SEPARATOR}#{Regexp.quote File::SEPARATOR}" SEPARATOR_PAT = /[#{SEPARATOR_LIST}]/ @@ -842,6 +853,14 @@ def readlines(...) IO.readlines(@path, ...) end # See IO.sysopen. def sysopen(*args) IO.sysopen(@path, *args) end + + # Writes +contents+ to the file. See File.write. + def write(...) IO.write(@path, ...) end + + # Writes +contents+ to the file, opening it in binary mode. + # + # See File.binwrite. + def binwrite(...) IO.binwrite(@path, ...) end end @@ -850,6 +869,12 @@ class Pathname # * File * # See File.atime. Returns last access time. def atime() File.atime(@path) end + # Returns the birth time for the file. + # If the platform doesn't have birthtime, raises NotImplementedError. + # + # See File.birthtime. + def birthtime() File.birthtime(@path) end + # See File.ctime. Returns last (directory entry, not file) change time. def ctime() File.ctime(@path) end @@ -927,6 +952,13 @@ def split() raise TypeError, 'wrong argument type nil (expected Array)' unless Array === array array.map {|f| self.class.new(f) } end + + # Returns the real (absolute) pathname for +self+ in the actual filesystem. + # + # Does not contain symlinks or useless dots, +..+ and +.+. + # + # All components of the pathname must exist when this method is called. + def realpath(*args) self.class.new(File.realpath(@path, *args)) end end @@ -938,6 +970,17 @@ def blockdev?() FileTest.blockdev?(@path) end # See FileTest.chardev?. def chardev?() FileTest.chardev?(@path) end + # Tests the file is empty. + # + # See Dir#empty? and FileTest.empty?. + def empty? + if FileTest.directory?(@path) + Dir.empty?(@path) + else + FileTest.empty?(@path) + end + end + # See FileTest.executable?. def executable?() FileTest.executable?(@path) end @@ -1016,6 +1059,21 @@ def Pathname.glob(*args, **kwargs) # :yield: pathname end end + # Returns or yields Pathname objects. + # + # Pathname("ruby-2.4.2").glob("R*.md") + # #=> [#, #] + # + # See Dir.glob. + # This method uses the +base+ keyword argument of Dir.glob. + def glob(*args, **kwargs) # :yield: pathname + if block_given? + Dir.glob(*args, **kwargs, base: @path) {|f| yield self + f } + else + Dir.glob(*args, **kwargs, base: @path).map {|f| self + f } + end + end + # 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 From 643585a7bad18f9372e939c95cf6cb995532086d Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 23:21:37 +0200 Subject: [PATCH 07/11] Use Regexp#match? instead of =~ for better performance * Avoids a MatchData allocation. --- lib/pathname.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index 69a95e5..bb3be18 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -233,7 +233,7 @@ def initialize(path) path = path.__send__(TO_PATH) if path.respond_to? TO_PATH @path = path.dup - if /\0/ =~ @path + if /\0/.match?(@path) raise ArgumentError, "pathname contains \\0: #{@path.inspect}" end end From 177a86d1f3fb2b84a71f8ad4c3701ad0c7d520ac Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Wed, 18 Jun 2025 23:55:18 +0200 Subject: [PATCH 08/11] Update the Pathname class documentation with the one in the C extension --- lib/pathname.rb | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index bb3be18..499a995 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -31,24 +31,25 @@ module ::Kernel require 'pathname.so' # -# == Pathname +# Pathname represents the name of a file or directory on the filesystem, +# but not the file itself. # -# 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. +# The pathname depends on the Operating System: Unix, Windows, etc. +# This library works with pathnames of local OS, however non-Unix pathnames +# are supported experimentally. # -# 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 +# The goal of this class is to manipulate file path information in a neater # way than standard Ruby provides. The examples below demonstrate the -# difference. *All* functionality from File, FileTest, and some from Dir and -# FileUtils is included, in an unsurprising way. It is essentially a facade for -# all of these, and more. +# 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 # @@ -96,8 +97,8 @@ module ::Kernel # === 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. +# all a path is. None of these access the file system except for +# #mountpoint?, #children, #each_child, #realdirpath and #realpath. # # - + # - #join @@ -146,6 +147,7 @@ module ::Kernel # # These methods are a facade for File: # - #atime +# - #birthtime # - #ctime # - #mtime # - #chmod(mode) @@ -164,6 +166,7 @@ module ::Kernel # - #make_symlink(old) # - #truncate(length) # - #utime(atime, mtime) +# - #lutime(atime, mtime) # - #basename(*args) # - #dirname # - #extname @@ -189,6 +192,8 @@ module ::Kernel # - #binread(*args) # - #readlines(*args) # - #sysopen(*args) +# - #write(*args) +# - #binwrite(*args) # # === Utilities # From f8e0cae2717b2fbc4857b5bc61f90d47704f77ca Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Thu, 19 Jun 2025 00:14:57 +0200 Subject: [PATCH 09/11] Handle Windows NTFS edge case in Pathname#sub_ext --- lib/pathname.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/pathname.rb b/lib/pathname.rb index 499a995..f1ecc53 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -308,6 +308,15 @@ def sub(pattern, *rest, &block) # #=> # def sub_ext(repl) ext = File.extname(@path) + + # File.extname("foo.bar:stream") returns ".bar" on NTFS and not ".bar:stream" + # (see ruby_enc_find_extname()). + # The behavior of Pathname#sub_ext is to replace everything + # from the start of the extname until the end of the path with repl. + unless @path.end_with?(ext) + ext = @path[@path.rindex(ext)..] + end + self.class.new(@path.chomp(ext) + repl) end From aa4d4c6fdf82ef7709400cffc4f1d334769f817c Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Thu, 19 Jun 2025 00:28:32 +0200 Subject: [PATCH 10/11] Optimize Pathname#initialize to avoid extra __send__ --- lib/pathname.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index f1ecc53..9e2e6db 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -235,7 +235,7 @@ class Pathname # If +path+ contains a NUL character (\0), an ArgumentError is raised. # def initialize(path) - path = path.__send__(TO_PATH) if path.respond_to? TO_PATH + path = path.to_path if path.respond_to? :to_path @path = path.dup if /\0/.match?(@path) From c96b55906b82364c0e07b27661ba4d4854f646e9 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Thu, 19 Jun 2025 00:33:18 +0200 Subject: [PATCH 11/11] Optimize Pathname#initialize to avoid extra ivar accesses --- lib/pathname.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/pathname.rb b/lib/pathname.rb index 9e2e6db..d6f27b9 100644 --- a/lib/pathname.rb +++ b/lib/pathname.rb @@ -236,11 +236,11 @@ class Pathname # def initialize(path) path = path.to_path if path.respond_to? :to_path - @path = path.dup - - if /\0/.match?(@path) - raise ArgumentError, "pathname contains \\0: #{@path.inspect}" + if /\0/.match?(path) + raise ArgumentError, "pathname contains \\0: #{path.inspect}" end + + @path = path.dup end def freeze() super; @path.freeze; self end