Class: File

Inherits:
Object show all
Defined in:
extend/file/atomic.rb

Class Method Summary collapse

Class Method Details

.atomic_write(file_name, temp_dir = dirname(file_name), &_block) ⇒ T.type_parameter(:out)

Write to a file atomically. Useful for situations where you don’t want other processes or threads to see half-written files.

File.atomic_write(‘important.file’) do |file| file.write(‘hello’) end

This method needs to create a temporary file. By default it will create it in the same directory as the destination file. If you don’t like this behavior you can provide a different directory but it must be on the same physical filesystem as the file you’re trying to write.

File.atomic_write(‘/data/something.important’, ‘/data/tmp’) do |file| file.write(‘hello’) end

Parameters:

  • file_name (Pathname, String)
  • temp_dir (String) (defaults to: dirname(file_name))
  • _block (T.proc.params(arg0: Tempfile).returns(T.type_parameter(:out)))

Returns:

  • (T.type_parameter(:out))


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'extend/file/atomic.rb', line 29

def self.atomic_write(file_name, temp_dir = dirname(file_name), &_block)
  require "tempfile" unless defined?(Tempfile)

  Tempfile.open(".#{basename(file_name)}", temp_dir) do |temp_file|
    temp_file.binmode
    return_val = yield temp_file
    temp_file.close

    old_stat = if exist?(file_name)
      # Get original file permissions
      stat(file_name)
    else
      # If not possible, probe which are the default permissions in the
      # destination directory.
      probe_stat_in(dirname(file_name))
    end

    if old_stat
      # Set correct permissions on new file
      begin
        chown(old_stat.uid, old_stat.gid, T.must(temp_file.path))
        # This operation will affect filesystem ACL's
        chmod(old_stat.mode, T.must(temp_file.path))
      rescue Errno::EPERM, Errno::EACCES
        # Changing file ownership failed, moving on.
      end
    end

    # Overwrite original file with temp file
    rename(T.must(temp_file.path), file_name)
    return_val
  end
end