Module | FileUtils
In: | fileutils.rb

# fileutils.rb

Copyright © 2000-2005 Minero Aoki <aamine@loveruby.net>

This program is free software. You can distribute/modify this program under the same terms of ruby.

## module FileUtils

Namespace for several file utility methods for copying, moving, removing, etc.

### Module Functions

      cd(dir, options)
      cd(dir, options) {|dir| .... }
      pwd()
      mkdir(dir, options)
      mkdir(list, options)
      mkdir_p(dir, options)
      mkdir_p(list, options)
      rmdir(dir, options)
      rmdir(list, options)
      ln(old, new, options)
      ln(list, destdir, options)
      ln_s(old, new, options)
      ln_s(list, destdir, options)
      ln_sf(src, dest, options)
      cp(src, dest, options)
      cp(list, dir, options)
      cp_r(src, dest, options)
      cp_r(list, dir, options)
      mv(src, dest, options)
      mv(list, dir, options)
      rm(list, options)
      rm_r(list, options)
      rm_rf(list, options)
      install(src, dest, mode = <src's>, options)
      chmod(mode, list, options)
      chmod_R(mode, list, options)
      chown(user, group, list, options)
      chown_R(user, group, list, options)
      touch(list, options)

The `options` parameter is a hash of options, taken from the list `:force`, `:noop`, `:preserve`, and `:verbose`. `:noop` means that no changes are made. The other two are obvious. Each method documents the options that it honours.

All methods that have the concept of a "source" file or directory can take either one file or a list of files in that argument. See the method documentation for examples.

There are some `low level’ methods, which do not accept any option:

      copy_entry(src, dest, preserve = false, dereference = false)
      copy_file(src, dest, preserve = false, dereference = true)
      copy_stream(srcstream, deststream)
      remove_entry(path, force = false)
      remove_entry_secure(path, force = false)
      remove_file(path, force = false)
      compare_file(path_a, path_b)
      compare_stream(stream_a, stream_b)
      uptodate?(file, cmp_list)

## module FileUtils::Verbose

This module has all methods of FileUtils module, but it outputs messages before acting. This equates to passing the `:verbose` flag to methods in FileUtils.

## module FileUtils::NoWrite

This module has all methods of FileUtils module, but never changes files/directories. This equates to passing the `:noop` flag to methods in FileUtils.

## module FileUtils::DryRun

This module has all methods of FileUtils module, but never changes files/directories. This equates to passing the `:noop` and `:verbose` flags to methods in FileUtils.

### Methods

cd chdir chmod chmod_R chown chown_R cmp compare_file compare_stream copy copy_entry copy_file copy_stream cp cp_r fu_have_symlink? fu_world_writable? getwd identical? install link ln ln_s ln_sf makedirs mkdir mkdir_p mkpath move mv pwd remove remove_dir remove_entry remove_entry_secure remove_file rm rm_f rm_r rm_rf rmdir rmtree safe_unlink symlink touch uptodate?

### Included Modules

StreamUtils_

### Classes and Modules

Module FileUtils::DryRun
Module FileUtils::NoWrite
Module FileUtils::StreamUtils_
Module FileUtils::Verbose

### Constants

METHODS | = | singleton_methods() - ['private_module_function']

### Public Instance methods

cd(dir, options = {}) {|dir| ...}

Options: verbose

Changes the current directory to the directory `dir`.

If this method is called with block, resumes to the old working directory after the block execution finished.

      FileUtils.cd('/', :verbose => true)   # chdir and report it

[Source]

    # File fileutils.rb, line 118
      def cd(dir, options = {}, &block) # :yield: dir
        fu_check_options options, :verbose
        fu_output_message "cd #{dir}" if options[:verbose]
        Dir.chdir(dir, &block)
        fu_output_message 'cd -' if options[:verbose] and block
      end

chdir(dir, options = {})

Alias for cd

chmod(mode, list, options = {})

Options: noop verbose

Changes permission bits on the named files (in `list`) to the bit pattern represented by `mode`.

      FileUtils.chmod 0755, 'somecommand'
      FileUtils.chmod 0644, %w(my.rb your.rb his.rb her.rb)
      FileUtils.chmod 0755, '/usr/bin/ruby', :verbose => true

[Source]

    # File fileutils.rb, line 853
      def chmod(mode, list, options = {})
        fu_check_options options, :noop, :verbose
        list = fu_list(list)
        fu_output_message sprintf('chmod %o %s', mode, list.join(' ')) if options[:verbose]
        return if options[:noop]
        list.each do |path|
          Entry_.new(path).chmod mode
        end
      end

chmod_R(mode, list, options = {})

Options: noop verbose force

Changes permission bits on the named files (in `list`) to the bit pattern represented by `mode`.

      FileUtils.chmod_R 0700, "/tmp/app.#{$$}"

[Source]

    # File fileutils.rb, line 874
      def chmod_R(mode, list, options = {})
        fu_check_options options, :noop, :verbose, :force
        list = fu_list(list)
        fu_output_message sprintf('chmod -R%s %o %s',
                                  (options[:force] ? 'f' : ''),
                                  mode, list.join(' ')) if options[:verbose]
        return if options[:noop]
        list.each do |root|
          Entry_.new(root).traverse do |ent|
            begin
              ent.chmod mode
            rescue
              raise unless options[:force]
            end
          end
        end
      end

chown(user, group, list, options = {})

Options: noop verbose

Changes owner and group on the named files (in `list`) to the user `user` and the group `group`. `user` and `group` may be an ID (Integer/String) or a name (String). If `user` or `group` is nil, this method does not change the attribute.

      FileUtils.chown 'root', 'staff', '/usr/local/bin/ruby'
      FileUtils.chown nil, 'bin', Dir.glob('/usr/bin/*'), :verbose => true

[Source]

    # File fileutils.rb, line 907
      def chown(user, group, list, options = {})
        fu_check_options options, :noop, :verbose
        list = fu_list(list)
        fu_output_message sprintf('chown %s%s',
                                  [user,group].compact.join(':') + ' ',
                                  list.join(' ')) if options[:verbose]
        return if options[:noop]
        uid = fu_get_uid(user)
        gid = fu_get_gid(group)
        list.each do |path|
          Entry_.new(path).chown uid, gid
        end
      end

chown_R(user, group, list, options = {})

Options: noop verbose force

Changes owner and group on the named files (in `list`) to the user `user` and the group `group` recursively. `user` and `group` may be an ID (Integer/String) or a name (String). If `user` or `group` is nil, this method does not change the attribute.

      FileUtils.chown_R 'www', 'www', '/var/www/htdocs'
      FileUtils.chown_R 'cvs', 'cvs', '/var/cvs', :verbose => true

[Source]

    # File fileutils.rb, line 936
      def chown_R(user, group, list, options = {})
        fu_check_options options, :noop, :verbose, :force
        list = fu_list(list)
        fu_output_message sprintf('chown -R%s %s%s',
                                  (options[:force] ? 'f' : ''),
                                  [user,group].compact.join(':') + ' ',
                                  list.join(' ')) if options[:verbose]
        return if options[:noop]
        uid = fu_get_uid(user)
        gid = fu_get_gid(group)
        return unless uid or gid
        list.each do |root|
          Entry_.new(root).traverse do |ent|
            begin
              ent.chown uid, gid
            rescue
              raise unless options[:force]
            end
          end
        end
      end

cmp(a, b)

Alias for compare_file

compare_file(a, b)

Returns true if the contents of a file A and a file B are identical.

      FileUtils.compare_file('somefile', 'somefile')  #=> true
      FileUtils.compare_file('/bin/cp', '/bin/mv')    #=> maybe false

[Source]

    # File fileutils.rb, line 782
      def compare_file(a, b)
        return false unless File.size(a) == File.size(b)
        File.open(a, 'rb') {|fa|
          File.open(b, 'rb') {|fb|
            return compare_stream(fa, fb)
          }
        }
      end

compare_stream(a, b)

Returns true if the contents of a stream `a` and `b` are identical.

[Source]

    # File fileutils.rb, line 800
      def compare_stream(a, b)
        bsize = fu_stream_blksize(a, b)
        sa = sb = nil
        while sa == sb
          sa = a.read(bsize)
          sb = b.read(bsize)
          unless sa and sb
            if sa.nil? and sb.nil?
              return true
            end
          end
        end
        false
      end

copy(src, dest, options = {})

Alias for cp

copy_entry(src, dest, preserve = false, dereference_root = false)

Copies a file system entry `src` to `dest`. If `src` is a directory, this method copies its contents recursively. This method preserves file types, c.f. symlink, directory… (FIFO, device files and etc. are not supported yet)

Both of `src` and `dest` must be a path name. `src` must exist, `dest` must not exist.

If `preserve` is true, this method preserves owner, group, permissions and modified time.

If `dereference_root` is true, this method dereference tree root.

[Source]

    # File fileutils.rb, line 444
      def copy_entry(src, dest, preserve = false, dereference_root = false)
        Entry_.new(src, nil, dereference_root).traverse do |ent|
          destent = Entry_.new(dest, ent.rel, false)
          ent.copy destent.path
          ent.copy_metadata destent.path if preserve
        end
      end

copy_file(src, dest, preserve = false, dereference = true)

Copies file contents of `src` to `dest`. Both of `src` and `dest` must be a path name.

[Source]

    # File fileutils.rb, line 457
      def copy_file(src, dest, preserve = false, dereference = true)
        ent = Entry_.new(src, nil, dereference)
        ent.copy_file dest
        ent.copy_metadata dest if preserve
      end

copy_stream(src, dest)

Copies stream `src` to `dest`. `src` must respond to read(n) and `dest` must respond to write(str).

[Source]

    # File fileutils.rb, line 469
      def copy_stream(src, dest)
        fu_copy_stream0 src, dest, fu_stream_blksize(src, dest)
      end

cp(src, dest, options = {})

Options: preserve noop verbose

Copies a file content `src` to `dest`. If `dest` is a directory, copies `src` to +dest/src+.

If `src` is a list of files, then `dest` must be a directory.

      FileUtils.cp 'eval.c', 'eval.c.org'
      FileUtils.cp %w(cgi.rb complex.rb date.rb), '/usr/lib/ruby/1.6'
      FileUtils.cp %w(cgi.rb complex.rb date.rb), '/usr/lib/ruby/1.6', :verbose => true
      FileUtils.cp 'symlink', 'dest'   # copy content, "dest" is not a symlink

[Source]

    # File fileutils.rb, line 378
      def cp(src, dest, options = {})
        fu_check_options options, :preserve, :noop, :verbose
        fu_output_message "cp#{options[:preserve] ? ' -p' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
        return if options[:noop]
        fu_each_src_dest(src, dest) do |s, d|
          copy_file s, d, options[:preserve]
        end
      end

cp_r(src, dest, options = {})

Options: preserve noop verbose dereference_root

Copies `src` to `dest`. If `src` is a directory, this method copies all its contents recursively. If `dest` is a directory, copies `src` to +dest/src+.

`src` can be a list of files.

      # Installing ruby library "mylib" under the site_ruby
      FileUtils.rm_r site_ruby + '/mylib', :force
      FileUtils.cp_r 'lib/', site_ruby + '/mylib'

      # Examples of copying several files to target directory.
      FileUtils.cp_r %w(mail.rb field.rb debug/), site_ruby + '/tmail'
      FileUtils.cp_r Dir.glob('*.rb'), '/home/aamine/lib/ruby', :noop => true, :verbose => true

      # If you want to copy all contents of a directory instead of the
      # directory itself, c.f. src/x -> dest/x, src/y -> dest/y,
      # use following code.
      FileUtils.cp_r 'src/.', 'dest'     # cp_r('src', 'dest') makes src/dest,
                                         # but this doesn't.

[Source]

    # File fileutils.rb, line 417
      def cp_r(src, dest, options = {})
        fu_check_options options, :preserve, :noop, :verbose, :dereference_root
        fu_output_message "cp -r#{options[:preserve] ? 'p' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
        return if options[:noop]
        options[:dereference_root] = true unless options.key?(:dereference_root)
        fu_each_src_dest(src, dest) do |s, d|
          copy_entry s, d, options[:preserve], options[:dereference_root]
        end
      end

fu_have_symlink?(

[Source]

    # File fileutils.rb, line 722
      def fu_have_symlink?   #:nodoc
        File.symlink nil, nil
      rescue NotImplementedError
        return false
      rescue
        return true
      end

fu_world_writable?(st)

[Source]

    # File fileutils.rb, line 718
      def fu_world_writable?(st)
        (st.mode & 0002) != 0
      end

getwd()

Alias for pwd

identical?(a, b)

Alias for compare_file

install(src, dest, options = {})

Options: mode noop verbose

If `src` is not same as `dest`, copies it and changes the permission mode to `mode`. If `dest` is a directory, destination is `dest`/`src`.

      FileUtils.install 'ruby', '/usr/local/bin/ruby', :mode => 0755, :verbose => true
      FileUtils.install 'lib.rb', '/usr/local/lib/ruby/site_ruby', :verbose => true

[Source]

    # File fileutils.rb, line 825
      def install(src, dest, options = {})
        fu_check_options options, :mode, :preserve, :noop, :verbose
        fu_output_message "install -c#{options[:preserve] && ' -p'}#{options[:mode] ? (' -m 0%o' % options[:mode]) : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
        return if options[:noop]
        fu_each_src_dest(src, dest) do |s, d|
          unless File.exist?(d) and compare_file(s, d)
            remove_file d, true
            st = File.stat(s) if options[:preserve]
            copy_file s, d
            File.utime st.atime, st.mtime, d if options[:preserve]
            File.chmod options[:mode], d if options[:mode]
          end
        end
      end

link(src, dest, options = {})

Alias for ln

ln(src, dest, options = {})

Options: force noop verbose

`ln(old, new, options = {})`

Creates a hard link `new` which points to `old`. If `new` already exists and it is a directory, creates a symbolic link +new/old+. If `new` already exists and it is not a directory, raises Errno::EEXIST. But if :force option is set, overwrite `new`.

      FileUtils.ln 'gcc', 'cc', :verbose => true
      FileUtils.ln '/usr/bin/emacs21', '/usr/bin/emacs'

`ln(list, destdir, options = {})`

Creates several hard links in a directory, with each one pointing to the item in `list`. If `destdir` is not a directory, raises Errno::ENOTDIR.

      include FileUtils
      cd '/sbin'
      FileUtils.ln %w(cp mv mkdir), '/bin'   # Now /sbin/cp and /bin/cp are linked.

[Source]

    # File fileutils.rb, line 293
      def ln(src, dest, options = {})
        fu_check_options options, :force, :noop, :verbose
        fu_output_message "ln#{options[:force] ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
        return if options[:noop]
        fu_each_src_dest0(src, dest) do |s,d|
          remove_file d, true if options[:force]
          File.link s, d
        end
      end

ln_s(src, dest, options = {})

Options: force noop verbose

`ln_s(old, new, options = {})`

Creates a symbolic link `new` which points to `old`. If `new` already exists and it is a directory, creates a symbolic link +new/old+. If `new` already exists and it is not a directory, raises Errno::EEXIST. But if :force option is set, overwrite `new`.

      FileUtils.ln_s '/usr/bin/ruby', '/usr/local/bin/ruby'
      FileUtils.ln_s 'verylongsourcefilename.c', 'c', :force => true

`ln_s(list, destdir, options = {})`

Creates several symbolic links in a directory, with each one pointing to the item in `list`. If `destdir` is not a directory, raises Errno::ENOTDIR.

If `destdir` is not a directory, raises Errno::ENOTDIR.

      FileUtils.ln_s Dir.glob('bin/*.rb'), '/home/aamine/bin'

[Source]

    # File fileutils.rb, line 332
      def ln_s(src, dest, options = {})
        fu_check_options options, :force, :noop, :verbose
        fu_output_message "ln -s#{options[:force] ? 'f' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
        return if options[:noop]
        fu_each_src_dest0(src, dest) do |s,d|
          remove_file d, true if options[:force]
          File.symlink s, d
        end
      end

ln_sf(src, dest, options = {})

Options: noop verbose

Same as

      #ln_s(src, dest, :force)

[Source]

    # File fileutils.rb, line 355
      def ln_sf(src, dest, options = {})
        fu_check_options options, :noop, :verbose
        options = options.dup
        options[:force] = true
        ln_s src, dest, options
      end

makedirs(list, options = {})

Alias for mkdir_p

mkdir(list, options = {})

Options: mode noop verbose

Creates one or more directories.

      FileUtils.mkdir 'test'
      FileUtils.mkdir %w( tmp data )
      FileUtils.mkdir 'notexist', :noop => true  # Does not really create.
      FileUtils.mkdir 'tmp', :mode => 0700

[Source]

    # File fileutils.rb, line 165
      def mkdir(list, options = {})
        fu_check_options options, :mode, :noop, :verbose
        list = fu_list(list)
        fu_output_message "mkdir #{options[:mode] ? ('-m %03o ' % options[:mode]) : ''}#{list.join ' '}" if options[:verbose]
        return if options[:noop]

        list.each do |dir|
          fu_mkdir dir, options[:mode]
        end
      end

mkdir_p(list, options = {})

Options: mode noop verbose

Creates a directory and all its parent directories. For example,

      FileUtils.mkdir_p '/usr/local/lib/ruby'

causes to make following directories, if it does not exist.

        * /usr
        * /usr/local
        * /usr/local/lib
        * /usr/local/lib/ruby

You can pass several directories at a time in a list.

[Source]

    # File fileutils.rb, line 195
      def mkdir_p(list, options = {})
        fu_check_options options, :mode, :noop, :verbose
        list = fu_list(list)
        fu_output_message "mkdir -p #{options[:mode] ? ('-m %03o ' % options[:mode]) : ''}#{list.join ' '}" if options[:verbose]
        return *list if options[:noop]

        list.map {|path| path.sub(%r</\z>, '') }.each do |path|
          # optimize for the most common case
          begin
            fu_mkdir path, options[:mode]
            next
          rescue SystemCallError
            next if File.directory?(path)
          end

          stack = []
          until path == stack.last   # dirname("/")=="/", dirname("C:/")=="C:/"
            stack.push path
            path = File.dirname(path)
          end
          stack.reverse_each do |path|
            begin
              fu_mkdir path, options[:mode]
            rescue SystemCallError => err
              raise unless File.directory?(path)
            end
          end
        end

        return *list
      end

mkpath(list, options = {})

Alias for mkdir_p

move(src, dest, options = {})

Alias for mv

mv(src, dest, options = {})

Options: force noop verbose

Moves file(s) `src` to `dest`. If `file` and `dest` exist on the different disk partition, the file is copied instead.

      FileUtils.mv 'badname.rb', 'goodname.rb'
      FileUtils.mv 'stuff.rb', '/notexist/lib/ruby', :force => true  # no error

      FileUtils.mv %w(junk.txt dust.txt), '/home/aamine/.trash/'
      FileUtils.mv Dir.glob('test*.rb'), 'test', :noop => true, :verbose => true

[Source]

    # File fileutils.rb, line 486
      def mv(src, dest, options = {})
        fu_check_options options, :force, :noop, :verbose
        fu_output_message "mv#{options[:force] ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
        return if options[:noop]
        fu_each_src_dest(src, dest) do |s, d|
          destent = Entry_.new(d, nil, true)
          begin
            if destent.exist?
              if destent.directory?
                raise Errno::EEXIST, dest
              else
                destent.remove_file if rename_cannot_overwrite_file?
              end
            end
            begin
              File.rename s, d
            rescue Errno::EXDEV
              copy_entry s, d, true
            end
          rescue SystemCallError
            raise unless options[:force]
          end
        end
      end

pwd()

Options: (none)

Returns the name of the current directory.

[Source]

    # File fileutils.rb, line 100
      def pwd
        Dir.pwd
      end

remove(list, options = {})

Alias for rm

remove_dir(path, force = false)

Removes a directory `dir` and its contents recursively. This method ignores StandardError if `force` is true.

[Source]

    # File fileutils.rb, line 771
      def remove_dir(path, force = false)
        remove_entry path, force   # FIXME?? check if it is a directory
      end

remove_entry(path, force = false)

This method removes a file system entry `path`. `path` might be a regular file, a directory, or something. If `path` is a directory, remove it recursively.

See also remove_entry_secure.

[Source]

    # File fileutils.rb, line 743
      def remove_entry(path, force = false)
        Entry_.new(path).postorder_traverse do |ent|
          begin
            ent.remove
          rescue
            raise unless force
          end
        end
      rescue
        raise unless force
      end

remove_entry_secure(path, force = false)

This method removes a file system entry `path`. `path` shall be a regular file, a directory, or something. If `path` is a directory, remove it recursively. This method is required to avoid TOCTTOU (time-of-check-to-time-of-use) local security vulnerability of rm_r. rm_r causes security hole when:

      * Parent directory is world writable (including /tmp).
      * Removing directory tree includes world writable directory.
      * The system has symbolic link.

To avoid this security hole, this method applies special preprocess. If `path` is a directory, this method chown(2) and chmod(2) all removing directories. This requires the current process is the owner of the removing whole directory tree, or is the super user (root).

WARNING: You must ensure that ALL parent directories are not world writable. Otherwise this method does not work. Only exception is temporary directory like /tmp and /var/tmp, whose permission is 1777.

WARNING: Only the owner of the removing directory tree, or Unix super user (root) should invoke this method. Otherwise this method does not work.

For details of this security vulnerability, see Perl’s case:

      http://www.cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2005-0448
      http://www.cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2004-0452

For fileutils.rb, this vulnerability is reported in [ruby-dev:26100].

[Source]

    # File fileutils.rb, line 667
      def remove_entry_secure(path, force = false)
        unless fu_have_symlink?
          remove_entry path, force
          return
        end
        fullpath = File.expand_path(path)
        st = File.lstat(fullpath)
        unless st.directory?
          File.unlink fullpath
          return
        end
        # is a directory.
        parent_st = File.stat(File.dirname(fullpath))
        unless fu_world_writable?(parent_st)
          remove_entry path, force
          return
        end
        unless parent_st.sticky?
          raise ArgumentError, "parent directory is world writable, FileUtils#remove_entry_secure does not work; abort: #{path.inspect} (parent directory mode #{'%o' % parent_st.mode})"
        end
        # freeze tree root
        euid = Process.euid
        File.open(fullpath + '/.') {|f|
          unless fu_stat_identical_entry?(st, f.stat)
            # symlink (TOC-to-TOU attack?)
            File.unlink fullpath
            return
          end
          f.chown euid, -1
          f.chmod 0700
        }
        # ---- tree root is frozen ----
        root = Entry_.new(path)
        root.preorder_traverse do |ent|
          if ent.directory?
            ent.chown euid, -1
            ent.chmod 0700
          end
        end
        root.postorder_traverse do |ent|
          begin
            ent.remove
          rescue
            raise unless force
          end
        end
      rescue
        raise unless force
      end

remove_file(path, force = false)

Removes a file `path`. This method ignores StandardError if `force` is true.

[Source]

    # File fileutils.rb, line 760
      def remove_file(path, force = false)
        Entry_.new(path).remove_file
      rescue
        raise unless force
      end

rm(list, options = {})

Options: force noop verbose

Remove file(s) specified in `list`. This method cannot remove directories. All StandardErrors are ignored when the :force option is set.

      FileUtils.rm %w( junk.txt dust.txt )
      FileUtils.rm Dir.glob('*.so')
      FileUtils.rm 'NotExistFile', :force => true   # never raises exception

[Source]

    # File fileutils.rb, line 533
      def rm(list, options = {})
        fu_check_options options, :force, :noop, :verbose
        list = fu_list(list)
        fu_output_message "rm#{options[:force] ? ' -f' : ''} #{list.join ' '}" if options[:verbose]
        return if options[:noop]

        list.each do |path|
          remove_file path, options[:force]
        end
      end

rm_f(list, options = {})

Options: noop verbose

Equivalent to

      #rm(list, :force => true)

[Source]

    # File fileutils.rb, line 558
      def rm_f(list, options = {})
        fu_check_options options, :noop, :verbose
        options = options.dup
        options[:force] = true
        rm list, options
      end

rm_r(list, options = {})

Options: force noop verbose secure

remove files `list`[0] `list`[1]… If `list`[n] is a directory, removes its all contents recursively. This method ignores StandardError when :force option is set.

      FileUtils.rm_r Dir.glob('/tmp/*')
      FileUtils.rm_r '/', :force => true          #  :-)

WARNING: This method causes local vulnerability if one of parent directories or removing directory tree are world writable (including /tmp, whose permission is 1777), and the current process has strong privilege such as Unix super user (root), and the system has symbolic link. For secure removing, read the documentation of remove_entry_secure carefully, and set :secure option to true. Default is :secure=>false.

NOTE: This method calls remove_entry_secure if :secure option is set. See also remove_entry_secure.

[Source]

    # File fileutils.rb, line 593
      def rm_r(list, options = {})
        fu_check_options options, :force, :noop, :verbose, :secure
        # options[:secure] = true unless options.key?(:secure)
        list = fu_list(list)
        fu_output_message "rm -r#{options[:force] ? 'f' : ''} #{list.join ' '}" if options[:verbose]
        return if options[:noop]
        list.each do |path|
          if options[:secure]
            remove_entry_secure path, options[:force]
          else
            remove_entry path, options[:force]
          end
        end
      end

rm_rf(list, options = {})

Options: noop verbose secure

Equivalent to

      #rm_r(list, :force => true)

WARNING: This method causes local vulnerability. Read the documentation of rm_r first.

[Source]

    # File fileutils.rb, line 621
      def rm_rf(list, options = {})
        fu_check_options options, :noop, :verbose, :secure
        options = options.dup
        options[:force] = true
        rm_r list, options
      end

rmdir(list, options = {})

Options: noop, verbose

Removes one or more directories.

      FileUtils.rmdir 'somedir'
      FileUtils.rmdir %w(somedir anydir otherdir)
      # Does not really remove directory; outputs message.
      FileUtils.rmdir 'somedir', :verbose => true, :noop => true

[Source]

    # File fileutils.rb, line 258
      def rmdir(list, options = {})
        fu_check_options options, :noop, :verbose
        list = fu_list(list)
        fu_output_message "rmdir #{list.join ' '}" if options[:verbose]
        return if options[:noop]
        list.each do |dir|
          Dir.rmdir dir.sub(%r</\z>, '')
        end
      end

rmtree(list, options = {})

Alias for rm_rf

safe_unlink(list, options = {})

Alias for rm_f

symlink(src, dest, options = {})

Alias for ln_s

touch(list, options = {})

Options: noop verbose

Updates modification time (mtime) and access time (atime) of file(s) in `list`. Files are created if they don’t exist.

      FileUtils.touch 'timestamp'
      FileUtils.touch Dir.glob('*.c');  system 'make'

[Source]

    # File fileutils.rb, line 1006
      def touch(list, options = {})
        fu_check_options options, :noop, :verbose
        list = fu_list(list)
        fu_output_message "touch #{list.join ' '}" if options[:verbose]
        return if options[:noop]
        t = Time.now
        list.each do |path|
          begin
            File.utime(t, t, path)
          rescue Errno::ENOENT
            File.open(path, 'a') {
              ;
            }
          end
        end
      end

uptodate?(new, old_list, options = nil)

Options: (none)

Returns true if `newer` is newer than all `old_list`. Non-existent files are older than any file.

      FileUtils.uptodate?('hello.o', %w(hello.c hello.h)) or    #       system 'make hello.o'

[Source]

    # File fileutils.rb, line 141
      def uptodate?(new, old_list, options = nil)
        raise ArgumentError, 'uptodate? does not accept any option' if options

        return false unless File.exist?(new)
        new_time = File.mtime(new)
        old_list.each do |old|
          if File.exist?(old)
            return false unless new_time > File.mtime(old)
          end
        end
        true
      end

[Validate]