win32-process 0.6.3 → 0.6.4

data/CHANGES

@@ -1,3 +1,12 @@
+= 0.6.4 - 13-Nov-2010
+* Altered the wait, wait2, waitpid and waitpid2 methods to match the current
+  MRI interface, i.e. they accept and optional pid and flags, though the
+  latter is ignored. Thanks go to Robert Wahler for the spot.
+* Renamed the example scripts to avoid any potential confusion with actual
+  test scripts and cleaned them up a bit.
+* Added Rake tasks to run the example programs.
+* Updated the MANIFEST.
+
 = 0.6.3 - 9-Nov-2010
 * Fixed a bug in the Process.kill method where the remote thread created
   was not being properly closed. Thanks go to Ben Nagy for the spot.

data/MANIFEST

@@ -1,11 +1,11 @@
-* CHANGES
-* README
-* MANIFEST
-* Rakefile
-* win32-process.gemspec
-* examples/test_create.rb
-* examples/test_fork_wait.rb
-* examples/test_fork_waitpid.rb
-* examples/test_kill.rb
-* lib/win32/process.rb
-* test/tc_process.rb
+* CHANGES
+* README
+* MANIFEST
+* Rakefile
+* win32-process.gemspec
+* examples/example_create.rb
+* examples/example_fork_wait.rb
+* examples/example_fork_waitpid.rb
+* examples/example_kill.rb
+* lib/win32/process.rb
+* test/test_process.rb

data/Rakefile

@@ -20,6 +20,28 @@ namespace :gem do
   end
 end
 
+namespace :example do
+  desc 'Run the fork + wait example'
+  task :fork_wait do
+    sh "ruby -Ilib examples/example_fork_wait.rb"
+  end
+
+  desc 'Run the fork + waitpid example'
+  task :fork_waitpid do
+    sh "ruby -Ilib examples/example_fork_waitpid.rb"
+  end
+
+  desc 'Run the kill example'
+  task :kill do
+    sh "ruby -Ilib examples/example_kill.rb"
+  end
+
+  desc 'Run the create example'
+  task :create do
+    sh "ruby -Ilib examples/example_create.rb"
+  end
+end
+
 Rake::TestTask.new do |t|
   t.verbose = true
   t.warning = true

data/examples/{test_create.rb → example_create.rb}

@@ -1,39 +1,35 @@
-##########################################################################
-# test_create.rb
-#
-# Simple test program for the Process.create() method.
-##########################################################################
-Dir.chdir('..') if File.basename(Dir.pwd) == 'examples'
-$LOAD_PATH.unshift Dir.pwd
-$LOAD_PATH.unshift Dir.pwd + '/lib'
-Dir.chdir('examples') rescue nil
-
-require "win32/process"
-
-p Process::WIN32_PROCESS_VERSION
-
-struct = Process.create(
-   :app_name         => "notepad.exe",
-   :creation_flags   => Process::DETACHED_PROCESS,
-   :process_inherit  => false,
-   :thread_inherit   => true,
-   :cwd              => "C:\\",
-   :inherit          => true,
-   :environment      => "SYSTEMROOT=#{ENV['SYSTEMROOT']};PATH=C:\\"
-)
-
-p struct
-
-=begin
-# Don't run this from an existing terminal
-pid = Process.create(
-   :app_name       => "cmd.exe",
-   :creation_flags => Process::DETACHED_PROCESS,
-   :startf_flags   => Process::USEPOSITION,
-   :x              => 0,
-   :y              => 0,
-   :title          => "Hi Dan"
-)
-
-puts "Pid of new process: #{pid}"
-=end
+##########################################################################
+# example_create.rb
+#
+# Simple test program for the Process.create() method. You can run this
+# code via the 'example:create' task.
+##########################################################################
+require "win32/process"
+
+p Process::WIN32_PROCESS_VERSION
+
+struct = Process.create(
+   :app_name         => "notepad.exe",
+   :creation_flags   => Process::DETACHED_PROCESS,
+   :process_inherit  => false,
+   :thread_inherit   => true,
+   :cwd              => "C:\\",
+   :inherit          => true,
+   :environment      => "SYSTEMROOT=#{ENV['SYSTEMROOT']};PATH=C:\\"
+)
+
+p struct
+
+=begin
+# Don't run this from an existing terminal
+pid = Process.create(
+   :app_name       => "cmd.exe",
+   :creation_flags => Process::DETACHED_PROCESS,
+   :startf_flags   => Process::USEPOSITION,
+   :x              => 0,
+   :y              => 0,
+   :title          => "Hi Dan"
+)
+
+puts "Pid of new process: #{pid}"
+=end

data/examples/{test_fork_wait.rb → example_fork_wait.rb}

@@ -1,33 +1,29 @@
-##########################################################################
-# test_fork_wait.rb
-#
-# Generic test script for futzing around with the block form of fork/wait
-##########################################################################
-Dir.chdir('..') if File.basename(Dir.pwd) == 'examples'
-$LOAD_PATH.unshift Dir.pwd
-$LOAD_PATH.unshift Dir.pwd + '/lib'
-Dir.chdir('examples') rescue nil
-
-require 'win32/process'
-
-puts "VERSION: " + Process::WIN32_PROCESS_VERSION
-
-# In the child, using block form
-fork{
-  	7.times { |i|
-     	puts "Child: #{i}"
-     	sleep 1
-  	}
-}
-
-# Back in the parent
-4.times{ |i|
-   	puts "Parent: #{i}"
-   	sleep 1
-}
-
-# Wait for the children
-Process.wait
-
-# Children should be done here before continuing on
-puts "Continuing on..."
+##########################################################################
+# example_fork_wait.rb
+#
+# Generic test script for futzing around with the block form of
+# fork/wait. You can run this example via the 'example:fork_wait' task.
+##########################################################################
+require 'win32/process'
+
+puts "VERSION: " + Process::WIN32_PROCESS_VERSION
+
+# In the child, using block form
+fork{
+  7.times { |i|
+    puts "Child: #{i}"
+    sleep 1
+  }
+}
+
+# Back in the parent
+4.times{ |i|
+  puts "Parent: #{i}"
+  sleep 1
+}
+
+# Wait for the children
+Process.wait
+
+# Children should be done here before continuing on
+puts "Continuing on..."

data/examples/{test_fork_waitpid.rb → example_fork_waitpid.rb}

@@ -1,50 +1,46 @@
-##########################################################################
-# test_fork_waitpid.rb
-#
-# Generic test script for futzing around with the traditional form of
-# fork/wait, plus waitpid and waitpid2.
-##########################################################################
-Dir.chdir('..') if File.basename(Dir.pwd) == 'examples'
-$LOAD_PATH.unshift Dir.pwd
-$LOAD_PATH.unshift Dir.pwd + '/lib'
-Dir.chdir('examples') rescue nil
-
-require 'win32/process'
-
-puts "VERSION: " + Process::WIN32_PROCESS_VERSION
-
-pid = Process.fork
-puts "PID1: #{pid}"
-
-#child
-if pid.nil?
-   7.times{ |i|
-      puts "Child: #{i}"
-      sleep 1
-   }
-   exit(-1)
-end
-
-pid2 = Process.fork
-puts "PID2: #{pid2}"
-
-#child2
-if pid2.nil?
-   7.times{ |i|
-      puts "Child2: #{i}"
-      sleep 1
-   }
-   exit(1)
-end
-
-#parent
-2.times { |i|
-   puts "Parent: #{i}"
-   sleep 1
-}
-
-p Process.waitpid2(pid)
-p Process.waitpid2(pid2)
-
-puts "Continuing on..."
-
+##########################################################################
+# example_fork_waitpid.rb
+#
+# Generic test script for futzing around with the traditional form of
+# fork/wait, plus waitpid and waitpid2.
+#
+# You can run this code via the 'example:fork_waitpid' task.
+##########################################################################
+require 'win32/process'
+
+puts "VERSION: " + Process::WIN32_PROCESS_VERSION
+
+pid = Process.fork
+puts "PID1: #{pid}"
+
+#child
+if pid.nil?
+  7.times{ |i|
+    puts "Child: #{i}"
+    sleep 1
+  }
+  exit(-1)
+end
+
+pid2 = Process.fork
+puts "PID2: #{pid2}"
+
+#child2
+if pid2.nil?
+  7.times{ |i|
+    puts "Child2: #{i}"
+    sleep 1
+  }
+  exit(1)
+end
+
+#parent
+2.times { |i|
+  puts "Parent: #{i}"
+  sleep 1
+}
+
+p Process.waitpid2(pid)
+p Process.waitpid2(pid2)
+
+puts "Continuing on..."

data/examples/example_kill.rb

@@ -0,0 +1,34 @@
+##########################################################################
+# example_kill.rb
+#
+# Generic test script for futzing around Process.kill. This script
+# requires the sys-proctable library.
+#
+# You can run this example via the 'example:kill' task.
+##########################################################################
+require "win32/process"
+
+begin
+  require "sys/proctable"
+rescue LoadError
+  STDERR.puts "Whoa there!"
+  STDERR.puts "This script requires the sys-proctable package to work."
+  STDERR.puts "You can find it at http://ruby-sysutils.sf.net"
+  STDERR.puts "Exiting..."
+  exit
+end
+
+include Sys
+
+puts "VERSION: " + Process::WIN32_PROCESS_VERSION
+
+IO.popen("notepad")
+sleep 1 # Give it a chance to start before checking for its pid
+
+pids = []
+
+ProcTable.ps{ |s|
+  pids.push(s.pid) if s.cmdline =~ /notepad/i
+}
+
+p Process.kill(9,pids.last)

data/lib/win32/process.rb

@@ -21,7 +21,7 @@ module Process
   undef_method :setpriority, :wait, :wait2, :waitpid, :waitpid2, :uid
    
   # The version of the win32-process library
-  WIN32_PROCESS_VERSION = '0.6.3'
+  WIN32_PROCESS_VERSION = '0.6.4'
   
   include Windows::Process
   include Windows::Thread
@@ -424,10 +424,13 @@ module Process
 
   # Waits for the given child process to exit and returns that pid.
   # 
+  # The +flags+ argument is ignored at the moment. It is provided strictly
+  # for interface compatibility.
+  #
   # Note that the $? (Process::Status) global variable is NOT set.  This
   # may be addressed in a future release.
   # 
-  def waitpid(pid)
+  def waitpid(pid, flags = nil)
     exit_code = [0].pack('L')
     handle = OpenProcess(PROCESS_ALL_ACCESS, 0, pid)
      
@@ -456,6 +459,9 @@ module Process
    
   # Waits for the given child process to exit and returns an array containing
   # the process id and the exit status.
+  #
+  # The +flags+ argument is ignored at the moment. It is provided strictly
+  # for interface compatibility.
   # 
   # Note that the $? (Process::Status) global variable is NOT set. This
   # may be addressed in a future release if/when possible.
@@ -463,7 +469,7 @@ module Process
   # Ruby does not provide a way to hook into $? so there's no way for us
   # to set it.
   # 
-  def waitpid2(pid)
+  def waitpid2(pid, flags = nil)
     exit_code = [0].pack('L')
     handle    = OpenProcess(PROCESS_ALL_ACCESS, 0, pid)
       
@@ -877,7 +883,11 @@ module Process
   end
    
   # Waits for any child process to exit and returns the process id of that
-  # child.
+  # child. If a pid is provided that is greater than or equal to 0, then
+  # it is the equivalent of calling Process.waitpid.
+  #
+  # The +flags+ argument is ignored at the moment. It is provided strictly
+  # for interface compatibility.
   # 
   # Note that the $? (Process::Status) global variable is NOT set.  This
   # may be addressed in a future release.
@@ -885,7 +895,12 @@ module Process
   # The GetProcessId() function is not defined in Windows 2000 or earlier
   # so we have to do some extra work for those platforms.
   #   
-  def wait
+  def wait(pid = -1, flags = nil)
+    if pid && pid >= 0
+      pid, status = waitpid(pid, flags)
+      return pid
+    end
+
     handles = []
       
     # Windows 2000 or earlier
@@ -933,6 +948,9 @@ module Process
    
   # Waits for any child process to exit and returns an array containing the
   # process id and the exit status of that child.
+  #
+  # The +flags+ argument is ignored at the moment. It is provided strictly
+  # for interface compatibility.
   # 
   # Note that the $? (Process::Status) global variable is NOT set.  This
   # may be addressed in a future release.
@@ -940,7 +958,12 @@ module Process
   # The GetProcessId() function is not defined in Windows 2000 or earlier
   # so we have to do some extra work for those platforms.
   # 
-  def wait2
+  def wait2(pid = -1, flags = nil)
+    if pid && pid >= 0
+      pid, status = waitpid2(pid, flags)
+      return pid
+    end
+
     handles = []
      
     # Windows 2000 or earlier

data/test/test_win32_process.rb

@@ -41,7 +41,7 @@ class TC_Win32Process < Test::Unit::TestCase
   end
   
   def test_version
-    assert_equal('0.6.3', Process::WIN32_PROCESS_VERSION)
+    assert_equal('0.6.4', Process::WIN32_PROCESS_VERSION)
   end
    
   def test_kill

data/win32-process.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-process'
-  spec.version    = '0.6.3'
+  spec.version    = '0.6.4'
   spec.license    = 'Artistic 2.0'
   spec.authors    = ['Daniel Berger', 'Park Heesob']
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: win32-process
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 6
-  - 3
-  version: 0.6.3
+  - 4
+  version: 0.6.4
 platform: ruby
 authors: 
 - Daniel Berger
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-09 00:00:00 -07:00
+date: 2010-11-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,10 +77,10 @@ extra_rdoc_files:
 - MANIFEST
 files: 
 - CHANGES
-- examples/test_create.rb
-- examples/test_fork_wait.rb
-- examples/test_fork_waitpid.rb
-- examples/test_kill.rb
+- examples/example_create.rb
+- examples/example_fork_wait.rb
+- examples/example_fork_waitpid.rb
+- examples/example_kill.rb
 - lib/win32/process.rb
 - MANIFEST
 - Rakefile

data/examples/test_kill.rb

@@ -1,35 +0,0 @@
-##########################################################################
-# test_kill.rb
-#
-# Generic test script for futzing around Process.kill.  This script
-# requires the sys-proctable package (available on the RAA).
-##########################################################################
-Dir.chdir('..') if File.basename(Dir.pwd) == 'examples'
-$LOAD_PATH.unshift Dir.pwd
-$LOAD_PATH.unshift Dir.pwd + '/lib'
-Dir.chdir('examples') rescue nil
-
-require "win32/process"
-
-begin
-   require "sys/proctable"
-rescue LoadError
-   STDERR.puts "Whoa there!"
-   STDERR.puts "This script requires the sys-proctable package to work."
-   STDERR.puts "You can find it at http://ruby-sysutils.sf.net"
-   STDERR.puts "Exiting..."
-   exit
-end
-include Sys
-
-puts "VERSION: " + Process::WIN32_PROCESS_VERSION
-
-IO.popen("notepad")
-sleep 1 # Give it a chance to start before checking for its pid
-
-pids = []
-ProcTable.ps{ |s|
-   pids.push(s.pid) if s.cmdline =~ /notepad/i
-}
-
-p Process.kill(9,pids.last)