mkdtemp 1.1.1 → 1.2

data/ext/depend

@@ -1,18 +1,25 @@
-# depend
-# Additional material for Makefile
-# Copyright 2008-2009 Wincent Colaiuta
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright 2008-2010 Wincent Colaiuta. All rights reserved.
 #
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
 #
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
 
 # don't warn about unused params because many Ruby methods accept "self" but don't use it
 CFLAGS += -std=gnu99 -Wall -Wextra -Wno-unused-parameter

data/ext/extconf.rb

@@ -1,17 +1,25 @@
-# Copyright 2007 Wincent Colaiuta
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
 #
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
 #
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
 
 require 'mkmf'
 create_makefile('mkdtemp')
-

data/ext/mkdtemp.c

@@ -1,70 +1,110 @@
-/*
-Copyright 2007-2009 Wincent Colaiuta
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
+// Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+//    this list of conditions and the following disclaimer.
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+//    this list of conditions and the following disclaimer in the documentation
+//    and/or other materials provided with the distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
 
 #include <ruby.h>
 #include <errno.h>
 #include <unistd.h>
 #include "ruby_compat.h"
 
-/*
-
-call-seq:
-    Dir.mkdtemp([string])   -> String or nil
-
-This method securely creates temporary directories. It is a wrapper for the mkdtemp() function in the standard C library. It takes
-an optional String parameter as a template describing the desired form of the directory name and overwriting the template in-place;
-if no template is supplied then "/tmp/temp.XXXXXX" is used as a default.
+// helper function needed by rb_iterate; see:
+//  http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/144100
+VALUE call_chdir(VALUE dir)
+{
+    return rb_funcall(rb_cDir, rb_intern("chdir"), 1, dir);
+}
 
-Note that the exact implementation of mkdtemp() may vary depending on the target system. For example, on Mac OS X at the time of
-writing, the man page states that the template may contain "some number" of "Xs" on the end of the string, whereas on Red Hat
-Enterprise Linux it states that the template suffix "must be XXXXXX".
+// helper function needed by rb_iterate
+VALUE yield_block(VALUE ignored, VALUE block)
+{
+    return rb_funcall(block, rb_intern("call"), 0);
+}
 
-*/
+// Document-method: mkdtemp
+//
+// call-seq:
+//     Dir.mkdtemp([string]) -> String or nil
+//     Dir.mkdtemp([string]) { ... } -> String or nil
+//
+// This method securely creates temporary directories. It is a wrapper for the
+// mkdtemp() function in the standard C library. It takes an optional String
+// parameter as a template describing the desired form of the directory name
+// and overwriting the template in-place; if no template is supplied then
+// "/tmp/temp.XXXXXX" is used as a default.
+//
+// If supplied a block, performs a Dir.chdir into the created directory and
+// yields to the block:
+//
+//      # this:            # is a shorthand for:
+//      Dir.mkdtemp do     #   dir = Dir.mkdtemp
+//        puts Dir.pwd     #   Dir.chdir dir do
+//      end                #     puts Dir.pwd
+//                         #   end
+//
+// Note that the exact implementation of mkdtemp() may vary depending on the
+// target system. For example, on Mac OS X at the time of writing, the man page
+// states that the template may contain "some number" of "Xs" on the end of the
+// string, whereas on Red Hat Enterprise Linux it states that the template
+// suffix "must be XXXXXX".
 static VALUE dir_mkdtemp_m(int argc, VALUE *argv, VALUE self)
 {
-    VALUE template;
+    VALUE template, block;
     char *c_template;
     char *path;
 
-    /* process argument */
-    if (rb_scan_args(argc, argv, "01", &template) == 0) /* check for 0 mandatory arguments, 1 optional argument */
-        template = Qnil;                                /* default to nil if no argument passed */
+    // process arguments
+    if (rb_scan_args(argc, argv, "01&", &template, &block) == 0)    // 0 mandatory, 1 optional, 1 block
+        template = Qnil;                                            // default to nil if no argument passed
     if (NIL_P(template))
-        template = rb_str_new2("/tmp/temp.XXXXXX");     /* fallback to this template if passed nil */
-    SafeStringValue(template);                          /* raises if template is tainted and SAFE level > 0 */
-    template = StringValue(template);                   /* duck typing support */
+        template = rb_str_new2("/tmp/temp.XXXXXX");                 // fallback to this template if passed nil
+    SafeStringValue(template);                                      // raises if template is tainted and SAFE level > 0
+    template = StringValue(template);                               // duck typing support
 
-    /* create temporary storage */
+    // create temporary storage
     c_template = malloc(RSTRING_LEN(template) + 1);
     if (!c_template)
         rb_raise(rb_eNoMemError, "failed to allocate %ld bytes of template storage", RSTRING_LEN(template) + 1);
     strncpy(c_template, RSTRING_PTR(template), RSTRING_LEN(template));
-    c_template[RSTRING_LEN(template)] = 0;              /* NUL-terminate */
+    c_template[RSTRING_LEN(template)] = 0;              // NUL-terminate
 
-    /* fill out template */
+    // fill out template
     path = mkdtemp(c_template);
     if (path)
         template = rb_str_new2(path);
     free(c_template);
     if (path == NULL)
         rb_raise(rb_eSystemCallError, "mkdtemp failed (error #%d: %s)", errno, strerror(errno));
+
+    // yield to block if given, inside Dir.chdir
+    if (rb_block_given_p() == Qtrue)
+        rb_iterate(call_chdir, template, yield_block, block);
     return template;
 }
 
 void Init_mkdtemp()
 {
-    rb_define_module_function(rb_cDir, "mkdtemp", dir_mkdtemp_m, -1);
+#if 0
+    // for Yardoc, need to fake this here
+    VALUE rb_cDir = rb_define_class("Dir", rb_cObject);
+#endif
+    rb_define_singleton_method(rb_cDir, "mkdtemp", dir_mkdtemp_m, -1);
 }

data/lib/mkdtemp/version.rb

@@ -1,19 +1,28 @@
-# Copyright 2008-2009 Wincent Colaiuta
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# Copyright 2008-2010 Wincent Colaiuta. All rights reserved.
 #
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
 #
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
 
 class Dir
   module Mkdtemp
-    VERSION = '1.1.1'
+    VERSION = '1.2'
   end # module Mkdtemp
 end # class Dir

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: mkdtemp
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - Wincent Colaiuta
@@ -9,10 +13,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 +01:00
+date: 2010-07-29 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        version: 2.0.0.beta
+  type: :development
+  version_requirements: *id001
 description: "    mkdtemp is a C extension that wraps the Standard C Library function\n    of the same name to make secure creation of temporary directories\n    easily available from within Ruby.\n"
 email: win@wincent.com
 executables: []
@@ -23,14 +41,12 @@ extra_rdoc_files: []
 
 files: 
 - lib/mkdtemp/version.rb
-- spec/mkdtemp_spec.rb
-- spec/spec_helper.rb
 - ext/mkdtemp.c
 - ext/ruby_compat.h
 - ext/extconf.rb
 - ext/depend
-has_rdoc: true
-homepage: http://mkdtemp.rubyforge.org/
+has_rdoc: false
+homepage: https://wincent.com/products/mkdtemp
 licenses: []
 
 post_install_message: 
@@ -43,18 +59,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: mkdtemp
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Secure creation of temporary directories

data/spec/mkdtemp_spec.rb

@@ -1,78 +0,0 @@
-# Copyright 2008 Wincent Colaiuta
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-describe 'Dir.mkdtemp' do
-  before do
-    if not File.exist? '/tmp'
-      pending "cannot run spec because '/tmp' does not exist"
-    elsif not File.directory? '/tmp'
-      pending "cannot run spec because '/tmp' is not a directory"
-    elsif not File.writable? '/tmp'
-      pending "cannot run spec because '/tmp' is not writeable"
-    end
-  end
-
-  it 'should return the modified template path' do
-    path = Dir.mkdtemp
-    path.should be_kind_of(String)
-    path.should_not == '/tmp/temp.XXXXXX'
-  end
-
-  it 'should create the directory corresponding to the template' do
-    path = Dir.mkdtemp
-    File.exist?(path).should == true
-    File.directory?(path).should == true
-  end
-
-  it 'should create the directory with write permissions' do
-    path = Dir.mkdtemp
-    File.writable?(path).should == true
-  end
-
-  it 'should create the directory with read permissions' do
-    path = Dir.mkdtemp
-    File.readable?(path).should == true
-  end
-
-  it 'should create the directory with secure ownership (same user as caller)' do
-    path = Dir.mkdtemp
-    File.owned?(path).should == true
-  end
-
-  it 'should complain if passed a template that includes non-existentent parent directories' do
-    non_existent_dir = '/temp-which-does-not-exist'
-    if File.exist? non_existent_dir
-      pending "cannot run because '#{non_existent_dir}' exists"
-    end
-    lambda { Dir.mkdtemp "/#{non_existent_dir}/temp.XXXXXX" }.should raise_error(SystemCallError)
-  end
-
-  it 'should use "/tmp/temp.XXXXXX" as a template if passed nil' do
-    path = Dir.mkdtemp
-    path.should match(%r{\A/tmp/temp\..{6}\z})
-    path.should_not == '/tmp/temp.XXXXXX'
-  end
-
-  it 'should use substitute random characters for the trailing "Xs" in the template' do
-    path = Dir.mkdtemp '/tmp/test.XXXXXX'
-    path.should_not == '/tmp/test.XXXXXX'
-  end
-
-  it 'should leave the prefix portion of the template unchanged' do
-    path = Dir.mkdtemp '/tmp/test.XXXXXX'
-    path.should match(%r{\A/tmp/test\..{6}\z})
-  end
-end

data/spec/spec_helper.rb

@@ -1,18 +0,0 @@
-# Copyright 2008 Wincent Colaiuta
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-require 'pathname'
-require 'rubygems'
-require 'spec'
-require File.join(File.dirname(__FILE__), '..', 'ext', 'mkdtemp')