класс Tempfile

# File lib/tempfile.rb, line 327
def Tempfile.create(basename="", tmpdir=nil, mode: 0, **options)
  tmpfile = nil
  Dir::Tmpname.create(basename, tmpdir, options) do |tmpname, n, opts|
    mode |= File::RDWR|File::CREAT|File::EXCL
    opts[:perm] = 0600
    tmpfile = File.open(tmpname, mode, opts)
  end
  if block_given?
    begin
      yield tmpfile
    ensure
      unless tmpfile.closed?
        if File.identical?(tmpfile, tmpfile.path)
          unlinked = File.unlink tmpfile.path rescue nil
        end
        tmpfile.close
      end
      unless unlinked
        begin
          File.unlink tmpfile.path
        rescue Errno::ENOENT
        end
      end
    end
  else
    tmpfile
  end
end

Создаёт временный файл обычным образом, как объект File (а не Tempfile). Он не использует финализаторы и делегирование.

Если блок не задан, это аналогично Tempfile.new, за исключением создания объекта File вместо Tempfile. Созданный файл не удаляется автоматически. Для его удаления следует использовать File.unlink.

Если блок задан, то будет создан объект File, и блок будет вызван с этим объектом в качестве аргумента. Объект File будет автоматически закрыт, а временный файл удалён после завершения блока. Вызов вернёт значение блока.

В любом случае все аргументы (basename, tmpdir, mode, и **options) будут обработаны как в Tempfile.new.

Tempfile.create('foo', '/home/temp') do |f|
   # ... do something with f ...
end

# File lib/tempfile.rb, line 126
def initialize(basename="", tmpdir=nil, mode: 0, **options)
  warn "Tempfile.new doesn't call the given block.", uplevel: 1 if block_given?

  @unlinked = false
  @mode = mode|File::RDWR|File::CREAT|File::EXCL
  ::Dir::Tmpname.create(basename, tmpdir, options) do |tmpname, n, opts|
    opts[:perm] = 0600
    @tmpfile = File.open(tmpname, @mode, opts)
    @opts = opts.freeze
  end
  ObjectSpace.define_finalizer(self, Remover.new(@tmpfile))

  super(@tmpfile)
end

Создаёт временный файл с разрешениями 0600 (= только чтение и запись владельцем) и открывает его в режиме “w+”.

Параметр basename используется для определения имени временного файла. Можно передать строку String или массив Array из 2 элементов-строк String. В первом случае имя временного файла начнется с переданной строки. Во втором случае - с первого элемента массива и закончится вторым элементом. Например:

file = Tempfile.new('hello')
file.path  # => something like: "/tmp/hello2843-8392-92849382--0"

# Use the Array form to enforce an extension in the filename:
file = Tempfile.new(['hello', '.jpg'])
file.path  # => something like: "/tmp/hello2843-8392-92849382--0.jpg"

Временный файл будет помещён в директорию, указанную параметром tmpdir. По умолчанию это Dir.tmpdir. Если $SAFE > 0 и переданный tmpdir содержит ненадёжные данные, используется '/tmp' в качестве временного каталога. Обратите внимание, что значения ENV по умолчанию содержат ненадёжные данные, и возвращаемое значение Dir.tmpdir может быть получено из переменных окружения (например, $TMPDIR).

file = Tempfile.new('hello', '/home/aisaka')
file.path  # => something like: "/home/aisaka/hello2843-8392-92849382--0"

Также можно передать хэш опций. Под капотом, Tempfile создаёт временный файл, используя File.open. Эти опции будут переданы в File.open. Это полезно в основном для указания кодировочных опций, например:

Tempfile.new('hello', '/home/aisaka', encoding: 'ascii-8bit')

# You can also omit the 'tmpdir' parameter:
Tempfile.new('hello', encoding: 'ascii-8bit')

Примечание: ключевой аргумент mode, как принимаемый Tempfile, может быть только числовым, комбинацией режимов, определённых в File::Constants.

Исключения

Если Tempfile.new не может найти уникальное имя файла за ограниченное число попыток, то он сгенерирует исключение.

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

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

Создаёт новый Tempfile.

Если блок не задан, это синоним Tempfile.new.

Если блок задан, то будет создан объект Tempfile, и блок будет выполнен с данным объектом в качестве аргумента. Объект Tempfile будет автоматически закрыт после завершения блока. Вызов вернёт значение блока.

В любом случае все аргументы (*args) будут переданы в Tempfile.new.

Tempfile.open('foo', '/home/temp') do |f|
   # ... do something with f ...
end

# Equivalent:
f = Tempfile.open('foo', '/home/temp')
begin
   # ... do something with f ...
ensure
   f.close
end

# File lib/tempfile.rb, line 160
def close(unlink_now=false)
  _close
  unlink if unlink_now
end

Закрывает файл. Если unlink_now равно true, то файл будет удалён после закрытия. Конечно, вы можете позже вызвать unlink, если не хотите удалять его сейчас.

Если вы явно не удаляете временный файл, удаление будет отложено до финализации объекта.

# File lib/tempfile.rb, line 167
def close!
  close(true)
end

Закрывает и удаляет файл. Имеет тот же эффект, что и вызов close(true).

# File lib/tempfile.rb, line 142
def open
  _close
  mode = @mode & ~(File::CREAT|File::EXCL)
  @tmpfile = File.open(@tmpfile.path, mode, @opts)
  __setobj__(@tmpfile)
end

Открывает или повторно открывает файл в режиме “r+”.

# File lib/tempfile.rb, line 220
def path
  @unlinked ? nil : @tmpfile.path
end

Возвращает полное имя временного файла. Будет равно nil, если был вызван unlink.

# File lib/tempfile.rb, line 226
def size
  if !@tmpfile.closed?
    @tmpfile.size # File#size calls rb_io_flush_raw()
  else
    File.size(@tmpfile.path)
  end
end

Возвращает размер временного файла. В качестве побочного эффекта, буфер IO сбрасывается перед определением размера.

# File lib/tempfile.rb, line 204
def unlink
  return if @unlinked
  begin
    File.unlink(@tmpfile.path)
  rescue Errno::ENOENT
  rescue Errno::EACCES
    # may not be able to unlink on Windows; just ignore
    return
  end
  ObjectSpace.undefine_finalizer(self)
  @unlinked = true
end

Удаляет файл из файловой системы. Необходимо всегда удалять файл после его использования, как описано в разделе «Явное закрытие» в обзоре Tempfile:

file = Tempfile.new('foo')
begin
   # ...do something with file...
ensure
   file.close
   file.unlink   # deletes the temp file
end

Удаление перед закрытием

В системах POSIX можно удалить файл перед его закрытием. Подробнее об этом методе описано в обзоре Tempfile (раздел «Удаление после создания»); пожалуйста, ознакомьтесь с ним для получения дополнительной информации.

Однако, удаление перед закрытием может не поддерживаться в не-POSIX операционных системах. Microsoft Windows является наиболее заметным примером: удаление не закрытого файла приведёт к ошибке, которую этот метод проигнорирует. Если вы хотите практиковать удаление перед закрытием всегда, то ваш код должен выглядеть так:

file = Tempfile.new('foo')
file.unlink   # On Windows this silently fails.
begin
   # ... do something with file ...
ensure
   file.close!   # Closes the file handle. If the file wasn't unlinked
                 # because #unlink failed, then this method will attempt
                 # to do so again.
end