mkdtemp 1.2 → 1.2.1

data/ext/mkdtemp.c

@@ -1,4 +1,4 @@
-// Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
+// Copyright 2007-2011 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:
@@ -39,32 +39,43 @@ 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".
+/*
+ * @overload mkdtemp(template)
+ *   Securely create a temporary directory.
+ *
+ *   This method securely creates temporary directories. It is a wrapper for the
+ *   <code>mkdtemp()</code> function in the standard C library.
+ *
+ *   If supplied a block, performs a <code>Dir.chdir</code> into the created
+ *   directory and yields to the block:
+ *
+ *   @example
+ *      # this:            # is a shorthand for:
+ *      Dir.mkdtemp do     #   dir = Dir.mkdtemp
+ *        puts Dir.pwd     #   Dir.chdir dir do
+ *      end                #     puts Dir.pwd
+ *                         #   end
+ *
+ *   @yield an optional block to perform operations inside the created directory.
+ *   @param [String, nil] template a template describing the desired form of the
+ *      directory name. If no template is supplied then "/tmp/temp.XXXXXX" is used
+ *      as a default.
+ *   @return [String] the path to the created directory
+ *   @raise [TypeError] if <code>template</code> is not a String or cannot be
+ *      converted into one
+ *   @raise [SecurityError] if <code>template</code> is tainted and
+ *      <code>$SAFE</code> is > 0
+ *   @raise [NoMemoryError] if temporary storage for the template could not be
+ *      allocated
+ *   @raise [SystemCallError] if the call to <code>mkdtemp()</code> fails
+ *
+ * @note
+ *   Note that the exact implementation of <code>mkdtemp()</code> 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, block;
@@ -95,7 +106,7 @@ static VALUE dir_mkdtemp_m(int argc, VALUE *argv, VALUE self)
         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)
+    if (rb_block_given_p())
         rb_iterate(call_chdir, template, yield_block, block);
     return template;
 }
@@ -103,7 +114,7 @@ static VALUE dir_mkdtemp_m(int argc, VALUE *argv, VALUE self)
 void Init_mkdtemp()
 {
 #if 0
-    // for Yardoc, need to fake this here
+    // for YARD, 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,28 +1,5 @@
-# Copyright 2008-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.
-
 class Dir
   module Mkdtemp
-    VERSION = '1.2'
+    VERSION = '1.2.1'
   end # module Mkdtemp
 end # class Dir

metadata

@@ -1,11 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mkdtemp
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 29
+  prerelease: 
   segments: 
   - 1
   - 2
-  version: "1.2"
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Wincent Colaiuta
@@ -13,24 +15,65 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 +02:00
-default_executable: 
+date: 2011-09-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :development
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
-        - 2
         - 0
+        version: "0"
+  version_requirements: *id001
+  name: rake
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
         - 0
-        - beta
-        version: 2.0.0.beta
+        version: "0"
+  version_requirements: *id002
+  name: rcov
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  version_requirements: *id003
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: yard
 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: []
@@ -45,7 +88,6 @@ files:
 - ext/ruby_compat.h
 - ext/extconf.rb
 - ext/depend
-has_rdoc: false
 homepage: https://wincent.com/products/mkdtemp
 licenses: []
 
@@ -56,23 +98,27 @@ require_paths:
 - ext
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: mkdtemp
-rubygems_version: 1.3.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Secure creation of temporary directories