tmpdir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85004f3b0d2caff8af5b16c3cecd842adfd8ba7eaab2b4129aea2334121c5a7d
+  data.tar.gz: 2d1b2624b97a9673af669a05cc30ecde60acb1abada6e0e6fb8044ff5c8ac942
+SHA512:
+  metadata.gz: b6900648a6f5005b35e2809a6aca0d2e4f0ec858374a14b9d56a1f000b25f159eb3d42b39a4c6895782eb122896d8febfd56488bf16a46592449543e47acd9cc
+  data.tar.gz: 7d1a75bcaa076e6a3134faf0cb5b5d7682f7bde1e6ad41200bafa9e2e8c01de6a9f725b8c219cb7f4053b3ca7e622f040584f5c652f4a601ab8a8caf97b5ff7e

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: ubuntu
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
+    strategy:
+      matrix:
+        ruby: [ 2.7, 2.6, 2.5, 2.4, head ]
+        os: [ ubuntu-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: |
+        gem install bundler --no-document
+        bundle install
+    - name: Run test
+      run: rake test

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "test-unit"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    tmpdir (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    power_assert (1.1.5)
+    rake (12.3.3)
+    test-unit (3.3.5)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  test-unit
+  tmpdir!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,58 @@
+# tmpdir
+
+retrieve temporary directory path
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tmpdir'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tmpdir
+
+## Usage
+
+Dir.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, <i>prefix_suffix</i>.
+
+- 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.
+
+```ruby
+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 Dir.tmpdir or
+the optional second argument <i>tmpdir</i> if non-nil value is given.
+
+```ruby
+Dir.mktmpdir {|dir| dir is "#{Dir.tmpdir}/d..." }
+Dir.mktmpdir(nil, "/var/tmp") {|dir| dir is "/var/tmp/d..." }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/tmpdir.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test/lib"
+  t.ruby_opts << "-rhelper"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tmpdir"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tmpdir.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+#
+# tmpdir - retrieve temporary directory path
+#
+# $Id$
+#
+
+require 'fileutils'
+begin
+  require 'etc.so'
+rescue LoadError # rescue LoadError for miniruby
+end
+
+class Dir
+
+  @@systmpdir ||= defined?(Etc.systmpdir) ? Etc.systmpdir : '/tmp'
+
+  ##
+  # Returns the operating system's temporary file path.
+
+  def self.tmpdir
+    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
+
+  # Dir.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, <i>prefix_suffix</i>.
+  # - 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 Dir.tmpdir or
+  # the optional second argument <i>tmpdir</i> 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 Dir.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, Dir.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
+  #
+  def self.mktmpdir(prefix_suffix=nil, *rest, **options)
+    base = nil
+    path = Tmpname.create(prefix_suffix || "d", *rest, **options) {|path, _, _, d|
+      base = d
+      mkdir(path, 0700)
+    }
+    if block_given?
+      begin
+        yield path
+      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
+        FileUtils.remove_entry path
+      end
+    else
+      path
+    end
+  end
+
+  module Tmpname # :nodoc:
+    module_function
+
+    def tmpdir
+      Dir.tmpdir
+    end
+
+    UNUSABLE_CHARS = [File::SEPARATOR, File::ALT_SEPARATOR, File::PATH_SEPARATOR, ":"].uniq.join("").freeze
+
+    class << (RANDOM = Random.new)
+      MAX = 36**6 # < 0x100000000
+      def next
+        rand(MAX).to_s(36)
+      end
+    end
+    private_constant :RANDOM
+
+    def create(basename, tmpdir=nil, max_try: nil, **opts)
+      origdir = tmpdir
+      tmpdir ||= tmpdir()
+      n = nil
+      prefix, suffix = basename
+      prefix = (String.try_convert(prefix) or
+                raise ArgumentError, "unexpected prefix: #{prefix.inspect}")
+      prefix = prefix.delete(UNUSABLE_CHARS)
+      suffix &&= (String.try_convert(suffix) or
+                  raise ArgumentError, "unexpected suffix: #{suffix.inspect}")
+      suffix &&= suffix.delete(UNUSABLE_CHARS)
+      begin
+        t = Time.now.strftime("%Y%m%d")
+        path = "#{prefix}#{t}-#{$$}-#{RANDOM.next}"\
+               "#{n ? %[-#{n}] : ''}#{suffix||''}"
+        path = File.join(tmpdir, path)
+        yield(path, n, opts, origdir)
+      rescue Errno::EEXIST
+        n ||= 0
+        n += 1
+        retry if !max_try or n < max_try
+        raise "cannot generate temporary name using `#{basename}' under `#{tmpdir}'"
+      end
+      path
+    end
+  end
+end

data/tmpdir.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name          = "tmpdir"
+  spec.version       = "0.1.0"
+  spec.authors = ["Yukihiro Matsumoto"]
+  spec.email = ["matz@ruby-lang.org"]
+
+  spec.summary       = %q{Extends the Dir class to manage the OS temporary file path.}
+  spec.description   = %q{Extends the Dir class to manage the OS temporary file path.}
+  spec.homepage      = "https://github.com/ruby/tmpdir"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: tmpdir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yukihiro Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-01 00:00:00.000000000 Z
+dependencies: []
+description: Extends the Dir class to manage the OS temporary file path.
+email:
+- matz@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tmpdir.rb
+- tmpdir.gemspec
+homepage: https://github.com/ruby/tmpdir
+licenses: []
+metadata:
+  homepage_uri: https://github.com/ruby/tmpdir
+  source_code_uri: https://github.com/ruby/tmpdir
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.0.pre1
+signing_key: 
+specification_version: 4
+summary: Extends the Dir class to manage the OS temporary file path.
+test_files: []