childprocess 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f7bcd4a74bf8315015b61ff4a5dcf5774fec372
-  data.tar.gz: ebb386c0ffd4b05121cbc8c3f18ded1d8721552b
+SHA256:
+  metadata.gz: 0f88536969a207dced9e122e8adfbf38e7e4bea75bb0fdb6dc83838db75718b2
+  data.tar.gz: 711c4d76098b6f0d7487428cc7af99331f9b95e2b978bd7b1435a5cd65ae7a38
 SHA512:
-  metadata.gz: 264821e0ea3147f6d19f63d76f5e290462e0ae8991d6858839b949a470f8ef173b716f5000f24fdfe9b86446eab1da593e7ad81e7cac83880fa7af81e7441563
-  data.tar.gz: 26f5534f0cb73ad3482e513706ca7a53d87c7f610efeaf09f64f0c4205b293db565548c097290d27a4b49a2b831f9593edbfc4cf7c0da73903d05c1c3fd98b23
+  metadata.gz: 958c7579affa791c7c61e0dbe5f7f17118b57805b24f497876fb5a4bf0a35ff113dd69d52e2aaf3e0b3c1f9ae8a5e61104ac8cf17b88744280e94dbc4e1d5817
+  data.tar.gz: 7b65d73e847fe42c200cb2e42f8b89303358126d5a2490778f7523db38fd9bd63b209966c6e7eb4f2dbd123400a568f5c23e55e5948bcdb0a8edb949813e005b

data/.travis.yml

@@ -14,14 +14,18 @@ rvm:
   - 2.5
   - ruby-head
 
-sudo: true # Necessary to fix JRuby
+sudo: false
 
 cache: bundler
 
 before_install:
   - "echo 'gem: --no-document' > ~/.gemrc"
-  - gem update --system
-  - gem install bundler  # Necessary to fix 1.9.3
+  # RubyGems update is supported for Ruby 2.3 and later
+  - ruby -e "system('gem update --system') if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3')"
+  - gem install bundler --version '~> 1.17'
+
+before_script:
+  - 'export JAVA_OPTS="${JAVA_OPTS_FOR_SPECS}"'
 
 env:
   global:
@@ -35,6 +39,10 @@ matrix:
     - rvm: jruby-9.1.9.0
     - rvm: ruby-head
     - env: "CHILDPROCESS_POSIX_SPAWN=true"
+  include:
+  - rvm: jruby-9.2.5.0
+    jdk: openjdk11
+    env: "JAVA_OPTS_FOR_SPECS='--add-opens java.base/java.io=org.jruby.dist --add-opens java.base/sun.nio.ch=org.jruby.dist'"
   exclude:
     # Travis does not provide 1.9.3 on OSX
   - rvm: 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### Version 1.0.0 / 2019-01-28
+
+* [#134](https://github.com/enkessler/childprocess/pull/134): Add support for non-ASCII characters on Windows
+* [#132](https://github.com/enkessler/childprocess/pull/132): Install `ffi` gem requirement on Windows only
+* [#128](https://github.com/enkessler/childprocess/issues/128): Convert environment variable values to strings when `posix_spawn` enabled
+* [#141](https://github.com/enkessler/childprocess/pull/141): Support JRuby on Java >= 9
+
 ### Version 0.9.0 / 2018-03-10
 
 * Added support for DragonFly BSD.

data/Gemfile

@@ -1,15 +1,18 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in child_process.gemspec
 gemspec
 
-
 if RUBY_VERSION =~ /^1\./
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
 
-  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
-    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
-  end
+  # ffi gem for Windows requires Ruby 2.x on/after this version
+  gem 'ffi', '< 1.9.15' if ENV['CHILDPROCESS_POSIX_SPAWN'] == 'true' || Gem.win_platform?
+elsif Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2')
+  # Ruby 2.0/2.1 support only ffi before 1.10
+  gem 'ffi', '~> 1.9.0' if ENV['CHILDPROCESS_POSIX_SPAWN'] == 'true' || Gem.win_platform?
+else
+  gem 'ffi' if ENV['CHILDPROCESS_POSIX_SPAWN'] == 'true' || Gem.win_platform?
 end

data/README.md

@@ -129,6 +129,8 @@ ChildProcess.posix_spawn = true
 process = ChildProcess.build(*args)
 ```
 
+To be able to use this, please make sure that you have the `ffi` gem installed.
+
 ### Ensure entire process tree dies
 
 By default, the child process does not create a new process group. This means there's no guarantee that the entire process tree will die when the child process is killed. To solve this:
@@ -171,6 +173,8 @@ ChildProcess.logger = logger
 ## Caveats
 
 * With JRuby on Unix, modifying `ENV["PATH"]` before using childprocess could lead to 'Command not found' errors, since JRuby is unable to modify the environment used for PATH searches in `java.lang.ProcessBuilder`. This can be avoided by setting `ChildProcess.posix_spawn = true`.
+* With JRuby on Java >= 9, the JVM may need to be configured to allow JRuby to access neccessary implementations; this can be done by adding `--add-opens java.base/java.io=org.jruby.dist` and `--add-opens java.base/sun.nio.ch=org.jruby.dist` to the `JAVA_OPTS` environment variable that is used by JRuby when launching the JVM.
+
 
 # Implementation
 

data/childprocess.gemspec

@@ -19,12 +19,11 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "ffi", "~> 1.0", ">= 1.0.11"
-
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "yard", "~> 0.0"
   s.add_development_dependency 'rake', '< 12.0'
   s.add_development_dependency 'coveralls', '< 1.0'
-end
-
 
+  # Install FFI gem if we're running on Windows
+  s.extensions = 'ext/mkrf_conf.rb'
+end

data/ext/mkrf_conf.rb

@@ -0,0 +1,24 @@
+# Based on the example from https://en.wikibooks.org/wiki/Ruby_Programming/RubyGems#How_to_install_different_versions_of_gems_depending_on_which_version_of_ruby_the_installee_is_using
+require 'rubygems'
+require 'rubygems/command.rb'
+require 'rubygems/dependency_installer.rb'
+
+begin
+  Gem::Command.build_args = ARGV
+rescue NoMethodError # rubocop:disable Lint/HandleExceptions
+end
+
+inst = Gem::DependencyInstaller.new
+
+begin
+  if Gem.win_platform?
+    inst.install 'ffi', Gem::Requirement.new('~> 1.0', '>= 1.0.11')
+  end
+rescue # rubocop:disable Lint/RescueWithoutErrorClass
+  exit(1)
+end
+
+ # create dummy rakefile to indicate success
+File.open(File.join(File.dirname(__FILE__), 'Rakefile'), 'w') do |f|
+  f.write("task :default\n")
+end

data/lib/childprocess.rb

@@ -73,7 +73,12 @@ module ChildProcess
       enabled = @posix_spawn || %w[1 true].include?(ENV['CHILDPROCESS_POSIX_SPAWN'])
       return false unless enabled
 
-      require 'ffi'
+      begin
+        require 'ffi'
+      rescue LoadError
+        raise ChildProcess::MissingFFIError
+      end
+
       begin
         require "childprocess/unix/platform/#{ChildProcess.platform_name}"
       rescue LoadError

data/lib/childprocess/errors.rb

@@ -14,6 +14,17 @@ module ChildProcess
   class LaunchError < Error
   end
 
+  class MissingFFIError < Error
+    def initialize
+      message = "FFI is a required pre-requisite for posix_spawn, falling back to default implementation. " +
+                "Please add it to your deployment to unlock this functionality. " +
+                "If you believe this is an error, please file a bug at http://github.com/enkessler/childprocess/issues"
+
+      super(message)
+    end
+
+  end
+
   class MissingPlatformError < Error
     def initialize
       message = "posix_spawn is not yet supported on #{ChildProcess.platform_name} (#{RUBY_PLATFORM}), falling back to default implementation. " +

data/lib/childprocess/jruby/process.rb

@@ -46,24 +46,49 @@ module ChildProcess
         end
       end
 
-      #
-      # Only supported in JRuby on a Unix operating system, thanks to limitations
-      # in Java's classes
-      #
-      # @return [Integer] the pid of the process after it has started
-      # @raise [NotImplementedError] when trying to access pid on non-Unix platform
-      #
-      def pid
-        if @process.getClass.getName != "java.lang.UNIXProcess"
-          raise NotImplementedError, "pid is only supported by JRuby child processes on Unix"
+      # Implementation of ChildProcess::JRuby::Process#pid depends heavily on
+      # what Java SDK is being used; here, we look it up once at load, then
+      # define the method once to avoid runtime overhead.
+      normalised_java_version_major = java.lang.System.get_property("java.version")
+                                                      .slice(/^(1\.)?([0-9]+)/, 2)
+                                                      .to_i
+      if normalised_java_version_major >= 9
+
+        # On modern Javas, we can simply delegate through to `Process#pid`,
+        # which was introduced in Java 9.
+        #
+        # @return [Integer] the pid of the process after it has started
+        # @raise [NotImplementedError] when trying to access pid on platform for
+        #                              which it is unsupported in Java
+        def pid
+          @process.pid
+        rescue java.lang.UnsupportedOperationException => e
+          raise NotImplementedError, "pid is not supported on this platform: #{e.message}"
+        end
+
+      else
+
+        # On Legacy Javas, fall back to reflection.
+        #
+        # Only supported in JRuby on a Unix operating system, thanks to limitations
+        # in Java's classes
+        #
+        # @return [Integer] the pid of the process after it has started
+        # @raise [NotImplementedError] when trying to access pid on non-Unix platform
+        #
+        def pid
+          if @process.getClass.getName != "java.lang.UNIXProcess"
+            raise NotImplementedError, "pid is only supported by JRuby child processes on Unix"
+          end
+
+          # About the best way we can do this is with a nasty reflection-based impl
+          # Thanks to Martijn Courteaux
+          # http://stackoverflow.com/questions/2950338/how-can-i-kill-a-linux-process-in-java-with-sigkill-process-destroy-does-sigter/2951193#2951193
+          field = @process.getClass.getDeclaredField("pid")
+          field.accessible = true
+          field.get(@process)
         end
 
-        # About the best way we can do this is with a nasty reflection-based impl
-        # Thanks to Martijn Courteaux
-        # http://stackoverflow.com/questions/2950338/how-can-i-kill-a-linux-process-in-java-with-sigkill-process-destroy-does-sigter/2951193#2951193
-        field = @process.getClass.getDeclaredField("pid")
-        field.accessible = true
-        field.get(@process)
       end
 
       private

data/lib/childprocess/unix/posix_spawn_process.rb

@@ -111,11 +111,11 @@ module ChildProcess
           @ptrs = env.map do |key, val|
             next if val.nil?
 
-            if key =~ /=|\0/ || val.include?("\0")
-              raise InvalidEnvironmentVariable, "#{key.inspect} => #{val.inspect}"
+            if key =~ /=|\0/ || val.to_s.include?("\0")
+              raise InvalidEnvironmentVariable, "#{key.inspect} => #{val.to_s.inspect}"
             end
 
-            FFI::MemoryPointer.from_string("#{key}=#{val}")
+            FFI::MemoryPointer.from_string("#{key}=#{val.to_s}")
           end.compact
 
           @ptrs << FFI::Pointer.new(0)

data/lib/childprocess/version.rb

@@ -1,3 +1,3 @@
 module ChildProcess
-  VERSION = '0.9.0'
+  VERSION = '1.0.0'
 end

data/lib/childprocess/windows/lib.rb

@@ -55,9 +55,9 @@ module ChildProcess
       # );
       #
 
-      attach_function :create_process, :CreateProcessA, [
-        :pointer,
+      attach_function :create_process, :CreateProcessW, [
         :pointer,
+        :buffer_inout,
         :pointer,
         :pointer,
         :bool,

data/lib/childprocess/windows/process_builder.rb

@@ -39,9 +39,14 @@ module ChildProcess
 
       private
 
+      def to_wide_string(str)
+        newstr = str + "\0".encode(str.encoding)
+        newstr.encode!('UTF-16LE')
+      end
+      
       def create_command_pointer
-        string = @args.map { |arg| quote_if_necessary(arg.to_s) }.join ' '
-        @cmd_ptr = FFI::MemoryPointer.from_string string
+        string = @args.map { |arg| quote_if_necessary(arg.to_s) }.join(' ')
+        @cmd_ptr = to_wide_string(string)
       end
 
       def create_environment_pointer
@@ -59,15 +64,12 @@ module ChildProcess
           strings << "#{key}=#{val}\0"
         end
 
-        strings << "\0" # terminate the env block
-        env_str = strings.join
-
-        @env_ptr = FFI::MemoryPointer.new(:long, env_str.bytesize)
-        @env_ptr.put_bytes 0, env_str, 0, env_str.bytesize
+        env_str = to_wide_string(strings.join)
+        @env_ptr = FFI::MemoryPointer.from_string(env_str)
       end
 
       def create_cwd_pointer
-        @cwd_ptr = FFI::MemoryPointer.from_string(@cwd || Dir.pwd)
+        @cwd_ptr = FFI::MemoryPointer.from_string(to_wide_string(@cwd || Dir.pwd))
       end
 
       def create_process
@@ -98,6 +100,7 @@ module ChildProcess
       end
 
       def setup_flags
+        @flags |= CREATE_UNICODE_ENVIRONMENT
         @flags |= DETACHED_PROCESS if @detach
         @flags |= CREATE_BREAKAWAY_FROM_JOB if @leader
       end

data/spec/childprocess_spec.rb

@@ -83,11 +83,13 @@ describe ChildProcess do
 
   it "lets child process inherit the environment of the current process" do
     Tempfile.open("env-spec") do |file|
+      file.close
       with_env('INHERITED' => 'yes') do
         process = write_env(file.path).start
         process.wait
       end
 
+      file.open
       child_env = eval rewind_and_read(file)
       expect(child_env['INHERITED']).to eql 'yes'
     end
@@ -95,6 +97,7 @@ describe ChildProcess do
 
   it "can override env vars only for the current process" do
     Tempfile.open("env-spec") do |file|
+      file.close
       process = write_env(file.path)
       process.environment['CHILD_ONLY'] = '1'
       process.start
@@ -103,13 +106,30 @@ describe ChildProcess do
 
       process.wait
 
+      file.open
       child_env = eval rewind_and_read(file)
       expect(child_env['CHILD_ONLY']).to eql '1'
     end
   end
 
+  it 'allows unicode characters in the environment' do
+    Tempfile.open("env-spec") do |file|
+      file.close
+      process = write_env(file.path)
+      process.environment['FOö'] = 'baör'
+      process.start
+      process.wait
+
+      file.open
+      child_env = eval rewind_and_read(file)
+
+      expect(child_env['FOö']).to eql 'baör'
+    end
+  end
+
   it "inherits the parent's env vars also when some are overridden" do
     Tempfile.open("env-spec") do |file|
+      file.close
       with_env('INHERITED' => 'yes', 'CHILD_ONLY' => 'no') do
         process = write_env(file.path)
         process.environment['CHILD_ONLY'] = 'yes'
@@ -117,6 +137,7 @@ describe ChildProcess do
         process.start
         process.wait
 
+        file.open
         child_env = eval rewind_and_read(file)
 
         expect(child_env['INHERITED']).to eq 'yes'
@@ -127,6 +148,7 @@ describe ChildProcess do
 
   it "can unset env vars" do
     Tempfile.open("env-spec") do |file|
+      file.close
       ENV['CHILDPROCESS_UNSET'] = '1'
       process = write_env(file.path)
       process.environment['CHILDPROCESS_UNSET'] = nil
@@ -134,6 +156,7 @@ describe ChildProcess do
 
       process.wait
 
+      file.open
       child_env = eval rewind_and_read(file)
       expect(child_env).to_not have_key('CHILDPROCESS_UNSET')
     end
@@ -141,12 +164,14 @@ describe ChildProcess do
 
   it 'does not see env vars unset in parent' do
     Tempfile.open('env-spec') do |file|
+      file.close
       ENV['CHILDPROCESS_UNSET'] = nil
       process = write_env(file.path)
       process.start
 
       process.wait
 
+      file.open
       child_env = eval rewind_and_read(file)
       expect(child_env).to_not have_key('CHILDPROCESS_UNSET')
     end

data/spec/get_env.ps1

@@ -0,0 +1,13 @@
+param($p1)
+$env_list = Get-ChildItem Env:
+
+# Builds a ruby hash compatible string
+$hash_string = "{"
+
+foreach ($item in $env_list)
+{
+  $hash_string  += "`"" + $item.Name + "`" => `"" + $item.value.replace('\','\\').replace('"','\"') + "`","
+}
+$hash_string += "}"
+
+$hash_string | out-File -Encoding "UTF8" $p1

data/spec/spec_helper.rb

@@ -20,6 +20,10 @@ module ChildProcessSpecHelper
     @process = ChildProcess.build(RUBY , *args)
   end
 
+  def windows_process(*args)
+    @process = ChildProcess.build("powershell", *args)
+  end
+
   def sleeping_ruby(seconds = nil)
     if seconds
       ruby_process("-e", "sleep #{seconds}")
@@ -42,11 +46,16 @@ module ChildProcessSpecHelper
   end
 
   def write_env(path)
-    code = <<-RUBY
-      File.open(#{path.inspect}, "w") { |f| f << ENV.inspect }
-    RUBY
-
-    ruby_process tmp_script(code)
+    if ChildProcess.os == :windows
+      ps_env_file_path = File.expand_path(File.dirname(__FILE__))
+      args = ['-File', "#{ps_env_file_path}/get_env.ps1", path]
+      windows_process(*args)
+    else
+      code = <<-RUBY
+        File.open(#{path.inspect}, "w") { |f| f << ENV.inspect }
+      RUBY
+      ruby_process tmp_script(code)
+    end
   end
 
   def write_argv(path, *args)
@@ -102,7 +111,7 @@ module ChildProcessSpecHelper
       ruby(<<-CODE)
             STDIN.sync = STDOUT.sync = true
             IO.copy_stream(STDIN, STDOUT)
-          CODE
+      CODE
     else
       ChildProcess.build("cat")
     end
@@ -115,7 +124,7 @@ module ChildProcessSpecHelper
             STDOUT.sync = true
 
             puts "hello"
-          CODE
+      CODE
     else
       ChildProcess.build("echo", "hello")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: childprocess
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jari Bakken
@@ -9,28 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-10 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.11
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.11
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +72,8 @@ description: This gem aims at being a simple and reliable solution for controlli
 email:
 - morrow748@gmail.com
 executables: []
-extensions: []
+extensions:
+- ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
 - ".document"
@@ -106,6 +87,7 @@ files:
 - Rakefile
 - appveyor.yml
 - childprocess.gemspec
+- ext/mkrf_conf.rb
 - lib/childprocess.rb
 - lib/childprocess/abstract_io.rb
 - lib/childprocess/abstract_process.rb
@@ -135,6 +117,7 @@ files:
 - lib/childprocess/windows/structs.rb
 - spec/abstract_io_spec.rb
 - spec/childprocess_spec.rb
+- spec/get_env.ps1
 - spec/io_spec.rb
 - spec/jruby_spec.rb
 - spec/pid_behavior.rb
@@ -162,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: childprocess
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A simple and reliable solution for controlling external programs running
@@ -170,6 +153,7 @@ summary: A simple and reliable solution for controlling external programs runnin
 test_files:
 - spec/abstract_io_spec.rb
 - spec/childprocess_spec.rb
+- spec/get_env.ps1
 - spec/io_spec.rb
 - spec/jruby_spec.rb
 - spec/pid_behavior.rb