win32-open3 0.2.5 → 0.2.6

data/CHANGES

@@ -1,3 +1,10 @@
+== 0.2.6 - 1-June-2007
+* Fixed RubyForge bug #20455 (closed IO stream). Thanks go an anonymous user
+  for the spot.
+* Added a Rakefile with tasks for building, testing and installation.
+* Minor updates to the test file.
+* Some minor rdoc improvements.
+
 == 0.2.5 - 8-Dec-2006
 * Added a WIN32_OPEN3_VERSION constant.
 * Fixes and updates to the gemspec.

data/MANIFEST

@@ -1,14 +1,11 @@
-CHANGES
-MANIFEST
-README
-win32-open3.gemspec
-
-doc/open3.txt
-
-examples/open3_test.rb
-
-ext/extconf.rb
-ext/open3.c
-ext/open3.h
-
-test/tc_open3.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* win32-open3.gemspec
+* doc/open3.txt
+* examples/open3_test.rb
+* ext/extconf.rb
+* ext/win32/open3.c
+* ext/win32/open3.h
+* test/tc_open3.rb

data/README

@@ -1,20 +1,13 @@
 = Description
-   This package provides an Open3.popen3 implementation for Win32 systems
+   This library provides an Open3.popen3 implementation for MS Windows.
 
 = Prerequisites
-   Ruby 1.8.0 or later
+   Ruby 1.8.2 or later
    C++ compiler (if building from source).
    
 = Installation
-== Manual Installation
-   cd ext
-   ruby extconf.rb
-   nmake
-   ruby tc_open3.rb (optional, in the 'test' directory)
-   nmake install
-== Gem Installation
-   ruby win32-open3.gemspec
-   gem install win32-open3-X.Y.Z.gem
+   rake test (optional)
+   rake install (non-gem) or rake install_gem (gem)
    
 = Synopsis
    require 'win32/open3'
@@ -29,36 +22,39 @@
    }
 
 = Notes
-   This package is not supported on Windows 95, 98, or ME.
-   This is a stripped down version of Park Heesob's win32_popen package.
+   This library is not supported on Windows 95, 98, or ME.
+   This is a stripped down version of Park Heesob's win32_popen library.
 
 = Developer's Notes
-   This is a repackaging of Heesob's win32_popen module.  The purpose of the
+   This is a repackaging of Heesob's win32_popen module. The purpose of the
    repackaging was to create a unified API between the existing Ruby open3
-   package and this package.
+   library and this library.
 
-   The popen2 and posix_popen methods are not included in this release.  They
+   The popen2 and posix_popen methods are not included in this release. They
    were originally part of the win32_popen module, but have been left out.
    They may be added back in at a later date.
 
    There are a couple of differences in the Windows version for open3 (which
    also apply to Open4.popen4) - the mode flag and the show flag.  For the
    mode, you can specify either 't' (text, the default) or 'b' (binary) as a
-   second argument.  For the show flag, you can specify either true or false,
+   second argument. For the show flag, you can specify either true or false,
    which will show the console window, or not, depending on the value you
    pass.  The default is false.
 
 = Known Issues
-   I have noticed that this package (and others) may segfault if you are using
+   I have noticed that this library (and others) may segfault if you are using
    the latest version of the Ruby one-click installer and VC++ 7.0 or later.
    This appears to be an issue between VC++ 6 (which the installer was built
-   with) and VC++ 7.0.  Your best solution is to either upgrade your C
+   with) and VC++ 7.0. Your best solution is to either upgrade your C
    compiler or to rebuild Ruby from scratch rather than using the installer.
 
-   You can also download a precompiled binary from the project site.  Look for a
+   You can also download a precompiled binary from the project site. Look for a
    file called 'open3-x.y.z-vc6.so' on the 'files' page, where 'x.y.z' is a
    version number, if you want a binary that's compatible with Curt Hibbs one
    click installer.
+   
+= Future Plans
+   Replace the current implementation with a pure Ruby version.
  
- = More Documentation
+= More Documentation
    See the doc/open3.txt file for more details.

data/doc/open3.txt

@@ -1,5 +1,5 @@
 = Description
-   An open3 library for Win32
+   An open3 library for MS Windows.
 	
 = Synopsis
    require 'win32/open3'
@@ -63,7 +63,7 @@ Open4.popen4(command, mode='t', show=false){ |io_in, io_out, io_err, pid| ... }
    Ruby's
         
 = Copyright
-   (C) 2003-2006 Daniel J. Berger, All Rights Reserved .
+   (C) 2003-2008 Daniel J. Berger, All Rights Reserved .
        
 = Warranty
    This package is provided "as is" and without any express or

data/ext/extconf.rb

@@ -1,4 +1,4 @@
 require 'mkmf'
 
 have_type('rb_pid_t', 'ruby.h') # For 1.8.3 and later
-create_makefile('win32/open3')
+create_makefile('win32/open3', 'win32')

data/ext/{open3.c → win32/open3.c}

@@ -40,9 +40,8 @@ static int rb_io_mode_flags2(int mode){
    }
 
 #ifdef O_BINARY
-   if(mode & O_BINARY) {
+   if(mode & O_BINARY)
       flags |= FMODE_BINMODE;
-   }
 #endif
 
    return flags;
@@ -65,14 +64,17 @@ static char* rb_io_modenum_mode(int flags, char* mode){
    }
 
    *p++ = '\0';
+
 #ifdef O_BINARY
    if(flags & O_BINARY){
       if(mode[1] == '+'){
-         mode[1] = 'b'; mode[2] = '+'; mode[3] = '\0';
+         mode[1] = 'b';
+         mode[2] = '+';
+         mode[3] = '\0';
       }
       else{
          mode[1] = 'b'; mode[2] = '\0';
-      }
+      }      
    }
 #endif
    return mode;
@@ -81,10 +83,12 @@ static char* rb_io_modenum_mode(int flags, char* mode){
 /* Used to close io handle */
 static VALUE io_close(VALUE val) {
    int i;
-   for(i=0; i<3; i++){
+
+   for(i = 0; i < 3; i++){
       if(rb_funcall(RARRAY(val)->ptr[i], rb_intern("closed?"), 0) == Qfalse)
          rb_funcall(RARRAY(val)->ptr[i], rb_intern("close"), 0);
    }
+
    return Qnil;
 }
 
@@ -105,43 +109,38 @@ static VALUE io_close(VALUE val) {
  */
 static VALUE win32_popen3(int argc, VALUE *argv, VALUE klass)
 {
-   VALUE pname, pmode, port;
+   VALUE v_name, v_mode, v_port;
    VALUE v_show_window = Qfalse;
    char mbuf[4];
    int tm = 0;
    char *mode = "t";
 
-   rb_scan_args(argc, argv, "12", &pname, &pmode, &v_show_window);
+   rb_scan_args(argc, argv, "12", &v_name, &v_mode, &v_show_window);
 
-   /* Mode can be either a string or a number */
-   if(!NIL_P(pmode)){
-      if(FIXNUM_P(pmode)){
-         mode = rb_io_modenum_mode(FIX2INT(pmode), mbuf);
-      }
-      else{
-         mode = StringValuePtr(pmode);
-      }
+   // Mode can be either a string or a number
+   if(!NIL_P(v_mode)){
+      if(FIXNUM_P(v_mode))
+         mode = rb_io_modenum_mode(FIX2INT(v_mode), mbuf);
+      else
+         mode = StringValuePtr(v_mode);
    }
 
-   if(*mode == 't'){
-     tm = _O_TEXT;
-   }
-   else if(*mode != 'b') {
+   if(*mode == 't')
+      tm = _O_TEXT;
+   else if(*mode != 'b')
       rb_raise(rb_eArgError, "popen3() arg 2 must be 't' or 'b'");
-   }
-   else{
+   else
       tm = _O_BINARY;
-   }
 
-   port = ruby_popen(StringValuePtr(pname), tm, v_show_window);
+   v_port = ruby_popen(StringValuePtr(v_name), tm, v_show_window);
    
-   /* Ensure handles are closed in block form */
-   if(rb_block_given_p()) {
-      rb_ensure(rb_yield_splat, port, io_close, port);
+   // Ensure handles are closed in block form
+   if(rb_block_given_p()){
+      rb_ensure(rb_yield_splat, v_port, io_close, v_port);
       return win32_last_status;
    }
    
-   return port;
+   return v_port;
 }
 
 static BOOL RubyCreateProcess(char *cmdstring, HANDLE hStdin, HANDLE hStdout,
@@ -152,44 +151,44 @@ static BOOL RubyCreateProcess(char *cmdstring, HANDLE hStdin, HANDLE hStdout,
    char *s1,*s2, *s3 = " /c ";
    int i, x;
 
-
-   if(i = GetEnvironmentVariable("COMSPEC",NULL,0)){
+   if(i = GetEnvironmentVariable("COMSPEC", NULL, 0)){
       char *comshell;
       s1 = (char *)_alloca(i);
-      if (!(x = GetEnvironmentVariable("COMSPEC", s1, i)))
+
+      if(!(x = GetEnvironmentVariable("COMSPEC", s1, i)))
          return x;
 
-    /* Explicitly check if we are using COMMAND.COM.  If we are
-     * then use the w9xpopen hack.
-     */
-    comshell = s1 + x;
-    while (comshell >= s1 && *comshell != '\\')
+      /* Explicitly check if we are using COMMAND.COM. If we are
+       * then use the w9xpopen hack.
+       */
+      comshell = s1 + x;
+
+      while(comshell >= s1 && *comshell != '\\')
          --comshell;
-     ++comshell;
 
-      if (GetVersion() < 0x80000000 &&
-         _stricmp(comshell, "command.com") != 0) {
-       // NT/2000 and not using command.com.
+      ++comshell;
+
+      // Windows 95, 98 and ME are not supported      
+      if(GetVersion() < 0x80000000 && _stricmp(comshell, "command.com") != 0){
          x = i + strlen(s3) + strlen(cmdstring) + 1;
          s2 = ALLOCA_N(char, x);
-        sprintf(s2, "%s%s%s", s1, s3, cmdstring);
-     }
+         sprintf(s2, "%s%s%s", s1, s3, cmdstring);
+      }
       else{
-        // Windows 9x or ME
-        rb_raise(rb_eRuntimeError,"not supported on this platform");
-     }
+         rb_raise(rb_eRuntimeError,"not supported on this platform");
+      }
    }
-
-   // Could be an else here to try cmd.exe / command.com in the path
-   // Now we'll just error out..
-  else {
-    rb_raise(rb_eRuntimeError,
-        "Cannot locate a COMSPEC environment variable to "
-        "use as the shell");
-     return FALSE;
+   else{
+      // Could be an else here to try cmd.exe / command.com in the path.
+      // Now we'll just error out..
+      rb_raise(rb_eRuntimeError,
+         "Cannot locate a COMSPEC environment variable to use as the shell"
+      );
+      return FALSE;
    }
 
    ZeroMemory(&siStartInfo, sizeof(STARTUPINFO));
+
    siStartInfo.cb = sizeof(STARTUPINFO);
    siStartInfo.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
    siStartInfo.hStdInput = hStdin;
@@ -235,10 +234,10 @@ static BOOL RubyCreateProcess(char *cmdstring, HANDLE hStdin, HANDLE hStdout,
       &siStartInfo,
       &piProcInfo)
     ){
-      /* Close the handles now so anyone waiting is woken. */
+      // Close the handles now so anyone waiting is woken.
       CloseHandle(piProcInfo.hThread);
 
-      /* Return process handle */
+      // Return process handle
       *hProcess = piProcInfo.hProcess;
       *pid = (pid_t)piProcInfo.dwProcessId;
       return TRUE;
@@ -251,12 +250,12 @@ static BOOL RubyCreateProcess(char *cmdstring, HANDLE hStdin, HANDLE hStdout,
    return FALSE;
 }
 
-/* Set the Process::Status.  Based on patches by Samuel Tesla and John-Mason
- * Shackelford.
+/* Set the Process::Status. This code is based on patches by Samuel Tesla and
+ * John-Mason Shackelford.
  */
 static void win32_set_last_status(const int status, const int pid)
 {
-  /* rb_last_status is defined in process.c in the main ruby.exe */
+  // rb_last_status is defined in process.c in the main ruby.exe
   __declspec (dllimport) extern VALUE rb_last_status;
   VALUE klass = rb_path2class("Process::Status");
   VALUE process_status = rb_obj_alloc(klass);
@@ -269,16 +268,27 @@ static void win32_set_last_status(const int status, const int pid)
 static void win32_pipe_finalize(OpenFile *file, int noraise)
 {
    int status;
-   
+
+   if(file->f){
+   	fclose(file->f);
+   	file->f = NULL;
+   }
+
+   if(file->f2){
+   	fclose(file->f2);
+   	file->f2 = NULL;
+   }
+
    if(pid_handle != NULL){
       GetExitCodeProcess(pid_handle, &status);
-      if(status != STILL_ACTIVE){
-	  	   win32_set_last_status(status, file->pid);
-      }
+      CloseHandle(pid_handle);
+
+      if(status != STILL_ACTIVE)
+ 	      win32_set_last_status(status, file->pid);
    }
 }
 
-/* The following code is based off of KB: Q190351 */
+// The following code is based off of KB: Q190351
 static VALUE ruby_popen(char *cmdstring, int mode, VALUE v_show_window)
 {
    HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr,
@@ -322,6 +332,7 @@ static VALUE ruby_popen(char *cmdstring, int mode, VALUE v_show_window)
       FALSE,
       DUPLICATE_SAME_ACCESS
    );
+
    if(!fSuccess){
       rb_raise(rb_eRuntimeError, "DuplicateHandle() failed: %s",
          ErrorDescription(GetLastError())
@@ -390,12 +401,13 @@ static VALUE ruby_popen(char *cmdstring, int mode, VALUE v_show_window)
       m2 = "wb";
    }
 
-   // Convert our HANDLE's into file descriptors and, ultimately, into
-   // Ruby IO objects.
+   // Convert HANDLE's into file descriptors and, ultimately, Ruby IO objects.
    fd1 = _open_osfhandle((long)hChildStdinWrDup, mode);
    f1 = _fdopen(fd1, m2);
+
    fd2 = _open_osfhandle((long)hChildStdoutRdDup, mode);
    f2 = _fdopen(fd2, m1);
+
    fd3 = _open_osfhandle((long)hChildStderrRdDup, mode);
    f3 = _fdopen(fd3, m1);
 
@@ -491,19 +503,19 @@ static VALUE ruby_popen(char *cmdstring, int mode, VALUE v_show_window)
    * when the child process exits and the ReadFile() will hang.
    */
 
-   if (!CloseHandle(hChildStdinRd)) {
+   if(!CloseHandle(hChildStdinRd)){
       rb_raise(rb_eRuntimeError, "CloseHandle() failed: %s",
          ErrorDescription(GetLastError())
       );
    }
 
-   if (!CloseHandle(hChildStdoutWr)) {
+   if(!CloseHandle(hChildStdoutWr)){
       rb_raise(rb_eRuntimeError, "CloseHandle() failed: %s",
          ErrorDescription(GetLastError())
       );
    }
 
-   if(!CloseHandle(hChildStderrWr)) {
+   if(!CloseHandle(hChildStderrWr)){
       rb_raise(rb_eRuntimeError, "CloseHandle() failed: %s",
          ErrorDescription(GetLastError())
       );
@@ -512,15 +524,22 @@ static VALUE ruby_popen(char *cmdstring, int mode, VALUE v_show_window)
    return port;
 }
 
-void
-Init_open3()
+/*
+ * Spawn an external program and retrieve the stdin, stdout and stderr IO
+ * handles, as well as the process ID. Use in block or non-block form.
+ */
+void Init_open3()
 {
    VALUE mOpen3 = rb_define_module("Open3");
+   
    VALUE mOpen4 = rb_define_module("Open4");
 
    rb_define_module_function(mOpen3, "popen3", win32_popen3, -1);
    rb_define_module_function(mOpen4, "popen4", win32_popen3, -1);
    
+   /* 0.2.6: The version of this library */
    rb_define_const(mOpen3, "WIN32_OPEN3_VERSION", rb_str_new2(WIN32_OPEN3_VERSION));
+   
+   /* 0.2.6: The version of this library */
    rb_define_const(mOpen4, "WIN32_OPEN3_VERSION", rb_str_new2(WIN32_OPEN3_VERSION));
 }

data/ext/{open3.h → win32/open3.h}

@@ -1,4 +1,4 @@
-#define WIN32_OPEN3_VERSION "0.2.5"
+#define WIN32_OPEN3_VERSION "0.2.6"
 #define MAX_STRING 512
 
 static VALUE io_alloc _((VALUE));
@@ -70,4 +70,4 @@ LPTSTR ErrorDescription(DWORD p_dwError)
    strncpy(ErrStr, (LPTSTR)hLocal, len-2); /* remove \r\n */
    LocalFree(hLocal);
    return ErrStr;
-}
+}

data/test/tc_open3.rb

@@ -1,20 +1,12 @@
 ###########################################################################
 # tc_open3.rb
 #
-# Test suite for the win32-open3 package.  Except for the
+# Test suite for the win32-open3 library.  Except for the
 # 'test_open3_with_arguments' test and Open4 tests, this suite passes
 # on Unix as well.
+#
+# You should run this test suite via the 'rake test' task.
 ###########################################################################
-base = File.basename(Dir.pwd)
-if base == 'test' || base =~ /win32-open3/i
-   require 'ftools'
-   Dir.chdir('..') if base == 'test'
-   Dir.mkdir('win32') unless File.exists?('win32')
-   File.copy('open3.so', 'win32') if File.exists?('open3.so')
-   $LOAD_PATH.unshift Dir.pwd   
-   Dir.chdir('test') rescue nil
-end
-
 require 'win32/open3'
 require 'test/unit'
 
@@ -23,6 +15,11 @@ class TC_Win32_Open3 < Test::Unit::TestCase
       @good_cmd = 'ver'
       @bad_cmd  = 'verb'
    end
+
+   def test_open3_version
+      assert_equal('0.2.6', Open3::WIN32_OPEN3_VERSION)
+      assert_equal('0.2.6', Open4::WIN32_OPEN3_VERSION)
+   end
    
    def test_open3_basic
       assert_respond_to(Open3, :popen3)
@@ -98,4 +95,4 @@ class TC_Win32_Open3 < Test::Unit::TestCase
       @good_cmd = nil
       @bad_cmd  = nil
    end
-end
+end

metadata

@@ -1,56 +1,65 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: win32-open3
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
-date: 2006-12-08 00:00:00 -07:00
-summary: Provides an Open3.popen3 implementation for MS Windows
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: win32utils
-description: Provides an Open3.popen3 implementation for MS Windows
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.2
-  version: 
+  version: 0.2.6
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
-files: 
-- doc/open3.txt
-- test/tc_open3.rb
-- ext/open3.c
-- ext/open3.h
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-01 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Provides an Open3.popen3 implementation for MS Windows
+email: djberg96@gmail.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
 - CHANGES
 - README
 - MANIFEST
-test_files: 
+- doc/open3.txt
+- ext/win32/open3.c
+files: 
+- doc/open3.txt
 - test/tc_open3.rb
-rdoc_options: []
-
-extra_rdoc_files: 
+- ext/extconf.rb
+- ext/win32
+- ext/win32/open3.c
+- ext/win32/open3.h
 - CHANGES
 - README
 - MANIFEST
-- doc/open3.txt
-- ext/open3.c
-executables: []
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+post_install_message: 
+rdoc_options: []
 
-extensions: 
-- ext/extconf.rb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: win32utils
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Provides an Open3.popen3 implementation for MS Windows
+test_files: 
+- test/tc_open3.rb