spreadsheet_db_refi 0.0.0

data/lib/spreadsheet_db_refi.rb

@@ -0,0 +1,332 @@
+# encoding: UTF-8
+
+require 'sqlite3'
+
+module Refi
+
+# stores spreadsheet data in a sqlite database
+class SpreadsheetDb
+	@@std_create_tbls_strs = {
+		metadata: %q( 
+			create table metadata(
+				nam text, 
+				val text, 
+
+				primary key(nam)
+			);
+		),
+		sheet: %q(
+			create table sheet(
+				id integer, 
+				nam text, 
+				pos integer,
+
+				primary key(id), 
+				unique(nam),
+				unique(pos)
+			);
+		),
+		typ: %q(
+			create table typ(
+				id integer,
+				nam text,
+				mcv text,
+
+				primary key(id),
+				unique(nam)
+			);
+		),
+		cell: %q(
+			create table cell( 
+				sheet_id integer, 
+				row integer, 
+				col integer, 
+				val text, 
+				typ_id integer,
+
+				primary key(sheet_id, row, col), 
+				foreign key(sheet_id) references sheet(id),
+				foreign key(typ_id) references typ(id)
+			);
+		)
+	}.inject({}){|memo,(k,v)| memo[k] = v.strip_a_lot ; memo}
+	@@std_tbl_create_order = [:metadata, :sheet, :typ, :cell]
+	@@std_stmts_strs = {
+		metadata_set_nam_val: "insert or replace into metadata(nam,val) values(?,?);",
+		metadata_get_all: "select * from metadata;",
+		metadata_get_val_by_nam: "select val from metadata where nam=?;",
+		metadata_del_val_by_nam: "delete from metadata where nam=?;",
+		metadata_wipe: "delete from metadata;",
+		sheet_set_id_nam_pos: "insert or replace into sheet(id,nam,pos) values(?,?,?);",
+		sheet_get_id_by_nam: "select id from sheet where nam=?;",
+		sheet_get_nam_by_id: "select nam from sheet where id=?",
+		sheet_get_all: "select * from sheet;",
+		typ_set_id_nam_mcv: "insert or replace into typ(id,nam,mcv) values(?,?,?);",
+		typ_get_all_by_nam: "select * from typ where nam=?",
+		cell_set_sheet_row_col_val_typ: "insert or replace into cell(sheet_id,row,col,val,typ_id) values(?,?,?,?,?);",
+		cell_get: "select val,typ_id from cell where sheet_id=? and row=? and col=?;",
+		get_min_col: "select min(col) from cell where sheet_id=?;",
+		get_max_col: "select max(col) from cell where sheet_id=?;",
+		get_min_row: "select min(row) from cell where sheet_id=?;",
+		get_max_row: "select max(row) from cell where sheet_id=?;",
+		get_row: "select col,val,typ_id from cell where sheet_id=? and row=?;",
+		get_col: "select row,val,typ_id from cell where sheet_id=? and col=?;",
+		sqlite_get_tbl_nam_by_nam: "select name from sqlite_master where name=?;",
+	}
+	attr_accessor :db
+	def initialize(db_pn=nil)
+		@create_tbls_strs = @@std_create_tbls_strs
+		@stmts_strs = @@std_stmt_strs
+		@tbl_create_order = @@std_tbl_create_order
+		init2(db_pn)
+	end
+	def init2(db_pn=nil)
+		@is_open = false
+		reset
+		if(db_pn)
+			@db_pn = db_pn
+			open
+		end
+	end
+	def reset
+		if @is_open
+			@prep_stmts.each{|sym,prep_stmt| prep_stmt.close }
+			@db.close
+		end
+		@prep_stmts = {}
+		@db = nil
+		@is_open = false
+		@empty_cell_default_value = ''
+	end
+	def open
+		exist_prior = File.exist?(@db_pn)
+		if(exist_prior)
+			if(File.zero?(@db_pn))
+				File.delete(@db_pn)
+				exist_prior = false
+			end
+		end
+		@db = SQLite3::Database.new(@db_pn)
+		enhance_db_funcs
+
+		if(exist_prior)
+			assert_db_well_formed({exist_prior: exist_prior,on_err_exit: true}) 
+			prepare_statements
+		else
+			@db.transaction{|foo|
+				create_tables
+				prepare_statements
+				insert_minimum_records 
+			}
+			assert_db_well_formed({exist_prior: exist_prior,on_err_exit: true}) 
+		end
+		@is_open = true
+	end
+	def create_tables 
+		@tbl_create_order.each{|tbl_nam|
+			db.execute(@create_tbls_strs[tbl_nam])
+		}
+	end
+	def insert_minimum_records # requires prepared statements
+		@prep_stmts[:typ_set_id_nam_mcv].execute([nil,'std','{}'])
+	end
+	def assert_db_well_formed(p={}) # requires good tables(with minimum records) and prepared statements
+		exist_prior = p[:exist_prior] || false
+		on_err_exit = p[:on_err_exit] || true
+		good = true
+		@tbl_create_order.each{|sym|
+			nam = sym.to_s
+			# @prep_stmts is not ready yet
+			found_table = @db.execute(@stmts_strs[:sqlite_get_tbl_nam_by_nam],nam)[0] == [nam]
+			#found_table = @prep_stmts[:sqlite_get_tbl_name_by_name].execute(sym.to_s).size == 1
+			if(!found_table)
+				good = false
+				# missing table
+				$Log.tlog({id: 'err1122',table:sym.to_s})
+			end
+		}
+		if(!good)
+			if(exist_prior)
+				dperr(120,"existing db not well formed (pn:#{db_pn})",true,on_err_exit)
+			else
+				dperr(121,"new db not well formed (pn:#{db_pn})",true,on_err_exit)
+			end
+		end
+		return good
+	end
+	def enhance_db_funcs
+		$sqlite_enhance_funcs.each{|func_nam,func|
+			@db.create_function(func_nam,func[:func_body].arity + 1,func[:return_type], &func[:func_body])
+		}
+	end
+	def prepare_statements
+		@stmts_strs.each{|sym,stmt_str|
+			@prep_stmts[sym] = @db.prepare(stmt_str)
+		}
+	end
+	def get_metadata
+		if @db
+			return Hash[ @prep_stmts[:metadata_get_all].execute!() ]
+		else
+			return nil
+		end
+	end
+	def create_sheet(sheet_name,pos_ix)
+		@prep_stmts[:sheet_set_id_nam_pos].execute(nil,sheet_name,pos_ix)
+		new_sheet_id = @prep_stmts[:sheet_get_id_by_nam].execute!(sheet_name).flatten[0]
+		return new_sheet_id
+	end
+	def get_sheet_id_from_xid(sheet_xid)
+		if(sheet_xid.is_a?(String))
+			return @prep_stmts[:sheet_get_id_by_nam].execute!(sheet_xid).flatten[0]
+		elsif(sheet_xid.is_a?(Fixnum))
+			return sheet_xid
+		end
+	end
+	def get_sheet_name_from_xid(sheet_xid)
+		if(sheet_xid.is_a?(String))
+			return sheet_xid
+		elsif(sheet_xid.is_a?(Fixnum))
+			return @prep_stmts[:sheet_get_nam_by_id].execute!(sheet_xid).flatten[0]
+		end
+	end
+	def prep_ex(sym,p_ary=[])
+		return @prep_stmts[sym].execute!(p_ary)
+	end
+	def get_sheet_name_by_id(sheet_id)
+		return prep_ex(:sheet_get_nam_by_id,[sheet_id])[0]
+	end
+	def set_cell(sheet_id,row,col,value,type)
+		prep_ex(:cell_set_sheet_row_col_val_typ,[sheet_id,row,col,value,type])
+	end
+	def import_sheet(sheet_id,ss)
+		$Log.tlog({id: 'info1045'})
+		$Log.indent
+		#dputi("import all rows of sheet into cache")
+		#metadata = get_metadata
+		# CUR	
+		row_a = ss.first_row
+		row_e = ss.last_row
+		col_a = ss.first_column
+		col_e = ss.last_column
+		@db.transaction{|dbi|
+			row_a.upto(row_e){|row_i|
+				col_a.upto(col_e){|col_i|
+					#pp ss
+					#puts row_i
+					#puts col_i
+					cell_value = ss.cell(row_i,col_i)
+					value = ''
+					# TODO use hash?
+					if(cell_value == nil)
+						# TODO
+						#dparn(117,"empty cell (#{@ss_pn}:#{sheet_id}:#{row_i}:#{col_i}) using default value:'#{@empty_cell_default_value}'")
+						if(@empty_cell_default_value==nil)
+							dparn(777,"no empty cell default value using builtin string of the form 'XXX_empty_cell(...)'")
+							value = "XXX_empty_cell(#{@ss_pn}:#{sheet_id}:#{row_i}:#{col_i})"
+						else
+							value = @empty_cell_default_value
+						end
+					elsif(cell_value.is_a?(String))
+						value = cell_value
+					elsif(cell_value.is_a?(Date))
+						value = cell_value.iso8601
+					elsif(cell_value.is_a?(Float))
+						value = cell_value
+					elsif(cell_value.is_a?(NilClass))
+						dperr(113,"NilClass in cell")
+					else
+						dpev cell_value.class
+						dperr(1375, "#{__FILE__} #{__LINE__}")
+					end
+					type = 1
+					set_cell(sheet_id,row_i,col_i,value,type)
+				}
+				print 'c'
+			}
+			#dput
+			$Log.undent
+		}
+		#dpun
+		$Log.undent
+	end
+	def get_sheet(sheet_xid)
+		sheet_id = get_sheet_id_from_xid(sheet_xid)
+		new_sheet = SsDbSheet.new(self,sheet_id)
+		return new_sheet
+	end
+end
+
+class SsDbCellValue
+	attr_accessor :value
+	attr_accessor :type_id
+	def initialize(value,type_id)
+		dperr(131,"'value' is not of type 'String' (type:'#{value.class}'") if !value.is_a?(String)
+		dperr(132,"'type_id' is not of type 'Fixnum' (type:'#{type_id.class}'") if !type_id.is_a?(Fixnum)
+		@value = value
+		@type_id = type_id
+	end
+end
+
+class SsDbSheet
+	def initialize(ss_db,sheet_id)
+		@ss_db = ss_db
+		@sheet_id = sheet_id
+	end
+	def prep_ex(sym,p_ary=[])
+		@ss_db.prep_ex(sym,p_ary)
+	end
+	def get_dims
+		{
+			col: { 
+				min: prep_ex(:get_min_col,[@sheet_id])[0][0],
+				max: prep_ex(:get_max_col,[@sheet_id])[0][0],
+			},
+			row: {
+				min: prep_ex(:get_min_row,[@sheet_id])[0][0],
+				max: prep_ex(:get_max_row,[@sheet_id])[0][0],
+			},
+		}
+	end
+	def get_row(i,t=false)
+		q = if(t)
+			:get_col
+		else
+			:get_row
+		end
+		row = prep_ex(q,[@sheet_id,i]).inject({}){|memo,j|
+			memo[ j[0] ] = SsDbCellValue.new( j[1], j[2])
+			memo
+		}
+		return row
+	end
+	def get_cell(r,c,t=false) # row col transpose
+		r,c = c,r if t
+		value,type_id = *prep_ex(:cell_get,[@sheet_id,r,c])[0]
+ 		return SsDbCellValue.new(value,type_id)
+	end
+	def get_col(i,transpose=false)
+		return get_row(i,!transpose)
+	end
+
+  # if t is true rows and columns are transposed
+	def get_first_row(t=false)
+		return get_first_col if t
+		return prep_ex(:get_min_row)
+	end
+	def get_last_row(t=false)
+		return get_last_col if t
+		return prep_ex(:get_max_row)
+	end
+	def get_first_col(t=false)
+		return get_first_row if t
+		return prep_ex(:get_min_col)
+	end
+	def get_last_col(t=false)
+		return get_last_row if t
+		return prep_ex(:get_max_col)
+	end
+end
+
+
+end # module Refi

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: spreadsheet_db_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: sqlite3-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :runtime
+  version_requirements: *id001
+description: store spreadsheet data in a sqilte db
+email: feyrob@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/spreadsheet_db_refi.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/spreadsheet_db_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: ""
+test_files: []
+