phantom 0.0.3.pre → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccff1ad812d5dcc3fc8826446d1dc42de2c87ec5
-  data.tar.gz: 245a70cba1b1e2310f6e440d184acadc328405e0
+  metadata.gz: 1d30637c752f12133d0987930aa8be435bfae5cd
+  data.tar.gz: 4fb139973bbdf6c990ee41f1cf736072fa91ac56
 SHA512:
-  metadata.gz: 24e129fd455242d38337b962c71bd3bc603cfd101b762f9f83a6f2d313fe14d342ca4c27d849c06c1697803efcd9b59bcb0be97b4c10f7133e87aa8de2758669
-  data.tar.gz: 99a371f657d7723f456fef096314d2a2d8ba6cae984e9b702902c807194e5ffd805768c1c3138aad96d1d879e993dd1215c6b9d1ffb11e49882b2e9869599466
+  metadata.gz: dc63afdd0131f85c9369ba4e5d68cee2609f8e7a3bb1d3e6297dba98acabae0d279cf22c94ae8c3aaeb2a28f533c8c8f6c8a6a20c71a71de28511fb512dde51c
+  data.tar.gz: 0749b36d7bf51dd79aaece8b255cd618a2aa86801c4e38af5d9247648656f40e3a50006c1f6069ba8b09d09142c012695a224e83cccd8824e3be3fe06f2fe236

data/README.md

@@ -36,7 +36,21 @@ rescue Phantom::ForkError => e
   puts e.message   #=> error message
 end
 
-phantom.pid   #=> PID or nil if fork fails
+phantom.pid     #=> PID or nil if fork fails
+phantom.status  #=> 'Alive' | 'Dead' | 'Paused'
+phantom.dead?   #=> true if the sub process is dead (i.e. either ended normally or killed)
+phantom.alive?  #=> true if not dead.
+
+phantom.stop      #=> pause the sub process
+phantom.pause     #=> pause is an alias of stop
+phantom.continue  #=> resume the sub process
+phantom.resume    #=> resume is an alias of continue
+
+phantom.kill(1)     #=> send signal to the sub process
+phantom.kill(:TERM) #=> you can as well use the POSIX signal names
+
+phantom.terminate   #=> terminate the sub process gracefully
+phantom.abort!      #=> force the sub process to end immediately
 ```
 
 The `on_ok` parameter can be any instances that respond to `call` taking no arguments.
@@ -57,9 +71,9 @@ If you want a global mutex (i.e. mutex between multiple processes), you can use
 end
 ```
 
-## TODO
-
-Implement monitoring and intercepting mechanism
+## Caution
+1. The status is NOT completely retrieved from the sub process, so any manipulation out of the phantom instance,
+except terminating the sub process, will not be recognized.
 
 ## Contributing
 

data/lib/phantom/base.rb

@@ -1,9 +1,9 @@
 module Phantom
   class Base
-    attr_reader :pid, :status
+    attr_reader :pid
 
     def initialize(pid)
-      @pid = pid
+      @pid = pid.nil? ? nil : pid.to_i
     end
     
     def kill(signal)
@@ -30,9 +30,45 @@ module Phantom
       @process_priority ||= Process.getpriority(Process::PRIO_PROCESS, @pid)
     end
     
-    def abort
-      kill(:TERM)
+    def abort!
+      kill(:ABRT) if alive?
+    end
+
+    def terminate
+      kill(:TERM) if alive?
+    end
+
+    def stop
+      if alive?
+        kill(:STOP)
+        @status = Phantom::Status::PAUSED
+      end
+    end
+    alias :pause :stop
+
+    def continue
+      if alive?
+        kill(:CONT)
+        @status = Phantom::Status::ALIVE
+      end
+    end
+    alias :resume :continue
+
+    def status
+      begin
+        Process.kill(0, @pid)
+        return @status ||= Phantom::Status::ALIVE
+      rescue Errno::ESRCH
+        return @status = Phantom::Status::DEAD
+      end
+    end
+
+    def alive?
+      !dead?
+    end
+
+    def dead?
+      status == Phantom::Status::DEAD
     end
-    
   end
 end

data/lib/phantom/status.rb

@@ -4,5 +4,7 @@ module Phantom
     ABORTED = 'Aborted'
     ERROR = 'Error'
     PAUSED = 'Paused'
+    ALIVE = 'Alive'
+    DEAD = 'Dead'
   end
 end

data/lib/phantom/version.rb

@@ -1,3 +1,3 @@
 module Phantom
-  VERSION = "0.0.3.pre"
+  VERSION = "0.0.3"
 end

data/spec/base_spec.rb

@@ -1,14 +1,72 @@
 require 'phantom'
 
 describe Phantom::Base do
-  it 'should be kill the process when called on abort' do
-    i = 0
+
+  count_file = 'tmp/count.txt'
+
+  after(:each) do
+    File.delete count_file if File.exists? count_file
+  end
+
+  it 'should kill the process when called on abort' do
+    phantom = Phantom.run do
+      sleep 3
+      File.new(count_file, 'w').close
+    end
+    phantom.abort!
+    sleep 5
+    File.should_not exist(count_file)
+    phantom.status.should == Phantom::Status::DEAD
+  end
+
+  it 'should be kill the process when called on terminate' do
     phantom = Phantom.run do
       sleep 3
-      i = 1
+      File.new(count_file, 'w').close
     end
-    phantom.abort
+    phantom.terminate
     sleep 5
-    i.should == 0
+    File.should_not exist(count_file)
+    phantom.status.should == Phantom::Status::DEAD
+  end
+
+  it 'should be able to pause and to resume the process' do
+    phantom = Phantom.run do
+      loop do
+        File.open(count_file, 'a') {|f| f.write 'P'}
+      end
+      sleep 0.5
+    end
+    sleep 3
+    phantom.pause
+    current = File.read(count_file)
+    sleep 3
+    File.read(count_file).should == current
+    phantom.status.should == Phantom::Status::PAUSED
+
+    phantom.resume
+    sleep 3
+    phantom.status.should == Phantom::Status::ALIVE
+
+    phantom.terminate
+    sleep 3
+    File.read(count_file).length.should > current.length
+  end
+
+  it 'should be able to identify if the process is alive' do
+    phantom = Phantom.run do
+      @i += 1
+      sleep 0.5
+    end
+    phantom.should be_alive
+    phantom.status.should == Phantom::Status::ALIVE
+
+    phantom.terminate
+
+    sleep 0.5
+
+    phantom.should be_dead
+    phantom.status.should == Phantom::Status::DEAD
   end
+
 end

data/spec/phantom_spec.rb

@@ -3,7 +3,7 @@ require 'phantom'
 describe Phantom do
   pid_file = 'tmp/phantom.pid'
 
-  after do
+  after(:each) do
     File.delete pid_file if File.exist? pid_file
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phantom
 version: !ruby/object:Gem::Version
-  version: 0.0.3.pre
+  version: 0.0.3
 platform: ruby
 authors:
 - Aetherus
@@ -90,9 +90,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.1.9