rbatch 1.9.0 → 1.10.0

data/CHANGELOG

@@ -44,4 +44,8 @@ initial
 1.9.0(2013/02/11)
 ----
 * add "<host>" keyword to log_name option
-* Environmental variables ($TMPDIR and $HOSTNAME) are checked strictly 
+* Environmental variables ($TMPDIR and $HOSTNAME) are checked strictly 
+
+1.10.0(2013/02/12)
+----
+* add rbatch-init command

data/README.ja.md

@@ -124,53 +124,17 @@ RBatchの共通設定ファイルに"forbid_double_run: true"の設定を書け
 
 クイックスタート
 --------------
-### ステップ1: インストール
 
-```
-# gem install rbatch
-```
-
-### ステップ2: ディレクトリ作成
-
-```
-$ mkdir bin log conf
-```
-
-### ステップ3: バッチスクリプト作成 
-
-bin/backup.rbは以下の通り。
-```
-require 'rbatch'
+    $ sudo gem install rbatch
 
-RBatch::Log.new(){|log|
-  log.info( "start backup" )
-  result = RBatch::cmd( "cp -p /var/log/message /backup")
-  log.info( result )
-  log.error ( "backup failed") if result.status != 0
-}
-```
-
-### ステップ4: 実行
-
-```
-$ ruby bin/backup.rb
-```
-
-### ステップ5: 確認
+    $ rbatch-init    # => ディレクトリとサンプルスクリプトが作られます
 
-自動的にlog/YYYYMMDD_HHMMSS_backup.logにログファイルが出ます。 
+    $ ruby bin/hello_world.rb
 
-```
-$ cat log/YYYYMMDD_HHMMSS_backup.log
-
-# Logfile created on 2012-10-20 00:19:23 +0900 by logger.rb/25413
-[2012-10-20 00:19:23 +0900] [INFO ] start backup
-[2012-10-20 00:19:23 +0900] [INFO ] {:stdout=>"", :stderr=>"cp: cannot stat `/var/log/message': No such file or directory\n", :status=>1}
-[2012-10-20 00:19:23 +0900] [ERROR] backup failed
-```
+    $ cat log/YYYYMMDD_HHMMSS_backup.log
 
 
-マニュアル
+設定ファイル
 --------------
 
 ### RBatch全体設定ファイル

data/README.md

@@ -121,53 +121,16 @@ Forbit double run of the RBatch script by writing option "forbid_double_run: tru
 
 Quick Start
 --------------
-### Step1: Install
 
-```
-# gem install rbatch
-```
-
-### Step2: Make directories
-
-```
-$ mkdir bin log conf
-```
+    $ sudo gem install rbatch
 
-### Step3: Write batch script 
+    $ rbatch-init    # => make directories and sample scripts
 
-for bin/backup.rb
-```
-require 'rbatch'
-
-RBatch::Log.new(){|log|
-  log.info( "start backup" )
-  result = RBatch::cmd( "cp -p /var/log/message /backup")
-  log.info( result )
-  log.error ( "backup failed") if result.status != 0
-}
-```
-
-### Step4: Run
-
-```
-$ ruby bin/backup.rb
-```
-
-### Step5: Check
-
-Log file is generated automatically. 
-
-```
-$ cat log/YYYYMMDD_HHMMSS_backup.log
-
-# Logfile created on 2012-10-20 00:19:23 +0900 by logger.rb/25413
-[2012-10-20 00:19:23 +0900] [INFO ] start backup
-[2012-10-20 00:19:23 +0900] [INFO ] {:stdout=>"", :stderr=>"cp: cannot stat `/var/log/message': No such file or directory\n", :status=>1}
-[2012-10-20 00:19:23 +0900] [ERROR] backup failed
-```
+    $ ruby bin/hello_world.rb
 
+    $ cat log/YYYYMMDD_HHMMSS_backup.log
 
-Manual
+Config
 --------------
 
 ### RBatch Grobal Config File

data/bin/rbatch-init

@@ -0,0 +1,147 @@
+#!/usr/local/bin/ruby
+
+contents = {}
+contents["bin/hello_world.rb"] = <<EOF
+require 'rbatch'
+
+RBatch::Log.new{|log|
+  log.info("hello world")
+  log.info("config value: " + RBatch::config["key1"])
+  result = RBatch.cmd("ls")
+  log.info(result)
+}
+
+EOF
+
+contents["conf/hello_world.yaml"] = <<EOF
+key1 : value1
+EOF
+
+contents["conf/rbatch.yaml"] = <<EOF
+# RBatch Common Config
+#
+#   This file format is YAML.
+#
+
+# -------------------
+# Global setting
+# -------------------
+
+# Forbit Script Double Run
+#
+#   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
+# -------------------
+
+# Raise Exception
+#
+#   Default is false.
+#   If command exit status is not 0, raise exception.
+#
+#cmd_raise : true
+#cmd_raise : false
+
+
+# -------------------
+# Log setting
+# -------------------
+
+# 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.
+#
+#log_name : "<date>_<time>_<prog>.log"
+#log_name : "<date>_<prog>.log"
+
+# Log Output Directory
+#
+#   Default is "(Script path)/../log".
+#
+#log_dir : "/tmp/log"
+
+# Append log or not
+#
+#   Default is ture.
+#
+#log_append : true
+#log_append : false
+
+# Log Level
+#
+#   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 is false.
+#
+#log_stdout : true
+#log_stdout : false
+
+# Delete old log files
+#
+#   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 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". 
+#
+#log_send_mail : true
+
+# Send mail parameters
+#
+#log_mail_to   : "xxx@sample.com"
+#log_mail_from : "xxx@sample.com"
+#log_mail_server_host : "localhost"
+#log_mail_server_port : 25
+
+EOF
+
+require 'fileutils'
+["bin","conf","log"].each do | dir |
+  if ! Dir.exists?(dir)
+    FileUtils.mkdir(dir)
+    puts "create ./" + dir
+  else
+    puts "exist ./" + dir + " (not create)"
+  end
+end
+["bin/hello_world.rb","conf/hello_world.yaml","conf/rbatch.yaml"].each do | file |
+  if ! File.exists?(file)
+    File.open(file, "w") { |f| f.puts contents[file] }
+    puts "create ./" + file
+  else
+    puts "exist ./" + file + "  (not create)"
+  end
+end
+

data/lib/rbatch/version.rb

@@ -1,3 +1,3 @@
 module Rbatch
-  VERSION = "1.9.0"
+  VERSION = "1.10.0"
 end

data/rbatch.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Rbatch::VERSION
   gem.authors       = ["fetaro"]
   gem.email         = ["fetaro@gmail.com"]
-  gem.description   = ""
+  gem.description   = "Ruby-based simple batch framework"
   gem.summary       = "Ruby-based simple batch framework"
   gem.homepage      = "https://github.com/fetaro/rbatch"
 
@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.required_ruby_version     = ">= 1.9.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: rbatch
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors: 
 - fetaro
@@ -13,11 +13,11 @@ cert_chain: []
 date: 2013-02-11 00:00:00 Z
 dependencies: []
 
-description: ""
+description: Ruby-based simple batch framework
 email: 
 - fetaro@gmail.com
-executables: []
-
+executables: 
+- rbatch-init
 extensions: []
 
 extra_rdoc_files: []
@@ -31,6 +31,7 @@ files:
 - README.ja.md
 - README.md
 - Rakefile
+- bin/rbatch-init
 - doc/rdoc/CHANGELOG.html
 - doc/rdoc/LICENSE.html
 - doc/rdoc/RBatch.html
@@ -120,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: