childprocess 0.8.0 → 2.0.0

data/childprocess.gemspec

@@ -1,30 +1,32 @@
-# -*- 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.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.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'
+
+  s.add_runtime_dependency 'rake', '< 13.0'
+
+  # 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/abstract_io.rb

@@ -1,36 +1,36 @@
-module ChildProcess
-  class AbstractIO
-    attr_reader :stderr, :stdout, :stdin
-
-    def inherit!
-      @stdout = STDOUT
-      @stderr = STDERR
-    end
-
-    def stderr=(io)
-      check_type io
-      @stderr = io
-    end
-
-    def stdout=(io)
-      check_type io
-      @stdout = io
-    end
-
-    #
-    # @api private
-    #
-
-    def _stdin=(io)
-      check_type io
-      @stdin = io
-    end
-
-    private
-
-    def check_type(io)
-      raise SubclassResponsibility, "check_type"
-    end
-
-  end
-end
+module ChildProcess
+  class AbstractIO
+    attr_reader :stderr, :stdout, :stdin
+
+    def inherit!
+      @stdout = STDOUT
+      @stderr = STDERR
+    end
+
+    def stderr=(io)
+      check_type io
+      @stderr = io
+    end
+
+    def stdout=(io)
+      check_type io
+      @stdout = io
+    end
+
+    #
+    # @api private
+    #
+
+    def _stdin=(io)
+      check_type io
+      @stdin = io
+    end
+
+    private
+
+    def check_type(io)
+      raise SubclassResponsibility, "check_type"
+    end
+
+  end
+end

data/lib/childprocess/abstract_process.rb

@@ -1,192 +1,192 @@
-module ChildProcess
-  class AbstractProcess
-    POLL_INTERVAL = 0.1
-
-    attr_reader :exit_code
-
-    #
-    # Set this to true if you do not care about when or if the process quits.
-    #
-    attr_accessor :detach
-
-    #
-    # Set this to true if you want to write to the process' stdin (process.io.stdin)
-    #
-    attr_accessor :duplex
-
-    #
-    # Modify the child's environment variables
-    #
-    attr_reader :environment
-
-    #
-    # Set the child's current working directory.
-    #
-    attr_accessor :cwd
-
-    #
-    # Set this to true to make the child process the leader of a new process group
-    #
-    # This can be used to make sure that all grandchildren are killed
-    # when the child process dies.
-    #
-    attr_accessor :leader
-
-    #
-    # Create a new process with the given args.
-    #
-    # @api private
-    # @see ChildProcess.build
-    #
-
-    def initialize(args)
-      unless args.all? { |e| e.kind_of?(String) }
-        raise ArgumentError, "all arguments must be String: #{args.inspect}"
-      end
-
-      @args        = args
-      @started     = false
-      @exit_code   = nil
-      @io          = nil
-      @cwd         = nil
-      @detach      = false
-      @duplex      = false
-      @leader      = false
-      @environment = {}
-    end
-
-    #
-    # Returns a ChildProcess::AbstractIO subclass to configure the child's IO streams.
-    #
-
-    def io
-      raise SubclassResponsibility, "io"
-    end
-
-    #
-    # @return [Integer] the pid of the process after it has started
-    #
-
-    def pid
-      raise SubclassResponsibility, "pid"
-    end
-
-    #
-    # Launch the child process
-    #
-    # @return [AbstractProcess] self
-    #
-
-    def start
-      launch_process
-      @started = true
-
-      self
-    end
-
-    #
-    # Forcibly terminate the process, using increasingly harsher methods if possible.
-    #
-    # @param [Integer] timeout (3) Seconds to wait before trying the next method.
-    #
-
-    def stop(timeout = 3)
-      raise SubclassResponsibility, "stop"
-    end
-
-    #
-    # Block until the process has been terminated.
-    #
-    # @return [Integer] The exit status of the process
-    #
-
-    def wait
-      raise SubclassResponsibility, "wait"
-    end
-
-    #
-    # Did the process exit?
-    #
-    # @return [Boolean]
-    #
-
-    def exited?
-      raise SubclassResponsibility, "exited?"
-    end
-
-    #
-    # Has the process started?
-    #
-    # @return [Boolean]
-    #
-
-    def started?
-      @started
-    end
-
-    #
-    # Is this process running?
-    #
-    # @return [Boolean]
-    #
-
-    def alive?
-      started? && !exited?
-    end
-
-    #
-    # Returns true if the process has exited and the exit code was not 0.
-    #
-    # @return [Boolean]
-    #
-
-    def crashed?
-      exited? && @exit_code != 0
-    end
-
-    #
-    # Wait for the process to exit, raising a ChildProcess::TimeoutError if
-    # the timeout expires.
-    #
-
-    def poll_for_exit(timeout)
-      log "polling #{timeout} seconds for exit"
-
-      end_time = Time.now + timeout
-      until (ok = exited?) || Time.now > end_time
-        sleep POLL_INTERVAL
-      end
-
-      unless ok
-        raise TimeoutError, "process still alive after #{timeout} seconds"
-      end
-    end
-
-    private
-
-    def launch_process
-      raise SubclassResponsibility, "launch_process"
-    end
-
-    def detach?
-      @detach
-    end
-
-    def duplex?
-      @duplex
-    end
-
-    def leader?
-      @leader
-    end
-
-    def log(*args)
-      ChildProcess.logger.debug "#{self.inspect} : #{args.inspect}"
-    end
-
-    def assert_started
-      raise Error, "process not started" unless started?
-    end
-
-  end # AbstractProcess
-end # ChildProcess
+module ChildProcess
+  class AbstractProcess
+    POLL_INTERVAL = 0.1
+
+    attr_reader :exit_code
+
+    #
+    # Set this to true if you do not care about when or if the process quits.
+    #
+    attr_accessor :detach
+
+    #
+    # Set this to true if you want to write to the process' stdin (process.io.stdin)
+    #
+    attr_accessor :duplex
+
+    #
+    # Modify the child's environment variables
+    #
+    attr_reader :environment
+
+    #
+    # Set the child's current working directory.
+    #
+    attr_accessor :cwd
+
+    #
+    # Set this to true to make the child process the leader of a new process group
+    #
+    # This can be used to make sure that all grandchildren are killed
+    # when the child process dies.
+    #
+    attr_accessor :leader
+
+    #
+    # Create a new process with the given args.
+    #
+    # @api private
+    # @see ChildProcess.build
+    #
+
+    def initialize(args)
+      unless args.all? { |e| e.kind_of?(String) }
+        raise ArgumentError, "all arguments must be String: #{args.inspect}"
+      end
+
+      @args        = args
+      @started     = false
+      @exit_code   = nil
+      @io          = nil
+      @cwd         = nil
+      @detach      = false
+      @duplex      = false
+      @leader      = false
+      @environment = {}
+    end
+
+    #
+    # Returns a ChildProcess::AbstractIO subclass to configure the child's IO streams.
+    #
+
+    def io
+      raise SubclassResponsibility, "io"
+    end
+
+    #
+    # @return [Integer] the pid of the process after it has started
+    #
+
+    def pid
+      raise SubclassResponsibility, "pid"
+    end
+
+    #
+    # Launch the child process
+    #
+    # @return [AbstractProcess] self
+    #
+
+    def start
+      launch_process
+      @started = true
+
+      self
+    end
+
+    #
+    # Forcibly terminate the process, using increasingly harsher methods if possible.
+    #
+    # @param [Integer] timeout (3) Seconds to wait before trying the next method.
+    #
+
+    def stop(timeout = 3)
+      raise SubclassResponsibility, "stop"
+    end
+
+    #
+    # Block until the process has been terminated.
+    #
+    # @return [Integer] The exit status of the process
+    #
+
+    def wait
+      raise SubclassResponsibility, "wait"
+    end
+
+    #
+    # Did the process exit?
+    #
+    # @return [Boolean]
+    #
+
+    def exited?
+      raise SubclassResponsibility, "exited?"
+    end
+
+    #
+    # Has the process started?
+    #
+    # @return [Boolean]
+    #
+
+    def started?
+      @started
+    end
+
+    #
+    # Is this process running?
+    #
+    # @return [Boolean]
+    #
+
+    def alive?
+      started? && !exited?
+    end
+
+    #
+    # Returns true if the process has exited and the exit code was not 0.
+    #
+    # @return [Boolean]
+    #
+
+    def crashed?
+      exited? && @exit_code != 0
+    end
+
+    #
+    # Wait for the process to exit, raising a ChildProcess::TimeoutError if
+    # the timeout expires.
+    #
+
+    def poll_for_exit(timeout)
+      log "polling #{timeout} seconds for exit"
+
+      end_time = Time.now + timeout
+      until (ok = exited?) || Time.now > end_time
+        sleep POLL_INTERVAL
+      end
+
+      unless ok
+        raise TimeoutError, "process still alive after #{timeout} seconds"
+      end
+    end
+
+    private
+
+    def launch_process
+      raise SubclassResponsibility, "launch_process"
+    end
+
+    def detach?
+      @detach
+    end
+
+    def duplex?
+      @duplex
+    end
+
+    def leader?
+      @leader
+    end
+
+    def log(*args)
+      ChildProcess.logger.debug "#{self.inspect} : #{args.inspect}"
+    end
+
+    def assert_started
+      raise Error, "process not started" unless started?
+    end
+
+  end # AbstractProcess
+end # ChildProcess

data/lib/childprocess/errors.rb

@@ -1,26 +1,37 @@
-module ChildProcess
-  class Error < StandardError
-  end
-
-  class TimeoutError < Error
-  end
-
-  class SubclassResponsibility < Error
-  end
-
-  class InvalidEnvironmentVariable < Error
-  end
-
-  class LaunchError < Error
-  end
-
-  class MissingPlatformError < Error
-    def initialize
-      message = "posix_spawn is not yet supported on #{ChildProcess.platform_name} (#{RUBY_PLATFORM}), falling back to default implementation. " +
-                "If you believe this is an error, please file a bug at http://github.com/enkessler/childprocess/issues"
-
-      super(message)
-    end
-
-  end
-end
+module ChildProcess
+  class Error < StandardError
+  end
+
+  class TimeoutError < Error
+  end
+
+  class SubclassResponsibility < Error
+  end
+
+  class InvalidEnvironmentVariable < Error
+  end
+
+  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. " +
+                "If you believe this is an error, please file a bug at http://github.com/enkessler/childprocess/issues"
+
+      super(message)
+    end
+
+  end
+end

data/lib/childprocess/jruby/io.rb

@@ -1,16 +1,16 @@
-module ChildProcess
-  module JRuby
-    class IO < AbstractIO
-      private
-
-      def check_type(output)
-        unless output.respond_to?(:to_outputstream) && output.respond_to?(:write)
-          raise ArgumentError, "expected #{output.inspect} to respond to :to_outputstream"
-        end
-      end
-
-    end # IO
-  end # Unix
-end # ChildProcess
-
-
+module ChildProcess
+  module JRuby
+    class IO < AbstractIO
+      private
+
+      def check_type(output)
+        unless output.respond_to?(:to_outputstream) && output.respond_to?(:write)
+          raise ArgumentError, "expected #{output.inspect} to respond to :to_outputstream"
+        end
+      end
+
+    end # IO
+  end # Unix
+end # ChildProcess
+
+