Class: Bundler::Dir

Relationships & Source Files
Namespace Children
Modules: `Tmpname`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Dir
Instance Chain: self, Dir
Inherits:	Dir Object Dir Bundler::Dir
Defined in:	lib/bundler/vendor/tmpdir/lib/tmpdir.rb

Class Method Summary

.mktmpdir(prefix_suffix = nil, *rest, **options)

mktmpdir creates a temporary directory.
.tmpdir

Returns the operating system’s temporary file path.

Class Method Details

.mktmpdir(prefix_suffix = nil, *rest, **options)

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.

Bundler::Dir.mktmpdir {|dir| dir is ".../d..." }
Bundler::Dir.mktmpdir("foo") {|dir| dir is ".../foo..." }
Bundler::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.

Bundler::Dir.mktmpdir {|dir| dir is "#{Bundler::Dir.tmpdir}/d..." }
Bundler::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.

Bundler::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 = Bundler::Dir.mktmpdir
begin
  # use the directory...
  open("#{dir}/foo", "w") { ... }
ensure
  # remove the directory.
  Bundler::FileUtils.remove_entry dir
end

[ GitHub ]

# File 'lib/bundler/vendor/tmpdir/lib/tmpdir.rb', line 88


def self.mktmpdir(prefix_suffix=nil, *rest, **options)
  base = nil
  path = Tmpname.create(prefix_suffix || "d", *rest, **options) {|p, _, _, d|
    base = d
    mkdir(p, 0700)
  }
  if block_given?
    begin
      yield path.dup
    ensure
      unless base
        stat = File.stat(File.dirname(path))
        if stat.world_writable? and !stat.sticky?
          raise ArgumentError, "parent directory is world writable but not sticky"
        end
      end
      Bundler::FileUtils.remove_entry path
    end
  else
    path
  end
end

.tmpdir

Returns the operating system’s temporary file path.

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/bundler/vendor/tmpdir/lib/tmpdir.rb', line 21


def self.tmpdir
  tmp = nil
  ['TMPDIR', 'TMP', 'TEMP', ['system temporary path', @systmpdir], ['/tmp']*2, ['.']*2].each do |name, dir = ENV[name]|
    next if !dir
    dir = File.expand_path(dir)
    stat = File.stat(dir) rescue next
    case
    when !stat.directory?
      warn "#{name} is not a directory: #{dir}"
    when !stat.writable?
      warn "#{name} is not writable: #{dir}"
    when stat.world_writable? && !stat.sticky?
      warn "#{name} is world-writable: #{dir}"
    else
      tmp = dir
      break
    end
  end
  raise ArgumentError, "could not find a temporary directory" unless tmp
  tmp
end