rbatch 1.13.1 → 2.0.0

data/CHANGELOG

@@ -3,6 +3,10 @@ CHANGE LOG
 This document includes functions which is added or changed, does not include bugfix.
 About bugfix, see commit log of https://github.com/fetaro/rbatch .
 
+===================
+version 1
+===================
+
 1.0
 -----
 * initial
@@ -68,3 +72,14 @@ About bugfix, see commit log of https://github.com/fetaro/rbatch .
 ----
 * add customize point that can change RBatch home directory by using the environment variables, ${RB_HOME}.
 
+===================
+version 2
+===================
+
+2.0.0 (2013/12/28)
+----
+* change Run-Conf path from "${RB_HOME}/conf/rbatch.yaml" to "${RB_HOME}/.rbatchrc"
+* add checking existence of Run-Conf keys.
+* add option. "conf_dir", "common_conf_name",  and "cmd_timeout" are added.
+* when cmd_timeout occured, RBatch kill child process now. 
+* change test code from Test::Unit to RSpec. 

data/README.ja.md

@@ -1,10 +1,11 @@
 [[English]](https://github.com/fetaro/rbatch/blob/master/README.md "english") [[Japanese]](https://github.com/fetaro/rbatch/blob/master/README.ja.md "japanese")
 
-RBatch:Ruby-base バッチスクリプトフレームワーク
+RBatch:Ruby-base バッチ スクリプト フレームワーク
 =============
 
-RBatchについて
+RBatchについて (version 2)
 --------------
+
 これはRubyで書かれたシンプルなバッチスクリプトのフレームワークです。
 バッチスクリプト（バックアップやプロセスリロード等）を書く際に便利な機能をフレームワークとして提供しています。
 
@@ -16,11 +17,28 @@ RBatchについて
 * 外部コマンド実行 
 * 二重起動チェック
 
-注意：このフレームワークはRuby 1.9.x以降で動作します。また、Rubyプラットフォームは"linux","mswin","mingw","cygwin"で動作します。
+注意：このフレームワークはRuby 1.9で動作します。
 
 このソフトウェアは、MITライセンスのもとで公開しています。LICENSE.txtを見てください。
 
-### はじめに
+クイックスタート
+--------------
+
+    $ sudo gem install rbatch
+    $ rbatch-init    # => ディレクトリとサンプルスクリプトが作られます
+    $ ruby bin/hello_world.rb
+    $ cat log/YYYYMMDD_HHMMSS_hello_world.log
+
+マニュアル
+--------------
+
+### RBatchホームディレクトリ
+
+環境変数${RB_HOME}を定義する事で、その場所をRBatchのホームディレクトリに固定することができます。
+
+環境変数${RB_HOME}を定義していない場合は、「実行するスクリプトが配置されているディレクトリの親ディレクトリ」が${RB_HOME}になります。言い換えると${RB_HOME}のデフォルト値は"(実行するスクリプトのパス)/../"です。
+
+### ディレクトリ構成と命名規則
 
 RBatchでは、実行スクリプト、設定ファイルおよびログファイルについて、
 配置場所および命名規則が規約で決まっています。
@@ -30,7 +48,10 @@ RBatchでは、実行スクリプト、設定ファイルおよびログファ
 例を示すと以下の通りです。
 
 ```
-${RB_HOME}
+${RB_HOME}         ←RBatchホームディレクトリ
+ |
+ |-.rbatchrc       ←Run-Conf
+ |
  |-bin             ←実行スクリプト配置場所
  |  |- A.rb
  |  |- B.rb
@@ -38,21 +59,12 @@ ${RB_HOME}
  |-conf            ←設定ファイル配置場所
  |  |- A.yaml
  |  |- B.yaml
- |  |- rbatch.yaml ←RBatch全体設定ファイル
  |
  |-log             ←ログ出力場所
     |- YYYYMMDD_HHMMSS_A.log
     |- YYYYMMDD_HHMMSS_B.log
 ```
 
-### RBatchホームディレクトリ
-
-環境変数${RB_HOME}を定義する事で、その場所をRBatchのホームディレクトリに固定することができます。
-
-環境変数${RB_HOME}を定義していない場合は、「実行するスクリプトが配置されているディレクトリの親ディレクトリ」が${RB_HOME}になります。言い換えると${RB_HOME}のデフォルト値は"(実行するスクリプトのパス)/../"です。
-
-となります。
-
 ### 自動ログ出力
 
 Logging blockを使うことで、自動的にログファイルに出力することができます。
@@ -92,7 +104,7 @@ RBatch::Log.new(){ |log|  # Logging block
 ### 自動設定ファイル読み込み
 
 RBatchは簡単にデフォルトの位置の設定ファイルを読み込めます。
-デフォルトの位置は"${RB_HOME}/conf/${PROG_NAME}.yaml"です。
+デフォルトの位置は"${RB_HOME}/conf/(プログラムbase名).yaml"です。
 
 サンプル
 
@@ -118,7 +130,10 @@ p RBatch::config["not_exist"]
 => Raise Exception
 ```
 
+すべてのスクリプトから共通で読み込む設定ファイルを作りたい場合は、${RB_HOME}/conf/common.yamlというファイルを作ることで可能です。
+
 ### 外部コマンド実行 
+
 RBatchは外部コマンド（たとえば"ls -l"）を実行するラッパー関数を提供します。
 
 この関数は、実行結果をオブジェクトで返し、そのオブジェクトは標準出力、標準エラー出力、およびexitステータスを含みます。
@@ -137,44 +152,30 @@ p r.status
 
 ### 二重起動チェック
 
-RBatchの共通設定ファイルに"forbid_double_run: true"の設定を書けば、RBatchを利用したスクリプトの二重起動チェックができます。
+RBatchの共通設定ファイルに"forbid_double_run: true"の設定を書けば、RBatchを利用したプログラムの二重起動チェックができます。
 
-クイックスタート
---------------
-
-    $ sudo gem install rbatch
-    $ rbatch-init    # => ディレクトリとサンプルスクリプトが作られます
-    $ ruby bin/hello_world.rb
-    $ cat log/YYYYMMDD_HHMMSS_hello_world.log
-
-
-オプション
+カスタマイズ
 --------------
 
 RBatchではオプションの指定の仕方は以下の二つがあります。
 
-1. 全体設定ファイル(${RB_HOME}/conf/rbatch.yaml)に書く
-2. コンストラクタの引数に指定する
-
-全体設定ファイルにオプションを書くと、全てのスクリプトに効果がありますが、コンストラクタの引数に指定した場合はそのインスタンスのみ効果があります。
-
-全体設定ファイルとコンストラクタの引数に同じオプションが指定された場合、コンストラクタの引数が優先されます。
+(1) Run-Conf(${RB_HOME}/.rbatchrc)に書く
+(2) スクリプト内でオプションオブジェクトをコンストラクタの引数に渡す
 
-全体設定ファイルのキーの名前と、コンストラクタオプションのキーの名前は、対応関係があります。全体設定ファイルのキー名は「(クラス名)_(キー名)」となります。
-たとえばRBatch::Logクラスのコンストラクタオプションで「:name」というキーは、全体設定ファイルでは「log_name」というキーになります。
+同じオプションを(1)と(2)の両方で指定すると、(2)が優先されます。
 
-### 全体設定ファイルによるオプション指定
+### Run-Conf(.rbatchrc)によるカスタマイズ
 
 以下の場所にRBatch全体設定ファイルを配置すると、全てのスクリプトにてオプションが適用されます。
 
 
-     ${RB_HOME}/conf/rbatch.yaml
+     ${RB_HOME}/.rbatchrc
 
 
 設定ファイルのサンプルは以下の通り
 
 ```
-# RBatch 全体設定
+# RBatch Run-Conf (.rbatchrc)
 #
 #   設定ファイルの形式はYAML形式です
 #
@@ -183,6 +184,21 @@ RBatchではオプションの指定の仕方は以下の二つがあります
 # 全体
 # -------------------
 
+# Conf ディレクトリ
+#
+#   デフォルトは "<home>/conf"
+#
+#   <home> は ${RB_HOME} に置き換わります
+#
+#conf_dir: <home>/config
+#conf_dir: /etc/rbatch/
+
+# スクリプト間共通設定ファイル名
+#
+#   デフォルトは"common.yaml"
+#
+#common_conf_name: share.yaml
+
 # スクリプトの二重起動を可能にするかどうか
 #
 #   デフォルト値はfalse。
@@ -203,28 +219,37 @@ RBatchではオプションの指定の仕方は以下の二つがあります
 #cmd_raise: true
 #cmd_raise: false
 
+# 外部コマンドのタイムアウト
+#
+#   デフォルト値は0[sec]。
+#
+#cmd_timeout: 5
+
 # -------------------
 # ログ関連
 # -------------------
 
+# ログディレクトリ
+#
+#   デフォルトは "<home>/log"
+#
+#   <home> は ${RB_HOME} に置き換わります
+#
+#log_dir: <home>/rb_log
+#log_dir: /var/log/rbatch/
+
 # ログファイル名
 #
 #   デフォルト値は"<date>_<time>_<prog>.log"。
 #   以下の文字列は予約語
-#   <data> --> YYYYMMDDの日付形式に置換されます
-#   <time> --> hhmmssの時刻形式に置換されます
-#   <prog> --> 拡張子を除いたファイル名に置換されます
-#   <host> --> ホスト名に置換されます
+#   <data> はYYYYMMDDの日付形式に置換されます
+#   <time> はhhmmssの時刻形式に置換されます
+#   <prog> は拡張子を除いたファイル名に置換されます
+#   <host> はホスト名に置換されます
 #
 #log_name : "<date>_<time>_<prog>.log"
 #log_name : "<date>_<prog>.log"
 
-# ログ出力ディレクトリ
-#
-#   デフォルト値は"${RB_HOME}/log"。
-#
-#log_dir : "/tmp/log"
-
 # ログを追記するかどうか
 #
 #   デフォルト値はture。
@@ -291,7 +316,6 @@ RBatchではオプションの指定の仕方は以下の二つがあります
 
 #### RBatch::Logクラス
 
-    RBatch::Log.new(opt = nil)
     opt = {
           :name      => "<date>_<time>_<prog>.log",
           :dir       => "/var/log/",
@@ -307,10 +331,18 @@ RBatchではオプションの指定の仕方は以下の二つがあります
           :mail_server_port => 25
     }
 
+    RBatch::Log.new(opt)
+
 #### RBatch::Cmdクラス
 
-    RBatch::Log.new(cmd_str, opt = nil)
     opt = {
           :raise     => false,
           :timeout   => 0
           }
+
+    RBatch::Log.new(cmd_str, opt)
+
+version 1 から 2 へのマイグレーション
+--------------
+
+"${RB_HOME}/conf/rbatch.yaml" を "${RB_HOME}/.rbatchrc" に移動してください。

data/README.md

@@ -1,11 +1,12 @@
 [[English]](https://github.com/fetaro/rbatch/blob/master/README.md "english") [[Japanese]](https://github.com/fetaro/rbatch/blob/master/README.ja.md "japanese")
 
-RBatch:Ruby-base Simple Batch Framework
+RBatch:Ruby-base Batch-Script Framework
 =============
 
-About RBatch
+About RBatch (version 2)
 --------------
-This is Ruby-base Batch Script Framework. RBatch has many fanctions to help with your making a batch script such as "data backup script" or "proccess starting script".
+
+RBatch is Ruby-base Batch Script Framework. RBatch has many fanctions to help with your making a batch script such as "data backup" or "proccess starting".
 
 There are following functions. 
 
@@ -16,19 +17,39 @@ There are following functions.
 * Double Run Check
 
 
-Note: RBatch works on Ruby 1.9.x or later, and on Ruby platform of "linux","mswin","mingw","cygwin".
+Note: RBatch works on Ruby 1.9.
 
 Note: This software is released under the MIT License, see LICENSE.txt.
 
-### First
+Quick Start
+--------------
+
+    $ sudo gem install rbatch
+    $ rbatch-init    # => make directories and sample scripts
+    $ ruby bin/hello_world.rb
+    $ cat log/YYYYMMDD_HHMMSS_hello_world.log
+
+Manual
+--------------
+
+### RBatch home directory
+
+When you set ${RB_HOME} environment variable, RBatch home directory is fix at ${RB_HOME}.
+
+When you do NOT set ${RB_HOME}, ${RB_HOME} is the parent directory of the directory which script is located at. In other words, default of ${RB_HOME} is "(script path)/../" .
+
+### Directory Structure and Naming Convention
 
 RBach has convention of file naming and directorory structure.
 
-If you make "${RB_HOME}/bin/hoge.rb", you should name config file to "${RB_HOME}/conf/hoge.yaml". And the name of log file is decided on "${RB_HOME}/log/YYYYMMDD_HHMMSS_hoge.rb"
+If you make a script on "${RB_HOME}/bin/hoge.rb", script's config file is "${RB_HOME}/conf/hoge.yaml" , and log file is "${RB_HOME}/log/YYYYMMDD_HHMMSS_hoge.rb".
 
 For example
 ```
 ${RB_HOME}/         <--- RBatch home
+ |
+ |-.rbatchrc      <--- RBatch Run Conf
+ |
  |-bin            <--- Scripts
  |  |- A.rb
  |  |- B.rb
@@ -36,20 +57,12 @@ ${RB_HOME}/         <--- RBatch home
  |-conf           <--- Configuration files
  |  |- A.yaml
  |  |- B.yaml
- |  |- rbatch.yaml  <--- RBatch global config
  |
  |-log            <--- Log files
     |- YYYYMMDD_HHMMSS_A.log
     |- YYYYMMDD_HHMMSS_B.log
 ```
 
-### RBatch home directory
-
-When you set ${RB_HOME} environment variable, RBatch home directory is fix.
-
-When you do NOT set ${RB_HOME}, ${RB_HOME} is the parent directory of the directory which script is located at. In other words, default of ${RB_HOME} is "(script path)/../" .
-
-
 ### Auto Logging
 
 Use "Auto Logging block", RBatch automatically writes to logfile.
@@ -86,13 +99,10 @@ logfile : ${RB_HOME}/log/20121020_005953_sample1.log
 
 By using "log_send_mail" option, when an error occurs in script, RBatch sends an error-mail automatically. 
 
-
 ### Auto Config Reading
 
 By using RBatch, your script read a configuration file easily.
-First you make configuration file which is named "(script base name).yaml" ,
-Then, put it to ${RB_HOME}/conf/ .
-So your script read it automatically.
+If you make configuration file which is located ${RB_HOME}/conf/"(program base name).yaml", this file is read automatically.
 
 sample
 
@@ -141,54 +151,53 @@ p r.status
 
 ### Double Run Check
 
-Using "forbid_double_run" option, you forbit double run of the RBatch script.
-
+Using "forbid_double_run: true" option, two same name scripts cannot run at the same time. 
 
-Quick Start
+Customize
 --------------
+If you want to customize RBatch, you have two methods.
 
-    $ sudo gem install rbatch
-    $ rbatch-init    # => make directories and sample scripts
-    $ ruby bin/hello_world.rb
-    $ cat log/YYYYMMDD_HHMMSS_hello_world.log
+(1) Write Run-Conf (${RB_HOME}/.rbatchrc).
+(2) Pass an option object to constructor in your script.
 
-Option
---------------
-
-The optional designated way has following two in RBatch.
-
-1. Global configuration file (conf/rbatch.yaml)
-2. Argument of the constructer
-
-If you write an option to the global configuration file, all scripts are effective. On the other hand, if you set it in the argument of the constructer, there is an effect in only the instance.
+When an option is set in both (1) and (2), (2) is prior to (1).
 
-When the same option is set, the argument of the constructer is given priority to over the global configuration.
+#### Customize by writing Run-Conf (.rbatchrc)
 
-The name of the key to global configuration file and the name of the key to constructer option have correspondency. The key name in global configuration file is "(class name)_(key name)".
+If you make a follow config file, configurations effect to all scripts.
 
-#### Set by Grobal Configuration File
-
-If you make follow config file, option value effect to all scripts.
-
-```
-${RB_HOME}/conf/rbatch.yaml
-```
+    ${RB_HOME}/.rbatchrc
 
-Config Sample
+Run-Conf Sample
 ```
-# RBatch Common Config
+# RBatch Run-Conf (.rbatchrc)
 #
-#   This file format is YAML.
+#   This format is YAML.
 #
 
 # -------------------
 # Global setting
 # -------------------
 
+# Conf Directory
+#
+#   Default is "<home>/conf"
+#
+#   <home> is replaced to ${RB_HOME}
+#
+#conf_dir: <home>/config
+#conf_dir: /etc/rbatch/
+
+# Common config file name
+#
+#   Default is "common.yaml"
+#
+#common_conf_name: share.yaml
+
 # Forbit Script Double Run
 #
 #   Default is false.
-#   If this option is true, two same script cannot start at the same time. 
+#   If this option is true, two same name scripts cannot run at the same time. 
 #
 #forbid_double_run: true
 #forbid_double_run: false
@@ -205,29 +214,37 @@ Config Sample
 #cmd_raise : true
 #cmd_raise : false
 
+# Command Timeout
+#
+#   Default is 0 [sec].
+#
+#cmd_timeout: 5
 
 # -------------------
 # Log setting
 # -------------------
 
+# Log Directory
+#
+#   Default is "<home>/log"
+#
+#   <home> is replaced to ${RB_HOME}
+#
+#log_dir: <home>/rb_log
+#log_dir: /var/log/rbatch/
+
 # Log File Name
 #
 #   Default is "<date>_<time>_<prog>.log".
 #   Reservation words are follows.
-#   <data> --> Replace to YYYYMMDD date string
-#   <time> --> Replace to HHMMSS time string
-#   <prog> --> Replace to Program file base name (except extention).
-#   <host> --> Replace to Hostname.
+#   <data> is replaced to YYYYMMDD date string
+#   <time> is replaced to HHMMSS time string
+#   <prog> is replaced to Program file base name (except extention).
+#   <host> is replaced to Hostname.
 #
 #log_name : "<date>_<time>_<prog>.log"
 #log_name : "<date>_<prog>.log"
 
-# Log Output Directory
-#
-#   Default is "${RB_HOME}/log".
-#
-#log_dir : "/tmp/log"
-
 # Append log or not
 #
 #   Default is ture.
@@ -246,7 +263,7 @@ Config Sample
 #log_level : "error"
 #log_level : "fatal"
 
-# Print log-string both file and STDOUT
+# Print log string both file and STDOUT
 #
 #   Default is false.
 #
@@ -276,7 +293,7 @@ Config Sample
 #
 #log_send_mail : true
 
-# Send mail parameters
+# Mail parameters
 #
 #log_mail_to   : "xxx@sample.com"
 #log_mail_from : "xxx@sample.com"
@@ -285,16 +302,15 @@ Config Sample
 
 ```
 
-### Set by argument of the constracter
+### Customize by passing option object to constructor
 
 If you want to set options in a script, you hand an argument of options to a constructor.
 
 #### class RBatch::Log 
 
-    RBatch::Log.new(opt = nil)
     opt = {
           :name      => "<date>_<time>_<prog>.log",
-          :dir       => "/var/log/",
+          :dir       => "/var/log",
           :append    => true,
           :level     => "info",
           :stdout    => false,
@@ -307,10 +323,19 @@ If you want to set options in a script, you hand an argument of options to a con
           :mail_server_port => 25
     }
 
+    RBatch::Log.new(opt)
+
 #### class RBatch::Cmd
 
-    RBatch::Log.new(cmd_str, opt = nil)
     opt = {
           :raise     => false,
           :timeout   => 0
           }
+
+    RBatch::Log.new(cmd_str, opt)
+
+
+Migration from version 1 to version 2
+--------------
+
+Move "${RB_HOME}/conf/rbatch.yaml" to "${RB_HOME}/.rbatchrc" .

data/Rakefile

@@ -1,32 +1,3 @@
 require "bundler/gem_tasks"
-
-desc "Test lib/ by using test/cases/test_*.rb"
-task :test do
-  result = 0
-  cases = FileList["test/cases/*.rb"]
-  cases.each do | c |
-    cmd_str="ruby -I lib #{c}"
-    stdout_file = Tempfile::new("rbatch_tmpout",".")
-    stderr_file = Tempfile::new("rbatch_tmperr",".")
-    pid = spawn(cmd_str,:out => [stdout_file,"w"],:err => [stderr_file,"w"])
-    status =  Process.waitpid2(pid)[1] >> 8
-    puts ""
-    puts "> " + cmd_str
-    puts "------------------------------"
-    puts File.read(stdout_file)
-    puts "------------------------------"
-    if status != 0
-      result = 1
-    end
-  end
-  if result == 0
-    puts "\nTest Success \n"
-  else
-    puts "\nTest Failed \n"
-    exit 1
-  end
-end
-
-
-desc "Test, Make RDoc, Release"
-task :all => [:test, :rdoc, :release]
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)