nand 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64a59a5d1347cb4d11d48fa7224f8d9746039499
+  data.tar.gz: b891827552f927644004f4c16ede6999f067ab93
+SHA512:
+  metadata.gz: 03e62874073a537cee92d16e052f7e233f1c4f9c74065cf440d90c1ae8b94019ece653997c2d697aa66c48d76fdf386c19d182d658e2a4020125b9112eac328e
+  data.tar.gz: eba2559e047d7af7a7c92ff1fb7cef052fcf1a27b650d126874d13d69779196737d2e7256b7751d9e18f53d3c6cf9ca9cb1e703db0dd21352dce026910ddb701

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format doc 
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nand.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 satoyama
+
+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.ja.md

@@ -0,0 +1,206 @@
+# Nand [![Gem Version](https://badge.fury.io/rb/nand.svg)](http://badge.fury.io/rb/nand) [![Code Climate](https://codeclimate.com/github/linkodehub/nand/badges/gpa.svg)](https://codeclimate.com/github/linkodehub/nand) [![Join the chat at https://gitter.im/linkodehub/nand](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/linkodehub/nand?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## 概要
+
+Nand は Nandemo(ナンデモ) daemon にすることができるRubyで作られたシンプルなコマンドラインツールです。
+
+ここで言う"ナンデモ"とは、シェルコマンドや実行形式のファイル、
+Rubyファイル(ライブラリやnandのplugin)になります。
+
+デーモン化するには、シンプルに `nand start TARGET`をコマンドラインから実行するだけです。
+停止させるには、もちろん`nand stop TARGET`です。
+動作状態の確認は`nand status TARGET`で確認できます。
+
+## インストール
+
+    $ gem install nand
+
+## 簡単な利用方法
+
+### コマンド
+
+	$ nand SUB_COMMAND TARGET [オプション]
+
+`SUB_COMMAND` と デーモンプロセスのターゲットを指定します。
+
+### 起動
+
+	$ cd /any/path
+	$ nand start sleep 1000
+	sleep is Start Success [85596]
+
+ターゲット以降で、Nandのオプションとして認識されないものは、
+デーモンプロセスへ引き渡されます。
+なお、`sleep 1000` がデーモンプロセスとして動作し、`sleep`がデーモンプロセス名としてnandに認識されます。
+
+### 状態確認
+
+ターゲット`sleep`の動作状況を確認するためには、以下のコマンドを実行します。
+
+	$ cd /any/path
+	$ nand status sleep
+	sleep is Running [85596] by USER in /any/path
+
+`start`と同一ディレクトリであれば、デーモンプロセス名としての`sleep`は省略できます。
+
+### 停止
+
+	$ nand stop sleep
+	sleep is Stopped [85596]
+
+`stop`も`status`と同様に`start`と同一ディレクトリであれば、
+デーモンプロセス名としての`sleep`は省略もできます。
+
+	$ nand status sleep
+	sleep is Not Running in /any/path
+
+
+## Rubyファイルのデーモン化
+
+カレントディレクトリに 以下の様な `forever_sleep.rb` というファイルが存在する場合
+
+```ruby:forever_sleep.rb
+require 'nand/plugin'
+
+module Sample
+  class ForeverSleep
+    extend Plugin
+    def self.executor(*argv)
+      new(*argv)
+    end
+    def exec
+      sleep
+    end
+  end
+end
+```
+
+	$ nand start forever_sleep.rb -p Sample::ForeverSleep
+	forever_sleep.rb is Start Success [86326]
+
+	$ nand stop forever_sleep.rb
+	forever_sleep.rb is Stopped [86326]
+
+実行可能ファイルでないRubyのファイルを指定する場合は、Nand::Pluginをextendしたクラスの
+クラス名を`-p`オプションで指定する必要があります。
+ただし、`-p`オプションが未指定の場合、ファイル名からからクラス名を類推しようとします。
+この例の場合、
+ファイル名が _forever_sleep.rb_ のため、`ForeverSleep` クラスとして検索します。
+残念ながらこの例では、失敗します。
+
+もし、上記のようなファイルをsample-VERSION.gemとしてインストールした場合は、
+Rubyのファイル名ではなく、パッケージ名を指定することで、デーモン化できます。
+ただし、Pluginファイルを指定されたディレクトリとファイル名で
+(sample/nand/plugin.rb)配置する必要があります。
+
+
+## 様々な利用方法
+
+### Nandオプションと重複する場合
+
+Nandオプションと重複する場合は、2通りの方法で回避できます。
+
+一つめは、"や'(クォーテーション)でオプションを囲む方法
+
+	$ nand start any.sh "--run_dir /tmp"
+
+なお、`"--run_dir /tmp"`は内部では `--run_dir`, `/tmp`に分割されますので、
+分割されないようにするためには、`'"--run_dir /tmp"'`などのようにする必要があります。
+
+二つめは 2つのダッシュ(--)の後に記述する方法
+
+	$ nand start any.sh -- --run_dir /tmp
+
+これらの方法で、nandと重複するオプションを指定したターゲットに引き渡すことができます。
+
+### デーモンプロセスへのパイプ
+
+
+```sh
+#!/bin/sh
+sleep $1
+echo $2
+```
+
+sleep_echo.shという実行形式のファイルがあった場合、
+
+	$ nand start sleep_echo.sh 100 '"foo bar baz"' --out out.log
+	
+	$ cat out.log
+	foo bar baz
+
+なお、STDINは`--in`、STDERRは `--err`にそれぞれパイプをつなぐことができます。
+
+
+### 動作ディレクトリの変更
+
+Nandにとって、動作ディレクトリは非常に重要です。
+PIDファイルを出力したり、デーモンプロセスは動作ディレクトリに移動して動作します。
+
+動作ディレクトリは基本的にnandコマンドを実行したディレクトリですが、
+オプションで指定もできます。
+
+	$ nand start sleep_echo.sh 100 abc --run_dir /tmp --out out.log
+
+これにより、`out.log`は`/tmp/out.log`に出力されます。
+
+
+### 二重起動の禁止
+
+原則として同じターゲットを指定して、デーモン化できません。
+
+	$ nand start sleep 1000
+	sleep is Start Success [97649]
+	$ nand start sleep 1000
+	sleep is Start Failed [PID file exist /any/path/.nand_sleep.pid]
+
+これを回避する必要がある場合は、前述の動作ディレクトリを変更するか、
+`-n` オプションを利用してデーモンプロセス名を指定する方法があります。
+
+	$ nand start sleep 1000 -n sleep1
+	sleep1 is Start Success [97649]
+	$ nand status
+	sleep is Running [97649] by USER in /run/dir
+	sleep1 is Running [97765] by USER in /run/dir
+
+
+### 制限時間で自動停止させる
+
+
+制限時間を秒で設けて、自動停止させることができます。
+
+	$ nand start vmstat 5 --sec 600
+
+上記の例では、600秒後に自動で停止します。
+
+### 自動再起動
+
+デーモンプロセスが停止した場合、`-r` オプションを設定しておくことで、
+自動で再起動させることができます。
+
+	$ nand start sleep 100 -r
+
+この例では、100秒後に停止した`sleep 100`が、再度`sleep 100`で
+再起動します。
+
+## 注意事項
+
+
+`stop`時はデーモンプロセスが管理するプロセスグループに対して、SIGTERMを送信します。
+デーモンプロセスは送信したプロセスグループの終了を待ち合わせます。
+デーモン化したい処理については、必ずSIGTERMで終了するようにしてください。
+
+動作ディレクトリにおいて、`.nand_デーモンプロセス名.pid`というファイルが生成されます。
+このファイルは二重起動抑制のために利用される他、`stop/status`時の
+整合性確認にも利用されます。
+もし、このファイルを誤って削除した場合は、`stop/status`がエラーを出力します。
+その指示に従って、不要なプロセスであることをpsコマンドなどで確認して、
+手動でプロセスを停止させてください。
+	
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/README.md

@@ -0,0 +1,203 @@
+# Nand [![Gem Version](https://badge.fury.io/rb/nand.svg)](http://badge.fury.io/rb/nand) [![Code Climate](https://codeclimate.com/github/linkodehub/nand/badges/gpa.svg)](https://codeclimate.com/github/linkodehub/nand) [![Join the chat at https://gitter.im/linkodehub/nand](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/linkodehub/nand?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+### Overview
+
+Nand is a simple CLI tool to make anything daemon by Ruby.
+Nand is the meaning of Nandemo of Japanese.
+
+Nandemo of here is a executable file and shell command, a non-executable Ruby file.
+
+For starting daemonize TARGET, You can just type `nand start TARGET`.
+You can stop by `nand stop TARGET`. `nand status TARGET` show it running status.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nand'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nand
+
+## Easy Usage
+
+### Command Definition
+
+	$ nand SUB_COMMAND TARGET [OPTION]
+
+### Start
+
+	$ cd /any/path
+	$ nand start sleep 1000
+	sleep is Start Success [85596]
+
+You can start TARGET by `start` SUB_COMMAND.
+Though OPTION(s) after TARGET is Nand option, OPTION(s) Nand is unknown,
+will be handed over to TARGET.
+Here `1000` is handed over to `sleep`. 
+And Nand recognizes a shell command `sleep` as TARGET name.
+When TARGET is success to be a daemon process, Nand show TARGET namd and daemon
+process id.
+
+### Status
+
+For the TARGET `sleep` running status, Nand `status` command show running status.
+
+	$ cd /any/path
+	$ nand status sleep
+	sleep is Running [85596] by USER in /any/path
+
+You can omit the TARGET name `sleep` because you stay in `/any/path`.
+
+### Stop
+
+Nand `stop` command stop daemon process with TARGET name.
+
+	$ nand stop sleep
+	sleep is Stopped [85596]
+	$ nand status sleep
+	sleep is Not Running in /any/path
+
+You can also omit the TARGET name `sleep` as `status` because you stay in `/any/path`.
+
+## A Ruby File
+
+Following `forever_sleep.rb` in current directory, you can make it daemon with
+file name as TARGET name.
+
+```ruby:forever_sleep.rb
+require 'nand/plugin'
+
+module Sample
+  class ForeverSleep
+    extend Plugin
+    def self.executor(*argv)
+      new(*argv)
+    end
+    def exec
+      sleep
+    end
+  end
+end
+```
+
+	$ nand start forever_sleep.rb -p Sample::ForeverSleep
+	forever_sleep.rb is Start Success [86326]
+
+	$ nand stop forever_sleep.rb
+	forever_sleep.rb is Stopped [86326]
+
+Nand can find the executor with exec method from defined class by `-p` option.
+The class need to extend `Nand::Plugin`.
+Then then executor can become a daemon process as TARGET name `forever_sleep.rb`.
+
+## More Usage
+
+### Avoid duplicated Nand Options
+
+There are two ways to avoid duplicated Nand options for daemon's process options.
+
+First, the options can be enclosed in "(double) or '(single) quatations.
+
+	$ nand start any.sh "--run_dir /tmp"
+
+
+Others, you can put them after double dash(--).
+
+	$ nand start any.sh -- --run_dir /tmp
+
+### Pipes to Daemon Process
+
+You can pipe to daemon process STDOUT and STDERR, STDIN by using Nand options
+`--out` and `--err`, `--in`.
+
+Here is `sleep_echo.sh` as follows:
+
+```sh
+#!/bin/sh
+sleep $1
+echo $2
+```
+Then you can start with Nand pipe option.
+
+	$ nand start sleep_echo.sh 100 '"foo bar baz"' --out out.log
+	
+	$ cat out.log
+	foo bar baz
+
+### Running Directory
+
+It is very important that you define the running directory with Nand option `--run_dir`.
+A PID file is put in the running directory and daemon process change the running directory.
+If you don't define the running directory, it is the current directory.
+
+	$ nand start sleep_echo.sh 100 abc --run_dir /tmp --out out.log
+
+### Prohibition of Duplicated Start
+
+Basically, you can not start duplicated daemon process name.
+
+	$ nand start sleep 1000
+	sleep is Start Success [97649]
+	$ nand start sleep 1000
+	sleep is Start Failed [PID file exist /any/path/.nand_sleep.pid]
+
+If you would like to start duplicated daemon process name, you can
+start in another run directory or as another daemon process name.
+
+	$ nand start sleep 1000 --run_dir /tmp
+	sleep1 is Start Success [97611]
+	$ nand start sleep 1000 -n sleep1
+	sleep1 is Start Success [97649]
+	$ nand status -a
+	sleep is Running [97649] by USER in /run/dir
+	sleep1 is Running [97765] by USER in /run/dir
+	sleep is Running [97611] by USER in /tmp
+
+### Automatically Stop
+
+Daemon process can automatically stop at the time limit, you defined.
+
+	$ nand start vmstat 5 --sec 600
+
+Then `vmstat` will automatically stop after the lapse of 600 seconds.
+
+### Automatically Recovery
+
+If you defined Nand `-r` option, when the daemon process downed,
+it would restart.
+
+	$ nand start sleep 100 -r
+
+This `sleep 100` will be down after 100 seconds, then `sleep 100`
+will restart soon.
+
+
+## Note
+
+When `nand stop`, Nand send signal(SIGTERM) to daemon process group, and
+wait for termination of daemon process. Your daemon process finish by receiving
+a SIGTERM.
+
+You must not remove a PID file for Nand `.nand_[DAEMON_NAME].pid`.
+It has be required to confirm integrity.
+If you removed it, Nand output an error. Then you need to stop
+the daemon process manually.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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
+
+## License
+
+MIT