fileutils 1.7.3 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9187fa7b726decd18c3126b2ec86e2b4dcc9c867c523563b997708c6a3ef802
-  data.tar.gz: 9b31af2775d26c335a6322a420d6fc248646e2989b563b6698fc4aee93f95863
+  metadata.gz: 119ccdad9a61fd3b8d32a10a9737c25a71aa74c89af88793ddcd8f9dc08c7bd3
+  data.tar.gz: c84c86999eb6506a4d9b2115b1829d2820766ebbecf604aa07b8071320803e2d
 SHA512:
-  metadata.gz: '0187dc049dcc1cf76967f1d3f2b436b34e3b16ad7cc5a6b03482be3937633dbd5822d3c4f1f4d34e959155efa250935d7c7f8de122ace2a1ccda47883dfdd2ef'
-  data.tar.gz: 2381eef71dc0be7c3894e43947557ef56a3c4c4d9c5d12410ca9799ef48ec869340005eaeb7e7180f0af41fc909a1078bd934b3a9c8decf95e69d2acea0d0d63
+  metadata.gz: f33cafc4d2e0b7ec187909b6ee8f6396a08cbc7216cc135062e7d8d43f72195186e97cb8b085b107f31997f36542894ab52b86f634be881b4ad3f807521b246b
+  data.tar.gz: be31fb0185c76372fed0fdb585f37e67a875dafa63497c2095f40ae791228e8c0e5cc96bf6e44870c32652a9ccfc1f3d7bacdc4244084bdfdeb93675e8264077

data/lib/fileutils.rb

@@ -181,7 +181,7 @@ end
 #
 module FileUtils
   # The version number.
-  VERSION = "1.7.3"
+  VERSION = "1.8.1"
 
   def self.private_module_function(name)   #:nodoc:
     module_function name
@@ -279,38 +279,67 @@ module FileUtils
   end
   private_module_function :remove_trailing_slash
 
+  # :markup: markdown
   #
-  # Creates directories at the paths in the given +list+
-  # (a single path or an array of paths);
-  # returns +list+ if it is an array, <tt>[list]</tt> otherwise.
+  # call-seq:
+  #   FileUtils.mkdir(*paths, mode: 0775, noop: nil, verbose: nil) -> array_of_paths or nil
   #
-  # Argument +list+ or its elements
-  # should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
+  # Argument `paths` may be one path or an array of paths;
+  # each must be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
   #
-  # With no keyword arguments, creates a directory at each +path+ in +list+
-  # by calling: <tt>Dir.mkdir(path, mode)</tt>;
-  # see {Dir.mkdir}[https://docs.ruby-lang.org/en/master/Dir.html#method-c-mkdir]:
+  # By default, creates a directory entry at each of the given `paths`;
+  # each directory has permissions `0775`;
+  # returns an array of the paths:
   #
-  #   FileUtils.mkdir(%w[tmp0 tmp1]) # => ["tmp0", "tmp1"]
-  #   FileUtils.mkdir('tmp4')        # => ["tmp4"]
+  # ```ruby
+  # FileUtils.mkdir('foo')                 # => ["foo"]
+  # FileUtils.mkdir(%w[bar baz])           # => ["bar", "baz"]
+  # File.stat(Dir.new('foo')).mode.to_s(8) # => "40775"
+  # File.stat(Dir.new('bar')).mode.to_s(8) # => "40775"
+  # File.stat(Dir.new('baz')).mode.to_s(8) # => "40775"
+  # FileUtils.rmdir(%w[foo bar baz])       # => ["foo", "bar", "baz"]
+  # ```
   #
-  # Keyword arguments:
+  # Raises an exception if for any reason a directory cannot be created;
+  # a common reason is that the directory already exists.
   #
-  # - <tt>mode: <i>mode</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
-  #   see {File.chmod}[https://docs.ruby-lang.org/en/master/File.html#method-c-chmod].
-  # - <tt>noop: true</tt> - does not create directories.
-  # - <tt>verbose: true</tt> - prints an equivalent command:
+  # With keyword argument `mode` given,
+  # creates directories with the given permissions:
   #
-  #     FileUtils.mkdir(%w[tmp0 tmp1], verbose: true)
-  #     FileUtils.mkdir(%w[tmp2 tmp3], mode: 0700, verbose: true)
+  # ```ruby
+  # FileUtils.mkdir('bar', mode: 0664)
+  # File.stat(Dir.new('bar')).mode.to_s(8) # => "40664"
+  # FileUtils.rmdir('bar')
+  # ```
   #
-  #   Output:
+  # With keyword argument `noop` given as `true`,
+  # does not create directories;
+  # returns `nil`
+  #
+  # ```ruby
+  # FileUtils.mkdir('foo', noop: true) # => nil
+  # Dir.exist?('foo')                  # => false
+  # ```
+  #
+  # With keyword argument `verbose` given as `true`,
+  # prints a shell command:
   #
-  #     mkdir tmp0 tmp1
-  #     mkdir -m 700 tmp2 tmp3
+  # ```ruby
+  # FileUtils.mkdir('foo', verbose: true)
+  # FileUtils.mkdir(%w[bar baz], mode: 0644, verbose: true)
+  # FileUtils.mkdir(%w[bar baz], mode: 0644, verbose: true, noop: true)
+  # ```
   #
-  # Raises an exception if any path points to an existing
-  # file or directory, or if for any reason a directory cannot be created.
+  # Output:
+  #
+  # ```text
+  # mkdir foo
+  # mkdir -m 644 bar baz
+  # mkdir -m 644 bar baz
+  # ```
+  #
+  # Note that in the last call above (containing `noop: true`)
+  # the existence of the directory is not checked.
   #
   # Related: FileUtils.mkdir_p.
   #
@@ -686,7 +715,7 @@ module FileUtils
   # Keyword arguments:
   #
   # - <tt>force: true</tt> - overwrites +dest+ if it exists.
-  # - <tt>relative: false</tt> - create links relative to +dest+.
+  # - <tt>relative: true</tt> - create links relative to +dest+.
   # - <tt>noop: true</tt> - does not create links.
   # - <tt>verbose: true</tt> - prints an equivalent command:
   #
@@ -706,11 +735,12 @@ module FileUtils
   #
   def ln_s(src, dest, force: nil, relative: false, target_directory: true, noop: nil, verbose: nil)
     if relative
-      return ln_sr(src, dest, force: force, noop: noop, verbose: verbose)
+      return ln_sr(src, dest, force: force, target_directory: target_directory, noop: noop, verbose: verbose)
     end
-    fu_output_message "ln -s#{force ? 'f' : ''} #{[src,dest].flatten.join ' '}" if verbose
+    fu_output_message "ln -s#{force ? 'f' : ''}#{
+      target_directory ? '' : 'T'} #{[src,dest].flatten.join ' '}" if verbose
     return if noop
-    fu_each_src_dest0(src, dest) do |s,d|
+    fu_each_src_dest0(src, dest, target_directory) do |s,d|
       remove_file d, true if force
       File.symlink s, d
     end
@@ -730,42 +760,37 @@ module FileUtils
   # Like FileUtils.ln_s, but create links relative to +dest+.
   #
   def ln_sr(src, dest, target_directory: true, force: nil, noop: nil, verbose: nil)
-    options = "#{force ? 'f' : ''}#{target_directory ? '' : 'T'}"
-    dest = File.path(dest)
-    srcs = Array(src)
-    link = proc do |s, target_dir_p = true|
-      s = File.path(s)
-      if target_dir_p
-        d = File.join(destdirs = dest, File.basename(s))
+    cmd = "ln -s#{force ? 'f' : ''}#{target_directory ? '' : 'T'}" if verbose
+    fu_each_src_dest0(src, dest, target_directory) do |s,d|
+      if target_directory
+        parent = File.dirname(d)
+        destdirs = fu_split_path(parent)
+        real_ddirs = fu_split_path(File.realpath(parent))
       else
-        destdirs = File.dirname(d = dest)
+        destdirs ||= fu_split_path(dest)
+        real_ddirs ||= fu_split_path(File.realdirpath(dest))
       end
-      destdirs = fu_split_path(File.realpath(destdirs))
-      if fu_starting_path?(s)
-        srcdirs = fu_split_path((File.realdirpath(s) rescue File.expand_path(s)))
-        base = fu_relative_components_from(srcdirs, destdirs)
-        s = File.join(*base)
+      srcdirs = fu_split_path(s)
+      i = fu_common_components(srcdirs, destdirs)
+      n = destdirs.size - i
+      n -= 1 unless target_directory
+      link1 = fu_clean_components(*Array.new([n, 0].max, '..'), *srcdirs[i..-1])
+      begin
+        real_sdirs = fu_split_path(File.realdirpath(s)) rescue nil
+      rescue
       else
-        srcdirs = fu_clean_components(*fu_split_path(s))
-        base = fu_relative_components_from(fu_split_path(Dir.pwd), destdirs)
-        while srcdirs.first&. == ".." and base.last&.!=("..") and !fu_starting_path?(base.last)
-          srcdirs.shift
-          base.pop
-        end
-        s = File.join(*base, *srcdirs)
+        i = fu_common_components(real_sdirs, real_ddirs)
+        n = real_ddirs.size - i
+        n -= 1 unless target_directory
+        link2 = fu_clean_components(*Array.new([n, 0].max, '..'), *real_sdirs[i..-1])
+        link1 = link2 if !link2.empty? and link1.size > link2.size
       end
-      fu_output_message "ln -s#{options} #{s} #{d}" if verbose
+      s = File.join(link1)
+      fu_output_message [cmd, s, d].flatten.join(' ') if verbose
       next if noop
       remove_file d, true if force
       File.symlink s, d
     end
-    case srcs.size
-    when 0
-    when 1
-      link[srcs[0], target_directory && File.directory?(dest)]
-    else
-      srcs.each(&link)
-    end
   end
   module_function :ln_sr
 
@@ -800,13 +825,13 @@ module FileUtils
   #   File.file?('dest1/dir1/t2.txt') # => true
   #   File.file?('dest1/dir1/t3.txt') # => true
   #
-  # Keyword arguments:
+  # Optional arguments:
   #
-  # - <tt>dereference_root: true</tt> - dereferences +src+ if it is a symbolic link.
-  # - <tt>remove_destination: true</tt> - removes +dest+ before creating links.
+  # - +dereference_root+ - dereferences +src+ if it is a symbolic link (+false+ by default).
+  # - +remove_destination+ - removes +dest+ before creating links (+false+ by default).
   #
   # Raises an exception if +dest+ is the path to an existing file or directory
-  # and keyword argument <tt>remove_destination: true</tt> is not given.
+  # and optional argument +remove_destination+ is not given.
   #
   # Related: FileUtils.ln (has different options).
   #
@@ -1029,12 +1054,12 @@ module FileUtils
   # directories, and symbolic links;
   # other file types (FIFO streams, device files, etc.) are not supported.
   #
-  # Keyword arguments:
+  # Optional arguments:
   #
-  # - <tt>dereference_root: true</tt> - if +src+ is a symbolic link,
-  #   follows the link.
-  # - <tt>preserve: true</tt> - preserves file times.
-  # - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
+  # - +dereference_root+ - if +src+ is a symbolic link,
+  #   follows the link (+false+ by default).
+  # - +preserve+ - preserves file times (+false+ by default).
+  # - +remove_destination+ - removes +dest+ before copying files (+false+ by default).
   #
   # Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
   #
@@ -1065,12 +1090,12 @@ module FileUtils
   #   FileUtils.copy_file('src0.txt', 'dest0.txt')
   #   File.file?('dest0.txt') # => true
   #
-  # Keyword arguments:
+  # Optional arguments:
   #
-  # - <tt>dereference: false</tt> - if +src+ is a symbolic link,
-  #   does not follow the link.
-  # - <tt>preserve: true</tt> - preserves file times.
-  # - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
+  # - +dereference+ - if +src+ is a symbolic link,
+  #   follows the link (+true+ by default).
+  # - +preserve+ - preserves file times (+false+ by default).
+  # - +remove_destination+ - removes +dest+ before copying files (+false+ by default).
   #
   # Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
   #
@@ -1491,7 +1516,8 @@ module FileUtils
   # Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
   #
   def remove_dir(path, force = false)
-    remove_entry path, force   # FIXME?? check if it is a directory
+    raise Errno::ENOTDIR, path unless force or File.directory?(path)
+    remove_entry path, force
   end
   module_function :remove_dir
 
@@ -2040,10 +2066,6 @@ module FileUtils
       def fu_windows?; false end #:nodoc:
     end
 
-    def fu_copy_stream0(src, dest, blksize = nil)   #:nodoc:
-      IO.copy_stream(src, dest)
-    end
-
     def fu_stream_blksize(*streams) #:nodoc:
       streams.each do |s|
         next unless s.respond_to?(:stat)
@@ -2475,6 +2497,10 @@ module FileUtils
 
   def fu_each_src_dest0(src, dest, target_directory = true)   #:nodoc:
     if tmp = Array.try_convert(src)
+      unless target_directory or tmp.size <= 1
+        tmp = tmp.map {|f| File.path(f)} # A workaround for RBS
+        raise ArgumentError, "extra target #{tmp}"
+      end
       tmp.each do |s|
         s = File.path(s)
         yield s, (target_directory ? File.join(dest, File.basename(s)) : dest)
@@ -2509,7 +2535,11 @@ module FileUtils
     path = File.path(path)
     list = []
     until (parent, base = File.split(path); parent == path or parent == ".")
-      list << base
+      if base != '..' and list.last == '..' and !(fu_have_symlink? && File.symlink?(path))
+        list.pop
+      else
+        list << base
+      end
       path = parent
     end
     list << path
@@ -2517,14 +2547,14 @@ module FileUtils
   end
   private_module_function :fu_split_path
 
-  def fu_relative_components_from(target, base) #:nodoc:
+  def fu_common_components(target, base) #:nodoc:
     i = 0
     while target[i]&.== base[i]
       i += 1
     end
-    Array.new(base.size-i, '..').concat(target[i..-1])
+    i
   end
-  private_module_function :fu_relative_components_from
+  private_module_function :fu_common_components
 
   def fu_clean_components(*comp) #:nodoc:
     comp.shift while comp.first == "."
@@ -2534,7 +2564,7 @@ module FileUtils
     while c = comp.shift
       if c == ".." and clean.last != ".." and !(fu_have_symlink? && File.symlink?(path))
         clean.pop
-        path.chomp!(%r((?<=\A|/)[^/]+/\z), "")
+        path.sub!(%r((?<=\A|/)[^/]+/\z), "")
       else
         clean << c
         path << c << "/"

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fileutils
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.8.1
 platform: ruby
 authors:
 - Minero Aoki
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Several file utility methods for copying, moving, removing, etc.
 email:
-- 
+-
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -29,7 +28,6 @@ licenses:
 - BSD-2-Clause
 metadata:
   source_code_uri: https://github.com/ruby/fileutils
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -44,8 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Several file utility methods for copying, moving, removing, etc.
 test_files: []