rbatch 1.11.0 → 1.12.0

data/CHANGELOG

@@ -52,4 +52,9 @@ initial
 
 1.11.0(2013/02/24)
 ----
-* support MAC environment (change handling of the environment variable about hostname and temporary directory)
+* support MAC environment (change handling of the environment variable about hostname and temporary directory)
+
+1.12.0(2013/11/19)
+----
+* add Common Config Function
+* document enhance

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 fetaro@gmail.com
+
+MIT License
+
+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

@@ -11,22 +11,50 @@ RBatchについて
 主な機能は以下のとおり。 
 
 * 自動ログ出力
+* 自動メール送信
 * 自動設定ファイル読み込み
 * 外部コマンド実行 
-* ファイル名・ディレクトリ構造制約
 * 二重起動チェック
 
-このフレームワークはRuby 1.9.x以降で動作します。また、Rubyプラットフォームは"linux","mswin","mingw","cygwin"で動作します。
+注意：このフレームワークはRuby 1.9.x以降で動作します。また、Rubyプラットフォームは"linux","mswin","mingw","cygwin"で動作します。
+
+### はじめに
+
+RBatchでは、実行スクリプト、設定ファイルおよびログファイルについて、
+配置場所および命名規則が規約で決まっています。
+
+具体的には、"bin/hoge.rb"というバッチスクリプトでは、"conf/hoge.yaml"という設定ファイルを読み、
+"log/YYYYMMDD_HHMMSS_hoge.rb"というログを出力するという規則です。
+
+例を示すと以下の通りです。
+
+```
+$RB_HOME
+ |-bin             ←実行スクリプト配置場所
+ |  |- A.rb
+ |  |- B.rb
+ |
+ |-conf            ←設定ファイル配置場所
+ |  |- A.yaml
+ |  |- B.yaml
+ |  |- rbatch.yaml ←RBatch全体設定ファイル
+ |
+ |-log             ←ログ出力場所
+    |- YYYYMMDD_HHMMSS_A.log
+    |- YYYYMMDD_HHMMSS_B.log
+```
+
+注意：$RB_HOMEは環境変数として定義する必要はありません。$RB_HOMEは"(実行するスクリプトのパス)/../"として定義されています
 
 ### 自動ログ出力
+
 Logging blockを使うことで、自動的にログファイルに出力することができます。
-ログファイルはデフォルトで"../log/YYYYMMDD_HHMMSS_${PROG_NAME}.log"に出力されます。
+ログファイルはデフォルトで"$RB_HOME/log/YYYYMMDD_HHMMSS_${PROG_NAME}.log"に出力されます。
 例外が発生した場合でも、ログにスタックトレースを出力することができます。
-また、エラーが発生した場合に自動でメールを送信することもできます。
 
 サンプル
 
-スクリプト : ./bin/sample1.rb
+スクリプト : $RB_HOME/bin/sample1.rb
 ```
 require 'rbatch'
 
@@ -37,7 +65,7 @@ RBatch::Log.new(){ |log|  # Logging block
 }
 ```
 
-ログファイル : ./log/20121020_005953_sample1.log
+ログファイル : $RB_HOME/log/20121020_005953_sample1.log
 ```
 # Logfile created on 2012-10-20 00:59:53 +0900 by logger.rb/25413
 [2012-10-20 00:59:53 +900] [INFO ] info string
@@ -50,6 +78,10 @@ RBatch::Log.new(){ |log|  # Logging block
     [backtrace] test.rb:3:in `<main>'
 ```
 
+### 自動メール送信
+
+"log_send_mail"オプションを使う事により、スクリプトでエラーが発生した場合に、自動でメールを送信することができます。
+
 ### 自動設定ファイル読み込み
 
 RBatchは簡単にデフォルトの位置の設定ファイルを読み込めます。
@@ -57,7 +89,7 @@ RBatchは簡単にデフォルトの位置の設定ファイルを読み込め
 
 サンプル
 
-設定ファイル : ./conf/sample2.yaml
+設定ファイル : $RB_HOME/conf/sample2.yaml
 ```
 key: value
 array:
@@ -66,7 +98,7 @@ array:
  - item3
 ```
 
-スクリプト : ./bin/sample2.rb
+スクリプト : $RB_HOME/bin/sample2.rb
 ```
 require 'rbatch'
 p RBatch::config
@@ -96,28 +128,6 @@ p r.status
 => 0
 ```
 
-### ファイル名・ディレクトリ構造制約
-
-RBatchでは、「設定より規約」(convention over configuration)という原則に従い、バッチスクリプトで必要になるファイル群に、ファイル名とディレクトリ構造の制約をもたせます。
-
-具体的には、"bin/hoge.rb"というバッチスクリプトでは、"conf/hoge.yaml"という設定ファイルを読み、
-"log/YYYYMMDD_HHMMSS_hoge.rb"というログを出力するという規則です。
-
-これにより、バッチスクリプトの可読性・保守性が向上します。
-
-```
-./
- |-bin
- |  |- hoge.rb
- |  |- bar.rb
- |-conf
- |  |- hoge.yaml
- |  |- bar.yaml
- |-log
-    |- YYYYMMDD_HHMMSS_hoge.log
-    |- YYYYMMDD_HHMMSS_bar.log
-```
-
 ### 二重起動チェック
 
 RBatchの共通設定ファイルに"forbid_double_run: true"の設定を書けば、RBatchを利用したスクリプトの二重起動チェックができます。
@@ -136,7 +146,7 @@ RBatchの共通設定ファイルに"forbid_double_run: true"の設定を書け
 
 RBatchではオプションの指定の仕方は以下の二つがあります。
 
-1. 全体設定ファイル(conf/rbatch.yaml)に書く
+1. 全体設定ファイル($RB_HOME/conf/rbatch.yaml)に書く
 2. コンストラクタの引数に指定する
 
 全体設定ファイルにオプションを書くと、全てのスクリプトに効果がありますが、コンストラクタの引数に指定した場合はそのインスタンスのみ効果があります。
@@ -151,7 +161,7 @@ RBatchではオプションの指定の仕方は以下の二つがあります
 以下の場所にRBatch全体設定ファイルを配置すると、全てのスクリプトにてオプションが適用されます。
 
 
-    (スクリプトのパス)/../conf/rbatch.yaml
+     $RB_HOME/conf/rbatch.yaml
 
 
 設定ファイルのサンプルは以下の通り

data/README.md

@@ -5,27 +5,54 @@ RBatch:Ruby-base Simple Batch Framework
 
 About RBatch
 --------------
-This is a Ruby-base Batch Script Framework. RBatch offer a convenient function as a framework, when you write a batch script such as "data backup script" or "proccess start script".
+This is Ruby-base Batch Script Framework. RBatch offers convenient functions, when you write batch scripts such as "data backup script" or "proccess starting script".
 
 There are following functions. 
 
 * Auto Logging
+* Auto Mail Sending
 * Auto Config Reading
 * External Command Wrapper 
-* Directory Structure convention
 * Double Run Check
 
-This work on Ruby 1.9.x or later, and on Ruby platform of "linux","mswin","mingw","cygwin".
+
+Note: RBatch works on Ruby 1.9.x or later, and on Ruby platform of "linux","mswin","mingw","cygwin".
+
+### First
+
+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"
+
+For example
+```
+$RB_HOME/         <--- RBatch home
+ |-bin            <--- Scripts
+ |  |- A.rb
+ |  |- B.rb
+ |
+ |-conf           <--- Configuration files
+ |  |- A.yaml
+ |  |- B.yaml
+ |  |- rbatch.yaml  <--- RBatch global config
+ |
+ |-log            <--- Log files
+    |- YYYYMMDD_HHMMSS_A.log
+    |- YYYYMMDD_HHMMSS_B.log
+```
+
+Note: It is not necessary to define $RB_HOME as an environment variable. $RB_HOME is defined as "(running script path)/../"
+
 
 ### Auto Logging
-Use Auto Logging block, RBatch automatically write to logfile.
-Log file default location is "(script file path)/../log/YYYYMMDD_HHMMSS_${PROG_NAME}.log" .
-If exception occuerd, then RBatch write stack trace to logfile.
-When an error occurs, there is also a function to send an error by e-mail automatically. 
+
+Use "Auto Logging block", RBatch automatically writes to logfile.
+The default location of log file is $RB_HOME/log/YYYYMMDD_HHMMSS_${PROG_NAME}.log .
+If an exception occuerd, then RBatch write a stack trace to logfile.
 
 sample
 
-script : ./bin/sample1.rb
+script : $RB_HOME/bin/sample1.rb
 ```
 require 'rbatch'
 
@@ -36,7 +63,7 @@ RBatch::Log.new(){ |log|  # Logging block
 }
 ```
 
-logfile : ./log/20121020_005953_sample1.log
+logfile : $RB_HOME/log/20121020_005953_sample1.log
 ```
 # Logfile created on 2012-10-20 00:59:53 +0900 by logger.rb/25413
 [2012-10-20 00:59:53 +900] [INFO ] info string
@@ -49,13 +76,21 @@ logfile : ./log/20121020_005953_sample1.log
     [backtrace] test.rb:3:in `<main>'
 ```
 
+### Auto Mail Sending
+
+By using "log_send_mail" option, when an error occurs in script, RBatch sends an error-mail automatically. 
+
+
 ### Auto Config Reading
 
-RBatch easy to read config file (located on "(script file path)/../conf/${PROG_NAME}.yaml")
+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.
 
 sample
 
-config : ./conf/sample2.yaml
+config : $RB_HOME/conf/sample2.yaml
 ```
 key: value
 array:
@@ -64,7 +99,7 @@ array:
  - item3
 ```
 
-script : ./bin/sample2.rb
+script : $RB_HOME/bin/sample2.rb
 ```
 require 'rbatch'
 p RBatch::config
@@ -77,7 +112,11 @@ p RBatch::config["not_exist"]
 => Raise Exception
 ```
 
+If you can use common configuration file which is read from all scripts,
+you make "$RB_HOME/conf/common.yaml" .
+
 ### External Command Wrapper 
+
 RBatch provide a function which wrap external command (such as 'ls').
 
 This function return a result object which contain command's STDOUT, STDERR ,and exit status.
@@ -94,30 +133,10 @@ p r.status
 => 0
 ```
 
-### Directory Structure Convention
-
-Follow the axiom of "convention over configuration", RBatch restrict file naming rule and directory structure.
-
-For exsample, If you make "bin/hoge.rb", you should name config file to "conf/hoge.yaml". And the name of log file is decided on "log/YYYYMMDD_HHMMSS_hoge.rb"
-
-In this way, maintainability and readability of batch script get higher.
-
-```
-./
- |-bin
- |  |- hoge.rb
- |  |- bar.rb
- |-conf
- |  |- hoge.yaml
- |  |- bar.yaml
- |-log
-    |- YYYYMMDD_HHMMSS_hoge.log
-    |- YYYYMMDD_HHMMSS_bar.log
-```
-
 ### Double Run Check
 
-Forbit double run of the RBatch script by writing option "forbid_double_run: true" to the common configuration file.
+Using "forbid_double_run" option, you forbit double run of the RBatch script.
+
 
 Quick Start
 --------------
@@ -146,7 +165,7 @@ The name of the key to global configuration file and the name of the key to cons
 If you make follow config file, option value effect to all scripts.
 
 ```
-(script file path)/../conf/rbatch.yaml
+$RB_HOME/conf/rbatch.yaml
 ```
 
 Config Sample

data/doc/rdoc/RBatch/Cmd.html

@@ -245,9 +245,9 @@ is 0 sec ( 0 means disable) .
 52:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">opt</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>  <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">opt</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>
 53:           <span class="ruby-comment cmt"># use argument</span>
 54:           <span class="ruby-ivar">@opt</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">opt</span>[<span class="ruby-identifier">key</span>]
-55:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>            <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config</span>[<span class="ruby-value str">&quot;cmd_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>
+55:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>            <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config</span>[<span class="ruby-value str">&quot;cmd_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>
 56:           <span class="ruby-comment cmt"># use config</span>
-57:           <span class="ruby-ivar">@opt</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config</span>[<span class="ruby-value str">&quot;cmd_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>]
+57:           <span class="ruby-ivar">@opt</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config</span>[<span class="ruby-value str">&quot;cmd_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>]
 58:         <span class="ruby-keyword kw">else</span>
 59:           <span class="ruby-comment cmt"># use default</span>
 60:         <span class="ruby-keyword kw">end</span>

data/doc/rdoc/RBatch/Log.html

@@ -288,9 +288,9 @@ is true.
 100:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">opt</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>  <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">opt</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>
 101:           <span class="ruby-comment cmt"># use argument</span>
 102:           <span class="ruby-ivar">@opt</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">opt</span>[<span class="ruby-identifier">key</span>]
-103:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>            <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config</span>[<span class="ruby-value str">&quot;log_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>
+103:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>            <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config</span>[<span class="ruby-value str">&quot;log_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span>
 104:           <span class="ruby-comment cmt"># use config</span>
-105:           <span class="ruby-ivar">@opt</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config</span>[<span class="ruby-value str">&quot;log_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>]
+105:           <span class="ruby-ivar">@opt</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config</span>[<span class="ruby-value str">&quot;log_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>]
 106:         <span class="ruby-keyword kw">else</span>
 107:           <span class="ruby-comment cmt"># use default</span>
 108:         <span class="ruby-keyword kw">end</span>

data/doc/rdoc/RBatch.html

@@ -90,9 +90,9 @@
 					
 					<li><a href="#method-i-cmd">#cmd</a></li>
 					
-					<li><a href="#method-i-common_config">#common_config</a></li>
+					<li><a href="#method-i-rbatch_config">#rbatch_config</a></li>
 					
-					<li><a href="#method-i-common_config_path">#common_config_path</a></li>
+					<li><a href="#method-i-rbatch_config_path">#rbatch_config_path</a></li>
 					
 					<li><a href="#method-i-config">#config</a></li>
 					
@@ -224,11 +224,11 @@ shortcut of <a href="RBatch/Cmd.html">RBatch::Cmd</a>
 
 		
 			<div id="common-config-method" class="method-detail ">
-				<a name="method-i-common_config"></a>
+				<a name="method-i-rbatch_config"></a>
 
 				<div class="method-heading">
 				
-					<span class="method-name">common_config</span><span
+					<span class="method-name">rbatch_config</span><span
 						class="method-args">()</span>
 					<span class="method-click-advice">click to toggle source</span>
 				
@@ -244,9 +244,9 @@ shortcut of <a href="RBatch/Cmd.html">RBatch::Cmd</a>
 						id="common-config-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/rbatch.rb, line 21</span>
-21:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">common_config</span>
-22:     <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config_path</span>)
-23:       <span class="ruby-identifier">yaml</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">common_config_path</span>)
+21:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rbatch_config</span>
+22:     <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config_path</span>)
+23:       <span class="ruby-identifier">yaml</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">rbatch_config_path</span>)
 24:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">yaml</span>
 25:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">yaml</span>
 26:       <span class="ruby-keyword kw">else</span>
@@ -268,11 +268,11 @@ shortcut of <a href="RBatch/Cmd.html">RBatch::Cmd</a>
 
 		
 			<div id="common-config-path-method" class="method-detail ">
-				<a name="method-i-common_config_path"></a>
+				<a name="method-i-rbatch_config_path"></a>
 
 				<div class="method-heading">
 				
-					<span class="method-name">common_config_path</span><span
+					<span class="method-name">rbatch_config_path</span><span
 						class="method-args">()</span>
 					<span class="method-click-advice">click to toggle source</span>
 				
@@ -288,7 +288,7 @@ shortcut of <a href="RBatch/Cmd.html">RBatch::Cmd</a>
 						id="common-config-path-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/rbatch.rb, line 18</span>
-18:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">common_config_path</span>
+18:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rbatch_config_path</span>
 19:     <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-constant">RBatch</span>.<span class="ruby-identifier">program_name</span>),<span class="ruby-value str">&quot;..&quot;</span>,<span class="ruby-value str">&quot;conf&quot;</span>,<span class="ruby-value str">&quot;rbatch.yaml&quot;</span>)
 20:   <span class="ruby-keyword kw">end</span></pre>
 					</div>
@@ -358,7 +358,7 @@ Alias of RBatch::Config.new
     <span class="ruby-comment cmt"># File lib/rbatch.rb, line 34</span>
 34:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">double_run_check</span>
 35:     <span class="ruby-comment cmt"># double run check</span>
-36:     <span class="ruby-keyword kw">if</span> ( <span class="ruby-constant">RBatch</span><span class="ruby-operator">::</span><span class="ruby-identifier">common_config</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RBatch</span><span class="ruby-operator">::</span><span class="ruby-identifier">common_config</span>[<span class="ruby-value str">&quot;forbid_double_run&quot;</span>] )
+36:     <span class="ruby-keyword kw">if</span> ( <span class="ruby-constant">RBatch</span><span class="ruby-operator">::</span><span class="ruby-identifier">rbatch_config</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RBatch</span><span class="ruby-operator">::</span><span class="ruby-identifier">rbatch_config</span>[<span class="ruby-value str">&quot;forbid_double_run&quot;</span>] )
 37:       <span class="ruby-identifier">lock_file</span>=<span class="ruby-value str">&quot;rbatch_lock_&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">@@program_name</span>)
 38:       <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">exists?</span> <span class="ruby-constant">RBatch</span><span class="ruby-operator">::</span><span class="ruby-identifier">tmp_dir</span>
 39:         <span class="ruby-constant">Dir</span><span class="ruby-operator">::</span><span class="ruby-identifier">foreach</span>(<span class="ruby-constant">RBatch</span><span class="ruby-operator">::</span><span class="ruby-identifier">tmp_dir</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>

data/doc/rdoc/index.html

@@ -81,9 +81,9 @@
 		
 			<li><a href="RBatch/CmdResult.html#method-i-cmd_str">#cmd_str &mdash; RBatch::CmdResult</a></li>
 		
-			<li><a href="RBatch.html#method-i-common_config">#common_config &mdash; RBatch</a></li>
+			<li><a href="RBatch.html#method-i-rbatch_config">#rbatch_config &mdash; RBatch</a></li>
 		
-			<li><a href="RBatch.html#method-i-common_config_path">#common_config_path &mdash; RBatch</a></li>
+			<li><a href="RBatch.html#method-i-rbatch_config_path">#rbatch_config_path &mdash; RBatch</a></li>
 		
 			<li><a href="RBatch.html#method-i-config">#config &mdash; RBatch</a></li>
 		

data/lib/rbatch/cmd.rb

@@ -52,10 +52,10 @@ module RBatch
         if opt != nil  && opt[key] != nil
           # use argument
           @opt[key] = opt[key]
-        elsif RBatch.common_config != nil \
-          && RBatch.common_config["cmd_" + key.to_s] != nil
+        elsif RBatch.rbatch_config != nil \
+          && RBatch.rbatch_config["cmd_" + key.to_s] != nil
           # use config
-          @opt[key] = RBatch.common_config["cmd_" + key.to_s]
+          @opt[key] = RBatch.rbatch_config["cmd_" + key.to_s]
         else
           # use default
         end

data/lib/rbatch/common_config.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+require 'pathname'
+
+module RBatch
+
+  module_function
+
+  # Alias of RBatch::CommonConfig.new
+  def common_config ; CommonConfig.new end
+
+  # Read common config file and return hash opject.
+  #
+  # Default common config file path is "../conf/common.yaml"
+  # ==== Sample
+  # config : ./conf/common.yaml
+  #  key: value
+  #  array:
+  #   - item1
+  #   - item2
+  #   - item3
+  # script : ./bin/sample.rb
+  #  require 'rbatch'
+  #  p RBatch::common_config
+  #  => {"key" => "value", "array" => ["item1", "item2", "item3"]}
+  class CommonConfig
+    @path
+    @config
+    def initialize
+      file = "common.yaml"
+      dir = File.join(File.join(File.dirname(RBatch.program_name),".."),"conf")
+      @path = File.join(dir,file)
+      @config = YAML::load_file(@path)
+    end
+    def[](key)
+      raise RBatch::CommonConfig::Exception, "Value of key=\"#{key}\" is nil" if @config[key].nil?
+      @config[key]
+    end
+    def path ; @path ; end
+    def to_s ; @config.to_s ;end
+  end
+
+  class RBatch::CommonConfig::Exception < Exception; end
+end
+

data/lib/rbatch/log.rb

@@ -100,10 +100,10 @@ module RBatch
         if opt != nil  && opt[key] != nil
           # use argument
           @opt[key] = opt[key]
-        elsif RBatch.common_config != nil \
-          && RBatch.common_config["log_" + key.to_s] != nil
+        elsif RBatch.rbatch_config != nil \
+          && RBatch.rbatch_config["log_" + key.to_s] != nil
           # use config
-          @opt[key] = RBatch.common_config["log_" + key.to_s]
+          @opt[key] = RBatch.rbatch_config["log_" + key.to_s]
         else
           # use default
         end

data/lib/rbatch/version.rb

@@ -1,3 +1,3 @@
 module Rbatch
-  VERSION = "1.11.0"
+  VERSION = "1.12.0"
 end

data/lib/rbatch.rb

@@ -35,12 +35,12 @@ module RBatch
       end
     end
   end
-  def common_config_path
+  def rbatch_config_path
     File.join(File.dirname(RBatch.program_name),"..","conf","rbatch.yaml")
   end
-  def common_config
-    if File.exist?(RBatch.common_config_path)
-      yaml = YAML::load_file(RBatch.common_config_path)
+  def rbatch_config
+    if File.exist?(RBatch.rbatch_config_path)
+      yaml = YAML::load_file(RBatch.rbatch_config_path)
       if yaml
         return yaml
       else
@@ -53,7 +53,7 @@ module RBatch
   end
   def double_run_check
     # double run check
-    if ( RBatch::common_config != nil && RBatch::common_config["forbid_double_run"] )
+    if ( RBatch::rbatch_config != nil && RBatch::rbatch_config["forbid_double_run"] )
       lock_file="rbatch_lock_" + Digest::MD5.hexdigest(@@program_name)
       if Dir.exists? RBatch::tmp_dir
         Dir::foreach(RBatch::tmp_dir) do |f|
@@ -76,6 +76,7 @@ class RBatchException < Exception ; end
 # main
 require 'rbatch/log'
 require 'rbatch/config'
+require 'rbatch/common_config'
 require 'rbatch/cmd'
 
 RBatch::double_run_check

data/test/cases/test_cmd.rb

@@ -6,7 +6,7 @@ class RuncherTest < Test::Unit::TestCase
     @config_dir =  File.join(File.dirname(RBatch.program_name), "..", "conf")
     Dir::mkdir(@config_dir) if ! Dir.exists? @config_dir
     confstr = ""
-    open( RBatch.common_config_path  , "w" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "w" ){|f| f.write(confstr)}
   end
 
   def test_cmd_exists
@@ -104,7 +104,7 @@ class RuncherTest < Test::Unit::TestCase
   end
   def test_opt_raise_true_status_1_by_conf
     confstr = "cmd_raise: true "
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     cmd_str = "ruby -e 'STDOUT.print 1; STDERR.print 2; exit 1;'"
     assert_raise(RBatch::CmdException){
       RBatch::Cmd.new(cmd_str).run

data/test/cases/test_common_config.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require 'rbatch'
+
+class RuncherTest < Test::Unit::TestCase
+  def setup
+    @config_dir =  File.join(File.dirname(RBatch.program_name), "..", "conf")
+    @config_file = File.join(@config_dir,"common.yaml")
+    Dir::mkdir(@config_dir) if ! Dir.exists? @config_dir
+  end
+
+  def teardown
+    File.delete @config_file if File.exist? @config_file
+  end
+
+  def test_require
+  end
+
+  def test_config
+    open( @config_file  , "w" ){|f| f.write("key: value")}
+    assert_equal "value",  RBatch.common_config["key"]
+  end
+
+  def test_read_error
+    assert_raise(Errno::ENOENT){
+      RBatch.common_config
+    }
+  end
+
+  def test_double_read
+    open( @config_file  , "w" ){|f| f.write("key: value")}
+    assert_equal "value",  RBatch.common_config["key"]
+    assert_equal "value",  RBatch.common_config["key"]
+  end
+
+  def test_not_exist_key
+    open( @config_file  , "w" ){|f| f.write("key: value")}
+    assert_raise(RBatch::CommonConfig::Exception){
+      RBatch.common_config["not_exist"]
+    }
+  end
+end

data/test/cases/test_log.rb

@@ -13,12 +13,12 @@ class LoggerTest < Test::Unit::TestCase
 #    RBatch::Log.verbose = true
     # set STDOUT Logger stop
     confstr = "log_quiet: true\n"
-    open( RBatch.common_config_path  , "w" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "w" ){|f| f.write(confstr)}
 
   end
 
   def teardown
-    File::delete(RBatch.common_config_path) if File.exists?(RBatch.common_config_path)
+    File::delete(RBatch.rbatch_config_path) if File.exists?(RBatch.rbatch_config_path)
     if Dir.exists? @dir
       Dir::foreach(@dir) do |f|
         File::delete(File.join(@dir , f)) if ! (/\.+$/ =~ f)
@@ -84,7 +84,7 @@ class LoggerTest < Test::Unit::TestCase
 
   def test_change_name_by_config
     confstr = "log_name: name1"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     RBatch::Log.new({:name => "name1.log" }) do | log |
       log.info("test_change_name_by_config")
     end
@@ -109,7 +109,7 @@ class LoggerTest < Test::Unit::TestCase
 
   def test_change_log_dir_by_config
     confstr = "log_dir: " + @dir2
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     RBatch::Log.new({:output_dir=> @dir2 }) do | log |
       log.info("test_change_log_dir_by_config")
     end
@@ -135,7 +135,7 @@ class LoggerTest < Test::Unit::TestCase
 
   def test_opt_overwite_config
     confstr = "log_name: " + "name1"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     RBatch::Log.new({:name => "name2" }) do | log |
       log.info("test_opt_overwite_config")
     end
@@ -175,7 +175,7 @@ class LoggerTest < Test::Unit::TestCase
 
   def test_append_by_conf
     confstr = "log_append: true"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
 
     RBatch::Log.new({:name =>  "test_append" }) do | log |
       log.info("test_append1")
@@ -192,7 +192,7 @@ class LoggerTest < Test::Unit::TestCase
 
   def test_no_append_by_conf
     confstr = "log_append: false"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
 
     RBatch::Log.new({ :name =>  "test_append" }) do | log |
       log.info("test_append1")
@@ -318,7 +318,7 @@ class LoggerTest < Test::Unit::TestCase
 
   def test_log_level_debug_by_conf
     confstr = "log_level: debug"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
 
     RBatch::Log.new({ :name =>  "test_level" }) do | log |
       log.debug("test_debug")
@@ -339,7 +339,7 @@ class LoggerTest < Test::Unit::TestCase
 
  def test_log_level_info_by_conf
     confstr = "log_level: info"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     RBatch::Log.new({ :name =>  "test_level" }) do | log |
       log.debug("test_debug")
       log.info("test_info")
@@ -359,7 +359,7 @@ class LoggerTest < Test::Unit::TestCase
 
  def test_log_level_warn_by_conf
     confstr = "log_level: warn"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     RBatch::Log.new({ :name =>  "test_level" }) do | log |
       log.debug("test_debug")
       log.info("test_info")
@@ -379,7 +379,7 @@ class LoggerTest < Test::Unit::TestCase
 
  def test_log_level_error_by_conf
     confstr = "log_level: error"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     RBatch::Log.new({ :name =>  "test_level" }) do | log |
       log.debug("test_debug")
       log.info("test_info")
@@ -399,7 +399,7 @@ class LoggerTest < Test::Unit::TestCase
 
  def test_log_level_fatal_by_conf
     confstr = "log_level: fatal"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
     RBatch::Log.new({ :name =>  "test_level" }) do | log |
       log.debug("test_debug")
       log.info("test_info")
@@ -509,7 +509,7 @@ class LoggerTest < Test::Unit::TestCase
 
   def test_i_log_level_debug_by_conf
     confstr = "log_level: debug"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
 
     log = RBatch::Log.new({ :name =>  "test_level" })
     log.debug("test_debug")
@@ -544,7 +544,7 @@ class LoggerTest < Test::Unit::TestCase
   end
   def test_delete_old_log_by_config
     confstr = "log_delete_old_log: true"
-    open( RBatch.common_config_path  , "a" ){|f| f.write(confstr)}
+    open( RBatch.rbatch_config_path  , "a" ){|f| f.write(confstr)}
 
     loglist = [*0..20].map do |day|
       File.join(@dir , (Date.today - day).strftime("%Y%m%d") + "_test_delete.log")

metadata

@@ -2,7 +2,7 @@
 name: rbatch
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors: 
 - fetaro
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-23 00:00:00 Z
+date: 2013-11-18 00:00:00 Z
 dependencies: []
 
 description: Ruby-based simple batch framework
@@ -27,7 +27,7 @@ files:
 - CHANGELOG
 - Gemfile
 - HOW_TO_TEST.md
-- LICENSE
+- LICENSE.txt
 - README.ja.md
 - README.md
 - Rakefile
@@ -75,6 +75,7 @@ files:
 - doc/rdoc/rdoc.css
 - lib/rbatch.rb
 - lib/rbatch/cmd.rb
+- lib/rbatch/common_config.rb
 - lib/rbatch/config.rb
 - lib/rbatch/log.rb
 - lib/rbatch/version.rb
@@ -104,6 +105,7 @@ files:
 - sample/data/amAuthentication.error.2012-07-10
 - sample/log/empty
 - test/cases/test_cmd.rb
+- test/cases/test_common_config.rb
 - test/cases/test_config.rb
 - test/cases/test_log.rb
 - test/mocks/PrintArgs.exe
@@ -137,6 +139,7 @@ specification_version: 3
 summary: Ruby-based simple batch framework
 test_files: 
 - test/cases/test_cmd.rb
+- test/cases/test_common_config.rb
 - test/cases/test_config.rb
 - test/cases/test_log.rb
 - test/mocks/PrintArgs.exe