file-temp 0.1.0

data/CHANGES

@@ -0,0 +1,2 @@
+= 0.1.0 - 1-Jun-2007
+* Initial release

data/MANIFEST

@@ -0,0 +1,8 @@
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* file-temp.gemspec
+* ext/extconf.rb
+* ext/temp.c
+* test/tc_file_temp.rb

data/README

@@ -0,0 +1,56 @@
+= Description
+   The file-temp library is an alternate way to handle tempfile generation.
+
+= Synopsis
+   require 'file/temp'
+
+   fh = FileTemp.new
+   fh.puts "hello"
+   fh.close # => Tempfile automatically deleted
+
+   fh = FileTemp.new(false)
+   fh.puts "world"
+   fh.close # => Tempfile still on your filesystem
+
+= Installation
+== Standard Installation
+   rake test (optional)
+   rake install
+
+== Gem Installation
+   rake test (optional)
+   rake gem_install
+
+= 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.
+
+= Other libraries
+   I am aware of Cian Synnott's ruby-stemp project. However, I don't like the
+   interface, it's GNU-centric (which causes portability issues), and Cian
+   has disabled all the trackers and mailing lists on the RubyForge project
+   site, as well as online SCM access. So, if he doesn't want feedback, I'm
+   not going to waste time with it.
+
+= Future Plans
+   I plan on adding MS Windows support in the next release.
+
+= License
+   Ruby's
+
+= Copyright
+   (C) 2007 Daniel J. Berger
+   All Rights Reserved
+
+= Warranty
+   This package 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
+   djberg96 at gmail dot com
+
+= See also
+   tmpfile(), mkstemp(), tmpnam()

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+desc "Clean the build files for the file-temp source for UNIX filetems"
+task :clean do
+   make = RUBY_PLATFORM.match('mswin') ? 'nmake' : 'make'
+   Dir.chdir('ext') do
+      FileUtils.rm_rf('file') if File.exists?('file')
+      build_file = 'temp.' + Config::CONFIG['DLEXT']
+      obj_file   = 'temp.obj'
+      if File.exists?(build_file) || File.exists?(obj_file)
+         sh "#{make} distclean"
+      end
+      File.delete("temp.so.manifest") if File.exists?("temp.so.manifest")
+   end
+end
+
+desc "Build the file-temp package on UNIX filetems (but don't install it)"
+task :build => [:clean] do
+   make = RUBY_PLATFORM.match('mswin') ? 'nmake' : 'make'
+   Dir.chdir('ext') do
+      ruby 'extconf.rb'
+      sh "#{make}"
+      build_file = 'temp.' + Config::CONFIG['DLEXT']
+      Dir.mkdir('file') unless File.exists?('file')
+      FileUtils.cp(build_file, 'file')
+   end
+end
+
+desc "Install the file-temp package"
+task :install => [:build] do
+   Dir.chdir('ext') do
+      make = RUBY_PLATFORM.match('mswin') ? 'nmake' : 'make'
+      sh "#{make} install"
+   end
+end
+
+desc "Install the file-temp package as a gem"
+task :install_gem do
+   ruby 'file-temp.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+desc "Run the test suite"
+Rake::TestTask.new("test") do |t|
+   task :test => :build
+   t.libs << 'ext'
+   t.test_files = FileList['test/tc_file_temp.rb']
+end

data/ext/extconf.rb

@@ -0,0 +1,10 @@
+require 'mkmf'
+dir_config('tmpfile')
+
+unless have_func('tmpfile')
+   raise 'This library is not supported on your platform. Aborting'
+end
+
+have_func('mkstemp')
+
+create_makefile('file/temp')

data/ext/temp.c

@@ -0,0 +1,106 @@
+#include <ruby.h>
+#include <stdio.h>
+
+#ifndef HAVE_MKSTEMP
+#include <fcntl.h>
+#include <temp.h>
+#endif
+
+#ifdef HAVE__SOPEN_S
+#include <share.h>
+#endif
+
+#define VERSION "0.1.0"
+
+VALUE cFileTemp;
+
+/* call-seq:
+ *    FileTemp.new(delete = true, template = 'rb_file_temp_XXXXXX') => file
+ *
+ * Creates a new, anonymous temporary file in your FileTemp::TMPDIR directory,
+ * or /tmp if that cannot be accessed. If your $TMPDIR environment variable is
+ * set, it will be used instead. If $TMPDIR is not writable by the process, it
+ * will resort back to FileTemp::TMPDIR or /tmp.
+ *
+ * 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 $TMPDIR.
+ *
+ * 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.
+ */
+static VALUE tempfile_init(int argc, VALUE* argv, VALUE self){
+   VALUE v_args[1];
+   VALUE v_delete;
+   VALUE v_template;
+
+   rb_scan_args(argc, argv, "02", &v_delete, &v_template);
+
+   if(NIL_P(v_delete))
+      v_delete = Qtrue;
+
+   if(RTEST(v_delete)){
+      FILE* fptr = tmpfile();
+      if(!fptr)
+         rb_sys_fail("tmpfile()");
+      
+      v_args[0] = INT2FIX(fileno(fptr));
+   }
+   else{
+      int fd;
+      char buf[L_tmpnam];
+      
+      if(NIL_P(v_template))
+         v_template = rb_str_new2("rb_file_temp_XXXXXX");
+         
+      fd = mkstemp(StringValuePtr(v_template));
+
+      if(fd < 0)
+         rb_sys_fail("mkstemp()");
+
+      v_args[0] = INT2FIX(fd);
+      v_args[0] = INT2FIX(fd);
+   }
+
+
+   return rb_call_super(1, v_args);
+}
+
+/* 
+ * Generates a unique file name, prefixed with the value of FileTemp::TMPDIR.
+ * Note that a file is not actually generated on the filesystem.
+ */
+static VALUE tempfile_tmpnam(VALUE klass){
+   char buf[L_tmpnam];
+   return rb_str_new2(tmpnam(buf));
+}
+
+void Init_temp(){
+
+   /* The FileTemp class creates managed temporary files. Unlike Ruby's
+    * Tempfile class from this standard library, this is a subclass of File.
+    * In addition, the temporary file is automatically deleted when all
+    * references to it are closed (instead of waiting until the Ruby process
+    * is complete).
+    */
+   cFileTemp = rb_define_class("FileTemp", rb_cFile);
+
+   /* Instance Methods */
+   rb_define_method(cFileTemp, "initialize", tempfile_init, -1);
+
+   /* Singleton Methods */
+   rb_define_singleton_method(cFileTemp, "tmpnam", tempfile_tmpnam, 0);
+
+   /* Constants */
+   
+   /* ENV['P_tmpdir']: Your system's tmpdir */ 
+   rb_define_const(cFileTemp, "TMPDIR", rb_str_new2(P_tmpdir));
+   
+   /* 0.1.0: The version of this library */
+   rb_define_const(cFileTemp, "VERSION", rb_str_new2(VERSION));
+}

data/test/tc_file_temp.rb

@@ -0,0 +1,55 @@
+######################################################################
+# tc_file_temp.rb
+#
+# Test suite for the file-temp library. These tests should be run
+# via the 'rake test' task.
+######################################################################
+require 'test/unit'
+require 'file/temp'
+
+class TC_File_Temp < Test::Unit::TestCase
+   def setup
+      @template = 'file-temp-test-XXXXX'
+      @fh = nil
+   end
+
+   def test_file_temp_version
+      assert_equal('0.1.0', FileTemp::VERSION)
+   end
+
+   def test_file_temp_tmpdir
+      assert_not_nil(FileTemp::TMPDIR)
+      assert_kind_of(String, FileTemp::TMPDIR)
+      assert_equal(true, ['/tmp', '/var/tmp/'].include?(FileTemp::TMPDIR))
+   end
+
+   def test_file_temp_auto_delete
+      assert_nothing_raised{ @fh = FileTemp.new }
+      assert_nothing_raised{ @fh.print "hello" }
+      assert_nothing_raised{ @fh.close }
+   end
+
+   def test_file_temp_no_delete
+      assert_nothing_raised{ @fh = FileTemp.new(false) }
+      assert_equal(true, Dir["rb_file_temp*"].length == 1)
+      assert_nothing_raised{ @fh.print "hello" }
+      assert_nothing_raised{ @fh.close }
+   end
+
+   def test_file_temp_no_delete_with_template
+      assert_nothing_raised{ FileTemp.new(false, 'temp_foo_XXXXX') }
+      assert_equal(true, Dir["temp_foo*"].length == 1)
+   end
+
+   def test_file_temp_expected_errors
+      assert_raises(ArgumentError){ FileTemp.new(true, 'temp_bar_XXXXX', 1) }
+   end
+
+   def teardown
+      @template = nil
+      @fh.close if @fh rescue nil # Ignore closed streams
+      @fh = nil
+      Dir["temp_*"].each{ |f| File.delete(f) }
+      Dir["rb_file_temp_*"].each{ |f| File.delete(f) }
+   end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: file-temp
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-06-01 00:00:00 -06:00
+summary: An alternative way to generate tempfiles
+require_paths: 
+- lib
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/projects/shards
+rubyforge_project: shards
+description: An alternative way to generate tempfiles
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Daniel J. Berger
+files: 
+- test/tc_file_temp.rb
+- CHANGES
+- MANIFEST
+- Rakefile
+- README
+- ext/temp.c
+test_files: 
+- test/tc_file_temp.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
+- ext/temp.c
+executables: []
+
+extensions: 
+- ext/extconf.rb
+requirements: []
+
+dependencies: []
+