win32-job 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b05ef073cbab8e2e228f1bbe4dc4691d42d7e161
-  data.tar.gz: e8b44cab6624612b066f785e9895851384c3e963
+  metadata.gz: 0c046b91579b8ce36811d85d9dcf691e2c3ff555
+  data.tar.gz: 4e65f2fe4f2ded16f6a43c0cf672bab7fa5da91c
 SHA512:
-  metadata.gz: ad0a9b6601e876eb373e710fa900d2033ff45e2ab06a5dc1f18438ecf2dd9a71fff549e4eeb621a1c8c82d23bbed258d9c5aba8845d2732187e0f8604055dfe1
-  data.tar.gz: 977ff9aadaa433efa20a15637f51bdf13c2b2e72aea844543cf9a5aed99d43c2343d6a52145d7a883830be18729db76d86a7ed31c791dcdfa69ba826f9c05e09
+  metadata.gz: 73df699846e40e26e1bcaebcae9adc5301d2da6a336aafec73f08907a225955751c858098447601aad3f0bbd8967d2cb942bb149ec693da6953f2857c382644f
+  data.tar.gz: fad7d536c6fc5b1a3ca3f9326b5386c7ca54407b1f0d399a37f0f115e276e6b419dbada1f9d1dba71a588cf8c6c40aac6284b83596b576b598f6d8860df466ea

data/CHANGES

@@ -1,3 +1,9 @@
+= 0.1.2 - 6-Feb-2014
+* Altered the constructor. The second argument now controls whether or not
+  to raise an error if the job already exists. By default it will open the job
+  if it already exists.
+* Fixed a bug in the process_list method where it could return incorrect values.
+
 = 0.1.1 - 5-Feb-2014
 * Added a wait method.
 

data/lib/win32/job.rb

@@ -14,7 +14,7 @@ module Win32
     extend Windows::Functions
 
     # The version of the win32-job library
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
 
     private
 
@@ -41,6 +41,7 @@ module Win32
 
     public
 
+    # The name of the job, if specified.
     attr_reader :job_name
 
     alias :name :job_name
@@ -48,11 +49,14 @@ module Win32
     # Create a new Job object identified by +name+. If no name is provided
     # then an anonymous job is created.
     #
-    # If the +kill_on_close+ argument is true, all associated processes are
-    # terminated and the job object then destroys itself. Otherwise, the job
-    # object will not be destroyed until all associated processes have exited.
+    # If the job already exists then the existing job is opened instead, unless
+    # the +open_existing+ method is false. In that case an error is
+    # raised.
     #
-    def initialize(name = nil, security = nil)
+    # The +security+ argument accepts a raw SECURITY_ATTRIBUTES struct that is
+    # passed to the CreateJobObject function internally.
+    #
+    def initialize(name = nil, open_existing = true, security = nil)
       raise TypeError unless name.is_a?(String) if name
 
       @job_name = name
@@ -65,6 +69,10 @@ module Win32
         FFI.raise_windows_error('CreateJobObject', FFI.errno)
       end
 
+      if FFI.errno == ERROR_ALREADY_EXISTS && !open_existing
+        raise ArgumentError, "job '#{name}' already exists"
+      end
+
       if block_given?
         begin
           yield self
@@ -79,6 +87,12 @@ module Win32
     # Add process +pid+ to the job object. Process ID's added to the
     # job are tracked via the Job#process_list accessor.
     #
+    # Note that once a process is added to a job, the association cannot be
+    # broken. A process can be associated with more than one job in a
+    # hierarchy of nested jobs, however.
+    #
+    # You may add a maximum of 100 processes per job.
+    #
     def add_process(pid)
       if @process_list.size > 99
         raise ArgumentError, "maximum number of processes reached"
@@ -116,6 +130,8 @@ module Win32
     # Kill all processes associated with the job object that are
     # associated with the current process.
     #
+    # Note that killing a process does not dissociate it from the job.
+    #
     def kill
       unless TerminateJobObject(@job_handle, Process.pid)
         FFI.raise_windows_error('TerminateJobObject', FFI.errno)
@@ -360,7 +376,7 @@ module Win32
         FFI.raise_windows_error('QueryInformationJobObject', FFI.errno)
       end
 
-      info[:ProcessIdList].to_a.select{ |n| n != 0 }
+      info[:ProcessIdList].to_a[0...info[:NumberOfProcessIdsInList]]
     end
 
     # Returns an AccountInfoStruct that shows various job accounting

data/lib/win32/job/constants.rb

@@ -27,6 +27,7 @@ module Windows
     INFINITE = 0xFFFFFFFF
 
     INVALID_HANDLE_VALUE = FFI::Pointer.new(-1).address
+    ERROR_ALREADY_EXISTS = 183
 
     JOB_OBJECT_LIMIT_ACTIVE_PROCESS = 0x00000008
     JOB_OBJECT_LIMIT_AFFINITY = 0x00000010

data/test/test_win32_job.rb

@@ -15,7 +15,7 @@ class TC_Win32_Job < Test::Unit::TestCase
   end
 
   test "version number is what we expect" do
-    assert_equal('0.1.1', Win32::Job::VERSION)
+    assert_equal('0.1.2', Win32::Job::VERSION)
   end
 
   test "constructor argument may be omitted" do
@@ -26,10 +26,19 @@ class TC_Win32_Job < Test::Unit::TestCase
     assert_nothing_raised{ Win32::Job.new(@name) }
   end
 
+  test "constructor accepts a second argument" do
+    assert_nothing_raised{ Win32::Job.new(@name, true) }
+  end
+
   test "argument to constructor must be a string" do
     assert_raise(TypeError){ Win32::Job.new(1) }
   end
 
+  test "if second argument to constructor is false, an error is raised if the same job is reopened" do
+    @job = Win32::Job.new('test')
+    assert_raise(ArgumentError){ Win32::Job.new('test', false) }
+  end
+
   test "job_name basic functionality" do
     assert_respond_to(@job, :job_name)
     assert_nothing_raised{ @job.job_name }

data/win32-job.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-job
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Interface for Windows jobs (process groups)