frontkick 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6086b0058c21edf9586f841eef70e15a746dbbaf
-  data.tar.gz: 0b1f63ed60327e2907dee507eaebe8ac9393df06
+  metadata.gz: 6bb5e819a8afaf32b404b81f3b4d0792aa90f7b9
+  data.tar.gz: 9a35e8fafa3cfecde913653eaf4611a9ace3b70a
 SHA512:
-  metadata.gz: 170164a43b0a1a5175418a6c0216034a6b9d2e43637595699289bc9d100ef85767f466ef1dd2803eac27cd1c42cdbc825037ba807bab7fe3ab02bd3b70d48c5f
-  data.tar.gz: 5631ed597d2e5134fc5ef914f2bf51275485635b9fe6f022e50a34c070fa88b6b7f4117bc0aa9fbd73eb90d68c0f5e2d7f768248a13ef0d6f222c0617ea578bf
+  metadata.gz: 628155e7ae55b811fee9f9727f429b5a6e8b50bf28d722618583b8d82627ce60640ac2263dda02d4c43d75ad03a9ac474483a5c0a170586b27c55e656321bfe8
+  data.tar.gz: 5baf25776ba2790a21c4f9156fdc78fe960fff48dee5357ad6b7e8e655b24549baff06f48c9be1ce66048ac7f0e6087f0e98dbc9aca9463b911480baf21f53dd

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.5.3 (2017/01/12)
+
+Fixes:
+
+- Fix not to close given out and err IO objects
+
 # 0.5.2 (2016/03/18)
 
 Fixes:

data/README.md

@@ -1,66 +1,121 @@
 # frontkick [![Build Status](https://secure.travis-ci.org/sonots/frontkick.png?branch=master)](http://travis-ci.org/sonots/frontkick) [![Dependency Status](https://gemnasium.com/sonots/frontkick.png)](https://gemnasium.com/sonots/frontkick)
 
-Frontkick is a gem to execute a command and obtain exit\_code, stdout, stderr simply. 
+Frontkick is a gem to execute a command and obtain exit\_code, stdout, stderr simply.
 
 ## What is This For?
 
-Ruby's `Kernel.#system` method does not return STDOUT and STDERR. 
+Ruby's `Kernel.#system` method does not return STDOUT and STDERR.
 Ruby's back quote (``) returns STDOUT, but does not return STDERR.
 
-With frontkick, you can easily get the exit code, STDOUT, and STDERR. 
+With frontkick, you can easily get the exit code, STDOUT, and STDERR.
 
 ## USAGE
 
-    gem install frontkick
+```
+gem install frontkick
+```
 
 ### Basic Usage
 
-    result = Frontkick.exec("echo *")
-    puts result.successful? #=> true if exit_code is 0
-    puts result.success?    #=> alias to successful?, for compatibility with Process::Status
-    puts result.stdout      #=> stdout output of the command
-    puts result.stderr      #=> stderr output of the command
-    puts result.exit_code   #=> exit_code of the command
-    puts result.status      #=> alias to exit_code
-    puts result.exitstatus  #=> alias to exit_code, for compatibility with Process::Status
-    puts result.duration    #=> the time used to execute the command
+```ruby
+result = Frontkick.exec("echo *")
+puts result.successful? #=> true if exit_code is 0
+puts result.success?    #=> alias to successful?, for compatibility with Process::Status
+puts result.stdout      #=> stdout output of the command
+puts result.stderr      #=> stderr output of the command
+puts result.exit_code   #=> exit_code of the command
+puts result.status      #=> alias to exit_code
+puts result.exitstatus  #=> alias to exit_code, for compatibility with Process::Status
+puts result.duration    #=> the time used to execute the command
+```
+
+### No Shell
+
+**String argument**
+
+When the first argument is a String, the command is executed via shell if the command string includes meta characters of shell such as:
+
+```
+* ? {} [] <> () ~ & | \ $ ; ' ` " \n
+```
+
+otherwise, the command is not executed via shell.
+
+```ruby
+result = Frontkick.exec("echo foo") # no shell
+result = Frontkick.exec("echo *") # with shell
+```
+
+The process tree for the latter (with shell)  will be like:
 
-### Escape Command
+```
+ruby
+└─ sh -c
+    └── echo *
+```
+
+**Array argument**
 
-    result = Frontkick.exec(["echo", "*"]) #=> echo the asterisk character
+When the first argument is an Array, The command is not executed via a shell.
+Note that shell wildcards are not available with this way.
+
+```ruby
+result = Frontkick.exec(["echo", "*"]) #=> echo the asterisk character
+```
+
+The process tree will be like:
+
+```
+ruby
+└─ echo
+```
 
 ### Dry Run Option
 
-    result = Frontkick.exec(["echo", "*"], :dry_run => true)
-    puts result.stdout #=> echo \*
+```ruby
+result = Frontkick.exec(["echo", "*"], :dry_run => true)
+puts result.stdout #=> echo \*
+```
 
 ### Timeout Option
 
-    Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1) # raises Frontkick::Timeout
+```ruby
+Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1) # raises Frontkick::Timeout
+```
 
 not to kill timeouted process
 
-    Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1, :timeout_kill => false) # raises Frontkick::Timeout
+```ruby
+Frontkick.exec("sleep 2 && ls /hoge", :timeout => 1, :timeout_kill => false) # raises Frontkick::Timeout
+```
 
 ### Exclusive Option
 
 Prohibit another process to run a command concurrently
 
-    Frontkick.exec("sleep 2 && ls /hoge", :exclusive => "/tmp/frontkick.lock") # raises Fontkick::Locked if locked
+```ruby
+Frontkick.exec("sleep 2 && ls /hoge", :exclusive => "/tmp/frontkick.lock") # raises Fontkick::Locked if locked
+```
 
 If you prefer to be blocked:
 
-    Frontkick.exec("sleep 2 && ls /hoge", :exclusive => "/tmp/frontkick.lock", :exclusive_blocking => true)
+```ruby
+Frontkick.exec("sleep 2 && ls /hoge", :exclusive => "/tmp/frontkick.lock", :exclusive_blocking => true)
+```
 
 ### Redirect Options (:out and :err)
 
-    Frontkick.exec(["ls /something_not_found"], :out => 'stdout.txt', :err => 'stderr.txt')
+```ruby
+Frontkick.exec(["ls /something_not_found"], :out => 'stdout.txt', :err => 'stderr.txt')
+```
 
 This redirects STDOUT and STDERR into files. In this case, result.stdout, and result.stderr are the given filename.
 
-    out = File.open('stdout.txt', 'w').tap {|fp| fp.sync = true }
-    err = File.open('stderr.txt', 'w').tap {|fp| fp.sync = true }
-    Frontkick.exec(["ls /something_not_found"], :out => out, :err => err)
+```ruby
+out = File.open('stdout.txt', 'w').tap {|fp| fp.sync = true }
+err = File.open('stderr.txt', 'w').tap {|fp| fp.sync = true }
+Frontkick.exec(["ls /something_not_found"], :out => out, :err => err)
+```
 
 You can also give IO objects. In this case, result.stdout, and result.stderr are the given IO objects.
 
@@ -70,8 +125,8 @@ Other options such as :chdir are treated as options of `Open3.#popen3`.
 
 ### Kill Child Process
 
-Sending a signal to a kicked child process is fine because a frontkick process can finish.
-But, sending a signal to a frontkick process is not fine because a child process would become an orphan process.
+Although sending a signal to a kicked child process directly causes no problem (frontkick process can take care of it),
+sending a signal to a frontkick process may cause a problem that a child process becomes an orphan process.
 
 To kill your frontkick process with its child process correctly, send a signal to their **process group** as
 

data/lib/frontkick/command.rb

@@ -82,8 +82,8 @@ module Frontkick
         raise Frontkick::Timeout.new(pid, command, opts[:timeout_kill])
       ensure
         stdin.close if stdin and !stdin.closed?
-        out.close if out and !out.closed?
-        err.close if err and !err.closed?
+        stdout.close if stdout and !stdout.closed?
+        stderr.close if stderr and !stderr.closed?
         wait_thr.kill if wait_thr and !wait_thr.stop?
         lock_fd.flock(File::LOCK_UN) if lock_fd
         if opts[:out] and opts[:out].is_a?(String)

data/lib/frontkick/version.rb

@@ -1,3 +1,3 @@
 module Frontkick
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frontkick
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake