childprocess 0.2.2 → 0.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -7,6 +7,8 @@ external programs running in the background on any Ruby / OS combination.
 The code originated in the selenium-webdriver gem, but should prove useful as
 a standalone library.
 
+[![Build Status](https://secure.travis-ci.org/jarib/childprocess.png)](http://travis-ci.org/jarib/childprocess)
+
 Usage
 -----
 ```ruby
@@ -36,7 +38,6 @@ How the process is launched and killed depends on the platform:
 * Unix     : fork + exec
 * Windows  : CreateProcess and friends
 * JRuby    : java.lang.{Process,ProcessBuilder}
-* IronRuby : System.Diagnostics.Process
 
 Note on Patches/Pull Requests
 -----------------------------

data/lib/childprocess.rb

@@ -7,16 +7,12 @@ module ChildProcess
   autoload :Unix,     'childprocess/unix'
   autoload :Windows,  'childprocess/windows'
   autoload :JRuby,    'childprocess/jruby'
-  autoload :IronRuby, 'childprocess/ironruby'
 
   class << self
-
     def new(*args)
       case platform
       when :jruby
         JRuby::Process.new(args)
-      when :ironruby
-        IronRuby::Process.new(args)
       when :windows
         Windows::Process.new(args)
       when :macosx, :linux, :unix, :cygwin

data/lib/childprocess/abstract_process.rb

@@ -14,6 +14,11 @@ module ChildProcess
     #
     attr_accessor :duplex
 
+    #
+    # Modify the child's environment variables
+    #
+    attr_reader :environment
+
     #
     # Create a new process with the given args.
     #
@@ -22,12 +27,13 @@ module ChildProcess
     #
 
     def initialize(args)
-      @args      = args
-      @started   = false
-      @exit_code = nil
-      @io        = nil
-      @detach    = false
-      @duplex    = false
+      @args        = args
+      @started     = false
+      @exit_code   = nil
+      @io          = nil
+      @detach      = false
+      @duplex      = false
+      @environment = {}
     end
 
     #

data/lib/childprocess/errors.rb

@@ -2,4 +2,5 @@ module ChildProcess
   class Error < StandardError; end
   class TimeoutError < StandardError; end
   class SubclassResponsibility < StandardError; end
+  class InvalidEnvironmentVariableName < StandardError; end
 end

data/lib/childprocess/jruby/process.rb

@@ -52,12 +52,11 @@ module ChildProcess
 
       def launch_process(&blk)
         pb = java.lang.ProcessBuilder.new(@args)
-        pb.directory(java.io.File.new(Dir.pwd))
-        env = pb.environment
-        ENV.each { |k,v| env.put(k, v) }
 
-        @process = pb.start
+        pb.directory java.io.File.new(Dir.pwd)
+        set_env pb.environment
 
+        @process = pb.start
         setup_io
       end
 
@@ -87,6 +86,11 @@ module ChildProcess
         Thread.new { Redirector.new(input, output).run }
       end
 
+      def set_env(env)
+        ENV.each { |k,v| env.put(k, v) } # not sure why this is needed
+        @environment.each { |k,v| env.put(k.to_s, v.to_s) }
+      end
+
     end # Process
   end # JRuby
 end # ChildProcess

data/lib/childprocess/unix/process.rb

@@ -81,6 +81,8 @@ module ChildProcess
         end
 
         @pid = fork {
+          set_env
+
           STDOUT.reopen(stdout || "/dev/null")
           STDERR.reopen(stderr || "/dev/null")
 
@@ -100,6 +102,10 @@ module ChildProcess
         ::Process.detach(@pid) if detach?
       end
 
+      def set_env
+        @environment.each { |k, v| ENV[k.to_s] = v.to_s }
+      end
+
     end # Process
   end # Unix
 end # ChildProcess

data/lib/childprocess/version.rb

@@ -1,3 +1,3 @@
 module ChildProcess
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/childprocess/windows/constants.rb

@@ -25,6 +25,8 @@ module ChildProcess::Windows
 
   DUPLICATE_SAME_ACCESS         = 0x00000002
 
+  CREATE_UNICODE_ENVIRONMENT    = 0x00000400
+
   module Lib
     enum :wait_status, [ :wait_object_0,  0,
                          :wait_timeout,   0x102,

data/lib/childprocess/windows/functions.rb

@@ -4,6 +4,7 @@ module ChildProcess
 
       def self.create_proc(cmd, opts = {})
         cmd_ptr = FFI::MemoryPointer.from_string cmd
+        env_ptr = environment_pointer_for(opts[:environment])
 
         flags   = 0
         inherit = !!opts[:inherit]
@@ -25,7 +26,7 @@ module ChildProcess
         if opts[:duplex]
           read_pipe_ptr  = FFI::MemoryPointer.new(:pointer)
           write_pipe_ptr = FFI::MemoryPointer.new(:pointer)
-          sa         = SecurityAttributes.new(:inherit => true)
+          sa             = SecurityAttributes.new(:inherit => true)
 
           ok = create_pipe(read_pipe_ptr, write_pipe_ptr, sa, 0)
           ok or raise Error, last_error_message
@@ -36,7 +37,19 @@ module ChildProcess
           si[:hStdInput] = read_pipe
         end
 
-        ok = create_process(nil, cmd_ptr, nil, nil, inherit, flags, nil, nil, si, pi)
+        ok = create_process(
+          nil,      # application name
+          cmd_ptr,  # command line
+          nil,      # process attributes
+          nil,      # thread attributes
+          inherit,  # inherit handles
+          flags,    # creation flags
+          env_ptr,  # environment
+          nil,      # current directory
+          si,       # startup info
+          pi        # process info
+        )
+
         ok or raise Error, last_error_message
 
         close_handle pi[:hProcess]
@@ -60,13 +73,14 @@ module ChildProcess
           nil, errnum, 0, buf, buf.size, nil
         )
 
-        buf.read_string(size).strip
+        str = buf.read_string(size).strip
+        "#{str} (#{errnum})"
       end
 
       def self.handle_for(fd_or_io)
         case fd_or_io
         when IO
-          handle = get_osfhandle(fd.fileno)
+          handle = get_osfhandle(fd_or_io.fileno)
         when Fixnum
           handle = get_osfhandle(fd_or_io)
         else
@@ -113,6 +127,27 @@ module ChildProcess
         close_handle proc
       end
 
+      def self.environment_pointer_for(env)
+        return unless env.kind_of?(Hash) && env.any?
+
+        strings = ENV.map { |k,v| "#{k}=#{v}\0" }
+        env.each do |key, value|
+          if key.include?("=")
+            raise InvalidEnvironmentVariableName, key
+          end
+
+          strings << "#{key}=#{value}\0"
+        end
+
+        strings << "\0" # terminate the env block
+        env_str = strings.join
+
+        ptr = FFI::MemoryPointer.new(:long, env_str.bytesize)
+        ptr.write_bytes env_str, 0, env_str.bytesize
+
+        ptr
+      end
+
       #
       # BOOL WINAPI CreateProcess(
       #   __in_opt     LPCTSTR lpApplicationName,

data/lib/childprocess/windows/process.rb

@@ -42,9 +42,10 @@ module ChildProcess
 
       def launch_process
         opts = {
-          :inherit => false,
-          :detach  => detach?,
-          :duplex  => duplex?
+          :inherit     => false,
+          :detach      => detach?,
+          :duplex      => duplex?,
+          :environment => (@environment unless @environment.empty?)
         }
 
         if @io

data/spec/childprocess_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require File.expand_path('../spec_helper', __FILE__)
 
 describe ChildProcess do
@@ -49,6 +51,39 @@ describe ChildProcess do
     end
   end
 
+  it "can override env vars only for the current process" do
+    Tempfile.open("env-spec") do |file|
+      process = write_env(file.path)
+      process.environment['CHILD_ONLY'] = '1'
+      process.start
+
+      ENV['CHILD_ONLY'].should be_nil
+
+      process.poll_for_exit(EXIT_TIMEOUT)
+      file.rewind
+
+      child_env = eval(file.read)
+      child_env['CHILD_ONLY'].should == '1'
+    end
+  end
+
+  it "inherits the parent's env vars also when some are overridden" do
+    Tempfile.open("env-spec") do |file|
+      with_env('INHERITED' => 'yes', 'CHILD_ONLY' => 'no') do
+        process = write_env(file.path)
+        process.environment['CHILD_ONLY'] = 'yes'
+
+        process.start
+        process.poll_for_exit(EXIT_TIMEOUT)
+        file.rewind
+        child_env = eval(file.read)
+
+        child_env['INHERITED'].should == 'yes'
+        child_env['CHILD_ONLY'].should == 'yes'
+      end
+    end
+  end
+
   it "passes arguments to the child" do
     args = ["foo", "bar"]
 
@@ -137,32 +172,15 @@ describe ChildProcess do
   end
 
   it "preserves Dir.pwd in the child" do
-    require 'pathname'
-    begin
-      path = nil
-      Tempfile.open("dir-spec") {|tf| path = tf.path }
-      path = Pathname.new(path).realpath.to_s
-      File.unlink(path)
-      Dir.mkdir(path)
-      Dir.chdir(path) do
-        process = ruby("puts Dir.pwd")
-        begin
-          out = Tempfile.new("dir-spec-out")
-
-          process.io.stdout = out
-          process.io.stderr = out
-
-          process.start
-          process.poll_for_exit(EXIT_TIMEOUT)
-
-          out.rewind
-          out.read.should == "#{path}\n"
-        ensure
-          out.close
-        end
-      end
-    ensure
-      Dir.rmdir(path) if File.exist?(path)
+    Tempfile.open("dir-spec-out") do |file|
+      process = ruby("print Dir.pwd")
+      process.io.stdout = process.io.stderr = file
+
+      process.start
+      process.poll_for_exit(EXIT_TIMEOUT)
+
+      file.rewind
+      file.read.should == Dir.pwd
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: childprocess
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jari Bakken
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-26 00:00:00 Z
+date: 2011-11-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -92,6 +92,7 @@ files:
 - .document
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -101,8 +102,6 @@ files:
 - lib/childprocess/abstract_io.rb
 - lib/childprocess/abstract_process.rb
 - lib/childprocess/errors.rb
-- lib/childprocess/ironruby.rb
-- lib/childprocess/ironruby/process.rb
 - lib/childprocess/jruby.rb
 - lib/childprocess/jruby/io.rb
 - lib/childprocess/jruby/process.rb
@@ -155,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: childprocess
-rubygems_version: 1.8.9
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: This gem aims at being a simple and reliable solution for controlling external programs running in the background on any Ruby / OS combination.
@@ -167,3 +166,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/unix_spec.rb
 - spec/windows_spec.rb
+has_rdoc: 

data/lib/childprocess/ironruby.rb

@@ -1,6 +0,0 @@
-module ChildProcess
-  module IronRuby
-  end
-end
-
-require "childprocess/ironruby/process"

data/lib/childprocess/ironruby/process.rb

@@ -1,7 +0,0 @@
-module ChildProcess
-  module IronRuby
-    class Process < AbstractProcess
-
-    end # Process
-  end # IronRuby
-end # ChildProcess