Class: Dir (Ruby 2.3.2)
Description: Class : Dir - Ruby 2.3.2

- Home
- Core 2.3.2
- Std-lib 2.3.2
- Downloads

Support for the Ruby 2.3 series has ended. See here for reference.

### Home Classes Methods

### In Files

- tmpdir.rb

### Parent

Object

### Methods

- ::mktmpdir
- ::tmpdir

### Class/Module Index

Quicksearch

- Dir

No matching classes.

# Dir

### Public Class Methods

mktmpdir(prefix_suffix=nil, *rest) click to toggle source

::mktmpdir creates a temporary directory.

The directory is created with 0700 permission. Application should not change the permission to make the temporary directory accessible from other users.

The prefix and suffix of the name of the directory is specified by the optional first argument, prefix_suffix.

- If it is not specified or nil, “d” is used as the prefix and no suffix is used.

- If it is a string, it is used as the prefix and no suffix is used.

- If it is an array, first element is used as the prefix and second element is used as a suffix.

    Dir.mktmpdir {|dir| dir is ".../d..." }
    Dir.mktmpdir("foo") {|dir| dir is ".../foo..." }
    Dir.mktmpdir(["foo", "bar"]) {|dir| dir is ".../foo...bar" }

The directory is created under ::tmpdir or the optional second argument tmpdir if non-nil value is given.

    Dir.mktmpdir {|dir| dir is "#{Dir.tmpdir}/d..." }
    Dir.mktmpdir(nil, "/var/tmp") {|dir| dir is "/var/tmp/d..." }

If a block is given, it is yielded with the path of the directory. The directory and its contents are removed using FileUtils.remove_entry before ::mktmpdir returns. The value of the block is returned.

    Dir.mktmpdir {|dir|
      # use the directory...
      open("#{dir}/foo", "w") { ... }
    }

If a block is not given, The path of the directory is returned. In this case, ::mktmpdir doesn't remove the directory.

    dir = Dir.mktmpdir
    begin
      # use the directory...
      open("#{dir}/foo", "w") { ... }
    ensure
      # remove the directory.
      FileUtils.remove_entry dir
    end

                   # File tmpdir.rb, line 84
    def Dir.mktmpdir(prefix_suffix=nil, *rest)
      path = Tmpname.create(prefix_suffix || "d", *rest) {|n| mkdir(n, 0700)}
      if block_given?
        begin
          yield path
        ensure
          stat = File.stat(File.dirname(path))
          if stat.world_writable? and !stat.sticky?
            raise ArgumentError, "parent directory is world writable but not sticky"
          end
          FileUtils.remove_entry path
        end
      else
        path
      end
    end

tmpdir() click to toggle source

Returns the operating system's temporary file path.

                   # File tmpdir.rb, line 20
    def self.tmpdir
      if $SAFE > 0
        @@systmpdir.dup
      else
        tmp = nil
        [ENV['TMPDIR'], ENV['TMP'], ENV['TEMP'], @@systmpdir, '/tmp', '.'].each do |dir|
          next if !dir
          dir = File.expand_path(dir)
          if stat = File.stat(dir) and stat.directory? and stat.writable? and
              (!stat.world_writable? or stat.sticky?)
            tmp = dir
            break
          end rescue nil
        end
        raise ArgumentError, "could not find a temporary directory" unless tmp
        tmp
      end
    end