file-temp 1.3.0 → 1.7.1

data/certs/djberg96_pub.pem

@@ -1,21 +1,26 @@
 -----BEGIN CERTIFICATE-----
-MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
 cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-MB4XDTE1MDkwMjIwNDkxOFoXDTE2MDkwMTIwNDkxOFowPzERMA8GA1UEAwwIZGpi
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
 ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMyTkvXqRp6hLs9eoJOS
-Hmi8kRYbq9Vkf15/hMxJpotYMgJVHHWrmDcC5Dye2PbnXjTkKf266Zw0PtT9h+lI
-S3ts9HO+vaCFSMwFFZmnWJSpQ3CNw2RcHxjWkk9yF7imEM8Kz9ojhiDXzBetdV6M
-gr0lV/alUr7TNVBDngbXEfTWscyXh1qd7xZ4EcOdsDktCe5G45N/o3662tPQvJsi
-FOF0CM/KuBsa/HL1/eoEmF4B3EKIRfTHrQ3hu20Kv3RJ88QM4ec2+0dd97uX693O
-zv6981fyEg+aXLkxrkViM/tz2qR2ZE0jPhHTREPYeMEgptRkTmWSKAuLVWrJEfgl
-DtkCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFEwe
-nn6bfJADmuIDiMSOzedOrL+xMB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
-bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-ggEBAHmNOCWoDVD75zHFueY0viwGDVP1BNGFC+yXcb7u2GlK+nEMCORqzURbYPf7
-tL+/hzmePIRz7i30UM//64GI1NLv9jl7nIwjhPpXpf7/lu2I9hOTsvwSumb5UiKC
-/sqBxI3sfj9pr79Wpv4MuikX1XPik7Ncb7NPsJPw06Lvyc3Hkg5X2XpPtLtS+Gr2
-wKJnmzb5rIPS1cmsqv0M9LPWflzfwoZ/SpnmhagP+g05p8bRNKjZSA2iImM/GyYZ
-EJYzxdPOrx2n6NYR3Hk+vHP0U7UBSveI6+qx+ndQYaeyCn+GRX2PKS9h66YF/Q1V
-tGSHgAmcLlkdGgan182qsE/4kKM=
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
 -----END CERTIFICATE-----

data/file-temp.gemspec

@@ -2,22 +2,29 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'file-temp'
-  spec.version    = '1.3.0'
+  spec.version    = '1.7.1'
   spec.author     = 'Daniel J. Berger'
-  spec.license    = 'Artistic 2.0'
+  spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/file-temp'
   spec.summary    = 'An alternative way to generate temp files'
-  spec.test_file  = 'test/test_file_temp.rb'
+  spec.test_file  = 'spec/file_temp_spec.rb'
   spec.files      = Dir['**/*'].delete_if{ |item| item.include?('git') }
   spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files = ['CHANGES', 'README', 'MANIFEST']
-
-  spec.add_dependency('ffi', '>= 1.0.0')
-  spec.add_development_dependency('test-unit')
+  spec.add_dependency('ffi', '~> 1.1')
+  spec.add_development_dependency('rspec', '~> 3.9')
   spec.add_development_dependency('rake')
 
+  spec.metadata = {
+    'homepage_uri'      => 'https://github.com/djberg96/file-temp',
+    'bug_tracker_uri'   => 'https://github.com/djberg96/file-temp/issues',
+    'changelog_uri'     => 'https://github.com/djberg96/file-temp/blob/master/CHANGES.md',
+    'documentation_uri' => 'https://github.com/djberg96/file-temp/wiki',
+    'source_code_uri'   => 'https://github.com/djberg96/file-temp',
+    'wiki_uri'          => 'https://github.com/djberg96/file-temp/wiki'
+  }
+
   spec.description = <<-EOF
     The file-temp library provides an alternative approach to generating
     temporary files. Features included improved security, a superior

data/lib/file/java/temp.rb

@@ -2,17 +2,14 @@ require 'java'
 import java.lang.System
 
 class File::Temp < File
-  # The version of the file-temp library.
-  VERSION = '1.3.0'
-
   # The temporary directory used on MS Windows or Unix.
   TMPDIR = java.lang.System.getProperties["java.io.tmpdir"]
 
   # The name of the temporary file.
   attr_reader :path
 
-  # Creates a new, anonymous, temporary file in your File::Temp::TMPDIR
-  # directory.
+  # Creates a new, anonymous, temporary file in your system's temporary
+  # directory, or whichever directory you specify.
   #
   # If the +delete+ option is set to true (the default) then the temporary file
   # will be deleted automatically as soon as all references to it are closed.
@@ -30,11 +27,11 @@ class File::Temp < File
   #
   # Example:
   #
-  #    fh = File::Temp.new(true, 'rb_file_temp_XXXXXX') => file
+  #    fh = File::Temp.new(delete: true, template: 'rb_file_temp_XXXXXX')
   #    fh.puts 'hello world'
   #    fh.close
   #
-  def initialize(delete = true, template = 'rb_file_temp_XXXXXX')
+  def initialize(delete: true, template: 'rb_file_temp_XXXXXX', directory: TMPDIR, **options)
     raise TypeError unless template.is_a?(String)
 
     # Since Java uses a GUID extension to generate a unique file name
@@ -44,27 +41,27 @@ class File::Temp < File
     # For consistency between implementations, convert errors here
     # to Errno::EINVAL.
     begin
-      @file = java.io.File.createTempFile(template, nil)
+      @file = java.io.File.createTempFile(template, nil, java.io.File.new(directory))
     rescue NativeException => err
       raise SystemCallError.new(22), template # 22 is EINVAL
     end
 
     @file.deleteOnExit if delete
+    options[:mode] ||= 'wb+'
 
     path = @file.getName
-    super(path, 'wb+')
+    super(path, **options)
 
     @path = path unless delete
   end
 
-  # Generates a unique file name.
+  # Generates a unique file name based on your tmpdir, or whichever
+  # directory you specify.
   #
-  def self.temp_name
-    file = java.io.File.createTempFile('rb_file_temp_', nil)
+  def self.temp_name(directory = TMPDIR)
+    file = java.io.File.createTempFile('rb_file_temp_', nil, java.io.File.new(directory))
     file.deleteOnExit
-    name = file.getName
-    file.finalize
-    name
+    directory + file.getName
   end
 
   # Identical to the File#close method except that we also finalize

data/lib/file/temp.rb

@@ -1,3 +1,8 @@
+class File::Temp < File
+  # The version of the file-temp library
+  VERSION = '1.7.1'.freeze
+end
+
 if RUBY_PLATFORM == 'java'
   require_relative 'java/temp'
 else

data/lib/file/unix/temp.rb

@@ -23,22 +23,19 @@ class File::Temp < File
 
   # :startdoc:
 
-  # The version of the file-temp library.
-  VERSION = '1.3.0'
-
-  # The temporary directory used on MS Windows or Unix.
+  # The temporary directory used on MS Windows or Unix by default.
   TMPDIR = ENV['TEMP'] || ENV['TMP'] || ENV['TMPDIR'] || Dir.tmpdir
 
   # The name of the temporary file. Set to nil if the +delete+ option to the
   # constructor is true.
   attr_reader :path
 
-  # Creates a new, anonymous, temporary file in your File::Temp::TMPDIR
-  # directory
+  # Creates a new, anonymous, temporary file in your tmpdir, or whichever
+  # directory you specifiy.
   #
   # If the +delete+ option is set to true (the default) then the temporary file
   # will be deleted automatically as soon as all references to it are closed.
-  # Otherwise, the file will live on in your File::Temp::TMPDIR path.
+  # Otherwise, the file will live on in your tmpdir path.
   #
   # If the +delete+ option is set to false, then the file is not deleted. In
   # addition, you can supply a string +template+ that the system replaces with
@@ -50,48 +47,53 @@ class File::Temp < File
   #
   # Example:
   #
-  #    fh = File::Temp.new(true, 'rb_file_temp_XXXXXX') => file
+  #    fh = File::Temp.new(delete: true, template: 'rb_file_temp_XXXXXX') => file
   #    fh.puts 'hello world'
   #    fh.close
   #
-  def initialize(delete = true, template = 'rb_file_temp_XXXXXX')
+  def initialize(delete: true, template: 'rb_file_temp_XXXXXX', directory: TMPDIR, **options)
     @fptr = nil
 
     if delete
       @fptr = tmpfile()
+      raise SystemCallError.new('tmpfile', FFI.errno) if @fptr.null?
       fd = _fileno(@fptr)
     else
       begin
         omask = File.umask(077)
-
         ptr = FFI::MemoryPointer.from_string(template)
-
         str = mktemp(ptr)
 
         if str.nil? || str.empty?
           raise SystemCallError.new('mktemp', FFI.errno)
         end
 
-        @path = File.join(TMPDIR, ptr.read_string)
+        @path = File.join(directory, ptr.read_string)
       ensure
         File.umask(omask)
       end
     end
 
+    options[:mode] ||= 'wb+'
+
     if delete
-      super(fd, 'wb+')
+      super(fd, **options)
     else
-      super(@path, 'wb+')
+      super(@path, **options)
     end
   end
 
-  # The close method was overridden to ensure the internal file pointer we
-  # created in the constructor is closed. It is otherwise identical to the
-  # File#close method.
+  # The close method was overridden to ensure the internal file pointer that we
+  # potentially created in the constructor is closed. It is otherwise identical
+  # to the File#close method.
+  #--
+  # This is probably unnecessary since Ruby will close the fd, and in reality
+  # the fclose function probably fails with an Errno::EBADF. Consequently
+  # I will let it silently fail as a no-op.
   #
   def close
     super
-    fclose(@fptr) if @fptr
+    fclose(@fptr) if @fptr && !@fptr.null?
   end
 
   # Generates a unique file name.

data/lib/file/windows/temp.rb

@@ -53,10 +53,7 @@ class File::Temp < File
 
   # :startdoc:
 
-  # The version of the file-temp library.
-  VERSION = '1.3.0'
-
-  # The temporary directory used on MS Windows or Unix.
+  # The temporary directory used on MS Windows or Unix by default.
   TMPDIR = ENV['TEMP'] || ENV['TMP'] || ENV['USERPROFILE'] || Dir.tmpdir
 
   # The name of the temporary file. Set to nil if the +delete+ option to the
@@ -64,7 +61,7 @@ class File::Temp < File
   attr_reader :path
 
   # Creates a new, anonymous, temporary file in your File::Temp::TMPDIR
-  # directory
+  # directory, or whichever directory you specify.
   #
   # If the +delete+ option is set to true (the default) then the temporary file
   # will be deleted automatically as soon as all references to it are closed.
@@ -80,11 +77,11 @@ class File::Temp < File
   #
   # Example:
   #
-  #    fh = File::Temp.new(true, 'rb_file_temp_XXXXXX') => file
+  #    fh = File::Temp.new(delete: true, template: 'rb_file_temp_XXXXXX')
   #    fh.puts 'hello world'
   #    fh.close
   #
-  def initialize(delete = true, template = 'rb_file_temp_XXXXXX')
+  def initialize(delete: true, template: 'rb_file_temp_XXXXXX', directory: TMPDIR, **options)
     @fptr = nil
 
     if delete
@@ -93,24 +90,24 @@ class File::Temp < File
     else
       begin
         omask = File.umask(077)
-
         ptr = FFI::MemoryPointer.from_string(template)
-
         errno = mktemp_s(ptr, ptr.size)
 
         raise SystemCallError.new('mktemp_s', errno) if errno != 0
 
-        @path = File.join(TMPDIR, ptr.read_string)
+        @path = File.join(directory, ptr.read_string)
         @path.tr!(File::SEPARATOR, File::ALT_SEPARATOR)
       ensure
         File.umask(omask)
       end
     end
 
+    options[:mode] ||= 'wb+'
+
     if delete
-      super(fd, 'wb+')
+      super(fd, **options)
     else
-      super(@path, 'wb+')
+      super(@path, **options)
     end
   end
 
@@ -123,20 +120,21 @@ class File::Temp < File
     fclose(@fptr) if @fptr
   end
 
-  # Generates a unique file name.
+  # Generates a unique file name based on your default temporary directory,
+  # or whichever directory you specify.
   #
   # Note that a file is not actually generated on the filesystem.
   #--
   # NOTE: One quirk of the Windows function is that, after the first call, it
   # adds a file extension of sequential numbers in base 32, e.g. .1-.1vvvvvu.
   #
-  def self.temp_name
+  def self.temp_name(directory: TMPDIR)
     ptr = FFI::MemoryPointer.new(:char, 1024)
     errno = tmpnam_s(ptr, ptr.size)
 
     raise SystemCallError.new('tmpnam_s', errno) if errno != 0
 
-    TMPDIR + ptr.read_string + 'tmp'
+    directory + ptr.read_string + 'tmp'
   end
 
   private

data/spec/file_temp_spec.rb

@@ -0,0 +1,159 @@
+######################################################################
+# file_temp_spec.rb
+#
+# Test suite for the file-temp library. These tests should be run
+# via the 'rake spec' task.
+######################################################################
+require 'rspec'
+require 'file/temp'
+
+RSpec.describe File::Temp do
+  let(:windows) { File::ALT_SEPARATOR }
+  let(:osx) { RbConfig::CONFIG['host_os'] =~ /darwin/i }
+
+  before do
+    @dir = File::Temp::TMPDIR
+    @template = 'file-temp-test-XXXXX'
+    @fh = nil
+
+    # Because Dir[] doesn't work right with backslashes
+    @dir = @dir.tr("\\", "/") if windows
+  end
+
+  context "constants" do
+    example "library version is set to expected value" do
+      expect( File::Temp::VERSION).to eq('1.7.1')
+      expect(File::Temp::VERSION).to be_frozen
+    end
+
+    example "TMPDIR constant is defined" do
+      expect(File::Temp::TMPDIR).to be_kind_of(String)
+      expect(File::Temp::TMPDIR.size).to be > 0
+    end
+  end
+
+  context "threads" do
+    example "library works as expected with multiple threads" do
+      threads = []
+      expect{ 100.times{ threads << Thread.new{ File::Temp.new }}}.not_to raise_error
+      expect{ threads.each{ |t| t.join }.not_to raise_error }
+    end
+  end
+
+  context "constructor" do
+    example "constructor works as expected with default auto delete option" do
+      expect{
+        @fh = File::Temp.new
+        @fh.print "hello"
+        @fh.close
+      }.not_to raise_error
+    end
+
+    example "constructor works as expected with false auto delete option" do
+      expect{
+        @fh = File::Temp.new(:delete => false)
+        @fh.print "hello"
+        @fh.close
+      }.not_to raise_error
+    end
+
+    example "constructor accepts and uses an optional template as expected" do
+      expect{ File::Temp.new(:delete => false, :template => 'temp_foo_XXXXXX').close }.not_to raise_error
+      expect(Dir["#{@dir}/temp_foo*"].length).to be >= 1
+    end
+
+    example "constructor with false auto delete and block works as expected" do
+      expect{
+        File::Temp.open(:delete => false, :template => 'temp_foo_XXXXXX'){ |fh| fh.puts "hello" }
+      }.not_to raise_error
+      expect(Dir["#{@dir}/temp_foo*"].length).to be >= 1
+    end
+
+    example "other arguments are treated as file option arguments" do
+      expect{
+        @fh = File::Temp.new(
+          :delete    => true,
+          :template  => 'temp_bar_XXXXX',
+          :directory => Dir.pwd,
+          :mode      => 'xb'
+        )
+      }.to raise_error(ArgumentError, /invalid access mode/)
+    end
+  end
+
+  context "template" do
+    example "template argument must be a string" do
+      expect{ @fh = File::Temp.new(:delete => false, :template => 1) }.to raise_error(TypeError)
+    end
+
+    example "an error is raised if a custom template is invalid" do
+      skip "skipped on OSX" if osx
+      expect{ File::Temp.new(:delete => false, :template => 'xx') }.to raise_error(Errno::EINVAL)
+    end
+  end
+
+  context "temp_name" do
+    example "temp_name basic functionality" do
+      expect(File::Temp).to respond_to(:temp_name)
+      expect{ File::Temp.temp_name }.not_to raise_error
+      expect(File::Temp.temp_name).to be_kind_of(String)
+    end
+
+    example "temp_name returns expected value" do
+      if windows
+        expect( File.extname(File::Temp.temp_name)).to match(/^.*?\d*?tmp/)
+      else
+        expect( File.extname(File::Temp.temp_name)).to eq('.tmp')
+      end
+    end
+  end
+
+  context "path" do
+    example "temp path basic functionality" do
+      @fh = File::Temp.new
+      expect(@fh).to respond_to(:path)
+    end
+
+    example "temp path is nil if delete option is true" do
+      @fh = File::Temp.new
+      expect(@fh.path).to be_nil
+    end
+
+    example "temp path is not nil if delete option is false" do
+      @fh = File::Temp.new(delete: false)
+      expect(@fh.path).not_to be_nil
+    end
+  end
+
+  context "ffi" do
+    example "ffi functions are private" do
+      methods = File::Temp.methods(false).map(&:to_s)
+      expect(methods).not_to include('_fileno')
+      expect(methods).not_to include('mkstemp')
+      expect(methods).not_to include('_umask')
+      expect(methods).not_to include('fclose')
+      expect(methods).not_to include('strerror')
+      expect(methods).not_to include('tmpnam')
+      expect(methods).not_to include('CloseHandle')
+      expect(methods).not_to include('CreateFileA')
+      expect(methods).not_to include('DeleteFileA')
+      expect(methods).not_to include('GetTempPathA')
+      expect(methods).not_to include('GetTempFileNameA')
+    end
+  end
+
+  after do
+    @dir = nil
+    @template = nil
+    @fh.close if @fh && !@fh.closed?
+    @fh = nil
+
+    Dir["temp_*"].each{ |f| File.delete(f) }
+    Dir["rb_file_temp_*"].each{ |f| File.delete(f) }
+
+    Dir.chdir(File::Temp::TMPDIR) do
+      Dir["temp_*"].each{ |f| File.delete(f) }
+      Dir["rb_file_temp_*"].each{ |f| File.delete(f) }
+    end
+  end
+end