childprocess 0.1.5 → 0.1.6

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/childprocess.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{childprocess}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jari Bakken"]
-  s.date = %q{2010-12-10}
+  s.date = %q{2010-12-22}
   s.description = %q{This gem aims at being a simple and reliable solution for controlling external programs running in the background on any Ruby / OS combination.}
   s.email = %q{jari.bakken@gmail.com}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rspec",
     "LICENSE",
     "README.rdoc",
     "Rakefile",
@@ -47,7 +48,6 @@ Gem::Specification.new do |s|
     "spec/abstract_io_spec.rb",
     "spec/childprocess_spec.rb",
     "spec/jruby_spec.rb",
-    "spec/spec.opts",
     "spec/spec_helper.rb",
     "spec/unix_spec.rb",
     "spec/windows_spec.rb"

data/lib/childprocess/abstract_io.rb

@@ -1,6 +1,6 @@
 module ChildProcess
   class AbstractIO
-    attr_reader :stderr, :stdout
+    attr_reader :stderr, :stdout, :stdin
 
     def inherit!
       @stdout = STDOUT
@@ -17,6 +17,15 @@ module ChildProcess
       @stdout = io
     end
 
+    #
+    # @api private
+    #
+
+    def _stdin=(io)
+      check_type io
+      @stdin = io
+    end
+
     private
 
     def check_type(io)

data/lib/childprocess/abstract_process.rb

@@ -7,6 +7,10 @@ module ChildProcess
     #
     attr_accessor :detach
 
+    #
+    # Set this to true if you want to write to the process' stdin (process.io.stdin)
+    #
+    attr_accessor :duplex
 
     #
     # Create a new process with the given args.
@@ -20,6 +24,7 @@ module ChildProcess
       @started   = false
       @exit_code = nil
       @detach    = false
+      @duplex    = false
     end
 
     #
@@ -117,6 +122,10 @@ module ChildProcess
       @detach
     end
 
+    def duplex?
+      @duplex
+    end
+
     def log(*args)
       $stderr.puts "#{self.inspect} : #{args.inspect}" if $DEBUG
     end
@@ -126,4 +135,4 @@ module ChildProcess
     end
 
   end # AbstractProcess
-end # ChildProcess
+end # ChildProcess

data/lib/childprocess/jruby/process.rb

@@ -30,13 +30,14 @@ module ChildProcess
 
       private
 
-      def launch_process
+      def launch_process(&blk)
         pb = java.lang.ProcessBuilder.new(@args)
 
         env = pb.environment
         ENV.each { |k,v| env.put(k, v) }
 
         @process = pb.start
+
         setup_io
       end
 
@@ -48,6 +49,12 @@ module ChildProcess
           @process.getErrorStream.close
           @process.getInputStream.close
         end
+
+        if duplex?
+          io._stdin = @process.getOutputStream.to_io
+        else
+          @process.getOutputStream.close
+        end
       end
 
       def redirect(input, output)

data/lib/childprocess/unix/process.rb

@@ -72,13 +72,27 @@ module ChildProcess
           stderr = @io.stderr
         end
 
+        if duplex?
+          reader, writer = ::IO.pipe
+        end
+
         @pid = fork {
           STDOUT.reopen(stdout || "/dev/null")
           STDERR.reopen(stderr || "/dev/null")
 
+          if duplex?
+            STDIN.reopen(reader)
+            writer.close
+          end
+
           exec(*@args)
         }
 
+        if duplex?
+          io._stdin = writer
+          reader.close
+        end
+
         ::Process.detach(@pid) if detach?
       end
 

data/lib/childprocess/windows/api.rb

@@ -33,7 +33,7 @@ module ChildProcess
           raise ArgumentError, "expected #{file.inspect} to respond to :fileno"
         end
 
-        handle = Lib.get_os_file_handle(file.fileno)
+        handle = Lib.handle_for(file.fileno)
 
         ok = Lib.set_handle_information(handle, HANDLE_FLAG_INHERIT, 0)
         ok or raise Error, Lib.last_error_message

data/lib/childprocess/windows/constants.rb

@@ -23,6 +23,8 @@ module ChildProcess::Windows
   INVALID_HANDLE_VALUE          = 0xFFFFFFFF
   HANDLE_FLAG_INHERIT           = 0x00000001
 
+  DUPLICATE_SAME_ACCESS         = 0x00000002
+
   module Lib
     enum :wait_status, [ :wait_object_0,  0,
                          :wait_timeout,   0x102,

data/lib/childprocess/windows/functions.rb

@@ -18,8 +18,22 @@ module ChildProcess
           si[:dwFlags] |= STARTF_USESTDHANDLES
           inherit = true
 
-          si[:hStdOutput] = get_os_file_handle(opts[:stdout].fileno) if opts[:stdout]
-          si[:hStdError]  = get_os_file_handle(opts[:stderr].fileno) if opts[:stderr]
+          si[:hStdOutput] = handle_for(opts[:stdout].fileno) if opts[:stdout]
+          si[:hStdError]  = handle_for(opts[:stderr].fileno) if opts[:stderr]
+        end
+
+        if opts[:duplex]
+          read_pipe_ptr  = FFI::MemoryPointer.new(:pointer)
+          write_pipe_ptr = FFI::MemoryPointer.new(:pointer)
+          sa         = SecurityAttributes.new(:inherit => true)
+
+          ok = create_pipe(read_pipe_ptr, write_pipe_ptr, sa, 0)
+          ok or raise Error, last_error_message
+
+          read_pipe = read_pipe_ptr.read_pointer
+          write_pipe = write_pipe_ptr.read_pointer
+
+          si[:hStdInput] = read_pipe
         end
 
         ok = create_process(nil, cmd_ptr, nil, nil, inherit, flags, nil, nil, si, pi)
@@ -28,6 +42,12 @@ module ChildProcess
         close_handle pi[:hProcess]
         close_handle pi[:hThread]
 
+        if opts[:duplex]
+          opts[:stdin] = io_for(duplicate_handle(write_pipe), File::WRONLY)
+          close_handle read_pipe
+          close_handle write_pipe
+        end
+
         pi[:dwProcessId]
       end
 
@@ -43,12 +63,12 @@ module ChildProcess
         buf.read_string(size).strip
       end
 
-      def self.get_os_file_handle(fd_or_io)
+      def self.handle_for(fd_or_io)
         case fd_or_io
         when IO
-          handle = _get_osfhandle(fd.fileno)
+          handle = get_osfhandle(fd.fileno)
         when Fixnum
-          handle = _get_osfhandle(fd_or_io)
+          handle = get_osfhandle(fd_or_io)
         else
           if fd_or_io.respond_to?(:to_io)
             io = fd_or_io.to_io
@@ -57,19 +77,42 @@ module ChildProcess
               raise TypeError, "expected #to_io to return an instance of IO"
             end
 
-            handle = _get_osfhandle(io.fileno)
+            handle = get_osfhandle(io.fileno)
           else
             raise TypeError, "invalid type: #{fd_or_io.inspect}"
           end
         end
 
         if handle == INVALID_HANDLE_VALUE
-          raise Error, Lib.last_error_message
+          raise Error, last_error_message
         end
 
         handle
       end
 
+      def self.io_for(handle, flags = File::RDONLY)
+        fd = open_osfhandle(handle, flags)
+        if fd == -1
+          raise Error, last_error_message
+        end
+
+        ::IO.for_fd fd, flags
+      end
+
+      def self.duplicate_handle(handle)
+        dup  = FFI::MemoryPointer.new(:pointer)
+        proc = current_process
+
+        ok = _duplicate_handle(
+          proc, handle, proc, dup, 0, false, DUPLICATE_SAME_ACCESS)
+
+        ok or raise Error, last_error_message
+
+        dup.read_pointer
+      ensure
+        close_handle proc
+      end
+
       #
       # BOOL WINAPI CreateProcess(
       #   __in_opt     LPCTSTR lpApplicationName,
@@ -181,7 +224,16 @@ module ChildProcess
       # );
       #
 
-      attach_function :_get_osfhandle, :_get_osfhandle, [:int], :long
+      attach_function :get_osfhandle, :_get_osfhandle, [:int], :long
+
+      #
+      # int _open_osfhandle (
+      #    intptr_t osfhandle,
+      #    int flags
+      # );
+      #
+
+      attach_function :open_osfhandle, :_open_osfhandle, [:pointer, :int], :int
 
       # BOOL WINAPI SetHandleInformation(
       #   __in  HANDLE hObject,
@@ -191,6 +243,42 @@ module ChildProcess
 
       attach_function :set_handle_information, :SetHandleInformation, [:long, :ulong, :ulong], :bool
 
+      # BOOL WINAPI CreatePipe(
+      #   __out     PHANDLE hReadPipe,
+      #   __out     PHANDLE hWritePipe,
+      #   __in_opt  LPSECURITY_ATTRIBUTES lpPipeAttributes,
+      #   __in      DWORD nSize
+      # );
+
+      attach_function :create_pipe, :CreatePipe, [:pointer, :pointer, :pointer, :ulong], :bool
+
+      #
+      # HANDLE WINAPI GetCurrentProcess(void);
+      #
+
+      attach_function :current_process, :GetCurrentProcess, [], :pointer
+
+      #
+      # BOOL WINAPI DuplicateHandle(
+      #   __in   HANDLE hSourceProcessHandle,
+      #   __in   HANDLE hSourceHandle,
+      #   __in   HANDLE hTargetProcessHandle,
+      #   __out  LPHANDLE lpTargetHandle,
+      #   __in   DWORD dwDesiredAccess,
+      #   __in   BOOL bInheritHandle,
+      #   __in   DWORD dwOptions
+      # );
+      #
+
+      attach_function :_duplicate_handle, :DuplicateHandle, [
+                         :pointer,
+                         :pointer,
+                         :pointer,
+                         :pointer,
+                         :ulong,
+                         :bool,
+                         :ulong
+                      ], :bool
     end # Lib
   end # Windows
 end # ChildProcess

data/lib/childprocess/windows/process.rb

@@ -40,6 +40,7 @@ module ChildProcess
         opts = {
           :inherit => false,
           :detach  => detach?,
+          :duplex  => duplex?
         }
 
         if @io
@@ -47,12 +48,16 @@ module ChildProcess
           opts[:stderr] = @io.stderr
         end
 
-       # TODO: escape/quote arguments properly
-       command = @args.join ' '
+        # TODO: escape/quote arguments properly
+        command = @args.join ' '
 
         @pid = Lib.create_proc(command, opts)
         @handle = Handle.open(@pid)
 
+        if duplex?
+          io._stdin = opts[:stdin]
+        end
+
         self
       end
 

data/lib/childprocess/windows/structs.rb

@@ -57,4 +57,25 @@ module ChildProcess::Windows
            :dwThreadId,  :ulong
   end
 
+  #
+  # typedef struct _SECURITY_ATTRIBUTES {
+  #   DWORD  nLength;
+  #   LPVOID lpSecurityDescriptor;
+  #   BOOL   bInheritHandle;
+  # } SECURITY_ATTRIBUTES, *PSECURITY_ATTRIBUTES, *LPSECURITY_ATTRIBUTES;
+  #
+
+  class SecurityAttributes < FFI::Struct
+    layout :nLength,              :ulong,
+           :lpSecurityDescriptor, :pointer, # void ptr
+           :bInheritHandle,       :int
+
+    def initialize(opts = {})
+      super()
+
+      self[:nLength]              = self.class.size
+      self[:lpSecurityDescriptor] = nil
+      self[:bInheritHandle]       = opts[:inherit] ? 1 : 0
+    end
+  end
 end

data/spec/childprocess_spec.rb

@@ -66,12 +66,13 @@ describe ChildProcess do
     pending "how do we spec this?"
   end
 
-  it "can redirect stdout and stderr" do
+  it "can redirect stdout, stderr" do
     process = ruby(<<-CODE)
       [STDOUT, STDERR].each_with_index do |io, idx|
         io.sync = true
         io.puts idx
       end
+
       sleep 0.2
     CODE
 
@@ -83,6 +84,7 @@ describe ChildProcess do
       process.io.stderr = err
 
       process.start
+      process.io.stdin.should be_nil
       process.poll_for_exit(EXIT_TIMEOUT)
 
       out.rewind
@@ -96,6 +98,31 @@ describe ChildProcess do
     end
   end
 
+  it "can write to stdin if duplex = true" do
+    process = ruby(<<-CODE)
+      puts(STDIN.gets.chomp)
+    CODE
+
+    out = Tempfile.new("duplex")
+
+    begin
+      process.io.stdout = out
+      process.io.stderr = out
+      process.duplex = true
+
+      process.start
+      process.io.stdin.puts "hello world"
+      process.io.stdin.close # JRuby seems to need this
+
+      process.poll_for_exit(EXIT_TIMEOUT)
+
+      out.rewind
+      out.read.should == "hello world\n"
+    ensure
+      out.close
+    end
+  end
+
   it "can set close-on-exec when IO is inherited" do
     server = TCPServer.new("localhost", 4433)
     ChildProcess.close_on_exec server

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Jari Bakken
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-10 00:00:00 +01:00
+date: 2010-12-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .rspec
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -100,7 +101,6 @@ files:
 - spec/abstract_io_spec.rb
 - spec/childprocess_spec.rb
 - spec/jruby_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 - spec/unix_spec.rb
 - spec/windows_spec.rb