rbatch 1.10.0 → 1.11.0

data/CHANGELOG

@@ -48,4 +48,8 @@ initial
 
 1.10.0(2013/02/12)
 ----
-* add rbatch-init command
+* add rbatch-init command
+
+1.11.0(2013/02/24)
+----
+* support MAC environment (change handling of the environment variable about hostname and temporary directory)

data/README.ja.md

@@ -126,26 +126,36 @@ RBatchの共通設定ファイルに"forbid_double_run: true"の設定を書け
 --------------
 
     $ sudo gem install rbatch
-
     $ rbatch-init    # => ディレクトリとサンプルスクリプトが作られます
-
     $ ruby bin/hello_world.rb
+    $ cat log/YYYYMMDD_HHMMSS_hello_world.log
 
-    $ cat log/YYYYMMDD_HHMMSS_backup.log
 
-
-設定ファイル
+オプション
 --------------
 
-### RBatch全体設定ファイル
+RBatchではオプションの指定の仕方は以下の二つがあります。
 
-以下の場所にRBatch全体設定ファイルを配置すると、全てのスクリプトにてオプションが適用される。
+1. 全体設定ファイル(conf/rbatch.yaml)に書く
+2. コンストラクタの引数に指定する
+
+全体設定ファイルにオプションを書くと、全てのスクリプトに効果がありますが、コンストラクタの引数に指定した場合はそのインスタンスのみ効果があります。
+
+全体設定ファイルとコンストラクタの引数に同じオプションが指定された場合、コンストラクタの引数が優先されます。
+
+全体設定ファイルのキーの名前と、コンストラクタオプションのキーの名前は、対応関係があります。全体設定ファイルのキー名は「(クラス名)_(キー名)」となります。
+たとえばRBatch::Logクラスのコンストラクタオプションで「:name」というキーは、全体設定ファイルでは「log_name」というキーになります。
+
+### 全体設定ファイルによるオプション指定
+
+以下の場所にRBatch全体設定ファイルを配置すると、全てのスクリプトにてオプションが適用されます。
+
+
+    (スクリプトのパス)/../conf/rbatch.yaml
 
-```
-(スクリプトのパス)/../conf/rbatch.yaml
-```
 
 設定ファイルのサンプルは以下の通り
+
 ```
 # RBatch 全体設定
 #
@@ -257,3 +267,31 @@ RBatchの共通設定ファイルに"forbid_double_run: true"の設定を書け
 #log_mail_server_port : 25
 
 ```
+
+### コンストラクタの引数によるオプション指定
+
+#### RBatch::Logクラス
+
+    RBatch::Log.new(opt = nil)
+    opt = {
+          :name      => "<date>_<time>_<prog>.log",
+          :dir       => "/var/log/",
+          :append    => true,
+          :level     => "info",
+          :stdout    => false,
+          :delete_old_log => false,
+          :delete_old_log_date => 7,
+          :send_mail => false,
+          :mail_to   => nil,
+          :mail_from => "rbatch.localhost",
+          :mail_server_host => "localhost",
+          :mail_server_port => 25
+    }
+
+#### RBatch::Cmdクラス
+
+    RBatch::Log.new(cmd_str, opt = nil)
+    opt = {
+          :raise     => false,
+          :timeout   => 0
+          }

data/README.md

@@ -123,17 +123,25 @@ 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
 
-    $ cat log/YYYYMMDD_HHMMSS_backup.log
-
-Config
+Option
 --------------
 
-### RBatch Grobal Config File
+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 the same option is set, the argument of the constructer is given priority to over the global configuration.
+
+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)".
+
+#### Set by Grobal Configuration File
 
 If you make follow config file, option value effect to all scripts.
 
@@ -252,3 +260,30 @@ Config Sample
 
 ```
 
+### Set by argument of the constracter
+
+#### class RBatch::Log 
+
+    RBatch::Log.new(opt = nil)
+    opt = {
+          :name      => "<date>_<time>_<prog>.log",
+          :dir       => "/var/log/",
+          :append    => true,
+          :level     => "info",
+          :stdout    => false,
+          :delete_old_log => false,
+          :delete_old_log_date => 7,
+          :send_mail => false,
+          :mail_to   => nil,
+          :mail_from => "rbatch.localhost",
+          :mail_server_host => "localhost",
+          :mail_server_port => 25
+    }
+
+#### class RBatch::Cmd
+
+    RBatch::Log.new(cmd_str, opt = nil)
+    opt = {
+          :raise     => false,
+          :timeout   => 0
+          }

data/lib/rbatch/version.rb

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

data/lib/rbatch.rb

@@ -13,7 +13,7 @@ module RBatch
     when /cygwin|linux/
       return ENV["HOSTNAME"] ? ENV["HOSTNAME"] : "unknownhost"
     else
-      raise "Unknown RUBY_PRATFORM : " + RUBY_PLATFORM
+      return "unknownhost"
     end
   end
   # tmp dir
@@ -28,7 +28,11 @@ module RBatch
     when /cygwin|linux/
       return ENV["TMPDIR"] ? ENV["TMPDIR"] : "/tmp"
     else
-      raise "Unknown RUBY_PRATFORM : " + RUBY_PLATFORM
+      if ENV["TMPDIR"].nil? && ENV["TEMP"].nil?
+        raise "Unknown RUBY_PRATFORM : " + RUBY_PLATFORM
+      else
+        return ENV["TMPDIR"] || ENV["TEMP"]
+      end
     end
   end
   def common_config_path

metadata

@@ -2,7 +2,7 @@
 name: rbatch
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors: 
 - fetaro
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-11 00:00:00 Z
+date: 2013-02-23 00:00:00 Z
 dependencies: []
 
 description: Ruby-based simple batch framework