win32-process 0.5.8 → 0.5.9

data/CHANGES

@@ -1,3 +1,6 @@
+= 0.5.9 - 14-Jun-2008
+* Added a proper implementation of Process.ppid.
+
 = 0.5.8 - 24-Mar-2008
 * Fixed a bug in Process.create where the handles in the PROCESS_INFORMATION
   struct were not closed, regardless of the 'close_handles' option. Thanks

data/README

@@ -1,12 +1,12 @@
 = Description
    This package provides the fork, wait, wait2, waitpid, and waitpid2 methods
-   for MS Windows.  In addition, it provides a different implementation of the
-   kill method.
+   for MS Windows. In addition, it provides a different implementation of the
+   kill method, and a proper implementation of the Process.ppid method.
 
 = Prerequisites
    Ruby 1.8.2 or later.
-   The 'windows-pr' library, 0.7.4 or later.
-   The 'sys-proctable' library, 0.7.0 or later (test suite only).
+   The 'windows-pr' library, 0.8.6 or later.
+   The 'sys-proctable' library, 0.7.6 or later (test suite only).
 
 = Supported Platforms
    This library is supported on Windows 2000 or later.
@@ -29,7 +29,7 @@
    puts 'Done'
 	
 = Developer's Notes
-== The fork and wait methods
+== The Process.fork and Process.wait methods
    The fork method is emulated on Windows by spawning another Ruby process
    against $PROGRAM_NAME via the CreateProcess() Win32 API function. It will
    use its parent's environment and starting directory.
@@ -46,25 +46,29 @@
    IMPORTANT!	
    Note that because fork is calling CreateProcess($PROGRAM_NAME), it will
    start again from the top of the script instead of from the point of the
-   call.  We will try to address this in a future release, if possible.
+   call. We will try to address this in a future release, if possible.
 	
-== The kill method
+== The Process.kill method
    Initially, the kill method will try to get a HANDLE on the PID using the
-   OpenProcess() function.  If that succeeds, we know the process is running.
+   OpenProcess() function. If that succeeds, we know the process is running.
 
    In the event of signal 2 or signal 3, the GenerateConsoleCtrlEvent()
-   function is used to send a signal to that process.  These will not kill
-   GUI processes.  It will not (currently) send a signal to remote
+   function is used to send a signal to that process. These will not kill
+   GUI processes. It will not (currently) send a signal to remote
    processes.
 
    In the event of signal 1 or 4-8, the CreateRemoteThread() function is used
    after the HANDLE's process has been identified to create a thread
-   within that process.  The ExitProcess() function is then sent to that
+   within that process. The ExitProcess() function is then sent to that
    thread.
 
-   In the event of signal 9, the TerminateProcess() function is called.  This
+   In the event of signal 9, the TerminateProcess() function is called. This
    will almost certainly kill the process, but doesn't give the process a
    chance to necessarily do any cleanup it might otherwise do.
+   
+== The Process.ppid method
+   In MRI the Process.ppid always returns 0 on MS Windows. With this library
+   it returns the actual parent pid.
 
 == Differences between Ruby's kill and the Win32 Utils kill
    Ruby does not currently use the CreateRemoteThread() + ExitProcess()

data/lib/win32/process.rb

@@ -7,14 +7,15 @@ require 'windows/library'
 require 'windows/console'
 require 'windows/window'
 require 'windows/unicode'
+require 'windows/tool_helper'
 
 module Process
    class Error < RuntimeError; end
 
    # Eliminates redefinition warnings.
-   undef_method :kill, :wait, :wait2, :waitpid, :waitpid2
+   undef_method :kill, :wait, :wait2, :waitpid, :waitpid2, :ppid
    
-   WIN32_PROCESS_VERSION = '0.5.8'
+   WIN32_PROCESS_VERSION = '0.5.9'
    
    include Windows::Process
    include Windows::Thread
@@ -25,6 +26,7 @@ module Process
    include Windows::Synchronize
    include Windows::Window
    include Windows::Unicode
+   include Windows::ToolHelper
    extend Windows::Error
    extend Windows::Process
    extend Windows::Thread
@@ -33,6 +35,7 @@ module Process
    extend Windows::Library
    extend Windows::Console
    extend Windows::Unicode
+   extend Windows::ToolHelper
    
    # Used by Process.create
    ProcessInfo = Struct.new("ProcessInfo",
@@ -589,9 +592,46 @@ module Process
       nil
    end
 
+   # Returns the process ID of the parent of this process.
+   #--
+   # In MRI this method always returns 0.
+   #
+   def ppid
+      ppid = 0
+
+      return ppid if Process.pid == 0 # Paranoia
+
+      handle = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0)
+
+      if handle == INVALID_HANDLE_VALUE
+         raise Error, get_last_error
+      end
+
+      proc_entry = 0.chr * 296 # 36 + 260
+      proc_entry[0, 4] = [proc_entry.size].pack('L') # Set dwSize member
+      
+      unless Process32First(handle, proc_entry)
+         CloseHandle(handle)
+         raise Error, get_last_error
+      end
+
+      while Process32Next(handle, proc_entry)
+         if proc_entry[8, 4].unpack('L')[0] == Process.pid
+            ppid = proc_entry[24, 4].unpack('L')[0] # th32ParentProcessID
+            break
+         end
+      end
+
+      ppid
+   end
+
    # Creates the equivalent of a subshell via the CreateProcess() function.
    # This behaves in a manner that is similar, but not identical to, the
-   # Kernel.fork method for Unix.
+   # Kernel.fork method for Unix. Unlike the Unix fork, this method starts
+   # from the top of the script rather than the point of the call.
+   #
+   # WARNING: This implementation should be considered experimental. It is
+   # not recommended for production use.
    # 
    def fork
       last_arg = ARGV.last
@@ -640,6 +680,7 @@ module Process
    end
    
    module_function :kill, :wait, :wait2, :waitpid, :waitpid2, :create, :fork
+   module_function :ppid
 end
 
 # For backwards compatibility. Deprecated.

data/test/tc_process.rb

@@ -1,12 +1,12 @@
 ###############################################################################
 # tc_process.rb
 #
-# Test suite for the win32-process package.  This test suite will start
+# Test suite for the win32-process library.  This test suite will start
 # at least two instances of Notepad on your system, which will then
 # be killed. Requires the sys-proctable package.
 #
 # I haven't added a lot of test cases for fork/wait because it's difficult
-# to run such tests without causing havoc with TestUnit itself.  Ideas
+# to run such tests without causing havoc with Test::Unit itself.  Ideas
 # welcome.
 #
 # You should run this test case via the 'rake test' task.
@@ -18,9 +18,12 @@ begin
    require 'sys/proctable'
 rescue LoadError => e
    site = 'http://www.rubyforge.org/projects/sysutils'
-   STDERR.puts "Stopping!"
-   STDERR.puts "The sys/proctable module is required to run this test suite."
-   STDERR.puts "You can find it at #{site} or the RAA"
+   msg = %Q{
+      Stopping! The sys-proctable library is required to run this test suite.
+      You can find it at #{site} or the RAA.
+      Or, you can just 'gem install sys-proctable' and try again.
+   }
+   STDERR.puts msg
    exit!
 end   
 
@@ -43,7 +46,7 @@ class TC_Win32Process < Test::Unit::TestCase
    end
   
    def test_version
-      assert_equal('0.5.8', Process::WIN32_PROCESS_VERSION)
+      assert_equal('0.5.9', Process::WIN32_PROCESS_VERSION)
    end
    
    def test_kill
@@ -112,6 +115,12 @@ class TC_Win32Process < Test::Unit::TestCase
    def test_waitpid2
       assert_respond_to(Process, :waitpid2)
    end
+
+   def test_ppid
+      assert_respond_to(Process, :ppid)
+      assert_equal(true, Process.ppid > 0)
+      assert_equal(false, Process.pid == Process.ppid)
+   end
   	
    def test_creation_constants
       assert_not_nil(Process::CREATE_DEFAULT_ERROR_MODE)

data/win32-process.gemspec

@@ -3,7 +3,7 @@ require "rubygems"
 spec = Gem::Specification.new do |gem|
    desc = "Adds create, fork, wait, wait2, waitpid, and a special kill method"
    gem.name        = "win32-process"
-   gem.version     = "0.5.8"
+   gem.version     = "0.5.9"
    gem.authors     = ['Daniel Berger', 'Park Heesob']
    gem.email       = "djberg96@gmail.com"
    gem.rubyforge_project = 'win32utils'
@@ -17,7 +17,7 @@ spec = Gem::Specification.new do |gem|
    gem.files.reject! { |fn| fn.include? "CVS" }
    gem.require_path = "lib"
    gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
-   gem.add_dependency("windows-pr", ">= 0.8.1")
+   gem.add_dependency("windows-pr", ">= 0.8.6")
 end
 
 if $0 == __FILE__

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-process
 version: !ruby/object:Gem::Version 
-  version: 0.5.8
+  version: 0.5.9
 platform: ruby
 authors: 
 - Daniel Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-24 00:00:00 -06:00
+date: 2008-06-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.1
+        version: 0.8.6
     version: 
 description: Adds create, fork, wait, wait2, waitpid, and a special kill method
 email: djberg96@gmail.com