rbatch 2.4.0 → 2.5.0

data/CHANGELOG

@@ -9,6 +9,10 @@ If you want to know about bug fix, please see commit logs of https://github.com/
 version 2
 ===================
 
+2.5.0 (2015/06/14)
+----
+* [add] support erb format config.
+
 2.4.0 (2015/06/08)
 ----
 * [add] new option : "log_output_exit_status"

data/README.ja.md

@@ -151,9 +151,13 @@ RBatchは簡単にデフォルトの位置の設定ファイルを読み込め
     p RBatch.config["not_exist"] # => RBatch::ConfigExceptionが発生
 
 
+もし`erb`を使って`yaml`を記述したい場合は、設定ファイルの名前を`xxx.yaml`から`xxx.yaml.erb`に変えてください。RBatchはまず`erb`を評価した後`yaml`として読み込みます。`xxx.yaml`と`xxx.yaml.erb`の両方がある場合は`xxx.yaml`が読み込まれます。
+
 #### 共通設定ファイル
 
 すべてのスクリプトから共通で読み込む設定ファイルを作りたい場合は、`${RB_HOME}/conf/common.yaml`というファイルを作ることで可能です。
+このファイル名を変えたい場合は`common_conf_name`オプションを利用してください。
+通常の設定ファイルと同様に`erb`フォーマットも利用可能です。
 
 ### 外部コマンド実行
 
@@ -417,7 +421,7 @@ Run-Conf(`${RB_HOME}/.rbatchrc`)のサンプルは以下の通り
 # exitステータスをログに出すかどうか 
 #
 #   デフォルトはtrue。
-#   ログブロック内で "exist" メソッドを使った時に、
+#   ログブロック内で "exit" メソッドを使った時に、
 #   exitステータスをログファイルに出力する。
 #
 #log_output_exit_status : true

data/README.md

@@ -161,12 +161,15 @@ p RBatch.config["array"] # => ["item1", "item2", "item3"]
 p RBatch.config["not_exist"] # => Raise RBatch::ConfigException
 ```
 
+If you want to describe `yaml` by using `erb`, rename config file from `xxx.yaml` into `xxx.yaml.erb`. RBatch evaluates config file as `erb` after that read it as `yaml`. When both `xxx.yaml` and `xxx.yaml.erb` exist, `xxx.yaml` is read.
+
 #### Common Config
 
 By putting shard config file at `${RB_HOME}/conf/common.yaml`, the
 values in the file are shared by all scripts.
 If you want to change the name of the config file, you cau use the
 `common_conf_name` option.
+It accepts `erb` format like above normal config.
 
 ### External Command Wrapper
 
@@ -444,7 +447,7 @@ Sample of RBatch Run-Conf `${RB_HOME}/.rbatchrc`.
 # Output Exit Status
 #
 #   Default is true.
-#   When you use the "exist" method in a log block,
+#   When you use the "exit" method in a log block,
 #   output exit status into the log file.
 #
 #log_output_exit_status : true
@@ -511,6 +514,7 @@ opt = {
       :delete_old_log => false,
       :delete_old_log_date => 7,
       :bufferd => false,
+      :output_exit_status => true,
       :send_mail => false,
       :mail_to   => nil,
       :mail_from => "rbatch.localhost",

data/bin/rbatch-init

@@ -145,7 +145,7 @@ contents[".rbatchrc"] = <<EOF
 # Output Exit Status
 #
 #   Default is true.
-#   When you use the "exist" method in a log block,
+#   When you use the "exit" method in a log block,
 #   output exit status into the log file.
 #
 #log_output_exit_status : true

data/lib/rbatch/config.rb

@@ -1,6 +1,6 @@
 require 'yaml'
 require 'pathname'
-
+require 'erb'
 module RBatch
 
   class Config
@@ -11,10 +11,14 @@ module RBatch
     @hash
 
     # @param [String] path Config file path
-    def initialize(path)
+    def initialize(path,is_erb = false)
       @path = path
       begin
-        @hash = ConfigElement.new(YAML::load_file(@path))
+        if is_erb
+          @hash = ConfigElement.new(YAML::load(ERB.new(IO.read(@path)).result))
+        else
+          @hash = ConfigElement.new(YAML::load_file(@path))
+        end
       rescue Errno::ENOENT => e
         @hash = nil
       end

data/lib/rbatch/controller.rb

@@ -22,10 +22,26 @@ module RBatch
       @journal.put 1, "RB_HOME : \"#{@vars[:home_dir]}\""
       @journal.put 1, "Load Run-Conf: \"#{@vars[:run_conf_path]}\""
       @journal.put 2, "RBatch Variables : #{@vars.inspect}"
-      @common_config = RBatch::Config.new(@vars[:common_config_path])
-      @journal.put 1, "Load Config  : \"#{@vars[:common_config_path]}\"" if @common_config.exist?
-      @config = RBatch::Config.new(@vars[:config_path])
-      @journal.put 1, "Load Config  : \"#{@vars[:config_path]}\"" if @config.exist?
+      if File.exist?(@vars[:common_config_path])
+        @common_config = RBatch::Config.new(@vars[:common_config_path],false)
+      elsif File.exist?(@vars[:common_config_erb_path])
+        @common_config = RBatch::Config.new(@vars[:common_config_erb_path],true)
+      else
+        # If neither exist, make normal config instance.
+        # This avoid outputting "undefined method `[]'" when RBatch.config[xx] is called. 
+        @common_config = RBatch::Config.new(@vars[:common_config_path],false)
+      end
+      @journal.put 1, "Load Config  : \"#{@common_config.path}\"" if @common_config.exist?
+      if File.exist?(@vars[:config_path])
+        @config = RBatch::Config.new(@vars[:config_path],false)
+      elsif File.exist?(@vars[:config_erb_path])
+        @config = RBatch::Config.new(@vars[:config_erb_path],true)
+      else
+        # If neither exist, make normal config instance.
+        # This avoid outputting "undefined method `[]'" when RBatch.config[xx] is called. 
+        @config = RBatch::Config.new(@vars[:config_path],false)
+      end
+      @journal.put 1, "Load Config  : \"#{@config.path}\"" if @config.exist?
 
       # double_run_check
       if ( @vars[:forbid_double_run])

data/lib/rbatch/variables.rb

@@ -34,7 +34,9 @@ module RBatch
       @run_conf = RunConf.new(@vars[:run_conf_path]) # load run_conf
       @vars.merge!(@run_conf.opt)
       @vars[:common_config_path] = File.join(@vars[:conf_dir],@vars[:common_conf_name])
+      @vars[:common_config_erb_path] = @vars[:common_config_path] + ".erb"
       @vars[:config_path] = File.join(@vars[:conf_dir],@vars[:program_noext] + ".yaml")
+      @vars[:config_erb_path] = @vars[:config_path] + ".erb"
     end #end def
 
     def[](key)

data/lib/rbatch/version.rb

@@ -1,3 +1,3 @@
 module RBatch
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/sample/.rbatchrc

@@ -141,7 +141,7 @@
 # Output Exit Status
 #
 #   Default is true.
-#   When you use the "exist" method in a log block,
+#   When you use the "exit" method in a log block,
 #   output exit status into the log file.
 #
 #log_output_exit_status : true

data/spec/rbatch/config_spec.rb

@@ -64,6 +64,17 @@ describe RBatch::Config do
       RBatch::Config.new(@path)["key"]
     }.to raise_error(RBatch::ConfigException)
   end
+
+  it "read yaml format" do
+    open( @path  , "w" ){|f| f.write("key: <%= \"hoge\" %>")}
+    expect(RBatch::Config.new(@path,false)["key"]).to eq "<%= \"hoge\" %>"
+  end
+
+  it "read erb format" do
+    open( @path  , "w" ){|f| f.write("key: <%= \"hoge\" %>" )}
+    expect(RBatch::Config.new(@path,true)["key"]).to eq "hoge"
+  end
+
 end
 
 describe RBatch::ConfigElement do

data/spec/rbatch/controller_spec.rb

@@ -6,13 +6,88 @@ require 'rbatch/controller'
 describe RBatch::Controller do
 
   before :all do
-    @home = File.join(Dir.tmpdir, "rbatch_test_" + rand.to_s)
   end
 
   after :each do
   end
 
-  it "success" do
-    RBatch::Variables.new()
+  it "can reads yaml config" do
+    @rand = "rbatch_test_" + rand.to_s
+    @home = File.join(Dir.tmpdir, @rand)
+    @log_dir = File.join(@home,"log")
+    @conf_dir = File.join(@home,"conf")
+    ENV["RB_HOME"]=@home
+
+    Dir.mkdir(@home)
+    Dir.mkdir(@conf_dir)
+    open( File.join(@conf_dir,"rspec.yaml") , "a" ){|f|
+      f.write("key1 : <%= \"hoge1\" %>")
+    }
+
+    open( File.join(@conf_dir,"common.yaml") , "a" ){|f|
+      f.write("key2 : <%= \"hoge2\" %>")
+    }
+    $stdout = File.open("/tmp/rbatch.std.out", "w")  # change stdout
+    ctrl = RBatch::Controller.new()
+    $stdout = STDOUT# restore stdout
+
+    expect(ctrl.config["key1"]).to eq "<%= \"hoge1\" %>" 
+    expect(ctrl.common_config["key2"]).to eq "<%= \"hoge2\" %>" 
+  end
+
+  it "reads erb config" do
+    @rand = "rbatch_test_" + rand.to_s
+    @home = File.join(Dir.tmpdir, @rand)
+    @log_dir = File.join(@home,"log")
+    @conf_dir = File.join(@home,"conf")
+    ENV["RB_HOME"]=@home
+
+    Dir.mkdir(@home)
+    Dir.mkdir(@conf_dir)
+    open( File.join(@conf_dir,"rspec.yaml.erb") , "a" ){|f|
+      f.write("key1 : <%= \"hoge1\" %>")
+    }
+
+    open( File.join(@conf_dir,"common.yaml.erb") , "a" ){|f|
+      f.write("key2 : <%= \"hoge2\" %>")
+    }
+    $stdout = File.open("/tmp/rbatch.std.out", "w")  # change stdout
+    ctrl = RBatch::Controller.new()
+    $stdout = STDOUT# restore stdout
+
+    expect(ctrl.config["key1"]).to eq "hoge1" 
+    expect(ctrl.common_config["key2"]).to eq "hoge2" 
   end
+
+  it "reads yaml config when both yaml and erb exist" do
+    @rand = "rbatch_test_" + rand.to_s
+    @home = File.join(Dir.tmpdir, @rand)
+    @log_dir = File.join(@home,"log")
+    @conf_dir = File.join(@home,"conf")
+    ENV["RB_HOME"]=@home
+
+    Dir.mkdir(@home)
+    Dir.mkdir(@conf_dir)
+    open( File.join(@conf_dir,"rspec.yaml") , "a" ){|f|
+      f.write("key1 : <%= \"hoge1\" %>")
+    }
+    open( File.join(@conf_dir,"rspec.yaml.erb") , "a" ){|f|
+      f.write("key1 : <%= \"hoge1\" %>")
+    }
+
+    open( File.join(@conf_dir,"common.yaml") , "a" ){|f|
+      f.write("key2 : <%= \"hoge2\" %>")
+    }
+    open( File.join(@conf_dir,"common.yaml.erb") , "a" ){|f|
+      f.write("key2 : <%= \"hoge2\" %>")
+    }
+    $stdout = File.open("/tmp/rbatch.std.out", "w")  # change stdout
+    ctrl = RBatch::Controller.new()
+    $stdout = STDOUT# restore stdout
+
+    expect(ctrl.config["key1"]).to eq "<%= \"hoge1\" %>" 
+    expect(ctrl.common_config["key2"]).to eq "<%= \"hoge2\" %>" 
+  end
+
+
 end

data/spec/rbatch/variables_spec.rb

@@ -26,7 +26,9 @@ describe RBatch::Variables do
     expect(@vars[:lib_dir]).to eq File.join(@home,"lib")
     expect(@vars[:run_conf_path]).to eq File.join(@home,".rbatchrc")
     expect(@vars[:config_path]).to eq File.join(@home,"conf","rspec.yaml")
+    expect(@vars[:config_erb_path]).to eq File.join(@home,"conf","rspec.yaml.erb")
     expect(@vars[:common_config_path]).to eq File.join(@home,"conf","common.yaml")
+    expect(@vars[:common_config_erb_path]).to eq File.join(@home,"conf","common.yaml.erb")
     expect(@vars.run_conf[:log_dir]).to eq "<home>/log"
     expect(@vars.run_conf[:conf_dir]).to eq "<home>/conf"
     expect(@vars.run_conf[:lib_dir]).to eq "<home>/lib"

metadata

@@ -2,7 +2,7 @@
 name: rbatch
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors: 
 - fetaro
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-06-08 00:00:00 Z
+date: 2015-06-13 00:00:00 Z
 dependencies: []
 
 description: Batch Script Framework