childprocess 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc6ebd5fca28a63f0cc66f1694f31961aa8dbd59
+  data.tar.gz: 0a3a042ae2fa14dc9b70446553f296cedd4990f4
+SHA512:
+  metadata.gz: 721fae3f6625d89823fcc87fbc2188d611cb4b0f120b26a7bd4ddc2c421d4791dc608dbfe90275a312a920d3620ec377e463d01a6b118bb3f2cf938230cd4f65
+  data.tar.gz: 1a1f9e46433a97dc71e2937c6270f775d0c82db387daea194011eb83befde3e96912b83adbb472efbe03a381b7ac8a41e9009546c7157083f93c78738eeab6d6

data/.document

@@ -0,0 +1,6 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+-
+LICENSE

data/.gitignore

@@ -0,0 +1,28 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## RubyMine
+.idea/*
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.rbx
+Gemfile.lock
+.ruby-version
+.bundle
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,36 @@
+os:
+  - linux
+  - osx
+
+rvm:
+  - 1.9.3
+  - jruby-9.1.9.0
+  - rbx-3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3.5
+  - 2.4.0
+  - ruby-head
+
+sudo: true # Necessary to fix JRuby
+
+cache: bundler
+
+before_install:
+  - "echo 'gem: --no-document' > ~/.gemrc"
+  - gem update --system
+  - gem install bundler  # Necessary to fix 1.9.3
+
+env:
+  global:
+  matrix:
+    - CHILDPROCESS_POSIX_SPAWN=true CHILDPROCESS_UNSET=should-be-unset
+    - CHILDPROCESS_POSIX_SPAWN=false CHILDPROCESS_UNSET=should-be-unset
+
+matrix:
+  allow_failures:
+    - rvm: rbx-3
+    - rvm: jruby-9.1.9.0
+    - rvm: ruby-head
+    - env: "CHILDPROCESS_POSIX_SPAWN=true"

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+### Version 0.8.0 / 2017-09-23
+
+* Added a method for determining whether or nto a process had been started.
+
+
+### Version 0.7.1 / 2017-06-26
+
+* Fixed a noisy uninitialized variable warning
+
+
+### Version 0.7.0 / 2017-05-07
+
+* Debugging information now uses a Logger, which can be configured.
+
+
+### Version 0.6.3 / 2017-03-24
+
+See beta release notes.
+
+
+### Version 0.6.3.beta.1 / 2017-03-10
+
+* Bug fix: Fixed child process creation problems on Windows 7 when a child was declared as a leader.
+
+
+### Version 0.6.2 / 2017-02-25
+
+* Bug fix: Fixed a potentially broken edge case that could occur on older 32-bit OSX systems.
+
+
+### Version 0.6.1 / 2017-01-22
+
+* Bug fix: Fixed a dependency that was accidentally declared as a runtime 
+  dependency instead of a development dependency.
+
+
+### Version 0.6.0 / 2017-01-22
+
+* Support for Ruby 2.4 added
+
+
+### Version 0.5.9 / 2016-01-06
+
+* The Great Before Times...

data/Gemfile

@@ -0,0 +1,15 @@
+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
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2015 Jari Bakken
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,192 @@
+# childprocess
+
+This gem aims at being a simple and reliable solution for controlling
+external programs running in the background on any Ruby / OS combination.
+
+The code originated in the [selenium-webdriver](https://rubygems.org/gems/selenium-webdriver) gem, but should prove useful as
+a standalone library.
+
+[![Build Status](https://secure.travis-ci.org/enkessler/childprocess.svg)](http://travis-ci.org/enkessler/childprocess)
+[![Build status](https://ci.appveyor.com/api/projects/status/fn2snbcd7kku5myk/branch/dev?svg=true)](https://ci.appveyor.com/project/enkessler/childprocess/branch/dev)
+[![Gem Version](https://badge.fury.io/rb/childprocess.svg)](http://badge.fury.io/rb/childprocess)
+[![Code Climate](https://codeclimate.com/github/enkessler/childprocess.svg)](https://codeclimate.com/github/enkessler/childprocess)
+[![Coverage Status](https://coveralls.io/repos/enkessler/childprocess/badge.svg?branch=master)](https://coveralls.io/r/enkessler/childprocess?branch=master)
+
+# Usage
+
+The object returned from `ChildProcess.build` will implement `ChildProcess::AbstractProcess`.
+
+### Basic examples
+
+```ruby
+process = ChildProcess.build("ruby", "-e", "sleep")
+
+# inherit stdout/stderr from parent...
+process.io.inherit!
+
+# ...or pass an IO
+process.io.stdout = Tempfile.new("child-output")
+
+# modify the environment for the child
+process.environment["a"] = "b"
+process.environment["c"] = nil
+
+# set the child's working directory
+process.cwd = '/some/path'
+
+# start the process
+process.start
+
+# check process status
+process.alive?    #=> true
+process.exited?   #=> false
+
+# wait indefinitely for process to exit...
+process.wait
+process.exited?   #=> true
+
+# get the exit code
+process.exit_code #=> 0
+
+# ...or poll for exit + force quit
+begin
+  process.poll_for_exit(10)
+rescue ChildProcess::TimeoutError
+  process.stop # tries increasingly harsher methods to kill the process.
+end
+```
+
+### Advanced examples
+
+#### Output to pipe
+
+```ruby
+r, w = IO.pipe
+
+proc = ChildProcess.build("echo", "foo")
+proc.io.stdout = proc.io.stderr = w
+proc.start
+w.close
+
+begin
+  loop { print r.readpartial(8192) }
+rescue EOFError
+end
+
+proc.wait
+```
+
+Note that if you just want to get the output of a command, the backtick method on Kernel may be a better fit.
+
+#### Write to stdin
+
+```ruby
+process = ChildProcess.build("cat")
+
+out      = Tempfile.new("duplex")
+out.sync = true
+
+process.io.stdout = process.io.stderr = out
+process.duplex    = true # sets up pipe so process.io.stdin will be available after .start
+
+process.start
+process.io.stdin.puts "hello world"
+process.io.stdin.close
+
+process.poll_for_exit(exit_timeout_in_seconds)
+
+out.rewind
+out.read #=> "hello world\n"
+```
+
+#### Pipe output to another ChildProcess
+
+```ruby
+search           = ChildProcess.build("grep", '-E', %w(redis memcached).join('|'))
+search.duplex    = true # sets up pipe so search.io.stdin will be available after .start
+search.io.stdout = $stdout
+search.start
+
+listing           = ChildProcess.build("ps", "aux")
+listing.io.stdout = search.io.stdin
+listing.start
+listing.wait
+
+search.io.stdin.close
+search.wait
+```
+
+#### Prefer posix_spawn on *nix
+
+If the parent process is using a lot of memory, `fork+exec` can be very expensive. The `posix_spawn()` API removes this overhead.
+
+```ruby
+ChildProcess.posix_spawn = true
+process = ChildProcess.build(*args)
+```
+
+### 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:
+
+```ruby
+process = ChildProcess.build(*args)
+process.leader = true
+process.start
+```
+
+#### Detach from parent
+
+```ruby
+process = ChildProcess.build("sleep", "10")
+process.detach = true
+process.start
+```
+
+#### Invoking a shell
+
+As opposed to `Kernel#system`, `Kernel#exec` et al., ChildProcess will not automatically execute your command in a shell (like `/bin/sh` or `cmd.exe`) depending on the arguments.
+This means that if you try to execute e.g. gem executables (like `bundle` or `gem`) or Windows executables (with `.com` or `.bat` extensions) you may see a `ChildProcess::LaunchError`.
+You can work around this by being explicit about what interpreter to invoke:
+
+```ruby
+ChildProcess.build("cmd.exe", "/c", "bundle")
+ChildProcess.build("ruby", "-S", "bundle")
+```
+
+#### Log to file
+
+Errors and debugging information are logged to `$stderr` by default but a custom logger can be used instead. 
+
+```ruby
+logger = Logger.new('logfile.log')
+logger.level = Logger::DEBUG
+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 environemnt used for PATH searches in `java.lang.ProcessBuilder`. This can be avoided by setting `ChildProcess.posix_spawn = true`.
+
+# Implementation
+
+How the process is launched and killed depends on the platform:
+
+* Unix     : `fork + exec` (or `posix_spawn` if enabled)
+* Windows  : `CreateProcess()` and friends
+* JRuby    : `java.lang.{Process,ProcessBuilder}`
+
+# Note on Patches/Pull Requests
+
+1. Fork it
+2. Create your feature branch (off of the development branch)
+   `git checkout -b my-new-feature dev`
+3. Commit your changes
+   `git commit -am 'Add some feature'`
+4. Push to the branch
+   `git push origin my-new-feature`
+5. Create new Pull Request
+
+# Copyright
+
+Copyright (c) 2010-2015 Jari Bakken. See LICENSE for details.

data/Rakefile

@@ -0,0 +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

data/appveyor.yml

@@ -0,0 +1,43 @@
+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
+
+
+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