tie 0.1

data/README

@@ -0,0 +1,56 @@
+--------------------
+*  To run tests:
+spec test/*.spec
+
+--------------------
+*  To get help:
+ivec2: /usbwr/usr/chena/prj/phx/src/ruby/gem/tie >lib/tie.rb -h
+Usage: tie.rb [-tpmv]
+
+Specific options:
+    -t, --template=TEMPLATE          The path to the template file, e.g. -t a.tmpl
+    -p, --parameter=PARAMETER        One parameter file or multiple parameter files in single quote. (order matters).  e.g. -p a.param or -p 'a.param b.param'
+    -m, --merged=MERGED              Merged file path.
+
+Common options:
+        --help                       Show this message
+    -v, --version                    Show version
+
+--------------------
+*  To run:
+  * To get result to stdio:
+ivec2: /usbwr/usr/chena/prj/phx/src/ruby/gem/tie >lib/tie.rb -t data/test/template/input.tmpl -p 'data/test/template/input.param'
+fuel type: OFA
+fuel enrichments:
+  3.1
+  3.2
+  3.3
+heights of each segment:
+  segment1 : 2.0
+  segment2 : 3.7
+
+  *  To get result to file:
+ivec2: /usbwr/usr/chena/prj/phx/src/ruby/gem/tie >lib/tie.rb -t data/test/template/input.tmpl -p 'data/test/template/input.param' -m input.inp
+ivec2: /usbwr/usr/chena/prj/phx/src/ruby/gem/tie >cat input.inp
+fuel type: OFA
+fuel enrichments:
+  3.1
+  3.2
+  3.3
+heights of each segment:
+  segment1 : 2.0
+  segment2 : 3.7
+
+  *  To merge a few parameter files into one template file:
+ivec2: /usbwr/usr/chena/prj/phx/src/ruby/gem/tie >lib/tie.rb -t data/test/template/input.tmpl -p 'data/test/template/input.param data/test/template/input_1.param'
+fuel type: NEW
+fuel enrichments:
+  3.1
+  3.2
+  3.3
+heights of each segment:
+  segment1 : 2.0
+  segment2 : 3.7
+
+
+

data/data/test/md5data.txt

@@ -0,0 +1,2 @@
+abc
+345

data/data/test/md5data2.txt

@@ -0,0 +1,2 @@
+789
+cde

data/data/test/md5sum.txt

@@ -0,0 +1,3 @@
+cd981b6574d00ec0a4790f905bf3bcc8  md5data.txt
+6af87cf8cd41824bfff795a0c90d86f0  md5data2.txt
+d41d8cd98f00b204e9800998ecf8427e  md5sum.txt

data/data/test/property_file/property.txt

@@ -0,0 +1,4 @@
+key=value
+age= 9
+name =  John Smith
+

data/data/test/property_file/ruby_property.txt

@@ -0,0 +1,4 @@
+key=value
+array=[item1, item2,  item3]
+hash={key1 => v1, key2 => v2}
+

data/data/test/template/input.param

@@ -0,0 +1,11 @@
+# comment line starts with '#'
+
+# text in single quote(') or double quote (")
+fuel_type="OFA"
+
+# array elements are in [ , ]
+enrichments=[3.1, 3.2, 3.3]
+
+# hash elements are in { key => value , }
+segment_height = { 'segment1' => 2.0, 
+  "segment2" => 3.7}

data/data/test/template/input.tmpl

@@ -0,0 +1,10 @@
+fuel type: <%= fuel_type %>
+fuel enrichments:
+% enrichments.each do |enrichment|
+  <%= enrichment %>
+% end
+heights of each segment:
+% segment_height.each_pair do |k, v|
+  <%= k %> : <%= v %>
+% end
+

data/data/test/template/input_1.param

@@ -0,0 +1,2 @@
+fuel_type="NEW"
+test_flag=true

data/data/test/template/lattice.param

@@ -0,0 +1,5 @@
+lattice = {
+  "RA30" => ["80", "81", "82"],
+  "RA40" => ["90"],
+  "RA50" => ["100", "101", "102"]
+}

data/data/test/template/reference_2_param_merged_file

@@ -0,0 +1,9 @@
+fuel type: NEW
+fuel enrichments:
+  3.1
+  3.2
+  3.3
+heights of each segment:
+  segment1 : 2.0
+  segment2 : 3.7
+

data/data/test/template/reference_merged_file

@@ -0,0 +1,9 @@
+fuel type: OFA
+fuel enrichments:
+  3.1
+  3.2
+  3.3
+heights of each segment:
+  segment1 : 2.0
+  segment2 : 3.7
+

data/lib/template.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require 'erb'
+require File.dirname(__FILE__) + '/utils'
+
+class Template
+
+  attr :target_file
+  attr_reader :result
+
+  def initialize( template, parameter_array, target_file=nil)
+	if  ! parameter_array.kind_of? Array
+	  raise "parameter should be array"
+	end
+
+	if  parameter_array.size == 0
+	  raise "parameter files should not be empty"
+	end
+
+	check_file_existance template
+	@template_file = template
+
+	parameter_array.each_with_index do |param_file, index|
+	  check_file_existance param_file
+	end
+
+	if parameter_array.size == 1
+	  @param_file = parameter_array[0]
+	else
+	  @param_file = Utils.merge_files parameter_array
+	end
+
+	merge
+
+	if target_file != nil
+	  write target_file
+        else
+          puts @result
+	end
+  end
+
+  def merge
+	template = ERB.new(File.read(@template_file), 0, "%")
+	instance_eval(File.read(@param_file))
+	@result = template.result(binding)
+  end
+
+  def write target_file
+	File.open(target_file, "w") do |file|
+	  file.puts @result
+	end
+  end
+
+  def check_file_existance file_path
+	if ! File.exist? file_path
+	  raise "file: #{file_path} does not exist"
+	end
+  end
+  private :check_file_existance
+end
+

data/lib/tie.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'choice'
+require File.dirname(__FILE__) + '/template'
+
+PROGRAM_VERSION = 0.1
+
+Choice.options do
+    header ''
+    header 'Specific options:'
+
+    option :tmpl do
+      short '-t'
+      long '--template=TEMPLATE'
+      desc 'The path to the template file, e.g. -t a.tmpl'
+    end
+
+    option :param do
+      short '-p'
+      long '--parameter=PARAMETER'
+      desc 'One parameter file or multiple parameter files in single quote. (order matters).  e.g. -p a.param or -p \'a.param b.param\''
+    end
+
+    option :merged do
+      short '-m'
+      long '--merged=MERGED'
+      desc 'Merged file path. '
+    end
+
+    separator ''
+    separator 'Common options: '
+
+    option :help do
+      long '--help'
+      desc 'Show this message'
+    end
+
+    option :version do
+      short '-v'
+      long '--version'
+      desc 'Show version'
+      action do
+        puts "tie.rb v#{PROGRAM_VERSION}"
+        exit
+      end
+    end
+end
+
+if Choice.choices[:tmpl] != nil
+  Template.new(Choice.choices[:tmpl], Choice.choices[:param].split(" "), Choice.choices[:merged])
+else
+  puts "tie.rb --help"
+end

data/lib/utils.rb

@@ -0,0 +1,114 @@
+module Utils
+  def Utils.read_properties file
+	path = file
+	if file.kind_of? File
+	  path = file.path
+	end
+	properties = {}
+	IO.foreach(path) do |line|
+	  next if line =~ /^\s*#/
+	  if line =~ /([^=]*)=(.*)\/\/(.*)/ || line =~ /([^=]*)=(.*)/ 
+		key = $1.strip
+		value = $2.strip
+
+		if (value[0,1] == "[" && value[-1, 1]=="]")
+		  value = value[1..-2]
+		  value = value.split(",").collect {|v| v.strip}
+		end
+
+		if (value[0,1] == "{" && value[-1, 1]=="}")
+		  hash = value[1..-2]
+		  value = {}
+
+		  hash_array= hash.split(",").collect {|v| v.strip}
+
+		  hash_array.each do |item|
+			(k, v) = item.split("=>").collect {|item| item.strip}
+			value[k] = v
+		  end
+		end
+
+		properties[key] = value 
+	  end
+
+	end
+	return properties
+  end
+
+  # not thread-safe
+  def Utils.unique_stamp
+	new_stamp = Time.new.strftime("%Y%m%d-%h%m%s")
+	if $stamp == new_stamp
+	  $stamp = "#{$stamp}_"
+	else
+	  $stamp = new_stamp
+	end
+	$stamp
+  end
+
+  def Utils.home_dir
+	ENV['HOME']
+  end
+
+  def Utils.tmp_dir
+	tmp_dir = "#{Utils.home_dir}/tmp_dir"
+	FileUtils.mkdir_p tmp_dir if (! File.exist? tmp_dir)
+	tmp_dir
+  end
+
+  def Utils.rm_tmp_dir
+	FileUtils.rm_r Utils.tmp_dir, :force => true
+  end
+
+  def Utils.tmp_file
+	"#{Utils.tmp_dir}/#{Utils.unique_stamp}.tmp"
+  end
+
+  def Utils.merge_files file_array
+	merged_file = File.new("#{Utils.tmp_dir}/#{Utils.unique_stamp}_merge", "w") 
+
+	file_array.each do |file|
+	  if (! File.exist? file)
+		puts "input file does not exist!"
+		next
+	  end
+
+	  merged_file.puts File.new(file).to_a
+	  merged_file.puts "\n"
+	  merged_file.flush
+	end
+	merged_file.close
+
+	merged_file.path
+  end
+
+  require 'md5'
+  def Utils.md5_key file
+	MD5.new(File.open(file, 'rb').read).hexdigest
+  end
+
+  def Utils.md5_line file
+	"#{Utils.md5_key file}  #{file}"
+  end
+
+  def Utils.md5sum file_array
+	file_array.collect { |file| "#{Utils.md5_key file}  #{file}" }
+  end
+
+  def Utils.md5_key_exists(key_file, key)
+	IO.read(key_file).grep(/#{key}/).size > 0
+  end
+
+  def Utils.md5sum_file(file_array, key_file_name)
+	File.open(key_file_name, 'w') do |file|
+	  file.write Utils.md5sum(file_array).collect {|line| line+= "\n"}
+	end
+  end
+end
+
+class String
+  def chop_both
+	self.chop!.reverse.chop!.reverse!
+  end
+end
+

data/test/template.spec

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../lib/template'
+
+describe "Templating system specifications" do
+  before(:all) do
+	@tmpl = File.dirname(__FILE__) + '/../data/test/template/input.tmpl'
+	@param = File.dirname(__FILE__) + '/../data/test/template/input.param'
+	@merged_file= File.dirname(__FILE__) + '/merged_file'
+	@reference_merged_file= File.dirname(__FILE__) + '/../data/test/template/reference_merged_file'
+	File.delete(@merged_file) if File.exist? @merged_file
+  end
+
+  it "second parameter to the template input must be an array" do
+	begin
+	  Template.new(@tmpl, @param)
+	rescue RuntimeError => e
+	  e.message.should == "parameter should be array"
+	end
+  end
+
+  it "should handle one template file, and merged multiple parameter files as array" do
+	Template.new(@tmpl, [@param])
+  end
+
+  it "should raise exception if template file does not exist" do
+	begin
+	  Template.new("none_exist_file", [@param])
+	rescue RuntimeError => e
+	  e.message.should == "file: none_exist_file does not exist"
+	end
+  end
+
+  it "should check if each of the element of the 2nd parameter is valid existing file" do
+	begin
+	  Template.new(@tmpl, ["none_exist_file"])
+	rescue RuntimeError => e
+	  e.message.should == "file: none_exist_file does not exist"
+	end
+  end
+
+  it "should merge parameter into template" do
+	template =  Template.new(@tmpl, [@param])
+	template.merge
+	template.result.should == "fuel type: OFA\nfuel enrichments:\n  3.1\n  3.2\n  3.3\nheights of each segment:\n  segment1 : 2.0\n  segment2 : 3.7\n\n"
+  end
+
+  it "should write merged data into one output file" do
+	Template.new(@tmpl, [@param], @merged_file)
+	File.size(@merged_file).should == File.size(@reference_merged_file)
+  end
+
+  it "should take output file name as the third input parameter" do
+	template =  Template.new(@tmpl, [@param], @merged_file)
+	File.size(@merged_file).should == File.size(@reference_merged_file)
+  end
+
+  it "should handle multiple input files, with the values from the last parameter file override" do
+	param_1 = File.dirname(__FILE__) + '/../data/test/template/input_1.param'
+	template =  Template.new(@tmpl, [@param, param_1], @merged_file)
+	reference_2_param_merged_file= File.dirname(__FILE__) + '/../data/test/template/reference_2_param_merged_file'
+	File.size(@merged_file).should == File.size(reference_2_param_merged_file)
+  end
+
+  after(:each) do
+	File.delete(@merged_file) if File.exist? @merged_file
+  end
+
+end

data/test/utils_spec.rb

@@ -0,0 +1,130 @@
+require File.dirname(__FILE__) + '/../lib/utils'
+require 'fileutils'
+
+describe "Property file handler" do
+
+  before(:each) do
+	@property_file = File.dirname(__FILE__) + '/../data/test/property_file/property.txt'
+	@prop = Utils.read_properties @property_file
+  end
+
+  it "should read correct number of records from a property file" do
+	@prop.size.should == 3
+  end
+
+  it "should read property file into a hash" do
+	@prop.class.to_s == "Hash"
+  end
+
+  it "should read correct value in correct format" do
+	@prop['key'].should == "value"
+	@prop['name'].should == "John Smith"
+	@prop['age'].should == "9"
+  end
+end
+
+describe "Property file with ruby hash and array" do
+
+  before(:each) do
+	@ruby_param_file = File.dirname(__FILE__) + '/../data/test/property_file/ruby_property.txt'
+	@ruby_prop = Utils.read_properties @ruby_param_file
+  end
+
+  it "should read simple key from property file" do
+	@ruby_prop['key'].should == "value"
+  end
+
+  it "should read array from property file" do
+	@ruby_prop['array'].class.to_s.should == "Array"
+	@ruby_prop['array'].size.should == 3
+	@ruby_prop['array'][2].should == 'item3'
+  end
+
+  it "should read hash from property file" do
+	@ruby_prop['hash'].class.to_s.should == "Hash"
+	@ruby_prop['hash'].size.should == 2
+	@ruby_prop['hash']['key1'] == 'v1'
+	@ruby_prop['hash']['key2'] == 'v2'
+  end
+end
+
+describe "Misc utils" do
+  it "should provide unique time stamp" do
+	stamp = Utils.unique_stamp
+	stamp.should_not be_nil
+	Utils.unique_stamp.should_not eql(stamp)
+  end
+
+  it "should create tmp directory in ~/tmp_dir" do
+	dir = Utils.tmp_dir
+	File.exist?(dir).should be_true 
+	File.exist?("#{ENV['HOME']}/tmp_dir").should be_true 
+  end
+
+  it "should provide unique tmp file" do
+	Utils.tmp_file.should_not == Utils.tmp_file
+  end
+
+  it "should delete tmp directory in ~/tmp_dir" do
+	Utils.rm_tmp_dir
+	require 'rake'
+	FileList["#{ENV['HOME']}/tmp_dir/*"].size.should == 0
+  end
+
+end
+
+describe "String extentions" do
+  it "should chop one character from both ends of the string" do
+
+	"abcd".chop_both.should == 'bc'
+  end
+end
+
+describe "Md5sum utilities" do
+  it "should generate correct MD5 key from a file path" do
+	file = File.dirname(__FILE__) + '/../data/test/md5data.txt'
+	Utils.md5_key(file).should == "cd981b6574d00ec0a4790f905bf3bcc8"
+  end
+
+  it "should generate exact line as md5sum from linux command" do
+	file = File.dirname(__FILE__) + '/../data/test/md5data.txt'
+	Utils.md5_line(file).should == "cd981b6574d00ec0a4790f905bf3bcc8  #{file}"
+  end
+
+  it "should generate a md5sum file with input files as array" do
+	file1 = File.dirname(__FILE__) + '/../data/test/md5data.txt'
+	file2 = File.dirname(__FILE__) + '/../data/test/md5data.txt'
+	result = Utils.md5sum([file1, file2])
+	result.size.should == 2
+  end
+
+  it "should query md5 key from one file" do
+	key_file =  File.dirname(__FILE__) + '/../data/test/md5sum.txt'
+	Utils.md5_key_exists(key_file, 'cd981b6574d00ec0a4790f905bf3bcc8').should be_true
+  end
+
+  it "should create md5sum file with files, and target" do
+	file1 = File.dirname(__FILE__) + '/../data/test/md5data.txt'
+	file2 = File.dirname(__FILE__) + '/../data/test/md5data2.txt'
+	target = Utils.unique_stamp
+
+	Utils.md5sum_file([file1, file2], target)
+
+	Utils.md5_key_exists(target, 'cd981b6574d00ec0a4790f905bf3bcc8').should be_true
+	Utils.md5_key_exists(target, '6af87cf8cd41824bfff795a0c90d86f0').should be_true
+	File.delete target
+  end
+end
+
+describe "File handler" do
+  it "should merge a few files into one big temporary file" do
+	file1 = File.dirname(__FILE__) + '/../data/test/template/input.param'
+	file2 = File.dirname(__FILE__) + '/../data/test/template/input_1.param'
+	file_array = [file1, file2]
+	new_file = Utils.merge_files(file_array)
+
+	File.size(new_file).should == (File.size(file1) + File.size(file2) + file_array.size)
+	FileUtils.remove_file(new_file, true)
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: tie
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Andrew Chen
+autorequire: tie
+bindir: bin
+cert_chain: []
+
+date: 2008-03-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: choice
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
+    version: 
+description: 
+email: meihome gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/template.rb
+- lib/tie.rb
+- lib/utils.rb
+- test/template.spec
+- test/utils_spec.rb
+- data/test
+- data/test/property_file
+- data/test/property_file/ruby_property.txt
+- data/test/property_file/property.txt
+- data/test/template
+- data/test/template/reference_2_param_merged_file
+- data/test/template/lattice.param
+- data/test/template/reference_merged_file
+- data/test/template/input_1.param
+- data/test/template/input.tmpl
+- data/test/template/input.param
+- data/test/md5sum.txt
+- data/test/md5data.txt
+- data/test/md5data2.txt
+- README
+has_rdoc: true
+homepage: http://tie.sourceforge.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Merging template file and parameter files
+test_files: 
+- test/template.spec
+- test/utils_spec.rb