rbatch 2.1.7 → 2.1.8

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+php:
+  - "1.9"
+before_install:
+  - gem install rbatch rspec
+before_script:
+script:
+  - rake spec
+notifications:
+  emails:
+    - fetaro@gmail.com
+  on_success: always # default: change
+  on_failure: always

data/README.ja.md

@@ -1,12 +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") |  [Document (YardDoc)](http://fetaro.github.io/rbatch/index.html)
 
-RBatch:Ruby-base バッチ スクリプト フレームワーク
+RBatch: バッチスクリプト フレームワーク
 =============
 
-RBatchについて (version 2)
+RBatchについて
 --------------
 
-RBatchはRubyで書かれたシンプルなバッチスクリプトのフレームワークです。
+RBatchはRubyで書かれたシンプルなバッチスクリプト(運用スクリプト)のフレームワークです。
 バッチスクリプト（バックアップやプロセスリロード等）を書く際に便利な機能をフレームワークとして提供しています。
 
 主な機能は以下のとおり。
@@ -41,10 +41,21 @@ RBatchはRubyで書かれたシンプルなバッチスクリプトのフレー
 
 ### ディレクトリ構成と命名規則
 
+"設定より規約"の原則に基づいて、
 RBatchでは、実行スクリプト、設定ファイルおよびログファイルについて、
-配置場所および命名規則が規約で決まっています。
+配置場所および命名規則が規約で決めています。
+ルールに従えば、ほとんど設定せずに、スクリプト開発に十分な環境が整います。
 
-具体的には、`${RB_HOME}/bin/hoge.rb`というスクリプトでは、`${RB_HOME}/lib/*.rb`にあるライブラリをロードし、`${RB_HOME}/conf/hoge.yaml`という設定ファイルを読み、`${RB_HOME}/log/YYYYMMDD_HHMMSS_hoge.rb`というログを出力するという規則です。
+ルールは以下の通り
+
+* 仮に`${RB_HOME}/bin/hoge.rb`というスクリプトを作った場合
+* 個別設定ファイルは`${RB_HOME}/conf/hoge.yaml`としてください。
+* 共通設定ファイルは`${RB_HOME}/conf/common.yaml`としてください。
+* ライブラリは`${RB_HOME}/lib/*.rb`としてください。
+
+すると
+
+* `${RB_HOME}/log/YYYYMMDD_HHMMSS_hoge.rb`にログが出ます。
 
 例を示すと以下の通りです。
 
@@ -57,7 +68,7 @@ RBatchでは、実行スクリプト、設定ファイルおよびログファ
      |  |- B.rb
      |
      |-conf            ←設定ファイル配置場所
-     |  |- A.yaml
+     |  |- A.yaml      ←個別設定ファイル
      |  |- B.yaml
      |  |- common.yaml  ←共通設定ファイル
      |

data/README.md

@@ -1,13 +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") |  [Document (YardDoc)](http://fetaro.github.io/rbatch/index.html)
 
-RBatch: Framework for Ruby-based Batch Script
+RBatch: Batch Script Framework
 =============
 
-About RBatch (for ver 2)
+About RBatch
 --------------
 
-
-RBatch is a framework for Ruby-based batch script. RBatch help to make a batch script such as "data backup" or "proccess start ".
+RBatch is a ruby-based framework for batch scripts. RBatch help to make a batch script such as "data backup" or "proccess start ".
 
 There are following functions.
 
@@ -18,7 +17,6 @@ There are following functions.
 * External Command Wrapper
 * Double Run Check
 
-
 Note: RBatch works on Ruby 1.9.
 
 Note: This software is released under the MIT License, see LICENSE.txt.
@@ -36,15 +34,26 @@ Overview
 
 ### RBatch home directory
 
-When you set `${RB_HOME}` environment variable, RBatch home directory is fix at `${RB_HOME}`.
+When you set `${RB_HOME}` environment variable, RBatch home directory is fixed 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)/../` .
+When you do NOT set `${RB_HOME}`, `${RB_HOME}` is the parent directory of the directory where the script is located. In other words, default of `${RB_HOME}` is `(script path)/../` .
 
 ### Directory Structure and File Naming Convention
 
-RBach has convention of file naming and directory structure.
+Follow the rule of "convention over configuration",
+RBach has convention of file naming and directory structure in advance.
+If you follow these rules, you will gain plenty development environment without any configurations.
+
+The rules are
+
+* If you make `${RB_HOME}/bin/hoge.rb` as the script...
+* individual config file should be `${RB_HOME}/conf/hoge.yaml`
+* common(shared) config file should be `${RB_HOME}/conf/common.yaml`
+* libraries should be `${RB_HOME}/lib/*.rb`
+
+then
 
-If you make a script on `${RB_HOME}/bin/hoge.rb`, libraries are `${RB_HOME}/lib/*.rb`, script's config file is `${RB_HOME}/conf/hoge.yaml` , and log file is output at `${RB_HOME}/log/YYYYMMDD_HHMMSS_hoge.log`.
+* log files are output at `${RB_HOME}/log/YYYYMMDD_HHMMSS_hoge.log`
 
 For example
 
@@ -57,9 +66,9 @@ For example
      |   |-  B.rb
      |
      |- conf           <--- Config files
-     |   |-  A.yaml
+     |   |-  A.yaml    <--- Individual config file
      |   |-  B.yaml
-     |   |-  common.yaml <--- Common-Config file
+     |   |-  common.yaml <--- Common config file
      |
      |- log            <--- Log files
      |   |-  YYYYMMDD_HHMMSS_A.log
@@ -71,9 +80,9 @@ For example
 
 ### Auto Logging
 
-Use auto logging block `RBatch::Log`, RBatch automatically output logfiles.
-The default location of log file is `${RB_HOME}/log/YYYYMMDD_HHMMSS_(script base).log`.
-If an exception is raised, then RBatch write the stack trace to the logfile.
+Use the auto logging block ,`RBatch::Log`, RBatch automatically output logfiles.
+The default location of log files are `${RB_HOME}/log/YYYYMMDD_HHMMSS_(script base).log`.
+If an exception is raised in auto logging block, RBatch rescue and write the stack trace to the logfile.
 
 sample
 
@@ -102,19 +111,19 @@ Run script. Log file is `${RB_HOME}/log/20121020_005953_sample1.log`
 
 ### Auto Library Loading
 
-If you make libraries at `${RB_HOME}/lib/*.rb`, those files are required before script run.
+If you make the libraries at `${RB_HOME}/lib/*.rb`, these are loaded(required) before script run.
 
 ### Auto Mail Sending
 
-By using `log_send_mail` option, when an error or fatal log is output in script, RBatch sends error-mail. 
+By using `log_send_mail` option, when the logs with ERROR or FATAL level are output, RBatch sends the error messages by e-mail. 
 
 ### Auto Config Reading
 
-If you make configuration file which is located `${RB_HOME}/conf/"(script base).yaml"`, this file is read automatically.
+If you make the configuration file ,`${RB_HOME}/conf/"(script base).yaml"`, this file is read and parsed automatically.
 
 sample
 
-make config file `${RB_HOME}/conf/sample2.yaml`.
+make the config file `${RB_HOME}/conf/sample2.yaml`.
 
     key: value
     array:
@@ -122,7 +131,7 @@ make config file `${RB_HOME}/conf/sample2.yaml`.
      - item2
      - item3
 
-In script `${RB_HOME}/bin/sample2.rb` , you can read config.
+In script named `${RB_HOME}/bin/sample2.rb`, this config values can be used.
 
 ```ruby
 require 'rbatch'
@@ -137,14 +146,14 @@ p RBatch.config["not_exist"] # => Raise RBatch::ConfigException
 
 #### Common Config
 
-If you can use a common config file which is read from all scripts, you make `${RB_HOME}/conf/common.yaml`.
-You can change name of common config file by using option `common_conf_name`.
+If you can use the common config file , `${RB_HOME}/conf/common.yaml`, this config values can be used by all scripts.
+The name of common config file is changed by option `common_conf_name`.
 
 ### External Command Wrapper
 
-RBatch provide a function which wrap external command (such as 'ls').
+`RBatch.cmd` is external command wapper.
 
-This function return a result object which contain command's "STDOUT", "STDERR" ,and "exit status".
+This function return a result object which contains command's "STDOUT", "STDERR" and "exit status".
 
 sample
 
@@ -159,12 +168,12 @@ p r.status # => 0
 
 If you want to set a timeout of external command, you can use `cmd_timeout` option.
 
-And by using `cmd_raise` option, if status of command is not 0, raise Exception.
-You have no use for an error handring.
+By using `cmd_raise` option, if exit status of command is not 0, RBatch raise an Exception.
+This function help to handle the errors of external command.
 
 ### Double Run Check
 
-Using `forbid_double_run` option, two same name scripts cannot run at the same time.
+By using `forbid_double_run` option, two scripts both has same name cannot run at the same time.
 
 Manual
 --------------
@@ -176,7 +185,7 @@ Sample
 
 ### AWS EC2 Volume Backup Script
 
-First you make configuration file.
+First you make the configuration file.
 
 Config File : `${RB_HOME}/conf/ec2_create_snapshot.yaml`
 
@@ -186,7 +195,7 @@ secret_key : JoqJSdP8+tpdFYWljVbG0+XXXXXXXXXXXXXXX
 
 ```
 
-Next, you write script.
+Next, you write the script.
 
 Script : `${RB_HOME}/bin/ec2_create_snapshot.rb`
 
@@ -225,7 +234,7 @@ end
 
 ```
 
-Finally Run script , then following logfile is output.
+Finally you run the script, then following logfile is output.
 
 Log file : `${RB_HOME}/log/20140121_123124_ec2_create_snapshot.log`
 
@@ -242,14 +251,14 @@ Log file : `${RB_HOME}/log/20140121_123124_ec2_create_snapshot.log`
 [2014-01-21 12:31:25 -0500] [INFO ] sucess
 ```
 
-Only you write a small code, this batch script has logging and read-config function.
+Only you write a short code, this batch script has logging and read-config function.
 
 Customize
 --------------
 If you want to customize RBatch, you have two methods.
 
 * (1) Write Run-Conf(`${RB_HOME}/.rbatchrc`).
-* (2) Pass an option object to constructor in your script.
+* (2) Pass an option object to constructor of RBatch classes in a script.
 
 When an option is set in both (1) and (2), (2) is prior to (1).
 

data/lib/rbatch/log.rb

@@ -217,7 +217,7 @@ module RBatch
       if Dir.exists?(@vars[:log_dir]) && @vars.raw_value(:log_name).include?("<date>")
         Dir::foreach(@vars[:log_dir]) do |file|
           r = Regexp.new("^" \
-                         + @vars.raw_value(:log_name).gsub("<prog>",@vars[:program_base])\
+                         + @vars.raw_value(:log_name).gsub("<prog>",@vars[:program_noext])\
                            .gsub("<time>","[0-2][0-9][0-5][0-9][0-5][0-9]")\
                            .gsub("<date>","([0-9][0-9][0-9][0-9][0-1][0-9][0-3][0-9])")\
                          + "$")

data/lib/rbatch/version.rb

@@ -1,3 +1,3 @@
 module RBatch
-  VERSION = "2.1.7"
+  VERSION = "2.1.8"
 end

data/rbatch.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = RBatch::VERSION
   gem.authors       = ["fetaro"]
   gem.email         = ["fetaro@gmail.com"]
-  gem.description   = "Simple Framework of Batch Script"
-  gem.summary       = "Simple Framework of Batch Script"
+  gem.description   = "Batch Script Framework"
+  gem.summary       = "Batch Script Framework"
   gem.homepage      = "https://github.com/fetaro/rbatch"
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -2,7 +2,7 @@
 name: rbatch
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.7
+  version: 2.1.8
 platform: ruby
 authors: 
 - fetaro
@@ -10,10 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-02-13 00:00:00 Z
+date: 2014-03-17 00:00:00 Z
 dependencies: []
 
-description: Simple Framework of Batch Script
+description: Batch Script Framework
 email: 
 - fetaro@gmail.com
 executables: 
@@ -24,6 +24,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -93,7 +94,7 @@ rubyforge_project:
 rubygems_version: 1.7.1
 signing_key: 
 specification_version: 3
-summary: Simple Framework of Batch Script
+summary: Batch Script Framework
 test_files: 
 - spec/01_rbach_spec.rb
 - spec/rbatch/cmd_spec.rb