childprocess 0.9.0 → 3.0.0

data/Rakefile

@@ -1,61 +1,61 @@
-require 'rubygems'
-require 'rake'
-require 'tmpdir'
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-include Rake::DSL if defined?(::Rake::DSL)
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.ruby_opts  = "-I lib:spec -w"
-  spec.pattern    = 'spec/**/*_spec.rb'
-end
-
-desc 'Run specs for rcov'
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.ruby_opts = "-I lib:spec"
-  spec.pattern   = 'spec/**/*_spec.rb'
-  spec.rcov      = true
-  spec.rcov_opts = %w[--exclude spec,ruby-debug,/Library/Ruby,.gem --include lib/childprocess]
-end
-
-task :default => :spec
-
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
-end
-
-task :clean do
-  rm_rf "pkg"
-  rm_rf "childprocess.jar"
-end
-
-desc 'Create jar to bundle in selenium-webdriver'
-task :jar => [:clean, :build] do
-  tmpdir = Dir.mktmpdir("childprocess-jar")
-  gem_to_package = Dir['pkg/*.gem'].first
-  gem_name = File.basename(gem_to_package, ".gem")
-  p :gem_to_package => gem_to_package, :gem_name => gem_name
-
-  sh "gem install -i #{tmpdir} #{gem_to_package} --ignore-dependencies --no-rdoc --no-ri"
-  sh "jar cf childprocess.jar -C #{tmpdir}/gems/#{gem_name}/lib ."
-  sh "jar tf childprocess.jar"
-end
-
-task :env do
-  $:.unshift File.expand_path("../lib", __FILE__)
-  require 'childprocess'
-end
-
-desc 'Calculate size of posix_spawn structs for the current platform'
-task :generate => :env do
-  require 'childprocess/tools/generator'
-  ChildProcess::Tools::Generator.generate
-end
+require 'rubygems'
+require 'rake'
+require 'tmpdir'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+include Rake::DSL if defined?(::Rake::DSL)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts  = "-I lib:spec -w"
+  spec.pattern    = 'spec/**/*_spec.rb'
+end
+
+desc 'Run specs for rcov'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern   = 'spec/**/*_spec.rb'
+  spec.rcov      = true
+  spec.rcov_opts = %w[--exclude spec,ruby-debug,/Library/Ruby,.gem --include lib/childprocess]
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+task :clean do
+  rm_rf "pkg"
+  rm_rf "childprocess.jar"
+end
+
+desc 'Create jar to bundle in selenium-webdriver'
+task :jar => [:clean, :build] do
+  tmpdir = Dir.mktmpdir("childprocess-jar")
+  gem_to_package = Dir['pkg/*.gem'].first
+  gem_name = File.basename(gem_to_package, ".gem")
+  p :gem_to_package => gem_to_package, :gem_name => gem_name
+
+  sh "gem install -i #{tmpdir} #{gem_to_package} --ignore-dependencies --no-rdoc --no-ri"
+  sh "jar cf childprocess.jar -C #{tmpdir}/gems/#{gem_name}/lib ."
+  sh "jar tf childprocess.jar"
+end
+
+task :env do
+  $:.unshift File.expand_path("../lib", __FILE__)
+  require 'childprocess'
+end
+
+desc 'Calculate size of posix_spawn structs for the current platform'
+task :generate => :env do
+  require 'childprocess/tools/generator'
+  ChildProcess::Tools::Generator.generate
+end

data/appveyor.yml

@@ -1,60 +1,42 @@
-version: '1.0.{build}'
-
-environment:
-  matrix:
-    - CHILDPROCESS_POSIX_SPAWN: true
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 193-x64
-    - CHILDPROCESS_POSIX_SPAWN: false
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 193-x64
-    - CHILDPROCESS_POSIX_SPAWN: true
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 200-x64
-    - CHILDPROCESS_POSIX_SPAWN: false
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 200-x64
-    - CHILDPROCESS_POSIX_SPAWN: true
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 21-x64
-    - CHILDPROCESS_POSIX_SPAWN: false
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 21-x64
-    - CHILDPROCESS_POSIX_SPAWN: true
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 22-x64
-    - CHILDPROCESS_POSIX_SPAWN: false
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 22-x64
-    - CHILDPROCESS_POSIX_SPAWN: true
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 23-x64
-    - CHILDPROCESS_POSIX_SPAWN: false
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 23-x64
-    - CHILDPROCESS_POSIX_SPAWN: true
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 24-x64
-    - CHILDPROCESS_POSIX_SPAWN: false
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 24-x64
-    - CHILDPROCESS_POSIX_SPAWN: true
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 25-x64
-    - CHILDPROCESS_POSIX_SPAWN: false
-      CHILDPROCESS_UNSET: should-be-unset
-      RUBY_VERSION: 25-x64
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle install
-
-build: off
-
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-
-test_script:
-  - bundle exec rake
+version: '1.0.{build}'
+
+environment:
+  matrix:
+    - CHILDPROCESS_POSIX_SPAWN: true
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 23-x64
+    - CHILDPROCESS_POSIX_SPAWN: false
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 23-x64
+    - CHILDPROCESS_POSIX_SPAWN: true
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 24-x64
+    - CHILDPROCESS_POSIX_SPAWN: false
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 24-x64
+    - CHILDPROCESS_POSIX_SPAWN: true
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 25-x64
+    - CHILDPROCESS_POSIX_SPAWN: false
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 25-x64
+    - CHILDPROCESS_POSIX_SPAWN: true
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 26-x64
+    - CHILDPROCESS_POSIX_SPAWN: false
+      CHILDPROCESS_UNSET: should-be-unset
+      RUBY_VERSION: 26-x64
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake

data/childprocess.gemspec

@@ -1,30 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "childprocess/version"
-
-Gem::Specification.new do |s|
-  s.name        = "childprocess"
-  s.version     = ChildProcess::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Jari Bakken", "Eric Kessler"]
-  s.email       = ["morrow748@gmail.com"]
-  s.homepage    = "http://github.com/enkessler/childprocess"
-  s.summary     = %q{A simple and reliable solution for controlling external programs running in the background on any Ruby / OS combination.}
-  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.rubyforge_project = "childprocess"
-  s.license           = 'MIT'
-
-  s.files         = `git ls-files`.split("\n")
-  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
-
-
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "childprocess/version"
+
+Gem::Specification.new do |s|
+  s.name        = "childprocess"
+  s.version     = ChildProcess::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jari Bakken", "Eric Kessler", "Shane da Silva"]
+  s.email       = ["morrow748@gmail.com", "shane@dasilva.io"]
+  s.homepage    = "http://github.com/enkessler/childprocess"
+  s.summary     = %q{A simple and reliable solution for controlling external programs running in the background on any Ruby / OS combination.}
+  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.license           = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "yard", "~> 0.0"
+  s.add_development_dependency 'coveralls', '< 1.0'
+end

data/lib/childprocess.rb

@@ -1,205 +1,210 @@
-require 'childprocess/version'
-require 'childprocess/errors'
-require 'childprocess/abstract_process'
-require 'childprocess/abstract_io'
-require "fcntl"
-require 'logger'
-
-module ChildProcess
-
-  @posix_spawn = false
-
-  class << self
-    attr_writer :logger
-
-    def new(*args)
-      case os
-      when :macosx, :linux, :solaris, :bsd, :cygwin, :aix
-        if posix_spawn?
-          Unix::PosixSpawnProcess.new(args)
-        elsif jruby?
-          JRuby::Process.new(args)
-        else
-          Unix::ForkExecProcess.new(args)
-        end
-      when :windows
-        Windows::Process.new(args)
-      else
-        raise Error, "unsupported platform #{platform_name.inspect}"
-      end
-    end
-    alias_method :build, :new
-
-    def logger
-      return @logger if defined?(@logger) and @logger
-
-      @logger = Logger.new($stderr)
-      @logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
-
-      @logger
-    end
-
-    def platform
-      if RUBY_PLATFORM == "java"
-        :jruby
-      elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == "ironruby"
-        :ironruby
-      else
-        os
-      end
-    end
-
-    def platform_name
-      @platform_name ||= "#{arch}-#{os}"
-    end
-
-    def unix?
-      !windows?
-    end
-
-    def linux?
-      os == :linux
-    end
-
-    def jruby?
-      platform == :jruby
-    end
-
-    def windows?
-      os == :windows
-    end
-
-    def posix_spawn?
-      enabled = @posix_spawn || %w[1 true].include?(ENV['CHILDPROCESS_POSIX_SPAWN'])
-      return false unless enabled
-
-      require 'ffi'
-      begin
-        require "childprocess/unix/platform/#{ChildProcess.platform_name}"
-      rescue LoadError
-        raise ChildProcess::MissingPlatformError
-      end
-
-      require "childprocess/unix/lib"
-      require 'childprocess/unix/posix_spawn_process'
-
-      true
-    rescue ChildProcess::MissingPlatformError => ex
-      warn_once ex.message
-      false
-    end
-
-    #
-    # Set this to true to enable experimental use of posix_spawn.
-    #
-
-    def posix_spawn=(bool)
-      @posix_spawn = bool
-    end
-
-    def os
-      @os ||= (
-        require "rbconfig"
-        host_os = RbConfig::CONFIG['host_os'].downcase
-
-        case host_os
-        when /linux/
-          :linux
-        when /darwin|mac os/
-          :macosx
-        when /mswin|msys|mingw32/
-          :windows
-        when /cygwin/
-          :cygwin
-        when /solaris|sunos/
-          :solaris
-        when /bsd|dragonfly/
-          :bsd
-        when /aix/
-          :aix
-        else
-          raise Error, "unknown os: #{host_os.inspect}"
-        end
-      )
-    end
-
-    def arch
-      @arch ||= (
-        host_cpu = RbConfig::CONFIG['host_cpu'].downcase
-        case host_cpu
-        when /i[3456]86/
-          if workaround_older_macosx_misreported_cpu?
-            # Workaround case: older 64-bit Darwin Rubies misreported as i686
-            "x86_64"
-          else
-            "i386"
-          end
-        when /amd64|x86_64/
-          "x86_64"
-        when /ppc|powerpc/
-          "powerpc"
-        else
-          host_cpu
-        end
-      )
-    end
-
-    #
-    # By default, a child process will inherit open file descriptors from the
-    # parent process. This helper provides a cross-platform way of making sure
-    # that doesn't happen for the given file/io.
-    #
-
-    def close_on_exec(file)
-      if file.respond_to?(:close_on_exec=)
-        file.close_on_exec = true
-      elsif file.respond_to?(:fcntl) && defined?(Fcntl::FD_CLOEXEC)
-        file.fcntl Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
-
-        if jruby? && posix_spawn?
-          # on JRuby, the fcntl call above apparently isn't enough when
-          # we're launching the process through posix_spawn.
-          fileno = JRuby.posix_fileno_for(file)
-          Unix::Lib.fcntl fileno, Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
-        end
-      elsif windows?
-        Windows::Lib.dont_inherit file
-      else
-        raise Error, "not sure how to set close-on-exec for #{file.inspect} on #{platform_name.inspect}"
-      end
-    end
-
-    private
-
-    def warn_once(msg)
-      @warnings ||= {}
-
-      unless @warnings[msg]
-        @warnings[msg] = true
-        logger.warn msg
-      end
-    end
-
-    # Workaround: detect the situation that an older Darwin Ruby is actually
-    # 64-bit, but is misreporting cpu as i686, which would imply 32-bit.
-    #
-    # @return [Boolean] `true` if:
-    #   (a) on Mac OS X
-    #   (b) actually running in 64-bit mode
-    def workaround_older_macosx_misreported_cpu?
-      os == :macosx && is_64_bit?
-    end
-
-    # @return [Boolean] `true` if this Ruby represents `1` in 64 bits (8 bytes).
-    def is_64_bit?
-      1.size == 8
-    end
-
-  end # class << self
-end # ChildProcess
-
-require 'jruby' if ChildProcess.jruby?
-
-require 'childprocess/unix'    if ChildProcess.unix?
-require 'childprocess/windows' if ChildProcess.windows?
-require 'childprocess/jruby'   if ChildProcess.jruby?
+require 'childprocess/version'
+require 'childprocess/errors'
+require 'childprocess/abstract_process'
+require 'childprocess/abstract_io'
+require "fcntl"
+require 'logger'
+
+module ChildProcess
+
+  @posix_spawn = false
+
+  class << self
+    attr_writer :logger
+
+    def new(*args)
+      case os
+      when :macosx, :linux, :solaris, :bsd, :cygwin, :aix
+        if posix_spawn?
+          Unix::PosixSpawnProcess.new(args)
+        elsif jruby?
+          JRuby::Process.new(args)
+        else
+          Unix::ForkExecProcess.new(args)
+        end
+      when :windows
+        Windows::Process.new(args)
+      else
+        raise Error, "unsupported platform #{platform_name.inspect}"
+      end
+    end
+    alias_method :build, :new
+
+    def logger
+      return @logger if defined?(@logger) and @logger
+
+      @logger = Logger.new($stderr)
+      @logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
+
+      @logger
+    end
+
+    def platform
+      if RUBY_PLATFORM == "java"
+        :jruby
+      elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == "ironruby"
+        :ironruby
+      else
+        os
+      end
+    end
+
+    def platform_name
+      @platform_name ||= "#{arch}-#{os}"
+    end
+
+    def unix?
+      !windows?
+    end
+
+    def linux?
+      os == :linux
+    end
+
+    def jruby?
+      platform == :jruby
+    end
+
+    def windows?
+      os == :windows
+    end
+
+    def posix_spawn?
+      enabled = @posix_spawn || %w[1 true].include?(ENV['CHILDPROCESS_POSIX_SPAWN'])
+      return false unless enabled
+
+      begin
+        require 'ffi'
+      rescue LoadError
+        raise ChildProcess::MissingFFIError
+      end
+
+      begin
+        require "childprocess/unix/platform/#{ChildProcess.platform_name}"
+      rescue LoadError
+        raise ChildProcess::MissingPlatformError
+      end
+
+      require "childprocess/unix/lib"
+      require 'childprocess/unix/posix_spawn_process'
+
+      true
+    rescue ChildProcess::MissingPlatformError => ex
+      warn_once ex.message
+      false
+    end
+
+    #
+    # Set this to true to enable experimental use of posix_spawn.
+    #
+
+    def posix_spawn=(bool)
+      @posix_spawn = bool
+    end
+
+    def os
+      @os ||= (
+        require "rbconfig"
+        host_os = RbConfig::CONFIG['host_os'].downcase
+
+        case host_os
+        when /linux/
+          :linux
+        when /darwin|mac os/
+          :macosx
+        when /mswin|msys|mingw32/
+          :windows
+        when /cygwin/
+          :cygwin
+        when /solaris|sunos/
+          :solaris
+        when /bsd|dragonfly/
+          :bsd
+        when /aix/
+          :aix
+        else
+          raise Error, "unknown os: #{host_os.inspect}"
+        end
+      )
+    end
+
+    def arch
+      @arch ||= (
+        host_cpu = RbConfig::CONFIG['host_cpu'].downcase
+        case host_cpu
+        when /i[3456]86/
+          if workaround_older_macosx_misreported_cpu?
+            # Workaround case: older 64-bit Darwin Rubies misreported as i686
+            "x86_64"
+          else
+            "i386"
+          end
+        when /amd64|x86_64/
+          "x86_64"
+        when /ppc|powerpc/
+          "powerpc"
+        else
+          host_cpu
+        end
+      )
+    end
+
+    #
+    # By default, a child process will inherit open file descriptors from the
+    # parent process. This helper provides a cross-platform way of making sure
+    # that doesn't happen for the given file/io.
+    #
+
+    def close_on_exec(file)
+      if file.respond_to?(:close_on_exec=)
+        file.close_on_exec = true
+      elsif file.respond_to?(:fcntl) && defined?(Fcntl::FD_CLOEXEC)
+        file.fcntl Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
+
+        if jruby? && posix_spawn?
+          # on JRuby, the fcntl call above apparently isn't enough when
+          # we're launching the process through posix_spawn.
+          fileno = JRuby.posix_fileno_for(file)
+          Unix::Lib.fcntl fileno, Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
+        end
+      elsif windows?
+        Windows::Lib.dont_inherit file
+      else
+        raise Error, "not sure how to set close-on-exec for #{file.inspect} on #{platform_name.inspect}"
+      end
+    end
+
+    private
+
+    def warn_once(msg)
+      @warnings ||= {}
+
+      unless @warnings[msg]
+        @warnings[msg] = true
+        logger.warn msg
+      end
+    end
+
+    # Workaround: detect the situation that an older Darwin Ruby is actually
+    # 64-bit, but is misreporting cpu as i686, which would imply 32-bit.
+    #
+    # @return [Boolean] `true` if:
+    #   (a) on Mac OS X
+    #   (b) actually running in 64-bit mode
+    def workaround_older_macosx_misreported_cpu?
+      os == :macosx && is_64_bit?
+    end
+
+    # @return [Boolean] `true` if this Ruby represents `1` in 64 bits (8 bytes).
+    def is_64_bit?
+      1.size == 8
+    end
+
+  end # class << self
+end # ChildProcess
+
+require 'jruby' if ChildProcess.jruby?
+
+require 'childprocess/unix'    if ChildProcess.unix?
+require 'childprocess/windows' if ChildProcess.windows?
+require 'childprocess/jruby'   if ChildProcess.jruby?