shexecutor 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 015cbac59f4b5483310082114036aba224b33d71
-  data.tar.gz: a46a875e6f3a89771b18c3c55ecab921036e1318
+  metadata.gz: abaf52298bab64d4d610fd898c8595bbbfe9b3a7
+  data.tar.gz: 5d9cbd52b722d5fcca21de5756ab67214f3be3ca
 SHA512:
-  metadata.gz: 622776ff057643462f4a635ae6420fb3f4d1394337801c1c05f78efa1f715b8ba17e5eb946a971d2f8ad46b5201730e39726581d1a8eaacb1351d084d93742c6
-  data.tar.gz: 8830062712bd2ab7eac8a2b5d0f3bd4eaf5b91637796f991c05453ab0738b6f744a2309cb2f25d08342d25caa6a66acaca3a4218162fd8fc9d038c9fbbb2b372
+  metadata.gz: e3c8314db1c8d18514d07d233c9e30d61b35412f662dea3b83607c3c4c3af3fdbd5a97dfbb874dbc7df4f9e4928b7cededa19b1ad1d46724547a650fb2abd603
+  data.tar.gz: 384a910b71555021718514d492cf185057d23e0120ce40c9abacdaf790ad0a1d3a4f30a6e7b78cdd0ead4d49d4e28f600b89fa064001601d258e54573d7dbe90

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shexecutor (0.0.17)
+    shexecutor (0.0.19)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -11,6 +11,7 @@ SHExecutor is a convenience wrapper for executing shell commands from with-in a
 
 ## It does not support:
 - streaming input to stdin
+- being nested in an outer Timeout (see 'complications' below)
 
 ## For any executor:
 - you can ask status, which will tell you "not executed", current status (e.g. run or sleep) and "no longer executing"
@@ -139,7 +140,24 @@ puts iut.stdout
 puts iut.stderr
 ```
 
-  Remember to call iut.flush in order to stream stdout and stderr to the Executor object.
+## Complications
+  Remember to call iut.flush in order to access stdout and stderr in the Executor object.
+
+  Nested timeouts can result in complications. Because Executor drains stdout and stderr to avoid dead-locking, these StringIO streams will raise an IOError if they are interrupted. The backtrace of these IOErrors will not contain information of an outer Timeout or other exception that interrupted the Executor. The code below illustrates the complication:
+
+```
+def shexecutor_complication
+  result, stdout, stderr = ::SHExecutor::execute_and_timeout_after("/bin/sleep", "30", 20)
+end
+
+Timeout::timeout(5) do
+  shexecutor_complication
+end
+
+# shexecutor.rb:in 'copy_stream': stream closed (IOError)
+```
+
+## Contributing
 
   Please send feedback and comments to the author at:
 
@@ -147,8 +165,6 @@ puts iut.stderr
 
   Thanks to Sheldon Hearn for review and great ideas that unblocked complex challenges (https://rubygems.org/profiles/sheldonh).
 
-## Contributing
-
 1. Fork it ( https://github.com/[my-github-username]/executor/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/shexecutor/version.rb

@@ -1,3 +1,3 @@
 module SHExecutor
-  VERSION = "0.0.19"
+  VERSION = "0.0.20"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shexecutor
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Ernst van Graan