subexec 0.1.0 → 0.2.0

data/{README.rdoc → README.md}

@@ -1,8 +1,8 @@
-= Subexec
+# Subexec
 by Peter Kieltyka
 http://github/nulayer/subexec
 
-=== Description
+## 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
@@ -12,18 +12,21 @@ 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
+Tested with MRI 1.9.3, 1.9.2, 1.8.7
 
-  sub = Subexec.run "echo 'hello' && sleep 3", :timeout => 5
-  puts sub.output     # returns: hello
-  puts sub.exitstatus # returns: 0
+## Usage
 
-  sub = Subexec.run "echo 'hello' && sleep 3", :timeout => 1
-  puts sub.output     # returns: 
-  puts sub.exitstatus # returns:
+```ruby
+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
+## Limitations
 
 Only Ruby 1.9 can spawn non-blocking subprocesses, via Process.spawn.
 So Ruby 1.8 support is sheerly for backwards compatibility. 

data/lib/subexec.rb

@@ -1,8 +1,8 @@
-# = Subexec
+# # Subexec
 # * by Peter Kieltyka
-# * http://github/nulayer/subprocess
+# * http://github/nulayer/subexec
 # 
-# === Description
+# ## 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
@@ -11,9 +11,9 @@
 # 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.
+# executes mogrify and preempts if it gets lost.
 # 
-# === Usage
+# ## Usage
 # 
 # # Print hello
 # sub = Subexec.run "echo 'hello' && sleep 3", :timeout => 5
@@ -26,14 +26,15 @@
 # puts sub.exitstatus # returns:
 
 class Subexec
+  VERSION = '0.2.0'
 
-  attr_accessor :pid
-  attr_accessor :command
-  attr_accessor :timeout
-  attr_accessor :timer
-  attr_accessor :output
-  attr_accessor :exitstatus
-  attr_accessor :lang
+  attr_accessor :pid,
+                :command,
+                :lang,
+                :output,
+                :exitstatus,
+                :timeout,
+                :log_file
 
   def self.run(command, options={})
     sub = new(command, options)
@@ -42,13 +43,15 @@ class Subexec
   end
   
   def initialize(command, options={})
-    self.command  = command
-    self.timeout  = options[:timeout] || -1 # default is to never timeout
-    self.lang     = options[:lang] || "C"
+    self.command    = command
+    self.lang       = options[:lang]      || "C"
+    self.timeout    = options[:timeout]   || -1     # default is to never timeout
+    self.log_file   = options[:log_file]
+    self.exitstatus = 0
   end
   
   def run!
-    if timeout > 0 && RUBY_VERSION >= '1.9'
+    if RUBY_VERSION >= '1.9'
       spawn
     else
       exec
@@ -59,27 +62,41 @@ class Subexec
   private
   
     def spawn
-      r, w = IO.pipe
-      self.pid = Process.spawn({'LANG' => self.lang}, command, STDERR=>w, STDOUT=>w)
+      # TODO: weak implementation for log_file support.
+      # Ideally, the data would be piped through to both descriptors
+      r, w = IO.pipe      
+      if !log_file.nil?
+        self.pid = Process.spawn({'LANG' => self.lang}, command, [:out, :err] => [log_file, 'a'])
+      else
+        self.pid = Process.spawn({'LANG' => self.lang}, command, STDERR=>w, STDOUT=>w)
+      end
       w.close
-
-      self.timer = Time.now + timeout
+      
+      @timer = Time.now + timeout
       timed_out = false
 
-      loop do
+      waitpid = Proc.new do
         begin
           flags = (timeout > 0 ? Process::WUNTRACED|Process::WNOHANG : 0)
-          ret = Process.waitpid(pid, flags)
+          Process.waitpid(pid, flags)
         rescue Errno::ECHILD
           break
         end
+      end
 
-        break if ret == pid
-        sleep 0.01
-        if Time.now > timer
-          timed_out = true
-          break
+      if timeout > 0
+        loop do
+          ret = waitpid.call
+
+          break if ret == pid
+          sleep 0.01
+          if Time.now > @timer
+            timed_out = true
+            break
+          end
         end
+      else
+        waitpid.call
       end
 
       if timed_out
@@ -98,8 +115,6 @@ class Subexec
   
     def exec
       self.output = `export LANG=#{lang} && #{command} 2>&1`
-      self.exitstatus = $?.exitstatus
     end
 
 end
-

metadata

@@ -1,59 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: subexec
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Peter Kieltyka
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-03 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
-description: Subexec spawns an external command with a timeout
-email: 
+date: 2011-11-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70265363645600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70265363645600
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70265363643540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70265363643540
+description: Subexec spawns a subprocess with an optional timeout
+email:
 - peter@nulayer.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- README.rdoc
-- VERSION
+files:
+- README.md
 - lib/subexec.rb
-has_rdoc: true
 homepage: http://github.com/nulayer/subexec
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Subexec spawns an external command with a timeout
+summary: Subexec spawns a subprocess with an optional timeout
 test_files: []
-
+has_rdoc: 

data/VERSION

@@ -1 +0,0 @@
-0.1.0