rbatch 1.7.0 → 1.8.0

data/README.ja.md

@@ -5,7 +5,7 @@ RBatch:Ruby-base バッチスクリプトフレームワーク
 
 RBatchについて
 --------------
-これはRubyで書かれたバッチスクリプトのフレームワークです。
+これはRubyで書かれたシンプルなバッチスクリプトのフレームワークです。
 バッチスクリプト（バックアップやプロセスリロード等）を書く際に便利な機能をフレームワークとして提供しています。
 
 主な機能は以下のとおり。 
@@ -184,7 +184,7 @@ $ cat log/YYYYMMDD_HHMMSS_backup.log
 ```
 # RBatch 全体設定
 #
-# 設定ファイルの形式はYAML形式です
+#   設定ファイルの形式はYAML形式です
 #
 
 # -------------------
@@ -193,11 +193,11 @@ $ cat log/YYYYMMDD_HHMMSS_backup.log
 
 # スクリプトの二重起動を可能にするかどうか
 #
-# trueにすると、requireしたタイミングで例外を投げます。
-#
-#   Default : false
+#   デフォルト値はfalse。
+#   trueにすると、同じスクリプトは二つ同時に起動できなくなります。
 #
 #forbid_double_run: true
+#forbid_double_run: false
 
 # -------------------
 # 外部コマンド実行関連
@@ -205,11 +205,11 @@ $ cat log/YYYYMMDD_HHMMSS_backup.log
 
 # 例外発生機能を有効にするかどうか
 #
-#   Default : false
-#
-# trueの場合、コマンドの終了ステータスが0でない場合に例外を発生する。
+#   デフォルト値はfalse。
+#   trueの場合、コマンドの終了ステータスが0でない場合に例外を発生する。
 #
 #cmd_raise: true
+#cmd_raise: false
 
 # -------------------
 # ログ関連
@@ -217,9 +217,8 @@ $ cat log/YYYYMMDD_HHMMSS_backup.log
 
 # ログファイル名
 #
-#   Default : "<date>_<time>_<prog>.log"
-#
-#   予約語
+#   デフォルト値は"<date>_<time>_<prog>.log"。
+#   以下の文字列は予約語
 #   <data> --> YYYYMMDDの日付形式に置換されます
 #   <time> --> hhmmssの時刻形式に置換されます
 #   <prog> --> 拡張子を除いたファイル名に置換されます
@@ -229,46 +228,66 @@ $ cat log/YYYYMMDD_HHMMSS_backup.log
 
 # ログ出力ディレクトリ
 #
-#   Default : "(スクリプトの配置パス)/../log"
+#   デフォルト値は"(スクリプトの配置パス)/../log"。
 #
 #log_dir : "/tmp/log"
 
 # ログを追記するかどうか
 #
-#   Default : ture
+#   デフォルト値はture。
 #
+#log_append : true
 #log_append : false
 
 # ログレベル
 #
-#   Default : "info"
-#   Value   : "debug","info","wran","error","fatal"
+#   デフォルト値は"info"。
+#   設定できる値は"debug","info","wran","error","fatal"。
 #
 #log_level : "debug"
+#log_level : "info"
+#log_level : "warn"
+#log_level : "error"
+#log_level : "fatal"
 
 # 標準出力とログの両方に文字列を出力するかどうか
 #
-#   Default : false
+#   デフォルト値はfalse。
 #
 #log_stdout : true
+#log_stdout : false
 
 # 古いログを削除するかどうか
 #
-# trueの場合、RBatch::Log.newを呼んだタイミングで、古いログを削除する。
-# 削除対象のログは、そのRBatch::Logのインスタンスが出力するログファイルと
-# 同じファイル名フォーマットであり、かつログファイル名のフォーマットに<date>が
-# 含まれるもの。
-# 例えば、RBatch::Logで出力するログファイルが「20120105_hoge.log」だった場合、
-# 削除対象のログは「YYYYMMDD_hoge.log」のログとなる。
-#
-#   Default : false
+#   デフォルト値はfalse。
+#   trueの場合、RBatch::Log.newを呼んだタイミングで、古いログを削除する。
+#   削除対象のログは、そのRBatch::Logのインスタンスが出力するログファイルと
+#   同じファイル名フォーマットであり、かつログファイル名のフォーマットに<date>が
+#   含まれるもの。
+#   例えば、RBatch::Logで出力するログファイルが「20120105_hoge.log」だった場合、
+#   削除対象のログは「YYYYMMDD_hoge.log」のログとなる。
 #
 #log_delete_old_log: true
+#log_delete_old_log: false
 
 # 古いログの残す日数
 #
-#   Default : 7
+#   デフォルト値は 7
 #
 #log_delete_old_log_date: 14
 
+# メール送信するかどうか
+# 
+#   デフォルト値は false。
+#   log.error(msg)かlog.fatal(msg) を呼び出したときに,"msg"の内容をメールで送信する。
+#
+#send_mail : true
+
+# メール送信のパラメータ
+#
+#mail_to   : "xxx@sample.com"
+#mail_from : "xxx@sample.com"
+#mail_server_host : "localhost"
+#mail_server_port : 25
+
 ```

data/README.md

@@ -1,6 +1,6 @@
 [[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 Script Framework
+RBatch:Ruby-base Simple Batch Framework
 =============
 
 About RBatch
@@ -181,18 +181,20 @@ Config Sample
 ```
 # RBatch Common Config
 #
-# This file format is YAML
+#   This file format is YAML.
 #
 
 # -------------------
 # Global setting
 # -------------------
 
-# Forbit Double Run
+# Forbit Script Double Run
 #
-#   Default : false
+#   Default is false.
+#   If this option is true, two same script cannot start at the same time. 
 #
 #forbid_double_run: true
+#forbid_double_run: false
 
 # -------------------
 # Cmd setting
@@ -200,11 +202,11 @@ Config Sample
 
 # Raise Exception
 #
-#   Default : false
-#
-# If command exit status is not 0, raise exception.
+#   Default is false.
+#   If command exit status is not 0, raise exception.
 #
 #cmd_raise : true
+#cmd_raise : false
 
 
 # -------------------
@@ -213,9 +215,8 @@ Config Sample
 
 # Log File Name
 #
-#   Default : "<date>_<time>_<prog>.log"
-#
-#   Reservation words
+#   Default is "<date>_<time>_<prog>.log".
+#   Reservation words are follows.
 #   <data> --> replace to YYYYMMDD date string
 #   <time> --> replace to hhmmss time string
 #   <prog> --> Program file base name (except extention)
@@ -225,51 +226,64 @@ Config Sample
 
 # Log Output Directory
 #
-#   Default : "(Script path)/../log"
+#   Default is "(Script path)/../log".
 #
 #log_dir : "/tmp/log"
 
 # Append log or not
 #
-#   Default : ture
+#   Default is ture.
 #
+#log_append : true
 #log_append : false
 
 # Log Level
 #
-#   Default : "info"
-#   Value   : "debug","info","wran","error","fatal"
+#   Default is "info".
+#   Effective values are "debug","info","wran","error",and "fatal".
 #
 #log_level : "debug"
+#log_level : "info"
+#log_level : "warn"
+#log_level : "error"
+#log_level : "fatal"
 
 # Print log-string both file and STDOUT
 #
-#   Default : false
-#
-#log_stdout : true
-
-# 標準出力とログの両方に文字列を出力するかどうか
-#
-#   Default : false
+#   Default is false.
 #
 #log_stdout : true
+#log_stdout : false
 
 # Delete old log files
 #
-# If this is true, delete old log file when RBatch::Log.new is called.
-# A log file to delete is a log file which was made by the RBatch::Log instance, 
-# and log filename format include "<date>".
-#
-#   Default : false
+#   Default is false.
+#   If this is true, delete old log file when RBatch::Log.new is called.
+#   A log file to delete is a log file which was made by the RBatch::Log instance, 
+#   and log filename format include "<date>".
 #
 #log_delete_old_log: true
+#log_delete_old_log: false
 
 # The day of leaving log files
 #
-#   Default : 7
+#   Default is 7.
 #
 #log_delete_old_log_date: 14
 
+# Send mail or not
+# 
+#   Default is false.
+#   When log.error(msg) or log.fatal(msg) called , send e-mail including "msg". 
+#
+#send_mail : true
+
+# Send mail parameters
+#
+#mail_to   : "xxx@sample.com"
+#mail_from : "xxx@sample.com"
+#mail_server_host : "localhost"
+#mail_server_port : 25
 
 ```
 

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'rbatch'
-  s.version = '1.7.0'
+  s.version = '1.8.0'
   s.extra_rdoc_files = ['README.md', 'LICENSE']
   s.summary = 'simple batch framework'
   s.description = ''

data/doc/rdoc/CHANGELOG.html

@@ -1,163 +1,207 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
 
-  <title>File: CHANGELOG [RBatch Docs]</title>
+	<title>File: CHANGELOG [RBatch Docs]</title>
 
-  <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+	<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
 
-  <script src="./js/jquery.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="./js/thickbox-compressed.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="./js/quicksearch.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="./js/darkfish.js" type="text/javascript"
-    charset="utf-8"></script>
+	<script src="./js/jquery.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/thickbox-compressed.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/quicksearch.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/darkfish.js" type="text/javascript"
+		charset="utf-8"></script>
 </head>
 
 <body class="file">
-  <div id="metadata">
-    <div id="home-metadata">
-      <div id="home-section" class="section">
+	<div id="metadata">
+		<div id="home-metadata">
+			<div id="home-section" class="section">
         <h3 class="section-header">
           <a href="./index.html">Home</a>
           <a href="./index.html#classes">Classes</a>
           <a href="./index.html#methods">Methods</a>
         </h3>
-      </div>
-    </div>
-
-    <div id="project-metadata">
-      
-      
-      <div id="fileindex-section" class="section project-section">
-        <h3 class="section-header">Files</h3>
-        <ul>
-        
-          <li class="file"><a href="./CHANGELOG.html">CHANGELOG</a></li>
-        
-          <li class="file"><a href="./LICENSE.html">LICENSE</a></li>
-        
-        </ul>
-      </div>
-      
-
-      <div id="classindex-section" class="section project-section">
-        <h3 class="section-header">Class Index
-          <span class="search-toggle"><img src="./images/find.png"
-            height="16" width="16" alt="[+]"
-            title="show/hide quicksearch" /></span></h3>
-        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-        <fieldset>
-          <legend>Quicksearch</legend>
-          <input type="text" name="quicksearch" value=""
-            class="quicksearch-field" />
-        </fieldset>
-        </form>
-
-        <ul class="link-list">
-        
-          <li><a href="./RBatch.html">RBatch</a></li>
-        
-          <li><a href="./RBatch/Cmd.html">RBatch::Cmd</a></li>
-        
-          <li><a href="./RBatch/CmdException.html">RBatch::CmdException</a></li>
-        
-          <li><a href="./RBatch/CmdResult.html">RBatch::CmdResult</a></li>
-        
-          <li><a href="./RBatch/Config.html">RBatch::Config</a></li>
-        
-          <li><a href="./RBatch/Log.html">RBatch::Log</a></li>
-        
-          <li><a href="./RBatch/RBatch.html">RBatch::RBatch</a></li>
-        
-          <li><a href="./RBatch/RBatch/RBatch.html">RBatch::RBatch::RBatch</a></li>
-        
-          <li><a href="./RBatch/RBatch/RBatch/Config.html">RBatch::RBatch::RBatch::Config</a></li>
-        
-          <li><a href="./RBatch/RBatch/RBatch/Config/Exception.html">RBatch::RBatch::RBatch::Config::Exception</a></li>
-        
-        </ul>
-        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
-      </div>
-
-      
-    </div>
-  </div>
-
-  <div id="documentation">
-    <hr style="height: 3px">
-
-<p>initial</p>
-
-<p>1.1.0(2012/11/9)</p>
-<hr style="height: 3px">
-<ul><li>
-<p>make common config file</p>
-</li><li>
-<p>change log option</p>
-</li></ul>
-
-<p>1.2.0(2012/11/13)</p>
-<hr style="height: 3px">
-<ul><li>
-<p>change log level option format</p>
-</li><li>
-<p>make log append option</p>
-</li></ul>
-
-<p>1.3.0(2012/12/30)</p>
-<hr style="height: 3px">
-<ul><li>
-<p>add <a href="RBatch/Log.html">RBatch::Log</a> to instance interface</p>
-</li><li>
-<p>add double run check option</p>
-</li></ul>
-
-<p>1.4.0(2013/1/5)</p>
-<hr style="height: 2px">
-<ul><li>
-<p>add log_stdout option</p>
-</li><li>
-<p>add sample code</p>
-</li><li>
-<p>add cmd_raise option</p>
-</li><li>
-<p>add log_delete_old_log option</p>
-</li></ul>
-
-<p>1.5.0(2013/1/11)</p>
-<hr style="height: 2px">
-<ul><li>
-<p>change default config dir “../config” -&gt; “../conf”</p>
-</li></ul>
-
-<p>1.6.0(2013/1/14)</p>
-<hr style="height: 2px">
-<ul><li>
-<p>add config key check</p>
-</li></ul>
-
-<p>1.7.0(2013/01/30)</p>
-<hr style="height: 2px">
-<ul><li>
-<p>change log format</p>
-</li><li>
-<p>delete change log format option</p>
-</li></ul>
-
-  </div>
-
-  <div id="validator-badges">
-    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-      Rdoc Generator</a> 2</small>.</p>
-  </div>
+			</div>
+		</div>
+
+		<div id="project-metadata">
+			
+			
+			<div id="fileindex-section" class="section project-section">
+				<h3 class="section-header">Files</h3>
+				<ul>
+				
+					<li class="file"><a href="./CHANGELOG.html">CHANGELOG</a></li>
+				
+					<li class="file"><a href="./LICENSE.html">LICENSE</a></li>
+				
+				</ul>
+			</div>
+			
+
+			<div id="classindex-section" class="section project-section">
+				<h3 class="section-header">Class Index
+					<span class="search-toggle"><img src="./images/find.png"
+						height="16" width="16" alt="[+]"
+						title="show/hide quicksearch" /></span></h3>
+				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+				<fieldset>
+					<legend>Quicksearch</legend>
+					<input type="text" name="quicksearch" value=""
+						class="quicksearch-field" />
+				</fieldset>
+				</form>
+
+				<ul class="link-list">
+				
+					<li><a href="./RBatch.html">RBatch</a></li>
+				
+					<li><a href="./RBatch/Cmd.html">RBatch::Cmd</a></li>
+				
+					<li><a href="./RBatch/CmdException.html">RBatch::CmdException</a></li>
+				
+					<li><a href="./RBatch/CmdResult.html">RBatch::CmdResult</a></li>
+				
+					<li><a href="./RBatch/Config.html">RBatch::Config</a></li>
+				
+					<li><a href="./RBatch/Config/Exception.html">RBatch::Config::Exception</a></li>
+				
+					<li><a href="./RBatch/Log.html">RBatch::Log</a></li>
+				
+					<li><a href="./RBatchException.html">RBatchException</a></li>
+				
+				</ul>
+				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
+			</div>
+
+			
+		</div>
+	</div>
+
+	<div id="documentation">
+		<hr style="height: 3px"></hr><p>
+initial
+</p>
+<p>
+1.1.0(2012/11/9)
+</p>
+<hr style="height: 3px"></hr><ul>
+<li><p>
+make common config file
+</p>
+</li>
+<li><p>
+change log option
+</p>
+</li>
+</ul>
+<p>
+1.2.0(2012/11/13)
+</p>
+<hr style="height: 3px"></hr><ul>
+<li><p>
+change log level option format
+</p>
+</li>
+<li><p>
+make log append option
+</p>
+</li>
+</ul>
+<p>
+1.3.0(2012/12/30)
+</p>
+<hr style="height: 3px"></hr><ul>
+<li><p>
+add <a href="RBatch/Log.html">RBatch::Log</a> to instance interface
+</p>
+</li>
+<li><p>
+add double run check option
+</p>
+</li>
+</ul>
+<p>
+1.4.0(2013/1/5)
+</p>
+<hr style="height: 2px"></hr><ul>
+<li><p>
+add log_stdout option
+</p>
+</li>
+<li><p>
+add sample code
+</p>
+</li>
+<li><p>
+add cmd_raise option
+</p>
+</li>
+<li><p>
+add log_delete_old_log option
+</p>
+</li>
+</ul>
+<p>
+1.5.0(2013/1/11)
+</p>
+<hr style="height: 2px"></hr><ul>
+<li><p>
+change default config dir &#8220;../config&#8221; -> &#8220;../conf&#8220;
+</p>
+</li>
+</ul>
+<p>
+1.6.0(2013/1/14)
+</p>
+<hr style="height: 2px"></hr><ul>
+<li><p>
+add config key check
+</p>
+</li>
+</ul>
+<p>
+1.7.0(2013/01/30)
+</p>
+<hr style="height: 2px"></hr><ul>
+<li><p>
+change log format
+</p>
+</li>
+<li><p>
+delete change log format option
+</p>
+</li>
+</ul>
+<p>
+1.8.0(2013/02/10)
+</p>
+<hr style="height: 2px"></hr><ul>
+<li><p>
+add log_send_mail option
+</p>
+</li>
+<li><p>
+add cmd_timeout option
+</p>
+</li>
+</ul>
+
+	</div>
+
+	<div id="validator-badges">
+		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+			Rdoc Generator</a> 1.1.6</small>.</p>
+	</div>
 </body>
 </html>