fileutils 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c6c5b356b1a4609616761dd686d3fef6611d3e60bb6cef6b44c624454a2e2f
-  data.tar.gz: ec91ec1155d38977abefbfa963d6c5bdc6ebadaf22481a70f6359a4e5a3a4b6d
+  metadata.gz: 119ccdad9a61fd3b8d32a10a9737c25a71aa74c89af88793ddcd8f9dc08c7bd3
+  data.tar.gz: c84c86999eb6506a4d9b2115b1829d2820766ebbecf604aa07b8071320803e2d
 SHA512:
-  metadata.gz: 14affe38fe72bee2de39d9cf4897361ab1fcfd47a8e25f9faae47f563f283491826525a170d01e86bb3423a17cd43477daeceb1ac6c64d6dff6483cab36da702
-  data.tar.gz: 174d36e824096f64e63db03c42631d0f3511cbdf48be425cf922ddbe711956404b1b39bc8d2f7d9241d218beba4c0fca7b40d9a5bbb15b29a7980db5db10cde2
+  metadata.gz: f33cafc4d2e0b7ec187909b6ee8f6396a08cbc7216cc135062e7d8d43f72195186e97cb8b085b107f31997f36542894ab52b86f634be881b4ad3f807521b246b
+  data.tar.gz: be31fb0185c76372fed0fdb585f37e67a875dafa63497c2095f40ae791228e8c0e5cc96bf6e44870c32652a9ccfc1f3d7bacdc4244084bdfdeb93675e8264077

data/lib/fileutils.rb

@@ -181,7 +181,7 @@ end
 #
 module FileUtils
   # The version number.
-  VERSION = "1.8.0"
+  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:
   #
@@ -754,7 +783,7 @@ module FileUtils
         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 link1.size > link2.size
+        link1 = link2 if !link2.empty? and link1.size > link2.size
       end
       s = File.join(link1)
       fu_output_message [cmd, s, d].flatten.join(' ') if verbose
@@ -2037,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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fileutils
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Minero Aoki