Class Tempfile
In: lib/tempfile.rb
Parent: DelegateClass(File)

A class for managing temporary files. This library is written to be thread safe.

Methods

close   close!   delete   length   new   open   open   path   size   unlink  

Constants

MAX_TRY = 10

Public Class methods

Creates a temporary file of mode 0600 in the temporary directory, opens it with mode "w+", and returns a Tempfile object which represents the created temporary file. A Tempfile object can be treated just like a normal File object.

The basename parameter is used to determine the name of a temporary file. If an Array is given, the first element is used as prefix string and the second as suffix string, respectively. Otherwise it is treated as prefix string.

If tmpdir is omitted, the temporary directory is determined by Dir::tmpdir provided by ‘tmpdir.rb’. When $SAFE > 0 and the given tmpdir is tainted, it uses /tmp. (Note that ENV values are tainted by default)

[Source]

# File lib/tempfile.rb, line 30
  def initialize(basename, tmpdir=Dir::tmpdir)
    if $SAFE > 0 and tmpdir.tainted?
      tmpdir = '/tmp'
    end

    lock = nil
    n = failure = 0
    
    begin
      Thread.critical = true

      begin
        tmpname = File.join(tmpdir, make_tmpname(basename, n))
        lock = tmpname + '.lock'
        n += 1
      end while @@cleanlist.include?(tmpname) or
        File.exist?(lock) or File.exist?(tmpname)

      Dir.mkdir(lock)
    rescue
      failure += 1
      retry if failure < MAX_TRY
      raise "cannot generate tempfile `%s'" % tmpname
    ensure
      Thread.critical = false
    end

    @data = [tmpname]
    @clean_proc = Tempfile.callback(@data)
    ObjectSpace.define_finalizer(self, @clean_proc)

    @tmpfile = File.open(tmpname, File::RDWR|File::CREAT|File::EXCL, 0600)
    @tmpname = tmpname
    @@cleanlist << @tmpname
    @data[1] = @tmpfile
    @data[2] = @@cleanlist

    super(@tmpfile)

    # Now we have all the File/IO methods defined, you must not
    # carelessly put bare puts(), etc. after this.

    Dir.rmdir(lock)
  end

If no block is given, this is a synonym for new().

If a block is given, it will be passed tempfile as an argument, and the tempfile will automatically be closed when the block terminates. In this case, open() returns nil.

[Source]

# File lib/tempfile.rb, line 183
    def open(*args)
      tempfile = new(*args)

      if block_given?
        begin
          yield(tempfile)
        ensure
          tempfile.close
        end

        nil
      else
        tempfile
      end
    end

Public Instance methods

Closes the file. If the optional flag is true, unlinks the file after closing.

If you don‘t explicitly unlink the temporary file, the removal will be delayed until the object is finalized.

[Source]

# File lib/tempfile.rb, line 108
  def close(unlink_now=false)
    if unlink_now
      close!
    else
      _close
    end
  end

Closes and unlinks the file.

[Source]

# File lib/tempfile.rb, line 117
  def close!
    _close
    @clean_proc.call
    ObjectSpace.undefine_finalizer(self)
    @data = @tmpname = nil
  end
delete()

Alias for unlink

length()

Alias for size

Opens or reopens the file with mode "r+".

[Source]

# File lib/tempfile.rb, line 89
  def open
    @tmpfile.close if @tmpfile
    @tmpfile = File.open(@tmpname, 'r+')
    @data[1] = @tmpfile
    __setobj__(@tmpfile)
  end

Returns the full path name of the temporary file.

[Source]

# File lib/tempfile.rb, line 142
  def path
    @tmpname
  end

Returns the size of the temporary file. As a side effect, the IO buffer is flushed before determining the size.

[Source]

# File lib/tempfile.rb, line 148
  def size
    if @tmpfile
      @tmpfile.flush
      @tmpfile.stat.size
    else
      0
    end
  end

Unlinks the file. On UNIX-like systems, it is often a good idea to unlink a temporary file immediately after creating and opening it, because it leaves other programs zero chance to access the file.

[Source]

# File lib/tempfile.rb, line 128
  def unlink
    # keep this order for thread safeness
    begin
      File.unlink(@tmpname) if File.exist?(@tmpname)
      @@cleanlist.delete(@tmpname)
      @data = @tmpname = nil
      ObjectSpace.undefine_finalizer(self)
    rescue Errno::EACCES
      # may not be able to unlink on Windows; just ignore
    end
  end

[Validate]