[GR-14873] Add support for base keyword to Dir.{[], glob}.

PullRequest: truffleruby/762

Author: nirvdrum

CHANGELOG.md

@@ -34,6 +34,7 @@ Compatibility:
 
 * Yield different number of arguments for `Hash#each` and `Hash#each_pair` based
   on the block arity like MRI (#1629).
+* Add support for the `base` keyword argument to `Dir.{[], glob}`.
 
 # 1.0 RC 14
 

lib/mri/rubygems/util.rb

@@ -121,12 +121,11 @@ def self.traverse_parents(directory, &block)
   # returning absolute paths to the matching files.
 
   def self.glob_files_in_dir(glob, base_path)
-    # TruffleRuby bug doesn't support base:, and gem tests remove RUBY_ENGINE
-    #if RUBY_VERSION >= "2.5"
-    #  Dir.glob(glob, base: base_path).map! {|f| File.expand_path(f, base_path) }
-    #else
+    if RUBY_VERSION >= "2.5"
+      Dir.glob(glob, base: base_path).map! {|f| File.expand_path(f, base_path) }
+    else
       Dir.glob(File.expand_path(glob, base_path))
-    #end
+    end
   end
 
 end

spec/tags/core/dir/element_reference_tags.txt

@@ -4,9 +4,3 @@ fails:Dir.[] matches non-dotfiles with '*'
 fails:Dir.[] matches non-dotfiles in the current directory with '**'
 fails:Dir.[] recursively matches any nondot subdirectories with '**/'
 fails:Dir.[] matches dot or non-dotfiles with '{,.}*'
-fails:Dir.[] :base option passed matches entries only from within the specified directory
-fails:Dir.[] :base option passed accepts both relative and absolute paths
-fails:Dir.[] :base option passed returns [] if specified path does not exist
-fails:Dir.[] :base option passed returns [] if specified path is a file
-fails:Dir.[] :base option passed handles '' as current directory path
-fails:Dir.[] :base option passed handles nil as current directory path

spec/tags/core/dir/glob_tags.txt

@@ -4,9 +4,3 @@ fails:Dir.glob matches non-dotfiles with '*'
 fails:Dir.glob matches non-dotfiles in the current directory with '**'
 fails:Dir.glob recursively matches any nondot subdirectories with '**/'
 fails:Dir.glob matches dot or non-dotfiles with '{,.}*'
-fails:Dir.glob :base option passed matches entries only from within the specified directory
-fails:Dir.glob :base option passed accepts both relative and absolute paths
-fails:Dir.glob :base option passed returns [] if specified path does not exist
-fails:Dir.glob :base option passed returns [] if specified path is a file
-fails:Dir.glob :base option passed handles '' as current directory path
-fails:Dir.glob :base option passed handles nil as current directory path

src/main/ruby/core/dir.rb

@@ -209,17 +209,17 @@ def home(user=nil)
       PrivateFile.expand_path("~#{user}")
     end
 
-    def [](*patterns)
+    def [](*patterns, base: nil)
       if patterns.size == 1
         pattern = Truffle::Type.coerce_to_path(patterns[0], false)
         return [] if pattern.empty?
         patterns = glob_split pattern
       end
 
-      glob patterns
+      glob patterns, base: base
     end
 
-    def glob(pattern, flags=0, &block)
+    def glob(pattern, flags=0, base: nil, &block)
       if pattern.kind_of? Array
         patterns = pattern
       else
@@ -233,10 +233,17 @@ def glob(pattern, flags=0, &block)
       matches = []
       index = 0
 
+      normalized_base = if base.nil?
+                          nil
+                        else
+                          path = Truffle::Type.coerce_to_path(base)
+                          path.empty? ? '.' : path
+                        end
+
       patterns.each do |pat|
         pat = Truffle::Type.coerce_to_path pat
         enc = Truffle::Type.ascii_compatible_encoding pat
-        Dir::Glob.glob pat, flags, matches
+        Dir::Glob.glob normalized_base, pat, flags, matches
 
         total = matches.size
         while index < total

src/main/ruby/core/dir_glob.rb

@@ -46,12 +46,7 @@ def separator
       end
 
       def path_join(parent, ent)
-        return ent unless parent
-        if parent == '/'
-          "/#{ent}"
-        else
-          "#{parent}#{separator}#{ent}"
-        end
+        Dir::Glob.path_join(parent, ent, separator)
       end
     end
 
@@ -61,12 +56,12 @@ def initialize(nxt, flags, dir)
         @dir = dir
       end
 
-      def call(matches, path)
+      def call(matches, path, glob_base_dir)
         full = path_join(path, @dir)
 
         # Don't check if full exists. It just costs us time
         # and the downstream node will be able to check properly.
-        @next.call matches, full
+        @next.call matches, full, glob_base_dir
       end
     end
 
@@ -76,31 +71,31 @@ def initialize(nxt, flags, name)
         @name = name
       end
 
-      def call(matches, parent)
+      def call(matches, parent, glob_base_dir)
         path = path_join(parent, @name)
 
-        if File.exist? path
+        if File.exist? path_join(glob_base_dir, path)
           matches << path
         end
       end
     end
 
     class RootDirectory < Node
-      def call(matches, path)
-        @next.call matches, '/'
+      def call(matches, path, glob_base_dir)
+        @next.call matches, '/', glob_base_dir
       end
     end
 
     class RecursiveDirectories < Node
-      def call(matches, start)
-        return if !start || !File.exist?(start)
+      def call(matches, start, glob_base_dir)
+        return if !start || !File.exist?(path_join(glob_base_dir, start))
 
         # Even though the recursive entry is zero width
         # in this case, its left separator is still the
         # dominant one, so we fix things up to use it.
         switched = @next.dup
         switched.separator = @separator
-        switched.call matches, start
+        switched.call matches, start, glob_base_dir
 
         stack = [start]
 
@@ -109,19 +104,19 @@ def call(matches, start)
         until stack.empty?
           path = stack.pop
           begin
-            dir = Dir.new(path)
+            dir = Dir.new(path_join(glob_base_dir, path))
           rescue Errno::ENOTDIR
             next
           end
 
           while ent = dir.read
             next if ent == '.' || ent == '..'
             full = path_join(path, ent)
-            mode = Truffle::POSIX.truffleposix_lstat_mode(full)
+            mode = Truffle::POSIX.truffleposix_lstat_mode(path_join(glob_base_dir, full))
 
             if Truffle::StatOperations.directory?(mode) and (allow_dots or ent.getbyte(0) != 46) # ?.
               stack << full
-              @next.call matches, full
+              @next.call matches, full, glob_base_dir
             end
           end
           dir.close
@@ -130,7 +125,7 @@ def call(matches, start)
     end
 
     class StartRecursiveDirectories < Node
-      def call(matches, start)
+      def call(matches, start, glob_base_dir)
         raise 'invalid usage' if start
 
         # Even though the recursive entry is zero width
@@ -139,38 +134,38 @@ def call(matches, start)
         if @separator
           switched = @next.dup
           switched.separator = @separator
-          switched.call matches, start
+          switched.call matches, start, glob_base_dir
         else
-          @next.call matches, start
+          @next.call matches, start, glob_base_dir
         end
 
         stack = []
 
         allow_dots = ((@flags & File::FNM_DOTMATCH) != 0)
 
-        dir = Dir.new('.')
+        dir = Dir.new(path_join(glob_base_dir, '.'))
         while ent = dir.read
           next if ent == '.' || ent == '..'
-          mode = Truffle::POSIX.truffleposix_lstat_mode(ent)
+          mode = Truffle::POSIX.truffleposix_lstat_mode(path_join(glob_base_dir, ent))
 
           if Truffle::StatOperations.directory?(mode) and (allow_dots or ent.getbyte(0) != 46) # ?.
             stack << ent
-            @next.call matches, ent
+            @next.call matches, ent, glob_base_dir
           end
         end
         dir.close
 
         until stack.empty?
           path = stack.pop
-          dir = Dir.new(path)
+          dir = Dir.new(path_join(glob_base_dir, path))
           while ent = dir.read
             next if ent == '.' || ent == '..'
             full = path_join(path, ent)
-            mode = Truffle::POSIX.truffleposix_lstat_mode(full)
+            mode = Truffle::POSIX.truffleposix_lstat_mode(path_join(glob_base_dir, full))
 
             if Truffle::StatOperations.directory?(mode) and ent.getbyte(0) != 46  # ?.
               stack << full
-              @next.call matches, full
+              @next.call matches, full, glob_base_dir
             end
           end
           dir.close
@@ -196,16 +191,16 @@ def initialize(nxt, flags, glob)
         @glob.gsub! '**', '*'
       end
 
-      def call(matches, path)
-        return if path and !File.exist?("#{path}/.")
+      def call(matches, path, glob_base_dir)
+        return if path and !File.exist?(path_join(glob_base_dir, "#{path}/."))
 
-        dir = Dir.new(path ? path : '.')
+        dir = Dir.new(path_join(glob_base_dir, path ? path : '.'))
         while ent = dir.read
           if match? ent
             full = path_join(path, ent)
 
-            if File.directory? full
-              @next.call matches, full
+            if File.directory? path_join(glob_base_dir, full)
+              @next.call matches, full, glob_base_dir
             end
           end
         end
@@ -214,11 +209,11 @@ def call(matches, path)
     end
 
     class EntryMatch < Match
-      def call(matches, path)
-        return if path and !File.exist?("#{path}/.")
+      def call(matches, path, glob_base_dir)
+        return if path and !File.exist?("#{path_join(glob_base_dir, path)}/.")
 
         begin
-          dir = Dir.new(path ? path : '.')
+          dir = Dir.new(path_join(glob_base_dir, path ? path : '.'))
         rescue SystemCallError
           return
         end
@@ -233,8 +228,8 @@ def call(matches, path)
     end
 
     class DirectoriesOnly < Node
-      def call(matches, path)
-        if path and File.exist?("#{path}/.")
+      def call(matches, path, glob_base_dir)
+        if path and File.exist?("#{path_join(glob_base_dir, path)}/.")
           matches << "#{path}/"
         end
       end
@@ -322,21 +317,31 @@ def self.single_compile(glob, flags=0)
       last
     end
 
-    def self.run(node, all_matches=[])
+    def self.run(node, all_matches, glob_base_dir)
       if ConstantEntry === node
-        node.call all_matches, nil
+        node.call all_matches, nil, glob_base_dir
       else
         matches = []
-        node.call matches, nil
+        node.call matches, nil, glob_base_dir
         # Truffle: ensure glob'd files are always sorted in consistent order,
         # it avoids headaches due to platform differences (OS X is sorted, Linux not).
         matches.sort!
         all_matches.concat(matches)
       end
     end
 
-    def self.glob(pattern, flags, matches=[])
-      # Rubygems uses Dir[] as a glorified File.exist?  to check for multiple
+    def self.path_join(parent, entry, separator = '/')
+      return entry unless parent
+
+      if parent == '/'
+        "/#{entry}"
+      else
+        "#{parent}#{separator}#{entry}"
+      end
+    end
+
+    def self.glob(base_dir, pattern, flags, matches)
+      # Rubygems uses Dir[] as a glorified File.exist? to check for multiple
       # extensions. So we went ahead and sped up that specific case.
 
       if flags == 0 and m = TRAILING_BRACES.match(pattern)
@@ -349,17 +354,17 @@ def self.glob(pattern, flags, matches=[])
 
           braces.split(',').each do |s|
             path = "#{stem}#{s}"
-            if File.exist? path
+            if File.exist? path_join(base_dir, path)
               matches << path
             end
           end
 
           # Split strips an empty closing part, so we need to add it back in
           if braces.getbyte(-1) == 44 # ?,
-            matches << stem if File.exist? stem
+            matches << stem if File.exist? path_join(base_dir, stem)
           end
         else
-          matches << pattern if File.exist?(pattern)
+          matches << pattern if File.exist?(path_join(base_dir, pattern))
         end
 
         return matches
@@ -370,10 +375,10 @@ def self.glob(pattern, flags, matches=[])
         patterns = compile(pattern, left_brace_index, flags)
 
         patterns.each do |node|
-          run node, matches
+          run node, matches, base_dir
         end
       elsif node = single_compile(pattern, flags)
-        run node, matches
+        run node, matches, base_dir
       else
         matches
       end