open4 1.0.1 → 1.3.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTUyNzE3MzczYmM1N2M5ZTQ0MWY0ZTkxMGM2NDcwODQzZWU3YjBkZg==
+  data.tar.gz: !binary |-
+    NDU2NWRlNGIxZjg5OGZmYjA5OGZhNDhhMTBiZDI2NTEyYzgxMTc5ZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDJjMzYwZjA5OGY5ODI2MDA3YzY5MmVkZjNjYjYzYTQyMjIzNmRjNzk3NDZi
+    NjRiMDExNjZjZDBkMWM5MWY0ZTlmNTYxNDRlODQ5NTNjMjk3YzcyNTYzYzU0
+    ZGIxYTNiZjc0MjdkY2JkZmNkYWIxYWY1MDlmY2RmYTdmZTUyZDk=
+  data.tar.gz: !binary |-
+    MzkxZDc2ODhjMjk4ZDEwMzM0YjIxYzEyYThiYTg3YmRlOTljYmRiOGUzMGY2
+    NTU0NmM4OTg2OTRlNDYwODMzMmU5ODA5OTkzNmYzMTgxYmIzY2ZlNGQ1NzE4
+    ZmY3ZDNlZmRmYzRiYmE2MGM0MDgxYjJhYWZkZTZhM2Q4ZmIyMzM=

data/LICENSE

@@ -0,0 +1,3 @@
+same as Ruby's
+
+http://www.ruby-lang.org/en/LICENSE.txt

data/README

@@ -193,6 +193,44 @@ SAMPLES
     42
     /dmsp/reference/ruby-1.8.1//lib/ruby/1.8/timeout.rb:42:in `relay': execution expired (Timeout::Error)
 
+  ----------------------------------------------------------------------------
+  pfork4 is similar to popen4, but instead of executing a command, it runs
+  ruby code in a child process. if the child process raises an exception, it
+  propagates to the parent.
+  ----------------------------------------------------------------------------
+
+    harp: > cat sample/pfork4.rb
+    require 'open4'
+
+    echo = lambda do
+      $stdout.write $stdin.read
+      raise 'finish implementing me'
+    end
+
+    org_message = "hello, world!"
+    got_message = nil
+    exception   = nil
+
+    begin
+      Open4.pfork4(echo) do |cid, stdin, stdout, stderr|
+        stdin.write org_message
+        stdin.close
+        got_message = stdout.read
+      end
+    rescue RuntimeError => e
+      exception = e.to_s
+    end
+
+    puts "org_message: #{org_message}"
+    puts "got_message: #{got_message}"
+    puts "exception  : #{exception}"
+
+
+    harp: > ruby sample/pfork4.rb
+    org_message: hello, world!
+    got_message: hello, world!
+    exception  : finish implementing me
+
 HISTORY
   1.0.0
     - added ability for spawn to take a proc (respond_to?(:call))

data/README.erb

@@ -193,6 +193,44 @@ SAMPLES
     42
     /dmsp/reference/ruby-1.8.1//lib/ruby/1.8/timeout.rb:42:in `relay': execution expired (Timeout::Error)
 
+  ----------------------------------------------------------------------------
+  pfork4 is similar to popen4, but instead of executing a command, it runs
+  ruby code in a child process. if the child process raises an exception, it
+  propagates to the parent.
+  ----------------------------------------------------------------------------
+
+    harp: > cat sample/pfork4.rb
+    require 'open4'
+
+    echo = lambda do
+      $stdout.write $stdin.read
+      raise 'finish implementing me'
+    end
+
+    org_message = "hello, world!"
+    got_message = nil
+    exception   = nil
+
+    begin
+      Open4.pfork4(echo) do |cid, stdin, stdout, stderr|
+        stdin.write org_message
+        stdin.close
+        got_message = stdout.read
+      end
+    rescue RuntimeError => e
+      exception = e.to_s
+    end
+
+    puts "org_message: #{org_message}"
+    puts "got_message: #{got_message}"
+    puts "exception  : #{exception}"
+
+
+    harp: > ruby sample/pfork4.rb
+    org_message: hello, world!
+    got_message: hello, world!
+    exception  : finish implementing me
+
 HISTORY
   1.0.0
     - added ability for spawn to take a proc (respond_to?(:call))

data/lib/open4.rb

@@ -4,23 +4,69 @@ require 'timeout'
 require 'thread'
 
 module Open4
-#--{{{
-  VERSION = '1.0.1'
-  def self.version() VERSION end
+  VERSION = '1.3.4'
+  def Open4.version() VERSION end
+
+  def Open4.description
+    'open child process with handles on pid, stdin, stdout, and stderr: manage child processes and their io handles easily.'
+  end
 
   class Error < ::StandardError; end
 
+  def pfork4(fun, &b)
+    Open4.do_popen(b, :block) do |ps_read, _|
+      ps_read.close
+      begin
+        fun.call
+      rescue SystemExit => e
+        # Make it seem to the caller that calling Kernel#exit in +fun+ kills
+        # the child process normally. Kernel#exit! bypasses this rescue
+        # block.
+        exit! e.status
+      else
+        exit! 0
+      end
+    end
+  end
+  module_function :pfork4
+
   def popen4(*cmd, &b)
-#--{{{
+    Open4.do_popen(b, :init) do |ps_read, ps_write|
+      ps_read.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+      ps_write.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+      exec(*cmd)
+      raise 'forty-two'   # Is this really needed?
+    end
+  end
+  alias open4 popen4
+  module_function :popen4
+  module_function :open4
+
+  def popen4ext(closefds=false, *cmd, &b)
+    Open4.do_popen(b, :init, closefds) do |ps_read, ps_write|
+      ps_read.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+      ps_write.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+      exec(*cmd)
+      raise 'forty-two'   # Is this really needed?
+    end
+  end
+  module_function :popen4ext
+
+  def self.do_popen(b = nil, exception_propagation_at = nil, closefds=false, &cmd)
     pw, pr, pe, ps = IO.pipe, IO.pipe, IO.pipe, IO.pipe
 
     verbose = $VERBOSE
     begin
       $VERBOSE = nil
-      ps.first.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
-      ps.last.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
 
       cid = fork {
+        if closefds
+          exlist = [0, 1, 2] | [pw,pr,pe,ps].map{|p| [p.first.fileno, p.last.fileno] }.flatten
+          ObjectSpace.each_object(IO){|io|
+            io.close if (not io.closed?) and (not exlist.include? io.fileno) rescue nil
+          }
+        end
+
         pw.last.close
         STDIN.reopen pw.first
         pw.first.close
@@ -36,52 +82,59 @@ module Open4
         STDOUT.sync = STDERR.sync = true
 
         begin
-          exec(*cmd)
-          raise 'forty-two' 
+          cmd.call(ps)
         rescue Exception => e
           Marshal.dump(e, ps.last)
           ps.last.flush
+        ensure
+          ps.last.close unless ps.last.closed?
         end
-        ps.last.close unless (ps.last.closed?)
+
         exit!
       }
     ensure
       $VERBOSE = verbose
     end
 
-    [pw.first, pr.last, pe.last, ps.last].each{|fd| fd.close}
+    [ pw.first, pr.last, pe.last, ps.last ].each { |fd| fd.close }
 
-    begin
-      e = Marshal.load ps.first
-      raise(Exception === e ? e : "unknown failure!")
-    rescue EOFError # If we get an EOF error, then the exec was successful
-      42
-    ensure
-      ps.first.close
-    end
+    Open4.propagate_exception cid, ps.first if exception_propagation_at == :init
 
     pw.last.sync = true
 
-    pi = [pw.last, pr.first, pe.first]
+    pi = [ pw.last, pr.first, pe.first ]
+
+    begin
+      return [cid, *pi] unless b
 
-    if b 
       begin
-        b[cid, *pi]
-        Process.waitpid2(cid).last
+        b.call(cid, *pi)
       ensure
-        pi.each{|fd| fd.close unless fd.closed?}
+        pi.each { |fd| fd.close unless fd.closed? }
       end
-    else
-      [cid, pw.last, pr.first, pe.first]
+
+      Open4.propagate_exception cid, ps.first if exception_propagation_at == :block
+
+      Process.waitpid2(cid).last
+    ensure
+      ps.first.close unless ps.first.closed?
     end
-#--}}}
   end
-  alias open4 popen4
-  module_function :popen4
-  module_function :open4
+
+  def self.propagate_exception(cid, ps_read)
+    e = Marshal.load ps_read
+    raise Exception === e ? e : "unknown failure!"
+  rescue EOFError
+    # Child process did not raise exception.
+  rescue
+    # Child process raised exception; wait it in order to avoid a zombie.
+    Process.waitpid2 cid
+    raise
+  ensure
+    ps_read.close
+  end
 
   class SpawnError < Error
-#--{{{
     attr 'cmd'
     attr 'status'
     attr 'signals'
@@ -98,11 +151,9 @@ module Open4
       sigs = @signals.map{|k,v| "#{ k }:#{ v.inspect }"}.join(' ')
       super "cmd <#{ cmd }> failed with status <#{ exitstatus.inspect }> signals <#{ sigs }>"
     end
-#--}}}
   end
 
   class ThreadEnsemble
-#--{{{
     attr 'threads'
 
     def initialize cid
@@ -132,9 +183,9 @@ module Open4
 
       begin
         @argv.each do |a, b|
-          @threads << Thread.new(*a) do |*a|
+          @threads << Thread.new(*a) do |*_a|
             begin
-              b[*a]
+              b[*_a]
             ensure
               killall rescue nil if $!
               @done.push Thread.current
@@ -154,54 +205,48 @@ module Open4
     def all_done
       @threads.size.times{ @done.pop }
     end
-#--}}}
   end
 
   def to timeout = nil
-#--{{{
     Timeout.timeout(timeout){ yield }
-#--}}}
   end
   module_function :to
 
   def new_thread *a, &b
-#--{{{
     cur = Thread.current
-    Thread.new(*a) do |*a|
+    Thread.new(*a) do |*_a|
       begin
-        b[*a]
+        b[*_a]
       rescue Exception => e
         cur.raise e
       end
     end
-#--}}}
   end
   module_function :new_thread
 
   def getopts opts = {}
-#--{{{
     lambda do |*args|
-      keys, default, ignored = args
-      catch('opt') do
+      keys, default, _ = args
+      catch(:opt) do
         [keys].flatten.each do |key|
-          [key, key.to_s, key.to_s.intern].each do |key|
-            throw 'opt', opts[key] if opts.has_key?(key)
+          [key, key.to_s, key.to_s.intern].each do |_key|
+            throw :opt, opts[_key] if opts.has_key?(_key)
           end
         end
         default
       end
     end
-#--}}}
   end
   module_function :getopts
 
   def relay src, dst = nil, t = nil
-#--{{{
     send_dst =
       if dst.respond_to?(:call)
         lambda{|buf| dst.call(buf)}
+      elsif dst.respond_to?(:<<)
+        lambda{|buf| dst << buf }
       else
-        lambda{|buf| dst << buf}
+        lambda{|buf| buf }
       end
 
     unless src.nil?
@@ -214,19 +259,19 @@ module Open4
         q = Queue.new
         th = nil
 
-        timer_set = lambda do |t|
-          th = new_thread{ to(t){ q.pop } }
+        timer_set = lambda do |_t|
+          th = new_thread{ to(_t){ q.pop } }
         end
 
-        timer_cancel = lambda do |t|
+        timer_cancel = lambda do |_t|
           th.kill if th rescue nil
         end
 
         timer_set[t]
         begin
-          src.each do |buf|
+          src.each do |_buf|
             timer_cancel[t]
-            send_dst[buf]
+            send_dst[_buf]
             timer_set[t]
           end
         ensure
@@ -242,12 +287,10 @@ module Open4
         send_dst[buf]
       end
     end
-#--}}}
   end
   module_function :relay
 
   def spawn arg, *argv 
-#--{{{
     argv.unshift(arg)
     opts = ((argv.size > 1 and Hash === argv.last) ? argv.pop : {})
     argv.flatten!
@@ -269,6 +312,7 @@ module Open4
     stderr_timeout = getopt[ %w( stderr_timeout ) ]
     status = getopt[ %w( status ) ]
     cwd = getopt[ %w( cwd dir ) ]
+    closefds = getopt[ %w( close_fds ) ]
 
     exitstatus =
       case exitstatus
@@ -289,7 +333,7 @@ module Open4
       begin
         chdir(cwd) do
           Timeout::timeout(timeout) do
-            popen4(*argv) do |c, i, o, e|
+            popen4ext(closefds, *argv) do |c, i, o, e|
               started = true
 
               %w( replace pid= << push update ).each do |msg|
@@ -298,17 +342,17 @@ module Open4
 
               te = ThreadEnsemble.new c
 
-              te.add_thread(i, stdin) do |i, stdin|
-                relay stdin, i, stdin_timeout
-                i.close rescue nil
+              te.add_thread(i, stdin) do |_i, _stdin|
+                relay _stdin, _i, stdin_timeout
+                _i.close rescue nil
               end
 
-              te.add_thread(o, stdout) do |o, stdout|
-                relay o, stdout, stdout_timeout
+              te.add_thread(o, stdout) do |_o, _stdout|
+                relay _o, _stdout, stdout_timeout
               end
 
-              te.add_thread(e, stderr) do |o, stderr|
-                relay e, stderr, stderr_timeout
+              te.add_thread(e, stderr) do |_o, _stderr| # HACK: I think this is a bug
+                relay e, _stderr, stderr_timeout
               end
 
               te.run
@@ -323,7 +367,6 @@ module Open4
       (ignore_exit_failure or (status.nil? and ignore_exec_failure) or exitstatus.include?(status.exitstatus))
 
     status
-#--}}}
   end
   module_function :spawn
 
@@ -334,7 +377,6 @@ module Open4
   module_function :chdir
 
   def background arg, *argv 
-#--{{{
     require 'thread'
     q = Queue.new
     opts = { 'pid' => q, :pid => q }
@@ -344,7 +386,7 @@ module Open4
       else
         argv.push opts
     end
-    thread = Thread.new(arg, argv){|arg, argv| spawn arg, *argv}
+    thread = Thread.new(arg, argv){|_arg, _argv| spawn _arg, *_argv}
     sc = class << thread; self; end
     sc.module_eval {
       define_method(:pid){ @pid ||= q.pop }
@@ -352,14 +394,12 @@ module Open4
       define_method(:exitstatus){ @exitstatus ||= spawn_status.exitstatus }
     }
     thread
-#--}}}
   end
   alias bg background
   module_function :background
   module_function :bg
 
   def maim pid, opts = {}
-#--{{{
     getopt = getopts opts
     sigs = getopt[ 'signals', %w(SIGTERM SIGQUIT SIGKILL) ]
     suspend = getopt[ 'suspend', 4 ]
@@ -377,12 +417,10 @@ module Open4
       return true unless alive? pid
     end
     return(not alive?(pid)) 
-#--}}}
   end
   module_function :maim
 
   def alive pid
-#--{{{
     pid = Integer pid
     begin
       Process.kill 0, pid
@@ -390,12 +428,10 @@ module Open4
     rescue Errno::ESRCH
       false
     end
-#--}}}
   end
   alias alive? alive
   module_function :alive
   module_function :'alive?'
-#--}}}
 end
 
 def open4(*cmd, &b) cmd.size == 0 ? Open4 : Open4::popen4(*cmd, &b) end

data/open4.gemspec

@@ -3,26 +3,51 @@
 
 Gem::Specification::new do |spec|
   spec.name = "open4"
-  spec.version = "1.0.1"
+  spec.version = "1.3.4"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "open4"
+  spec.description = "open child process with handles on pid, stdin, stdout, and stderr: manage child processes and their io handles easily."
+  spec.license = "Ruby"
 
-  spec.description = "manage child processes and their io handles easily"
+  spec.files =
+["LICENSE",
+ "README",
+ "README.erb",
+ "lib",
+ "lib/open4.rb",
+ "open4.gemspec",
+ "rakefile",
+ "samples",
+ "samples/bg.rb",
+ "samples/block.rb",
+ "samples/exception.rb",
+ "samples/jesse-caldwell.rb",
+ "samples/pfork4.rb",
+ "samples/simple.rb",
+ "samples/spawn.rb",
+ "samples/stdin_timeout.rb",
+ "samples/timeout.rb",
+ "test",
+ "test/lib",
+ "test/lib/test_case.rb",
+ "test/pfork4_test.rb",
+ "test/popen4_test.rb",
+ "test/popen4ext_test.rb",
+ "white_box",
+ "white_box/leak.rb"]
 
-  spec.files = ["lib", "lib/open4.rb", "open4.gemspec", "Rakefile", "README", "README.erb", "samples", "samples/bg.rb", "samples/block.rb", "samples/exception.rb", "samples/simple.rb", "samples/spawn.rb", "samples/stdin_timeout.rb", "samples/timeout.rb", "white_box", "white_box/leak.rb"]
   spec.executables = []
   
   spec.require_path = "lib"
 
-  spec.has_rdoc = true
   spec.test_files = nil
-  #spec.add_dependency 'lib', '>= version'
-  #spec.add_dependency 'fattr'
+
+  
 
   spec.extensions.push(*[])
 
   spec.rubyforge_project = "codeforpeople"
   spec.author = "Ara T. Howard"
   spec.email = "ara.t.howard@gmail.com"
-  spec.homepage = "http://github.com/ahoward/open4/tree/master"
+  spec.homepage = "https://github.com/ahoward/open4"
 end