file-temp 1.2.0 → 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fb1391ce05c64e9f018206c3619e691cf2a0e1f
+  data.tar.gz: ab155469cf49f1546b700d2d9aa874da22ae9d53
+SHA512:
+  metadata.gz: 749a21db42342082d475e25025c496ea6ad5df1cb3965fdff3610b3a08ebc9e6c341ca863e3469c4b09056caa7ba05ce24aee2c9e3ddad7c1f47f53fd1cf31b2
+  data.tar.gz: 4349528879f6f62311bdfabee5cc2fe5fb30f3a194694809b3cfe53f46d7fd9ce9a48dc98475b7b1b85da1020f04e6d1429eac1f34c2ab084ce97eeef0af0540

data/CHANGES

@@ -1,50 +1,63 @@
-= 1.2.0 - 10-Apr-2012
-* Removed the old FileTemp alias for File::Temp. It was deprecated and
-  has now been officially removed.
-* Some refactoring of the custom internal Windows functions.
-* Nicer error handling if certain FFI functions fail.
-* Made the FFI functions private.
-
-= 1.1.5 - 17-Jul-2011
-* Now stores file path information if the file is retained on the filesystem.
-  Thanks go to joerixaop for the patch.
-* The TMPDIR fallback determination on Windows is no longer hard coded.
-
-= 1.1.4 - 16-Sep-2010
-* The File::Temp.temp_name method has been altered on Unix systems. It
-  no longer prefixes TMPDIR to the name since it was redundant and could
-  generate a bogus path.
-* Set the license to Artistic 2.0.
-* Set the test task as the default Rake task.
-
-= 1.1.3 - 14-Sep-2010
-* Fixed potential libc linker failure.
-
-= 1.1.2 - 28-Apr-2010
-* Explicitly link against libc for Unix versions.
-* Refactored the Rakefile. An old install task was removed and the gem
-  related tasks were placed under the 'gem' namespace.
-
-= 1.1.1 - 24-Oct-2009
-* Removed the 'use' library as a dependency.
-
-= 1.1.0 - 21-Oct-2009
-* Now pure Ruby, using FFI.
-* Fixed RF Bug #26757 - FILE pointer leak. Thanks go to Eric Wong for the spot.
-* Renamed and refactored the test file slightly.
-* Updated the gemspec.
-
-= 1.0.0 - 12-Apr-2008
-* Added security via umask().
-* Version bump to 1.0.0.
-
-= 0.1.2 - 6-Jun-2007
-* Gemspec fix (forgot the temp.h file - oops).
-* Added an extra test.
- 
-= 0.1.1 - 2-Jun-2007
-* Core code and test case now work properly on MS Windows.
-* Now uses MS VC++ 8 functions when available (tmpfile_s, _sopen_s).
-
-= 0.1.0 - 1-Jun-2007
-* Initial release.
+= 1.2.1 - 17-Feb-2014
+* There is now a completely separate implementation for JRuby that uses the
+  Java API instead of C. It uses a GUID to create the temporary file name
+  instead of the 'XXXXXX' template, but is otherwise identical in function.
+* Reworked the error handling. The posix functions now use a combination
+  of SystemCallError and FFI.errno, except on Windows, which uses _get_errno
+  instead for the posix compatible functions.
+* Refactored the tests to use declarative syntax and added one test for
+  invalid templates.
+* Removed the internal mkstemp function for Windows, no longer needed.
+* Use tmpnam_s on Windows instead of tmpnam.
+* Use wide character functions on Windows.
+
+= 1.2.0 - 10-Apr-2012
+* Removed the old FileTemp alias for File::Temp. It was deprecated and
+  has now been officially removed.
+* Some refactoring of the custom internal Windows functions.
+* Nicer error handling if certain FFI functions fail.
+* Made the FFI functions private.
+
+= 1.1.5 - 17-Jul-2011
+* Now stores file path information if the file is retained on the filesystem.
+  Thanks go to joerixaop for the patch.
+* The TMPDIR fallback determination on Windows is no longer hard coded.
+
+= 1.1.4 - 16-Sep-2010
+* The File::Temp.temp_name method has been altered on Unix systems. It
+  no longer prefixes TMPDIR to the name since it was redundant and could
+  generate a bogus path.
+* Set the license to Artistic 2.0.
+* Set the test task as the default Rake task.
+
+= 1.1.3 - 14-Sep-2010
+* Fixed potential libc linker failure.
+
+= 1.1.2 - 28-Apr-2010
+* Explicitly link against libc for Unix versions.
+* Refactored the Rakefile. An old install task was removed and the gem
+  related tasks were placed under the 'gem' namespace.
+
+= 1.1.1 - 24-Oct-2009
+* Removed the 'use' library as a dependency.
+
+= 1.1.0 - 21-Oct-2009
+* Now pure Ruby, using FFI.
+* Fixed RF Bug #26757 - FILE pointer leak. Thanks go to Eric Wong for the spot.
+* Renamed and refactored the test file slightly.
+* Updated the gemspec.
+
+= 1.0.0 - 12-Apr-2008
+* Added security via umask().
+* Version bump to 1.0.0.
+
+= 0.1.2 - 6-Jun-2007
+* Gemspec fix (forgot the temp.h file - oops).
+* Added an extra test.
+ 
+= 0.1.1 - 2-Jun-2007
+* Core code and test case now work properly on MS Windows.
+* Now uses MS VC++ 8 functions when available (tmpfile_s, _sopen_s).
+
+= 0.1.0 - 1-Jun-2007
+* Initial release.

data/MANIFEST

@@ -1,7 +1,9 @@
-* CHANGES
-* MANIFEST
-* README
-* Rakefile
-* file-temp.gemspec
-* lib/file/temp.rb
-* test/test_file_temp.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* file-temp.gemspec
+* lib/file/temp.rb
+* lib/file/temp_c.rb
+* lib/file/temp_java.rb
+* test/test_file_temp.rb

data/README

@@ -1,56 +1,61 @@
-== Description
-   The file-temp library is an alternate way to handle tempfile generation.
-
-== Requirements
-   ffi 0.5.0 or later
-
-== Installation
-   gem install file-temp
-
-== Synopsis
-   require 'file/temp'
-
-   fh = File::Temp.new
-   fh.puts "hello"
-   fh.close # => Tempfile automatically deleted
-
-   fh = File::Temp.new(false)
-   fh.puts "world"
-   fh.close # => Tempfile still on your filesystem
-
-== Motivation
-   Ruby's tempfile.rb is overwrought and susceptible to race conditions. This
-   This library uses your system's native tmpfile() or mkstemp() functions
-   instead of trying to handle race conditions manually via pure Ruby.
-   
-   This library is also more secure because it restricts file permission via
-   umask() for files created with mkstemp().
-
-   Finally, this library subclasses the File class. This means you get almost
-   exactly the same interface as the File class. The only difference is the
-   constructor.
-
-== JRuby
-   I'm afraid this library will not work with JRuby due to limitations
-   of JRuby itself.
-
-== MS Windows
-   You may need to use the mingw build in order to use this library.
-
-== License
-   Artistic 2.0
-
-== Copyright
-   (C) 2007-2012 Daniel J. Berger
-   All Rights Reserved
-
-== Warranty
-   This library is provided "as is" and without any express or
-   implied warranties, including, without limitation, the implied
-   warranties of merchantability and fitness for a particular purpose.
-
-== Author
-   Daniel J. Berger
-
-== See also
-   tmpfile(), mkstemp(), tmpnam()
+== Description
+   The file-temp library is an alternate way to handle tempfile generation.
+
+== Requirements
+   ffi 1.0.0 or later
+
+== Installation
+   gem install file-temp
+
+== Synopsis
+   require 'file/temp'
+
+   fh = File::Temp.new
+   fh.puts "hello"
+   fh.close # => Tempfile automatically deleted
+
+   fh = File::Temp.new(false)
+   fh.puts "world"
+   fh.close # => Tempfile still on your filesystem
+
+== Motivation
+   Ruby's tempfile.rb is overwrought and susceptible to race conditions.
+   This library uses your system's native tmpfile() or mkstemp() functions
+   instead of trying to handle race conditions manually via pure Ruby.
+   
+   This library is also more secure because it restricts file permission via
+   umask() for files created with mkstemp().
+
+   Finally, this library subclasses the File class. This means you get almost
+   exactly the same interface as the File class. The only difference is the
+   constructor.
+
+== JRuby
+   The implementation for JRuby uses the Java API, not the C API. The
+   temporary file name generated by Java is different than the C version,
+   since it uses a GUID instead of the 'XXXXXX' template, but the
+   interface is otherwise identical.
+
+   There is one test failure with JRuby (threaded tempfile creation). I am
+   not sure why, as sample code seems to work fine. Help wanted.
+
+== MS Windows
+   You may need to use the mingw build in order to use this library.
+
+== License
+   Artistic 2.0
+
+== Copyright
+   (C) 2007-2014 Daniel J. Berger
+   All Rights Reserved
+
+== Warranty
+   This library is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+
+== Author
+   Daniel J. Berger
+
+== See also
+   tmpfile(), mkstemp(), tmpnam()

data/Rakefile

@@ -1,61 +1,66 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-CLEAN.include('**/*.tar', '**/*.zip', '**/*.gz', '**/*.bz2')
-CLEAN.include('**/*.rbc', '**/*.gem')
-
-namespace 'gem' do
-  desc 'Create the file-temp gem'
-  task :create => [:clean] do
-    spec = eval(IO.read('file-temp.gemspec'))
-    Gem::Builder.new(spec).build
-  end
-
-  desc 'Install the file-temp gem'
-  task :install => [:create] do
-     file = Dir["*.gem"].first
-     sh "gem install #{file}"
-  end
-end
-
-# Export the contents of the library to an archive. Note that this requires
-# presence of the .gitattributes file in order to prevent the .git contents
-# from being included.
-#
-# It also appears that I must add a trailing slash to the prefix manually.
-# As of git 1.6.4.3 it does not automaticaly add it, despite what the docs
-# say.
-#
-namespace 'export' do
-  spec = eval(IO.read('file-temp.gemspec'))
-  file = 'file-temp-' + spec.version.to_s
-  pref = file + '/' # Git does not add the trailing slash, despite what the docs say.
-
-  desc 'Export to a .tar.gz file'
-  task :gzip => [:clean] do
-    file += '.tar'
-    sh "git archive --prefix #{pref} --output #{file} master"
-    sh "gzip #{file}"
-  end
-
-  desc 'Export to a .tar.bz2 file'
-  task :bzip2 => [:clean] do
-    file += '.tar'
-    sh "git archive --prefix #{pref} --output #{file} master"
-    sh "bzip2 -f #{file}"
-  end
-
-  desc 'Export to a .zip file'
-  task :zip => [:clean] do
-    file += '.zip'
-    sh "git archive --prefix #{pref} --output #{file} --format zip master"
-  end
-end
-
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
-end
-
-task :default => :test
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include('**/*.tar', '**/*.zip', '**/*.gz', '**/*.bz2')
+CLEAN.include('**/*.rbc', '**/*.gem', '**/*.tmp')
+
+namespace 'gem' do
+  desc 'Create the file-temp gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('file-temp.gemspec'))
+    if Gem::VERSION < "2.0"
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
+  end
+
+  desc 'Install the file-temp gem'
+  task :install => [:create] do
+     file = Dir["*.gem"].first
+     sh "gem install #{file}"
+  end
+end
+
+# Export the contents of the library to an archive. Note that this requires
+# presence of the .gitattributes file in order to prevent the .git contents
+# from being included.
+#
+# It also appears that I must add a trailing slash to the prefix manually.
+# As of git 1.6.4.3 it does not automaticaly add it, despite what the docs
+# say.
+#
+namespace 'export' do
+  spec = eval(IO.read('file-temp.gemspec'))
+  file = 'file-temp-' + spec.version.to_s
+  pref = file + '/' # Git does not add the trailing slash, despite what the docs say.
+
+  desc 'Export to a .tar.gz file'
+  task :gzip => [:clean] do
+    file += '.tar'
+    sh "git archive --prefix #{pref} --output #{file} master"
+    sh "gzip #{file}"
+  end
+
+  desc 'Export to a .tar.bz2 file'
+  task :bzip2 => [:clean] do
+    file += '.tar'
+    sh "git archive --prefix #{pref} --output #{file} master"
+    sh "bzip2 -f #{file}"
+  end
+
+  desc 'Export to a .zip file'
+  task :zip => [:clean] do
+    file += '.zip'
+    sh "git archive --prefix #{pref} --output #{file} --format zip master"
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+end
+
+task :default => :test

data/file-temp.gemspec

@@ -1,26 +1,27 @@
-require 'rubygems'
-
-Gem::Specification.new do |spec|
-  spec.name      = 'file-temp'
-  spec.version   = '1.2.0'
-  spec.author    = 'Daniel J. Berger'
-  spec.license   = 'Artistic 2.0'
-  spec.email     = 'djberg96@gmail.com'
-  spec.homepage  = 'http://www.rubyforge.org/projects/shards'
-  spec.summary   = 'An alternative way to generate temp files'
-  spec.test_file = 'test/test_file_temp.rb'
-  spec.files     = Dir['**/*'].delete_if{ |item| item.include?('git') }
-
-  spec.extra_rdoc_files = ['CHANGES', 'README', 'MANIFEST']
-  spec.rubyforge_project = 'shards'
-  spec.required_ruby_version = '>= 1.8.6'
-
-  spec.add_dependency('ffi', '>= 1.0.0')
-  spec.add_development_dependency('test-unit', '>= 2.4.0')
-
-  spec.description = <<-EOF
-    The file-temp library provides an alternative approach to generating
-    temporary files. Features included improved security, a superior
-    interface, and better support for MS Windows.
-  EOF
-end
+require 'rubygems'
+
+Gem::Specification.new do |spec|
+  spec.name      = 'file-temp'
+  spec.version   = '1.2.1'
+  spec.author    = 'Daniel J. Berger'
+  spec.license   = 'Artistic 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.files     = Dir['**/*'].delete_if{ |item| item.include?('git') }
+
+  spec.extra_rdoc_files = ['CHANGES', 'README', 'MANIFEST']
+  spec.rubyforge_project = 'shards'
+  spec.required_ruby_version = '>= 1.8.6'
+
+  spec.add_dependency('ffi', '>= 1.0.0')
+  spec.add_development_dependency('test-unit')
+  spec.add_development_dependency('rake')
+
+  spec.description = <<-EOF
+    The file-temp library provides an alternative approach to generating
+    temporary files. Features included improved security, a superior
+    interface, and better support for MS Windows.
+  EOF
+end

data/lib/file/temp.rb

@@ -1,254 +1,5 @@
-require 'ffi'
-require 'tmpdir'
-
-class File::Temp < File
-  extend FFI::Library
-  ffi_lib FFI::Library::LIBC
-
-  # :stopdoc:
-
-  private
-
-  if File::ALT_SEPARATOR
-    attach_function :_close, [:int], :int
-    attach_function :fclose, [:pointer], :int
-    attach_function :_fdopen, [:int, :string], :pointer
-    attach_function :_fileno, [:pointer], :int
-    attach_function :_mktemp_s, [:pointer, :size_t], :int
-    attach_function :_open, [:string, :int, :int], :int
-    attach_function :_open_osfhandle, [:long, :int], :int
-    attach_function :tmpnam, [:string], :string
-
-    ffi_lib :kernel32
-
-    attach_function :CloseHandle, [:long], :bool
-    attach_function :CreateFileA, [:string, :ulong, :ulong, :pointer, :ulong, :ulong, :ulong], :long
-    attach_function :DeleteFileA, [:string], :bool
-    attach_function :FormatMessageA, [:long, :long, :long, :long, :pointer, :long, :pointer], :long
-    attach_function :GetLastError, [], :int
-    attach_function :GetTempPathA, [:long, :pointer], :long
-    attach_function :GetTempFileNameA, [:string, :string, :uint, :pointer], :uint
-
-    private_class_method :_close, :_fdopen, :_mktemp_s, :_open, :_open_osfhandle
-    private_class_method :CloseHandle, :CreateFileA, :DeleteFileA, :FormatMessageA
-    private_class_method :GetLastError, :GetTempPathA, :GetTempFileNameA
-
-    S_IWRITE      = 128
-    S_IREAD       = 256
-    BINARY        = 0x8000
-    SHORT_LIVED   = 0x1000
-    GENERIC_READ  = 0x80000000
-    GENERIC_WRITE = 0x40000000
-    CREATE_ALWAYS = 2
-
-    FORMAT_MESSAGE_FROM_SYSTEM    = 0x00001000
-    FORMAT_MESSAGE_ARGUMENT_ARRAY = 0x00002000
-
-    FILE_ATTRIBUTE_NORMAL     = 0x00000080
-    FILE_FLAG_DELETE_ON_CLOSE = 0x04000000
-    INVALID_HANDLE_VALUE      = -1
-  else
-    attach_function :fclose, [:pointer], :int
-    attach_function :_fileno, :fileno, [:pointer], :int
-    attach_function :mkstemp, [:string], :int
-    attach_function :strerror, [:int], :string
-    attach_function :tmpfile, [], :pointer
-    attach_function :tmpnam, [:string], :string
-
-    private_class_method :mkstemp, :strerror, :tmpfile
-  end
-
-  private_class_method :fclose, :_fileno, :tmpnam
-
-  public
-
-  # :startdoc:
-
-  # The version of the file-temp library.
-  VERSION = '1.2.0'
-
-  # The temporary directory used on MS Windows or Unix.
-  if File::ALT_SEPARATOR
-    TMPDIR = ENV['TEMP'] || ENV['TMP'] || ENV['USERPROFILE'] || Dir.tmpdir
-  else
-    TMPDIR = ENV['TEMP'] || ENV['TMP'] || ENV['TMPDIR'] || Dir.tmpdir
-  end
-
-  # The name of the file. This is only retained if the first argument to the
-  # constructor is false.
-  attr_reader :path
-
-  # Creates a new, anonymous, temporary file in your File::Temp::TMPDIR
-  # directory
-  #
-  # 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.
-  #
-  # 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
-  # a unique filename. This template should end with 3 to 6 'X' characters.
-  # The default template is 'rb_file_temp_XXXXXX'. In this case the temporary
-  # file lives in the directory where it was created.
-  #
-  # The +template+ argument is ignored if the +delete+ argument is true.
-  #
-  # Example:
-  #
-  #    fh = File::Temp.new(true, 'rb_file_temp_XXXXXX') => file
-  #    fh.puts 'hello world'
-  #    fh.close
-  #
-  def initialize(delete = true, template = 'rb_file_temp_XXXXXX')
-    @fptr = nil
-
-    if delete
-      @fptr = tmpfile()
-      fd = _fileno(@fptr)
-    else
-      begin
-        omask = File.umask(077)
-
-        if File::ALT_SEPARATOR
-          ptr = FFI::MemoryPointer.from_string(template.dup)
-
-          if _mktemp_s(ptr, ptr.size) != 0
-            raise SystemCallError, '_mktemp_s function failed: ' + get_error
-          end
-
-          template = ptr.read_string
-        end
-
-        @path = File.join(TMPDIR, template)
-        fd = mkstemp(@path)
-
-        if fd < 0
-          raise SystemCallError, 'mkstemp function failed: ' + get_error
-        end
-      ensure
-        File.umask(omask)
-      end
-    end
-
-    super(fd, 'wb+')
-  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.
-  #
-  def close
-    super
-    fclose(@fptr) if @fptr
-  end
-
-  # Generates a unique file name.
-  #
-  # Note that a file is not actually generated on the filesystem.
-  #
-  def self.temp_name
-    if File::ALT_SEPARATOR
-      TMPDIR + tmpnam(nil) << '.tmp'
-    else
-      tmpnam(nil) << '.tmp'
-    end
-  end
-
-  private
-
-  def get_error
-    if File::ALT_SEPARATOR
-      errno  = GetLastError()
-      buffer = FFI::MemoryPointer.new(:char, 512)
-      flags  = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ARGUMENT_ARRAY
-
-      FormatMessageA(flags, 0, errno, 0, buffer, buffer.size, nil)
-
-      buffer.read_string
-    else
-      strerror(FFI.errno)
-    end
-  end
-
-  if File::ALT_SEPARATOR
-
-    # Simple wrapper around the GetTempPath function.
-    #
-    def get_temp_path
-      buf = FFI::MemoryPointer.new(:char, 1024)
-
-      if GetTempPathA(buf.size, buf) == 0
-        raise SystemCallError, 'GetTempPathA function failed: ' + get_error
-      end
-
-      buf.read_string.chop # remove trailing slash
-    end
-
-    # The version of tmpfile() implemented by Microsoft is unacceptable.
-    # It attempts to write to C:\ (root) instead of a temporary directory.
-    # This is not only bad behavior, it won't work on Windows 7 and later
-    # without admin rights due to security restrictions.
-    #
-    # This is a custom implementation based on some code from the Cairo
-    # project.
-    #
-    def tmpfile
-      file_name = get_temp_path()
-      buf = FFI::MemoryPointer.new(:char, 1024)
-
-      if GetTempFileNameA(file_name, 'rb_', 0, buf) == 0
-        raise SystemCallError, 'GetTempFileNameA function failed: ' + get_error
-      end
-
-      file_name = buf.read_string
-
-      handle = CreateFileA(
-        file_name,
-        GENERIC_READ | GENERIC_WRITE,
-        0,
-        nil,
-        CREATE_ALWAYS,
-        FILE_ATTRIBUTE_NORMAL | FILE_FLAG_DELETE_ON_CLOSE,
-        0
-      )
-
-      if handle == INVALID_HANDLE_VALUE
-        DeleteFileA(file_name)
-        raise SystemCallError, 'CreateFileA function failed: ' + get_error
-      end
-
-      fd = _open_osfhandle(handle, 0)
-
-      if fd < 0
-        CloseHandle(handle)
-        raise SystemCallError, '_open_osfhandle function failed: ' + get_error
-      end
-
-      fp = _fdopen(fd, 'w+b')
-
-      if fp.nil?
-        _close(fd)
-        CloseHandle(handle)
-        raise SystemCallError, 'fdopen function failed: ' + get_error
-      end
-
-      fp
-    end
-
-    # The MS C runtime does not define a mkstemp() function, so we've
-    # created one here.
-    #
-    def mkstemp(template)
-      flags = RDWR | BINARY | CREAT | EXCL | SHORT_LIVED
-      pmode = S_IREAD | S_IWRITE
-
-      fd = _open(template, flags, pmode)
-
-      if fd < 0
-        raise SystemCallError, '_open function failed: ' + get_error
-      end
-
-      fd
-    end
-  end
-end
+if RUBY_PLATFORM == 'java'
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'temp_java')
+else
+  require File.join(File.expand_path(File.dirname(__FILE__)), 'temp_c')
+end