wopen3 0.1 → 0.2

data/lib/wopen3.rb

@@ -1,15 +1,13 @@
-# Copyright 2007 Wincent Colaiuta
-# $Id$
-
 # Wopen3 is a replacement for Open3.
 #
-# Unlike Open3, Wopen3 does not throw away the exit code of the executed (grandchild) process.
-# Only a child process is spawned and the exit status is returned in $? as normal.
+# Unlike Open3, Wopen3 does not throw away the exit code of the executed
+# (grandchild) process. Only a child process is spawned and the exit status is
+# returned in $? as normal.
 #
 # Usage example:
 #
 #   result, errors = '', ''
-#   Wopen3.popen3('svn', 'log') do |stdin, stdout, stderr|
+#   Wopen3.popen3('git', 'log') do |stdin, stdout, stderr|
 #     threads = []
 #     threads << Thread.new(stdout) do |out|
 #       out.each { |line| result << line }
@@ -17,53 +15,56 @@
 #     threads << Thread.new(stderr) do |err|
 #       err.each { |line| errors << line }
 #     end
-#     threads.each { |thread| thread.join }      
+#     threads.each { |thread| thread.join }
 #   end
 #   status = $?.exitstatus
 #   raise "Non-zero exit status #{status}" if status != 0
 #
+# As this is such a common usage pattern, a 'system' method is provided as a
+# convenience:
+#
+#   result = Wopen3.system('git', 'log')
+#   result.status # => 0
+#   result.stderr # => ''
+#   result.stdout # => 'commit 491411b3...'
 #
 module Wopen3
-  
   class Opener
-    
     READ  = 0
     WRITE = 1
-    
-    def initialize(*cmd)
-      
+
+    def initialize *cmd
       write_pipe  = IO::pipe
       read_pipe   = IO::pipe
       error_pipe  = IO::pipe
-      
+
       pid = fork do
-        
         # in child
         write_pipe[WRITE].close
         STDIN.reopen(write_pipe[READ])    # file descriptor duplicated here
-        write_pipe[READ].close            # must close in order for parent to see EOF
-        
+        write_pipe[READ].close            # must close in order for parent to
+                                          # see EOF
         read_pipe[READ].close
         STDOUT.reopen(read_pipe[WRITE])
         read_pipe[WRITE].close
-        
+
         error_pipe[READ].close
         STDERR.reopen(error_pipe[WRITE])
         error_pipe[WRITE].close
-        
-        exec(*cmd)  # will raise SystemCallError if command can't be executed (eg Errno::NOENT)
+
+        exec(*cmd)  # will raise SystemCallError if command can't be executed
+                    # (eg Errno::NOENT)
         exit!       # should never get here
-        
       end
-      
+
       # in parent
       write_pipe[READ].close
       read_pipe[WRITE].close
       error_pipe[WRITE].close
-      
+
       pipes = [write_pipe[WRITE], read_pipe[READ], error_pipe[READ]]
       write_pipe[WRITE].sync = true
-      
+
       if defined? yield
         begin
           result = yield(*pipes)
@@ -73,17 +74,40 @@ module Wopen3
           pipes.each { |pipe| pipe.close unless pipe.closed? }
         end
       end
-      
-      # can't wait immediately (will hang); wait once garbage collection destroys/finalizes this instance
+
+      # can't wait immediately (will hang); wait once garbage collection
+      # destroys/finalizes this instance
       ObjectSpace.define_finalizer(self, proc { Process.waitpid(pid) })
       pipes
-      
     end
-    
+  end # class Opener
+
+  class Result
+    attr_reader :args, :status, :stderr, :stdout
+
+    def initialize *args
+      @args = args
+      @stderr = ''
+      @stdout = ''
+      Wopen3.popen3 *args do |stdin, stdout, stderr|
+        threads = []
+        threads << Thread.new(stdout) do |out|
+          out.each { |line| @stdout << line }
+        end
+        threads << Thread.new(stderr) do |err|
+          err.each { |line| @stderr << line }
+        end
+        threads.each { |thread| thread.join }
+      end
+      @status = $?.exitstatus
+    end
+  end # class Result
+
+  def self.popen3 *cmd, &block
+    Opener.new *cmd, &block
   end
-  
-  def self.popen3(*cmd, &block)
-    Opener.new(*cmd, &block)
+
+  def self.system *args
+    Result.new *args
   end
-  
 end # module Wopen3

metadata

@@ -1,46 +1,61 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: wopen3
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2007-04-12 00:00:00 +02:00
-summary: Wopen3 is a simple replacement for Open3.
-require_paths: 
-- lib
-email: win@wincent.com
-homepage: http://wincent.com/a/products/walrus/wopen3/
-rubyforge_project: 
-description: Unlike Open3, Wopen3 does not throw away the exit code of the executed (grandchild) process. Only a child process is spawned and the exit  status is returned in $? as normal.
-autorequire: wopen3
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Wincent Colaiuta
-files: 
-- lib/wopen3.rb
-test_files: []
-
-rdoc_options: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: []
+date: 2010-07-28 00:00:00 +02:00
+default_executable: 
+dependencies: []
 
+description: "    Unlike Open3, Wopen3 does not throw away the exit code of the executed\n    (grandchild) process. Only a child process is spawned and the exit\n    status is returned in $? as normal.\n"
+email: win@wincent.com
 executables: []
 
 extensions: []
 
+extra_rdoc_files: []
+
+files: 
+- lib/wopen3.rb
+has_rdoc: false
+homepage: https://wincent.com/products/wopen3
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
-dependencies: []
+rubyforge_project: walrus
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Wopen3 is a simple replacement for Open3
+test_files: []