open4 0.3.0 → 0.4.0

data/README

@@ -9,6 +9,10 @@ SYNOPSIS
 
 HISTORY
 
+  0.4.0:
+    - improved error handling contributed by jordan breeding.
+    - introduction of background/bg method
+
   0.3.0 :
     - bug fix from jordan breeding.  general clean up.  added spawn method.
 
@@ -136,6 +140,52 @@ SAMPLES
     "42"
     ""
 
+
+  ----------------------------------------------------------------------------
+  the bg/background method is similar to spawn, but the process is
+  automatically set running in a thread.  the returned thread has several
+  methods added dynamically which return the pid and blocking calls to the
+  exitstatus.
+  ----------------------------------------------------------------------------
+
+    harp: > cat sample/bg.rb
+    require 'yaml'
+    require 'open4'
+    include Open4
+
+    stdin = '42'
+    stdout = ''
+    stderr = ''
+
+    t = bg 'ruby -e"sleep 4; puts ARGF.read"', 0=>stdin, 1=>stdout, 2=>stderr
+
+    waiter = Thread.new{ y t.pid => t.exitstatus } # t.exitstatus is a blocking call!
+
+    while((status = t.status))
+      y "status" => status
+      sleep 1
+    end
+
+    waiter.join
+
+    y "stdout" => stdout
+
+
+    harp: > ruby sample/bg.rb
+    ---
+    status: run
+    ---
+    status: sleep
+    ---
+    status: sleep
+    ---
+    status: sleep
+    ---
+    21357: 0
+    ---
+    stdout: "42\n"
+
+
 AUTHOR
 
   ara.t.howard@noaa.gov

data/gemspec.rb

@@ -8,11 +8,11 @@ Gem::Specification::new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.summary = lib 
 
-  # spec.files = Dir[ File::join("{lib,bin}", "*") ]
-  # spec.require_path = "lib" 
-
   spec.files = Dir::glob "**/**"
   spec.executables = Dir::glob("bin/*").map{|exe| File::basename exe}
+  
+  spec.require_path = "lib" 
+  spec.autorequire = lib
 
   spec.has_rdoc = File::exist? "doc" 
   spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"

data/lib/{open4-0.3.0.rb → open4-0.4.0.rb}

@@ -2,7 +2,9 @@ require 'fcntl'
 
 module Open4
 #--{{{
-  def self.version() '0.3.0' end
+  def self.version
+    '0.4.0'
+  end
 
   def popen4(*cmd)
 #--{{{
@@ -46,11 +48,7 @@ module Open4
 
     begin
       e = Marshal.load ps.first
-      if Exception === e
-        raise e
-      else
-        raise "unknown failure"
-      end
+      raise(Exception === e ? e : "unknown failure!")
     rescue EOFError # If we get an EOF error, then the exec was successful
       42
     end
@@ -75,6 +73,20 @@ module Open4
   module_function :popen4
   module_function :open4
 
+  class Error < ::StandardError; end
+  class SpawnError < Error
+#--{{{
+    attr 'cmd'
+    attr 'status'
+    def exitstatus
+      @status.exitstatus
+    end
+    def initialize cmd, status
+      @cmd, @status = cmd, status
+      super "cmd <#{ cmd }> failed with <#{ exitstatus }>"
+    end
+#--}}}
+  end
   def spawn cmd, opts = {} 
 #--{{{
     getopt = lambda do |*args|
@@ -89,11 +101,13 @@ module Open4
       end
     end
 
-    dont_raise = getopt[ 'quiet', !getopt['raise', true] ]
+    ignore_exit_failure = getopt[ 'ignore_exit_failure', getopt['quiet', false] ]
+    ignore_exec_failure = getopt[ 'ignore_exec_failure', !getopt['raise', true] ]
     exitstatus = getopt[ %w( exitstatus exit_status status ), 0 ]
     stdin = getopt[ ['stdin', 'in', '0', 0] ]
     stdout = getopt[ ['stdout', 'out', '1', 1] ]
     stderr = getopt[ ['stderr', 'err', '2', 2] ]
+    pid = getopt[ 'pid' ]
 
     started = false
 
@@ -102,32 +116,60 @@ module Open4
         popen4(cmd) do |c, i, o, e|
           started = true
 
-          if stdin.respond_to? :each
-            stdin.each{|buf| i << buf}
-          elsif stdin.respond_to? :read
-            i << stdin.read
-          else
-            i << stdin.to_s
+          if pid.respond_to? '<<'
+            pid << c
           end
 
-          i.close
+          it = Thread.new(i,stdin) do |i,stdin|
+            if stdin
+              if stdin.respond_to? :each
+                stdin.each{|buf| i << buf}
+              elsif stdin.respond_to? :read
+                i << stdin.read
+              else
+                i << stdin.to_s
+              end
+            end
+            i.close
+          end
 
-          ot = Thread.new(o){ o.each{|buf| stdout << buf if stdout} }
-          et = Thread.new(e){ e.each{|buf| stderr << buf if stderr} }
+          ot = Thread.new(o,stdout){|o,stdout| o.each{|buf| stdout << buf if stdout}}
+          et = Thread.new(e,stderr){|e,stderr| e.each{|buf| stderr << buf if stderr}}
 
-          ot.join
-          et.join
+          it.join
+          ot.join if ot
+          et.join if et
         end
       rescue
-        raise unless(not started and dont_raise)
+        raise unless(not started and ignore_exec_failure)
       end
 
-    raise "cmd <#{ cmd }> failed with <#{ status }>" unless
-      ((status == exitstatus) or dont_raise)
+    raise SpawnError.new(cmd, status) unless
+      (ignore_exit_failure or (status.nil? and ignore_exec_failure) or (status.exitstatus == exitstatus))
 
     status
 #--}}}
   end
   module_function :spawn
+
+  def background cmd, opts = {}
+#--{{{
+    require 'thread'
+    q = Queue.new
+    opts['pid'] = opts[:pid] = q
+    thread = Thread.new(cmd, opts){|cmd, opts| spawn cmd, opts}
+    pid = q.pop
+    sc = class << thread; self; end
+    sc.module_eval {
+      define_method(:pid){ pid }
+      define_method(:spawn_status){ @spawn_status ||= value }
+      define_method(:exitstatus){ spawn_status.exitstatus }
+    }
+    thread
+#--}}}
+  end
+  alias bg background
+  module_function :background
+  module_function :bg
 #--}}}
 end

data/lib/open4.rb

@@ -2,7 +2,9 @@ require 'fcntl'
 
 module Open4
 #--{{{
-  def self.version() '0.3.0' end
+  def self.version
+    '0.4.0'
+  end
 
   def popen4(*cmd)
 #--{{{
@@ -46,11 +48,7 @@ module Open4
 
     begin
       e = Marshal.load ps.first
-      if Exception === e
-        raise e
-      else
-        raise "unknown failure"
-      end
+      raise(Exception === e ? e : "unknown failure!")
     rescue EOFError # If we get an EOF error, then the exec was successful
       42
     end
@@ -75,6 +73,20 @@ module Open4
   module_function :popen4
   module_function :open4
 
+  class Error < ::StandardError; end
+  class SpawnError < Error
+#--{{{
+    attr 'cmd'
+    attr 'status'
+    def exitstatus
+      @status.exitstatus
+    end
+    def initialize cmd, status
+      @cmd, @status = cmd, status
+      super "cmd <#{ cmd }> failed with <#{ exitstatus }>"
+    end
+#--}}}
+  end
   def spawn cmd, opts = {} 
 #--{{{
     getopt = lambda do |*args|
@@ -89,11 +101,13 @@ module Open4
       end
     end
 
-    dont_raise = getopt[ 'quiet', !getopt['raise', true] ]
+    ignore_exit_failure = getopt[ 'ignore_exit_failure', getopt['quiet', false] ]
+    ignore_exec_failure = getopt[ 'ignore_exec_failure', !getopt['raise', true] ]
     exitstatus = getopt[ %w( exitstatus exit_status status ), 0 ]
     stdin = getopt[ ['stdin', 'in', '0', 0] ]
     stdout = getopt[ ['stdout', 'out', '1', 1] ]
     stderr = getopt[ ['stderr', 'err', '2', 2] ]
+    pid = getopt[ 'pid' ]
 
     started = false
 
@@ -102,32 +116,60 @@ module Open4
         popen4(cmd) do |c, i, o, e|
           started = true
 
-          if stdin.respond_to? :each
-            stdin.each{|buf| i << buf}
-          elsif stdin.respond_to? :read
-            i << stdin.read
-          else
-            i << stdin.to_s
+          if pid.respond_to? '<<'
+            pid << c
           end
 
-          i.close
+          it = Thread.new(i,stdin) do |i,stdin|
+            if stdin
+              if stdin.respond_to? :each
+                stdin.each{|buf| i << buf}
+              elsif stdin.respond_to? :read
+                i << stdin.read
+              else
+                i << stdin.to_s
+              end
+            end
+            i.close
+          end
 
-          ot = Thread.new(o){ o.each{|buf| stdout << buf if stdout} }
-          et = Thread.new(e){ e.each{|buf| stderr << buf if stderr} }
+          ot = Thread.new(o,stdout){|o,stdout| o.each{|buf| stdout << buf if stdout}}
+          et = Thread.new(e,stderr){|e,stderr| e.each{|buf| stderr << buf if stderr}}
 
-          ot.join
-          et.join
+          it.join
+          ot.join if ot
+          et.join if et
         end
       rescue
-        raise unless(not started and dont_raise)
+        raise unless(not started and ignore_exec_failure)
       end
 
-    raise "cmd <#{ cmd }> failed with <#{ status }>" unless
-      ((status == exitstatus) or dont_raise)
+    raise SpawnError.new(cmd, status) unless
+      (ignore_exit_failure or (status.nil? and ignore_exec_failure) or (status.exitstatus == exitstatus))
 
     status
 #--}}}
   end
   module_function :spawn
+
+  def background cmd, opts = {}
+#--{{{
+    require 'thread'
+    q = Queue.new
+    opts['pid'] = opts[:pid] = q
+    thread = Thread.new(cmd, opts){|cmd, opts| spawn cmd, opts}
+    pid = q.pop
+    sc = class << thread; self; end
+    sc.module_eval {
+      define_method(:pid){ pid }
+      define_method(:spawn_status){ @spawn_status ||= value }
+      define_method(:exitstatus){ spawn_status.exitstatus }
+    }
+    thread
+#--}}}
+  end
+  alias bg background
+  module_function :background
+  module_function :bg
 #--}}}
 end

data/sample/bg.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+require 'open4'
+include Open4
+
+stdin = '42'
+stdout = ''
+stderr = ''
+
+t = bg 'ruby -e"sleep 4; puts ARGF.read"', 0=>stdin, 1=>stdout, 2=>stderr
+
+waiter = Thread.new{ y t.pid => t.exitstatus } # t.exitstatus is a blocking call!
+
+while((status = t.status))
+  y "status" => status
+  sleep 1
+end
+
+waiter.join
+
+y "stdout" => stdout
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: open4
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2006-04-19 00:00:00.000000 -06:00
+  version: 0.4.0
+date: 2006-04-26 00:00:00.000000 -06:00
 summary: open4
 require_paths: 
   - lib
@@ -12,7 +12,7 @@ email: ara.t.howard@noaa.gov
 homepage: http://codeforpeople.com/lib/ruby/open4/
 rubyforge_project: 
 description: 
-autorequire: 
+autorequire: open4
 default_executable: 
 bindir: bin
 has_rdoc: false
@@ -29,7 +29,6 @@ cert_chain:
 authors: 
   - Ara T. Howard
 files: 
-  - open4-0.3.0.gem
   - install.rb
   - sample
   - lib
@@ -37,11 +36,13 @@ files:
   - build
   - install
   - gemspec.rb
+  - open4-0.4.0.gem
   - sample/block.rb
   - sample/simple.rb
   - sample/exception.rb
   - sample/spawn.rb
-  - lib/open4-0.3.0.rb
+  - sample/bg.rb
+  - lib/open4-0.4.0.rb
   - lib/open4.rb
 test_files: []
 rdoc_options: []