fileutils.rb

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.

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

  Bundler::FileUtils.cd('/') do  # chdir
    # ...               # do something
  end                   # return to original directory

Alias for cd

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

mode is the symbolic and absolute mode can be used.

Absolute mode is

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

Symbolic mode is

  Bundler::FileUtils.chmod "u=wrx,go=rx", 'somecommand'
  Bundler::FileUtils.chmod "u=wr,go=rr", %w(my.rb your.rb his.rb her.rb)
  Bundler::FileUtils.chmod "u=wrx,go=rx", '/usr/bin/ruby', :verbose => true

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

  Bundler::FileUtils.chmod_R 0700, "/tmp/app.#{$$}"
  Bundler::FileUtils.chmod_R "u=wrx", "/tmp/app.#{$$}"

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.

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

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.

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

Alias for compare_file

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

  Bundler::FileUtils.compare_file('somefile', 'somefile')       #=> true
  Bundler::FileUtils.compare_file('/dev/null', '/dev/urandom')  #=> false

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

Alias for cp

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, and modified time. Permissions are copied regardless preserve.

If dereference_root is true, this method dereference tree root.

If remove_destination is true, this method removes each destination file before copy.

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

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

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.

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

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
  Bundler::FileUtils.rm_r site_ruby + '/mylib', :force
  Bundler::FileUtils.cp_r 'lib/', site_ruby + '/mylib'

  # Examples of copying several files to target directory.
  Bundler::FileUtils.cp_r %w(mail.rb field.rb debug/), site_ruby + '/tmail'
  Bundler::FileUtils.cp_r Dir.glob('*.rb'), '/home/foo/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.
  Bundler::FileUtils.cp_r 'src/.', 'dest'     # cp_r('src', 'dest') makes dest/src,
                                     # but this doesn't.

Alias for pwd

Alias for compare_file

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. This method removes destination before copy.

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

Alias for ln

In the first form, creates a hard link link which points to target. If link already exists, raises Errno::EEXIST. But if the :force option is set, overwrites link.

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

In the second form, creates a link +dir/target+ pointing to target. In the third form, creates several hard links in the directory dir, pointing to each item in targets. If dir is not a directory, raises Errno::ENOTDIR.

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

In the first form, creates a symbolic link link which points to target. If link already exists, raises Errno::EEXIST. But if the :force option is set, overwrites link.

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

In the second form, creates a link +dir/target+ pointing to target. In the third form, creates several symbolic links in the directory dir, pointing to each item in targets. If dir is not a directory, raises Errno::ENOTDIR.

  Bundler::FileUtils.ln_s Dir.glob('/bin/*.rb'), '/home/foo/bin'

Same as

  Bundler::FileUtils.ln_s(*args, force: true)

Alias for mkdir_p

Creates one or more directories.

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

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

  Bundler::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.

Alias for mkdir_p

Alias for mv

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

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

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

Returns the name of the current directory.

Alias for rm

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

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.

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 cannot be moved by other untrusted users. For example, parent directories should not be owned by untrusted users, and should not be world writable except when the sticky bit set.

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:

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

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

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

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

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

Equivalent to

  Bundler::FileUtils.rm(list, :force => true)

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.

  Bundler::FileUtils.rm_r Dir.glob('/tmp/*')
  Bundler::FileUtils.rm_r 'some_dir', :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.

Equivalent to

  Bundler::FileUtils.rm_r(list, :force => true)

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

Removes one or more directories.

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

Alias for rm_rf

Alias for rm_f

Alias for ln_s

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

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

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

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