File (Class)

In: ftools.rb
Parent: Object

When you 

  require 'ftools'

then the File class aquires some utility methods for copying, moving, and deleting files, and more.

See the method descriptions below, and consider using fileutils as it is more comprehensive.

Methods

catname   chmod   cmp   compare   copy   cp   install   makedirs   mkpath   move   mv   rm_f   safe_unlink   syscopy  

Constants

BUFSIZE = 8 * 1024

External Aliases

chmod -> o_chmod

Public Class methods

catname(from, to)

If to is a valid directory, from will be appended to to, adding and escaping backslashes as necessary. Otherwise, to will be returned. Useful for appending from to to only if the filename was not specified in to.

[Source]

# File ftools.rb, line 47
  def catname(from, to)
    if FileTest.directory? to
      File.join to.sub(%([/\\]$), ''), basename(from)
    else
      to
    end
  end
chmod(mode, *files)

Changes permission bits on files to the bit pattern represented by mode. If the last parameter isn’t a String, verbose mode will be enabled. 

  File.chmod 0755, 'somecommand'
  File.chmod 0644, 'my.rb', 'your.rb', true

[Source]

# File ftools.rb, line 231
  def chmod(mode, *files)
    verbose = if files[-1].is_a? String then false else files.pop end
    $deferr.printf "chmod %04o %s\n", mode, files.join(" ") if verbose
    o_chmod mode, *files
  end
cmp(from, to, verbose = false)

Alias for compare

compare(from, to, verbose = false)

Returns true iff the contents of files from and to are identical. If verbose is true, from <=> to is printed.

[Source]

# File ftools.rb, line 133
  def compare(from, to, verbose = false)
    $deferr.print from, " <=> ", to, "\n" if verbose

    return false if stat(from).size != stat(to).size

    from = open(from, "rb")
    to = open(to, "rb")

    ret = false
    fr = tr = ''

    begin
      while fr == tr
        fr = from.read(BUFSIZE)
        if fr
          tr = to.read(fr.size)
        else
          ret = to.read(BUFSIZE)
          ret = !ret || ret.length == 0
          break
        end
      end
    rescue
      ret = false
    ensure
      to.close
      from.close
    end
    ret
  end
copy(from, to, verbose = false)

Copies a file from to to using syscopy. If to is a directory, copies from to to/from. If verbose is true, from -> to is printed.

[Source]

# File ftools.rb, line 90
  def copy(from, to, verbose = false)
    $deferr.print from, " -> ", catname(from, to), "\n" if verbose
    syscopy from, to
  end
cp(from, to, verbose = false)

Alias for copy

install(from, to, mode = nil, verbose = false)

If src is not the same as dest, copies it and changes the permission mode to mode. If dest is a directory, destination is dest/src. If mode is not set, default is used. If verbose is set to true, the name of each file copied will be printed.

[Source]

# File ftools.rb, line 244
  def install(from, to, mode = nil, verbose = false)
    to = catname(from, to)
    unless FileTest.exist? to and cmp from, to
      safe_unlink to if FileTest.exist? to
      cp from, to, verbose
      chmod mode, to, verbose if mode
    end
  end
makedirs(*dirs)

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

    File.makedirs '/usr/lib/ruby'

causes the following directories to be made, if they do not exist. 

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

You can pass several directories, each as a parameter. If the last parameter isn’t a String, verbose mode will be enabled.

[Source]

# File ftools.rb, line 198
  def makedirs(*dirs)
    verbose = if dirs[-1].is_a? String then false else dirs.pop end
#    mode = if dirs[-1].is_a? Fixnum then dirs.pop else 0755 end

    mode = 0755
    for dir in dirs
      parent = dirname(dir)
      next if parent == dir or FileTest.directory? dir
      makedirs parent unless FileTest.directory? parent
      $deferr.print "mkdir ", dir, "\n" if verbose
      if basename(dir) != ""
        begin
          Dir.mkdir dir, mode
        rescue SystemCallError
          raise unless File.directory? dir
        end
      end
    end
  end
mkpath(*dirs)

Alias for makedirs

move(from, to, verbose = false)

Moves a file from to to using syscopy. If to is a directory, copies from from to to/from. If verbose is true, from -> to is printed.

[Source]

# File ftools.rb, line 102
  def move(from, to, verbose = false)
    to = catname(from, to)
    $deferr.print from, " -> ", to, "\n" if verbose

    if RUBY_PLATFORM =~ /djgpp|(cyg|ms|bcc)win|mingw/ and FileTest.file? to
      unlink to
    end
    fstat = stat(from)
    begin
      rename from, to
    rescue
      begin
        symlink File.readlink(from), to and unlink from
      rescue
        from_stat = stat(from)
        syscopy from, to and unlink from
        utime(from_stat.atime, from_stat.mtime, to)
        begin
          chown(fstat.uid, fstat.gid, to)
        rescue
        end
      end
    end
  end
mv(from, to, verbose = false)

Alias for move

rm_f(*files)

Alias for safe_unlink

safe_unlink(*files)

Removes a list of files. Each parameter should be the name of the file to delete. If the last parameter isn’t a String, verbose mode will be enabled. Returns the number of files deleted.

[Source]

# File ftools.rb, line 171
  def safe_unlink(*files)
    verbose = if files[-1].is_a? String then false else files.pop end
    begin
      $deferr.print files.join(" "), "\n" if verbose
      chmod 0777, *files
      unlink(*files)
    rescue
#      $deferr.print "warning: Couldn't unlink #{files.join ' '}\n"

    end
  end
syscopy(from, to)

Copies a file from to to. If to is a directory, copies from to to/from.

[Source]

# File ftools.rb, line 59
  def syscopy(from, to)
    to = catname(from, to)

    fmode = stat(from).mode
    tpath = to
    not_exist = !exist?(tpath)

    from = open(from, "rb")
    to = open(to, "wb")

    begin
      while true
        to.syswrite from.sysread(BUFSIZE)
      end
    rescue EOFError
      ret = true
    rescue
      ret = false
    ensure
      to.close
      from.close
    end
    chmod(fmode, tpath) if not_exist
    ret
  end

[Validate]