childprocess 0.5.9 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a01a1e0a06d2a6a7f18c576a48d11aa4bd78437
-  data.tar.gz: 4ad6d15fa3e38aa45d244533a617abb87af294d0
+  metadata.gz: ddee2715001c0588975716a640ae4318074657c8
+  data.tar.gz: 80beab872ef52ae9818ff1d87d283cf726ad0cb5
 SHA512:
-  metadata.gz: 67274313c2d786c42f637b597048138b5f9a0739779bb751c41ea14a1299e255310eff32abb75c93e022a4db785d2fb2368f11db9992d627b761f12364078b08
-  data.tar.gz: 4eda72acc23b6b4fefe76d6be567f8b2a7c047eca9e4cf967bc3a03d64b1f749edc65c0266e91a3f8eb19bf0c255b9bcc8d25b9fc19838d4af07ec8874b83d86
+  metadata.gz: b4ef32eedda3e6e84810f01fe4dd5a4f3adfe2faf35bc74fbb2f4130248d0295d3ac2c0855d3625f47492fe355e98d43ef4a7d4897eca60f5e8a654ec806fec9
+  data.tar.gz: e067faf2d9cf1d14e1367cc3afbca08754de15bd1360b09343455efdf59498acf4066d43603719a6ac74053d1a9d9c790ad67a60ff949db223b89b8c33ad9d14

data/.document

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

data/.gitignore

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

data/.rspec

@@ -1 +1 @@
---color
+--color

data/.travis.yml

@@ -1,18 +1,20 @@
-rvm:
-  - 1.9.3
-  - jruby
-  - rbx
-  - 2.0.0
-  - 2.1.0
-  - ruby-head
-sudo: false
-cache: bundler
-env:
-  - CHILDPROCESS_POSIX_SPAWN=true CHILDPROCESS_UNSET=should-be-unset
-  - CHILDPROCESS_POSIX_SPAWN=false CHILDPROCESS_UNSET=should-be-unset
-matrix:
-  allow_failures:
-    - rvm: rbx
-    - rvm: ruby-head
-    - rvm: 2.1.0
-      env: "CHILDPROCESS_POSIX_SPAWN=true"
+rvm:
+  - 1.9.3
+  - jruby
+  - rbx-3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+  - ruby-head
+sudo: false
+cache: bundler
+env:
+  - 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: ruby-head
+      env: "CHILDPROCESS_POSIX_SPAWN=true"

data/CHANGELOG.md

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

@@ -1,4 +1,11 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in child_process.gemspec
-gemspec
+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
+end

data/LICENSE

@@ -1,20 +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.
+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

@@ -1,178 +1,178 @@
-# 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/jarib/childprocess.png)](http://travis-ci.org/jarib/childprocess)
-[![Gem Version](https://badge.fury.io/rb/childprocess.png)](http://badge.fury.io/rb/childprocess)
-[![Code Climate](https://codeclimate.com/github/jarib/childprocess.png)](https://codeclimate.com/github/jarib/childprocess)
-[![Coverage Status](https://coveralls.io/repos/jarib/childprocess/badge.png?branch=master)](https://coveralls.io/r/jarib/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")
-```
-
-## 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
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-# Copyright
-
-Copyright (c) 2010-2015 Jari Bakken. See LICENSE for details.
+# 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.png)](http://travis-ci.org/enkessler/childprocess)
+[![Gem Version](https://badge.fury.io/rb/childprocess.png)](http://badge.fury.io/rb/childprocess)
+[![Code Climate](https://codeclimate.com/github/enkessler/childprocess.png)](https://codeclimate.com/github/enkessler/childprocess)
+[![Coverage Status](https://coveralls.io/repos/enkessler/childprocess/badge.png?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")
+```
+
+## 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
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+# Copyright
+
+Copyright (c) 2010-2015 Jari Bakken. See LICENSE for details.