og 0.16.0 → 0.17.0

data/lib/og/store/mysql.rb

@@ -0,0 +1,283 @@
+begin
+	require 'mysql'
+rescue Object => ex
+	Logger.error 'Ruby-Mysql bindings are not installed!'
+	Logger.error ex
+end
+
+require 'og/store/sql'
+
+# Customize the standard mysql resultset to make
+# more compatible with Og.
+
+class Mysql::Result
+	def blank?
+		0 == num_rows
+	end
+
+	alias_method :next, :fetch_row	
+
+	def each_row
+		each do |row|
+			yield(row, 0)
+		end
+	end
+	
+	def first_value
+		val = fetch_row[0]
+		free
+		return val
+	end
+	
+	alias_method :close, :free
+end
+
+module Og
+
+module MysqlUtils
+	include SqlUtils
+	
+	def escape(str)
+		return nil unless str
+		return Mysql.quote(str)
+	end
+	
+	def quote(val)
+		case val
+			when Fixnum, Integer, Float
+				val ? val.to_s : 'NULL'
+			when String
+				val ? "'#{escape(val)}'" : 'NULL'
+			when Time
+				val ? "'#{timestamp(val)}'" : 'NULL'
+			when Date
+				val ? "'#{date(val)}'" : 'NULL'
+			when TrueClass
+				val ? "'1'" : 'NULL'
+			else 
+				# gmosx: keep the '' for nil symbols.
+				val ? escape(val.to_yaml) : ''
+		end 
+	end	
+end
+
+# A Store that persists objects into a MySQL database.
+# To read documentation about the methods, consult the documentation
+# for SqlStore and Store.
+
+class MysqlStore < SqlStore
+	extend MysqlUtils
+	include MysqlUtils
+
+	def self.create(options)
+		# gmosx: system is used to avoid shell expansion.
+		system 'mysqladmin', '-f', "--user=#{options[:user]}", 
+				"--password=#{options[:password]}", 
+				'create', options[:name]		
+		super
+	end
+
+	def self.destroy(options)
+		system 'mysqladmin', '-f', "--user=#{options[:user]}", 
+				"--password=#{options[:password]}", 'drop', 
+				options[:name]
+		super
+	end
+
+	def initialize(options)
+		super
+
+		@typemap.update(TrueClass => 'tinyint')
+
+		@conn = Mysql.connect(
+			options[:address] || 'localhost', 
+			options[:user],
+			options[:password], 
+			options[:name]
+		)
+	rescue => ex
+		if ex.errno == 1049 # database does not exist.
+			Logger.info "Database '#{options[:name]}' not found!"
+			self.class.create(options)
+			retry
+		end
+		raise
+	end
+
+	def close
+		@conn.close
+		super
+	end
+
+	def enchant(klass, manager)
+		klass.property :oid, Fixnum, :sql => 'integer AUTO_INCREMENT PRIMARY KEY'
+		super
+	end
+	
+	def query(sql)
+#		Logger.debug sql if $DBG
+		@conn.query_with_result = true 
+		return @conn.query(sql)
+	rescue => ex
+		handle_sql_exception(ex, sql)
+	end
+
+	def exec(sql)
+#		Logger.debug sql if $DBG
+		@conn.query_with_result = false
+		@conn.query(sql)
+	rescue => ex
+		handle_sql_exception(ex, sql)
+	end
+
+	def start	
+		# nop
+		# FIXME: InnoDB supports transactions.
+	end
+	
+	# Commit a transaction.
+	
+	def commit
+		# nop, not supported?
+		# FIXME: InnoDB supports transactions.
+	end
+	
+	# Rollback a transaction.
+	
+	def rollback
+		# nop, not supported?
+		# FIXME: InnoDB supports transactions.
+	end
+
+private
+
+	def create_table(klass)
+		columns = columns_for_class(klass)
+
+		sql = "CREATE TABLE #{klass::OGTABLE} (#{columns.join(', ')}"
+		
+		# Create table constrains.
+		
+		if klass.__meta and constrains = klass.__meta[:sql_constrain]
+			sql << ", #{constrains.join(', ')}"
+		end
+		
+		sql << ");"
+		
+		# Create indices.
+		
+		if klass.__meta and indices = klass.__meta[:index]
+			for data in indices
+				idx, options = *data
+				idx = idx.to_s
+				pre_sql, post_sql = options[:pre], options[:post]
+				idxname = idx.gsub(/ /, "").gsub(/,/, "_").gsub(/\(.*\)/, "")
+				sql << " CREATE #{pre_sql} INDEX #{klass::OGTABLE}_#{idxname}_idx #{post_sql} ON #{klass::OGTABLE} (#{idx});"  
+			end
+		end
+		
+		@conn.query_with_result = false
+
+		begin
+			@conn.query(sql)
+			Logger.info "Created table '#{klass::OGTABLE}'."
+		rescue => ex
+			if ex.errno == 1050 # table already exists.
+				Logger.debug 'Table already exists' if $DBG
+				return
+			else
+				raise
+			end
+		end
+		
+		# Create join tables if needed. Join tables are used in
+		# 'many_to_many' relations.
+		
+ 		if klass.__meta and join_tables = klass.__meta[:join_tables] 
+			for join_table in join_tables
+				begin
+					@conn.query("CREATE TABLE #{join_table} (key1 integer NOT NULL, key2 integer NOT NULL)")
+					@conn.query("CREATE INDEX #{join_table}_key1_idx ON #{join_table} (key1)")
+					@conn.query("CREATE INDEX #{join_table}_key2_idx ON #{join_table} (key2)")
+				rescue => ex
+					if ex.errno == 1050 # table already exists.
+						Logger.debug 'Join table already exists'
+					else
+						raise
+					end
+				end
+			end
+		end
+	end
+
+	def create_column_map(klass)
+		conn.query_with_result = true
+		res = @conn.query "SELECT * FROM #{klass::OGTABLE} LIMIT 1"
+		map = {}
+
+		res.num_fields.times do |i|
+			map[res.fetch_field.name.intern] = i
+		end
+
+		return map
+	ensure
+		res.close if res
+	end
+
+	def write_prop(p)
+		if p.klass.ancestors.include?(Integer)
+			return "#\{@#{p.symbol} || 'NULL'\}"
+		elsif p.klass.ancestors.include?(Float)
+			return "#\{@#{p.symbol} || 'NULL'\}"		
+		elsif p.klass.ancestors.include?(String)
+			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol})\}'" : 'NULL'\}|
+		elsif p.klass.ancestors.include?(Time)
+			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.timestamp(@#{p.symbol})\}'" : 'NULL'\}|
+		elsif p.klass.ancestors.include?(Date)
+			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.date(@#{p.symbol})\}'" : 'NULL'\}|
+		elsif p.klass.ancestors.include?(TrueClass)
+			return "#\{@#{p.symbol} ? \"'1'\" : 'NULL' \}"
+		else 
+			# gmosx: keep the '' for nil symbols.
+			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol}.to_yaml)\}'" : "''"\}|
+		end
+	end		
+	
+	def read_prop(p, col)
+		if p.klass.ancestors.include?(Integer)
+			return "res[#{col} + offset].to_i"
+		elsif p.klass.ancestors.include?(Float)
+			return "res[#{col} + offset].to_f"
+		elsif p.klass.ancestors.include?(String)
+			return "res[#{col} + offset]"
+		elsif p.klass.ancestors.include?(Time)
+			return "#{self.class}.parse_timestamp(res[#{col} + offset])"
+		elsif p.klass.ancestors.include?(Date)
+			return "#{self.class}.parse_date(res[#{col} + offset])"
+		elsif p.klass.ancestors.include?(TrueClass)
+			return "('0' != res[#{col} + offset])"
+		else 
+			return "YAML.load(res[#{col} + offset])"
+		end				
+	end
+
+	def eval_og_insert(klass)
+		props = klass.properties
+		values = props.collect { |p| write_prop(p) }.join(',') 
+		
+		sql = "INSERT INTO #{klass::OGTABLE} (#{props.collect {|p| p.symbol.to_s}.join(',')}) VALUES (#{values})"
+
+		klass.class_eval %{
+			def og_insert(store)
+				#{Aspects.gen_advice_code(:og_insert, klass.advices, :pre) if klass.respond_to?(:advices)}
+				store.conn.query_with_result = false
+				store.conn.query "#{sql}"
+				@#{klass.pk_symbol} = store.conn.insert_id
+				#{Aspects.gen_advice_code(:og_insert, klass.advices, :post) if klass.respond_to?(:advices)}
+			end
+		}
+	end
+
+end
+
+end

data/lib/og/store/psql.rb

@@ -0,0 +1,238 @@
+begin
+	require 'postgres'
+rescue Object => ex
+	Logger.error 'Ruby-PostgreSQL bindings are not installed!'
+	Logger.error ex
+end
+
+require 'og/store/sql'
+
+# Customize the standard postgres resultset to make
+# more compatible with Og.
+
+class PGresult
+	def blank?
+		0 == num_tuples
+	end
+	
+	def next
+		self
+	end
+
+	def each_row
+		for row in (0...num_tuples)
+			yield(self, row)
+		end
+	end
+	
+	def first_value
+		val = getvalue(0, 0)
+		clear
+		return val
+	end
+	
+	alias_method :close, :clear
+end
+
+module Og
+
+module PsqlUtils
+	include SqlUtils
+	
+	def escape(str)
+		return nil unless str
+		return PGconn.escape(str)
+	end
+end
+
+# A Store that persists objects into a PostgreSQL database.
+# To read documentation about the methods, consult the documentation
+# for SqlStore and Store.
+# 
+# === Design
+#
+# The getvalue interface is used instead of each for extra
+# performance.
+
+class PsqlStore < SqlStore
+	extend PsqlUtils
+	include PsqlUtils
+
+	def self.create(options)
+		# gmosx: system is used to avoid shell expansion.
+		system 'createdb', options[:name], '-U', options[:user]
+		super
+	end
+
+	def self.destroy(options)
+		system 'dropdb', options[:name], '-U', options[:user]
+		super
+	end
+
+	def initialize(options)
+		super
+
+		@conn = PGconn.connect(
+			options[:address], 
+			options[:port], nil, nil, 
+			options[:name], 
+			options[:user].to_s, 
+			options[:password].to_s
+		)
+	rescue => ex
+		# gmosx: any idea how to better test this?
+		if ex.to_s =~ /database .* does not exist/i
+			Logger.info "Database '#{options[:name]}' not found!"
+			self.class.create(options)
+			retry
+		end
+		raise
+	end
+
+	def close
+		@conn.close
+		super
+	end
+
+	def enchant(klass, manager)
+		klass.const_set 'OGSEQ', "#{table(klass)}_oid_seq"
+		klass.property :oid, Fixnum, :sql => 'serial PRIMARY KEY'
+		super
+	end
+
+	def query(sql)
+		Logger.debug sql if $DBG
+		return @conn.exec(sql)
+	rescue => ex
+		handle_sql_exception(ex, sql)
+	end
+
+	def exec(sql)
+		Logger.debug sql if $DBG
+		@conn.exec(sql).clear
+	rescue => ex
+		handle_sql_exception(ex, sql)
+	end
+
+private
+
+	def create_table(klass)
+		columns = columns_for_class(klass)
+
+		sql = "CREATE TABLE #{klass::OGTABLE} (#{columns.join(', ')}"
+		
+		# Create table constrains.
+		
+		if klass.__meta and constrains = klass.__meta[:sql_constrain]
+			sql << ", #{constrains.join(', ')}"
+		end
+		
+		sql << ") WITHOUT OIDS;"
+		
+		# Create indices.
+		
+		if klass.__meta and indices = klass.__meta[:index]
+			for data in indices
+				idx, options = *data
+				idx = idx.to_s
+				pre_sql, post_sql = options[:pre], options[:post]
+				idxname = idx.gsub(/ /, "").gsub(/,/, "_").gsub(/\(.*\)/, "")
+				sql << " CREATE #{pre_sql} INDEX #{klass::OGTABLE}_#{idxname}_idx #{post_sql} ON #{klass::OGTABLE} (#{idx});"  
+			end
+		end
+
+		begin
+			@conn.exec(sql).clear
+			Logger.info "Created table '#{klass::OGTABLE}'."
+		rescue Object => ex
+			# gmosx: any idea how to better test this?
+			if ex.to_s =~ /relation .* already exists/i
+				Logger.debug 'Table already exists' if $DBG
+				return
+			else
+				raise
+			end
+		end
+
+		# Create join tables if needed. Join tables are used in
+		# 'many_to_many' relations.
+		
+ 		if klass.__meta and join_tables = klass.__meta[:join_tables] 
+			for join_table in join_tables
+				begin
+					@conn.exec("CREATE TABLE #{join_table} (key1 integer NOT NULL, key2 integer NOT NULL)").clear
+					@conn.exec("CREATE INDEX #{join_table}_key1_idx ON #{join_table} (key1)").clear
+					@conn.exec("CREATE INDEX #{join_table}_key2_idx ON #{join_table} (key2)").clear
+				rescue Object => ex
+					# gmosx: any idea how to better test this?
+					if ex.to_s =~ /relation .* already exists/i
+						Logger.debug 'Join table already exists'
+					else
+						raise
+					end
+				end
+			end
+		end
+	end
+
+	def drop_table(klass)
+		super
+		exec "DROP SEQUENCE #{klass::OGSEQ}"		
+	end
+
+	def create_column_map(klass)
+		res = @conn.exec "SELECT * FROM #{klass::OGTABLE} LIMIT 1"
+		map = {}
+	
+		for column in res.fields
+			map[column.intern] = res.fieldnum(column)
+		end
+	
+		return map
+	ensure
+		res.clear if res
+	end
+
+	def read_prop(p, col)
+		if p.klass.ancestors.include?(Integer)
+			return "res.getvalue(row, #{col} + offset).to_i"
+		elsif p.klass.ancestors.include?(Float)
+			return "res.getvalue(row, #{col} + offset).to_f"
+		elsif p.klass.ancestors.include?(String)
+			return "res.getvalue(row, #{col} + offset)"
+		elsif p.klass.ancestors.include?(Time)
+			return "#{self.class}.parse_timestamp(res.getvalue(row, #{col} + offset))"
+		elsif p.klass.ancestors.include?(Date)
+			return "#{self.class}.parse_date(res.getvalue(row, #{col} + offset))"
+		elsif p.klass.ancestors.include?(TrueClass)
+			return %|('t' == res.getvalue(row, #{col} + offset))|
+		else 
+			return "YAML.load(res.getvalue(row, #{col} + offset))"
+		end		
+	end
+
+	#--
+	# TODO: create stored procedure.
+	#++
+
+	def eval_og_insert(klass)
+		props = klass.properties
+		values = props.collect { |p| write_prop(p) }.join(',') 
+		
+		sql = "INSERT INTO #{klass::OGTABLE} (#{props.collect {|p| p.symbol.to_s}.join(',')}) VALUES (#{values})"
+
+		klass.class_eval %{ 
+			def og_insert(store)
+				#{Aspects.gen_advice_code(:og_insert, klass.advices, :pre) if klass.respond_to?(:advices)}
+				res = store.conn.exec "SELECT nextval('#{klass::OGSEQ}')"
+				@#{klass.pk_symbol} = res.getvalue(0, 0).to_i
+				res.clear
+				store.conn.exec("#{sql}").clear
+				#{Aspects.gen_advice_code(:og_insert, klass.advices, :post) if klass.respond_to?(:advices)}
+			end
+		}
+	end
+
+end
+
+end