spreadsheet_export_refi 0.0.0

data/lib/spreadsheet_export_refi.rb

@@ -0,0 +1,401 @@
+# encoding: UTF-8
+
+require 'spreadsheet_cache_manager_refi'
+require 'file_cache_manager_refi'
+require 'minival_refi'
+require 'minilang_refi'
+require 'template_refi'
+
+
+#myreq "#{$intern_base_path}/ss_db_cache_manager.rb"
+#myreq "#{$intern_base_path}/text_file_cache_manager.rb"
+#myreq "#{$intern_base_path}/minival.rb"
+#myreq "#{$intern_base_path}/minilang.rb"
+#myreq "#{$intern_base_path}/template.rb"
+
+$minival_parser = MinivalGrammarParser.new
+
+class SsExport
+	@@special_col_labels = ['ACTIVE','INSTRUCTION','FILE','SHEET','EXPORT','PARAMS','IGNORE']
+	@@dont_duplicate_from_super_map = ['INSTRUCTION','FILE','SHEET','IGNORE','PARAMS']
+
+
+	# \#placeholder_name_example#"
+	# \-a_function_name(a_minival_string)"
+ 	@@replace_functions = {
+ 		"nothing" => proc{|context,minival|
+ 			next ""
+ 		},
+		# file can only open files in subdirectories
+		# TODO security stuff
+ 		"read_file" => proc{|context,minival|
+			if(minival[0].is_a?(String))
+				text = context.text_file_cache_manager.get_text(minival[0])
+				next text
+			else
+				dparn('W1001',"read_file - could not open file because minival was not a string")
+				next nil
+			end
+ 		},
+ 		"current_spreadsheet_file_pathname" => proc{|context,minival|
+			next context.ss_pn
+ 		},
+ 		#"current_template_file_pathname" => proc{|context,minival|
+		#	next context.current_file_info[:pn]
+ 		#},
+		"catch" => proc{|context,minival|
+			catch_name = minival[0]
+			if(catch_name.is_a?(String))
+				res = context.var_map[catch_name]
+				if res==nil
+					dput
+					dparn 1012,"catch could not find '#{catch_name}' in var_map"
+					res = ''
+				end
+				next res
+			else
+				dparn(1002,"catch - could not open file because minival was not a string")
+				next nil
+			end
+		},
+ 		"minilang_eval" => proc{|context,minival|
+			next context.minilang_env.run_str(minival[0])
+ 		},
+ 	}
+	
+	def self.call_replace_function(context,name,minival_str)
+		fun = @@replace_functions[name]
+		return nil unless fun
+		minival = Minival.new(minival_str)
+		return nil unless minival.valid
+		return fun.call(context,minival)
+	end
+
+	attr_reader :ss_pn
+	attr_reader :var_map
+
+	def initialize(p={})
+		@instructions = {
+			"insert" => self.method(:insert_instruction),
+			"delegate" => self.method(:delegate_instruction),
+			"do" => self.method(:do_instruction),
+			"select" => self.method(:select_instruction),
+		}
+		@ss_pn = p[:ss_pn] || nil
+		@sheet_name = p[:sheet_name] || dperr(1008,'a sheetname must be specified')
+		@output_file = p[:output_file] || dperr(1009,'no output file specified')
+		@transpose = p[:transpose] || false
+		@ss_db_cache_manager = p[:ss_db_cache_manager] || SsDbCacheManager.new({default_db_pa: './cache/'})
+		@template_pa_prefix = p[:template_pa_prefix]
+		@text_file_cache_manager = p[:text_file_cache_manager] || TextFileCacheManager.new()
+		#@export_type = p[:export_type] || dperr(1010,'no export type specified')
+		@export_type = p[:export_type] || $Log.tlog({id: 'err1010'})
+		@super_var_map = p[:super_var_map] || {}
+		@subs = p[:subs] || dperr(1011,'no subsitutions passed to ss_export')
+		@var_map = {}
+		@ss_db_cache = @ss_db_cache_manager.get_ss_db_cache(@ss_pn)
+		@sheet = @ss_db_cache.get_sheet(@sheet_name)
+		@minilang_env = MinilangEnv.new(self, {export_type: @export_type} )
+		@loops = []
+		if(@sheet == nil)
+			# TODO make check for sheet_names
+			dperr('E1003',"no sheet: #{$st[:sheet]}#{@sheet_name}#{$st[:error]} in #{$st[:ss_file]}#{@ss_pn}\nsheets available are:#{@spreadsheet_cache.get_sheet_names.inspect}")
+		end
+	end
+	def process
+		#dputi "to #{$st[:ss_file]}#{@ss_pn}#{$st[:std]}" << reset << ":#{$st[:sheet]}#{@sheet_nam}"
+		#dputi
+		#dpit ''
+		get_sheet_dims
+		read_headers()
+		@on_sheet_exit_add = ''
+		process_instructions()
+		write @on_sheet_exit_add
+		#dput
+		$Log.tlog({id: 'newline'})
+		#dpun 
+	end
+	def write text
+		@subs[:write].each{|r,s|
+			text = text.gsub(r,s)
+		}
+		@output_file.write text
+	end
+	def read_headers()
+		#dputi "#{$st[:whisper]}K - read column labels"
+		first = @sheet_dims[:col][:min]
+		last = @sheet_dims[:col][:max]
+		@header_cols = get_row(1).inject({}){|memo,(k,v)| memo[v.value.to_s] = k ; memo } 
+		#dpun
+	end
+	def get_sheet_dims
+		sheet_dims = @sheet.get_dims
+		if(@transpose)
+			sheet_dims = { 
+				col: sheet_dims[:row],
+				row: sheet_dims[:col],
+			}
+		end
+		@sheet_dims = sheet_dims
+	end
+	def process_row(row_i)
+		@cur_row = row_i
+		if(is_row_active(row_i))
+			instruction_str = get_instruction(row_i)
+			process_instruction(instruction_str,row_i)
+		end
+	end
+	def consume_after_last_row
+			write @after_last_row
+			@after_last_row = ''
+	end
+	def process_rows_from from
+		last_row = @sheet_dims[:row][:max]
+		from.upto(last_row) do |row_i|
+			process_row(row_i)
+		end
+		consume_after_last_row
+	end
+	def process_instructions()
+		@after_last_row = ''
+		process_rows_from(2)
+		@loops.each{|l|
+			#pp l
+			from = l[:from]
+			ary = l[:ary]
+			l_var_name = l[:l_var_name]
+			while !ary.empty?
+				@minilang_env.set_l(l_var_name,ary.shift)
+				process_rows_from(from)
+			end
+		}
+	end
+	def get_cell(row_i,col_i)
+		return @sheet.get_cell(row_i,col_i,@transpose)
+	end
+	def get_instruction(row_i)
+		return get_cell(row_i,@header_cols['INSTRUCTION']).value
+	end
+	def is_row_active(row_i)
+		active_col_i = @header_cols['ACTIVE']
+		if(active_col_i == nil)
+			$Log.tlog( {id: 'err1402'} )
+			#dperr(402,"no column named 'ACTIVE' - this column is mandatory")
+		end
+		is_active_str = get_cell(row_i,active_col_i).value
+		if(is_active_str.is_a?(String))
+			if(is_active_str == "NO") 
+				$Log.tlog( {id: 'info1403'} )
+				return false
+			elsif(is_active_str == "YES")
+				ex_i = @header_cols['EXPORT']
+				ex_range = nil
+				if ex_i == nil
+					return true # missing EXPORT column defaults to active
+				else
+					ex_range = get_cell(row_i,ex_i).value
+				end
+				if (("*" == ex_range) or (@export_type == ex_range)) # EXPORT type matches 
+					return true
+				else # 'EXPORT' must be something we are not interested in
+					return false
+				end
+			else
+				dperr(404,"'ACTIVE' has invalid value: #{is_active_str}\n(valid values are the strings 'YES' and 'NO')")
+			end
+		else # not ''.class
+			dperr(403,"'ACTIVE' has invalid value/type (row:#{row_i} col:#{active_col_i}) value:'#{is_active_str}' value.class:'#{is_active_str.class}' last row:#{@sheet.get_last_row.to_s} (valid values are the strings 'YES' and 'NO')")
+		end
+		return false
+	end
+	def process_instruction(instruction_type,row_i)
+		# TODO add warnings
+		@debug_row_i = row_i
+		@var_map = @super_var_map.dup() 
+		@@dont_duplicate_from_super_map.each{|col_label|
+			@var_map.delete(col_label)
+		}
+		row = get_row(row_i)
+		@header_cols.each_pair{|col_label,col_i|
+			@var_map[col_label] = eval_var(row[col_i].value)
+		}
+		inst_p = @instructions[instruction_type]
+		if(inst_p)
+			inst_p.call(row_i)
+		else
+			$Log.tlog( {id: 'err1302', ss_pn: @ss_pn, sheet_name:@sheet_name, row_i: row_i} )
+			#dperr('E302',"invalid instruction - spreadsheet:'#{$st[:ss_file]}#{@ss_pn}#{$st[:error]} sheet:#{$st[:sheet]}#{@sheet_name}#{$st[:error]} row:#{$st[:num]}#{row_i}")
+		end
+	end
+	def get_row(row_i)
+		return @sheet.get_row(row_i,@transpose)
+	end
+
+	def do_instruction(row_i)
+		$Log.tlog({id: 'info1125_do_instruction'})
+		params = get_params(row_i)
+		@minilang_env.set_var_map @var_map
+		@minilang_env.run_str(params[:do])
+		text = @minilang_env.consume_text
+		if params[:on_exit]
+			@on_sheet_exit_add << text
+		else
+			write text
+		end
+	end
+
+	def select_instruction(row_i)
+		$Log.tlog( {id: 'info1123_select_instruction'} )
+	end
+
+	def create_loop(l_var_name,ary)
+		# TODO
+		# set l_var to ary.shift
+		@minilang_env.set_l(l_var_name,ary.shift)
+		@loops.push({from:(@cur_row+1),ary:ary,l_var_name:l_var_name})
+
+		#@creator.create_loop(l_var_name,ary)
+		#@loops.
+
+	end
+	def read_file pn
+		if pn == ''
+			return ''
+		end
+		return @text_file_cache_manager.get_text("#{@template_pa_prefix}#{pn}")
+	end
+	def insert_instruction(row_i)
+		print 'i'
+		#if(row_i <= 12 || row_i % 20 == 0)
+		#	print "r#{row_i} "
+		#end
+		params = get_params(row_i)
+		do_expression = params[:do]
+		template_text = ''
+		filename = @var_map['FILE']
+		#template_text = @text_file_cache_man.get_text("#{@template_pa_prefix}#{filename}")
+		template_text = read_file(filename)
+		text = template_text.gsub(/(\\)#(.*?)#/){
+			v = @var_map[$2]
+			if(v.is_a? String)
+				next v
+			else
+				dparn(304,"placeholder not in @var_map ('#{$2}')")
+				next "XXX WARN 304 @var_map[#{$2}].is_a? was not a string" # replace placeholder with error message
+			end
+		}
+		if params[:on_exit]
+			@on_sheet_exit_add << text
+		elsif params[:after_last_row]
+			@after_last_row << text
+		else
+			write text
+		end
+	end
+
+	def delegate_instruction(row_i)
+		@debug_row_i = row_i
+		params = get_params(row_i)
+		p2_ss_pn = eval_mvar('FILE')
+		p2_sheet_name = eval_mvar('SHEET')
+		transpose_str = params[:transpose]
+		transpose = false
+
+		$Log.tlog({id: 'info1124_delegate_instruction', ss_pn: @ss_pn, sheet_name: @sheet_name, row_i: row_i, p2_ss_pn: p2_ss_pn, p2_sheet_name: p2_sheet_name})
+		$Log.indent
+
+		#dputi "delegate from #{$st[:ss_file]}#{@ss_pn}#{$st[:std]}" << reset << ":#{$st[:sheet]}#{@sheet_name}:#{$st[:num]}#{row_i}" << reset << " to #{$st[:ss_file]}#{p2_ss_pn}#{$st[:std]}" << reset << ":#{$st[:sheet]}#{p2_sheet_name}"
+		if(transpose_str)
+			if(transpose_str == 'true')
+				transpose = true
+			elsif(transpose_str == 'false')
+				# ok
+			else
+				dparn(401,"delegate_instruction - value for transpose is neither 'true' nor 'false' (defaulting to false) - value is: #{transpose_str}")
+			end
+		end
+		se = SsExport.new({
+			ss_pn: p2_ss_pn,
+			sheet_name: p2_sheet_name,
+			output_file: @output_file,
+			transpose: transpose,
+			ss_db_cache_manager: @ss_db_cache_manager,
+			template_pa_prefix: @template_pa_prefix,
+			text_file_cache_manager: @text_file_cache_manager,
+			export_type: @export_type,
+			super_var_map: @var_map,
+			subs: @subs,
+		})
+		se.process()
+		#dpun
+		$Log.undent
+		#dput "done with: #{$st[:ss_file]}#{p2_ss_pn}#{$st[:std]}" << reset << ":#{$st[:sheet]}#{p2_sheet_name}"
+		$Log.tlog({id:'info1060',p2_ss_pn:p2_ss_pn,p2_sheet_name:p2_sheet_name})
+	end
+	def eval_mvar(col_label)
+		unless @var_map.has_key?(col_label)
+			dperr(1007,"no column named:'#{col_label}'")
+		end
+		str = @var_map[col_label]
+		if(str.is_a? String)
+			str = str.gsub(/\\_/,'')
+			return eval_var(str)
+		else
+			dparn(406,"")
+			return 'XXX - WARN 406'
+		end
+	end
+	def eval_var(var)
+		if(var.class == Fixnum)
+			return var.to_s
+		elsif(var.class == Bignum)
+			return var.to_s
+		end
+
+		if(var.class != String)
+				dparn('W601',"var from db is of class:'#{var.class.to_s}'")
+				return "XXX WARN 601 - var from db is of class:'#{var.class.to_s}'"
+		end
+		if(var == '')
+			dperr(1372,"empty cell #{$st[:ss_file]}#{@ss_pn}:#{$st[:sheet]}#{@sheet_name}:#{$st[:num]}#{@debug_row_i}")
+		end
+		var = var.gsub(/\\_/,'')
+		unless var.index("\\-")
+			return var
+		end
+		t = Template.new(var)
+		parts = t.get_parts
+		ret_var = ''
+		parts.each{|part|
+			if(part.is_a? FunctionCall)
+				r = @@replace_functions[part.name].call(self,part.args)
+				ret_var << r
+			elsif(part.is_a? String)
+				ret_var << part
+			end
+		}
+		return ret_var.strip
+	end
+	def get_params(row_i)
+		params_str = @var_map['PARAMS']
+		params = {}
+		if(params_str == nil)
+		elsif(params_str.is_a? String)
+			pr = Minival.new(params_str)
+			if(pr.valid)
+				params = pr.get_value
+			else
+				pr.report_errors
+				dperr(311,"invalid 'PARAMS' ? - value: '#{params_str}' (row:#{row_i})")
+			end
+		else
+			dperr 310,"params_str not nil and not string (params_str.class:#{params_str.class.to_s})"
+		end
+
+		if(params.class != {}.class)
+			dparn(303,"failed to parse minival (row:#{row_i} column:'PARAMS')")
+			params = {'WARN'=>'303'}
+		end
+		return params
+	end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: spreadsheet_export_refi
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Robert Fey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-26 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spreadsheet_cache_manager_refi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: file_cache_refi
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minilang_refi
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: template_refi
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id004
+description: ""
+email: feyrob@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/spreadsheet_export_refi.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/spreadsheet_export_refi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: nowarning
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: create documents with instructions in spreadsheets
+test_files: []
+