subexec 0.0.1

data/README.rdoc

@@ -0,0 +1,29 @@
+= Subexec
+by Peter Kieltyka
+http://github/nulayer/subexec
+
+=== Description
+
+Subexec is a simple library that spawns an external command with
+an optional timeout parameter. It relies on Ruby 1.9's Process.spawn
+method. Also, it works with synchronous and asynchronous code.
+
+Useful for libraries that are Ruby wrappers for CLI's. For example,
+resizing images with ImageMagick's mogrify command sometimes stalls
+and never returns control back to the original process. Enter Subexec.
+
+=== Usage
+
+  sub = Subexec.run "echo 'hello' && sleep 3", :timeout => 5
+  puts sub.output     # returns: hello
+  puts sub.exitstatus # returns: 0
+
+  sub = Subexec.run "echo 'hello' && sleep 3", :timeout => 1
+  puts sub.output     # returns: 
+  puts sub.exitstatus # returns:
+
+
+=== Limitations
+
+Supports only Ruby 1.9.
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/subexec.rb

@@ -0,0 +1,86 @@
+# = Subexec
+# * by Peter Kieltyka
+# * http://github/nulayer/subprocess
+# 
+# === Description
+# 
+# Subexec is a simple library that spawns an external command with
+# an optional timeout parameter. It relies on Ruby 1.9's Process.spawn
+# method. Also, it works with synchronous and asynchronous code.
+# 
+# Useful for libraries that are Ruby wrappers for CLI's. For example,
+# resizing images with ImageMagick's mogrify command sometimes stalls
+# and never returns control back to the original process. Subexec
+# executes mogrify and preempts if gets lost.
+# 
+# === Usage
+# 
+# # Print hello
+# sub = Subexec.run "echo 'hello' && sleep 3", :timeout => 5
+# puts sub.output     # returns: hello
+# puts sub.exitstatus # returns: 0
+# 
+# # Timeout process after a second
+# sub = Subexec.run "echo 'hello' && sleep 3", :timeout => 1
+# puts sub.output     # returns: 
+# puts sub.exitstatus # returns:
+
+class Subexec
+
+  attr_accessor :pid
+  attr_accessor :command
+  attr_accessor :timeout
+  attr_accessor :timer
+  attr_accessor :output
+  attr_accessor :exitstatus
+
+  def self.run(command, options={})
+    new(command, options)
+  end
+  
+  def initialize(command, options={})
+    self.command  = command
+    self.timeout  = options[:timeout] || -1 # default is to never timeout
+    run!
+  end
+  
+  def run!
+    r, w = IO.pipe
+    self.pid = Process.spawn(command, STDERR=>STDOUT, STDOUT=>w)
+    w.close
+    
+    self.timer = Time.now + timeout
+    timed_out = false
+
+    loop do
+      begin
+        flags = (timeout > 0 ? Process::WUNTRACED|Process::WNOHANG : 0)
+        ret = Process.waitpid(pid, flags)
+      rescue Errno::ECHILD
+        break
+      end
+
+      break if ret == pid
+      sleep 0.001
+      if Time.now > timer
+        timed_out = true
+        break
+      end
+    end
+    
+    if timed_out
+      # The subprocess timed out -- kill it
+      Process.kill(9, pid) rescue Errno::ESRCH
+      self.exitstatus = nil
+    else
+      # The subprocess exited on its own
+      self.exitstatus = $?.exitstatus
+      self.output = r.readlines.join("")
+    end
+    r.close
+    
+    self
+  end
+
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: subexec
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Kieltyka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-24 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Subexec spawns an external command with a timeout
+email: 
+- peter@nulayer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION
+- lib/subexec.rb
+has_rdoc: true
+homepage: http://github.com/nulayer/subexec
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Subexec spawns an external command with a timeout
+test_files: []
+