nitro 0.11.0 → 0.12.0

data/lib/og.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: og.rb 266 2005-02-28 14:50:48Z gmosx $
+# $Id: og.rb 270 2005-03-07 17:52:16Z gmosx $
 
 require 'glue'
 require 'glue/logger'
@@ -15,7 +15,7 @@ require 'glue/validation'
 # Og (ObjectGraph) is an efficient, yet simple Object-Relational 
 # mapping library. 
 #
-# == Features
+# === Features
 #
 # The library provides the following features:
 #
@@ -30,12 +30,13 @@ require 'glue/validation'
 # + Thread safety.
 # + SQL transactions.
 # + Lifecycle callbacks.
+# + Lifecycle observers.
 # + Transparent support for cascading deletes for all backends.
 # + Hierarchical structures (preorder traversal, materialized paths)
 # + Works safely as part of distributed application.
 # + Simple implementation.
 #
-# == Meta language
+# === Meta language
 #
 # primary_key :pid (NOT IMPLEMENTED)
 # name_key :name (NOT IMPLEMENTED)
@@ -44,13 +45,24 @@ require 'glue/validation'
 # many_to_many Role, :roles
 # sql_index :pid
 #
-# == Design
+# === Property Metadata
+#
+# Og defines, reserves and uses the following property 
+# metadata types:
+#
+# [+:sql_index+]
+#		Create an sql index for this property.
+#
+# [+:unique+]
+#		This value of the property must be unique.
+#
+# [+:name_key+] 
+#		This property is used as name-key.
+#
+# === Design
 #
 # Keep the main classes backend agnostic. 
-#--
-# Try to make the methods work with oids. Do NOT implement descendants 
-# use a root id (rid).
-#++
+#
 # For class ids we use the name instead of a hash. Class ids are
 # typically not used in querys, they are stored for completeness.
 # If we store a hash we cannot reclaim the class thus invalidating
@@ -68,8 +80,10 @@ require 'glue/validation'
 # The og.xxx methods are more flexible and allow you to use
 # multiple databases for example.
 # 
-# == Managed Objects Lifecycle Callbacks
+# === Managed Objects Lifecycle Callbacks
 #
+# * og_pre_read
+# * og_post_read
 # * og_pre_insert
 # * og_post_insert
 #	* og_pre_update
@@ -81,7 +95,7 @@ require 'glue/validation'
 # A class level callback is used for delete because typically you call
 # delete with an oid and not an object to avoid a deserialization.
 #
-# == Future 
+# === Future 
 # 
 # * Support prepared statements (pgsql)
 # * Support stored procedures (pgsql)
@@ -97,7 +111,7 @@ module Og
 
 	# The version.
 
-	Version = '0.11.0'
+	Version = '0.12.0'
 
 	# Library path.
 

data/lib/og/adapter.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: adapter.rb 266 2005-02-28 14:50:48Z gmosx $
+# $Id: adapter.rb 270 2005-03-07 17:52:16Z gmosx $
 
 require 'yaml'
 require 'singleton'
@@ -20,6 +20,11 @@ class Adapter
 	# A mapping between Ruby and backend Datastore types.
 
 	attr_accessor :typemap
+
+	# A map for casting Ruby types to SQL safe textual
+	# representations.
+
+	attr_accessor :typecast
 	
 	# Lookup the adapter instance from the adapter name.
 
@@ -29,6 +34,9 @@ class Adapter
 	end
 
 	def initialize
+		# The default mappings, should be valid for most
+		# RDBMS.
+
 		@typemap = {
 			Integer => 'integer',
 			Fixnum => 'integer',
@@ -41,6 +49,19 @@ class Adapter
 			Array => 'text',
 			Hash => 'text'
 		}
+
+		# The :s: is a marker that will be replaced with the
+		# actual value to be casted. The default parameter of
+		# the Hash handles all other types (Object, Array, etc)
+
+		@typecast = Hash.new("'#\{#{self.class}.escape(:s:.to_yaml)\}'").update(
+			Integer => "\#\{:s:\}",
+			Float => "\#\{:s:\}",
+			String => "'#\{#{self.class}.escape(:s:)\}'",
+			Time => "'#\{#{self.class}.timestamp(:s:)\}'",
+			Date => "'#\{#{self.class}.date(:s:)\}'",
+			TrueClass => "#\{:s: ? \"'t'\" : 'NULL' \}"
+		)
 	end
 
 	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
@@ -105,7 +126,7 @@ class Adapter
 	# Create a new connection to the backend.
 
 	def new_connection(db)
-		return Og::Connection.new(db)
+		return Connection.new(db)
 	end
 
 	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
@@ -145,8 +166,8 @@ class Adapter
 	# You may want to override this method to map an existing
 	# database schema using Og.
 	
-	def self.join_table(klass1, klass2)
-		"og_#{Og.table_prefix}j_#{encode(klass1)}_#{encode(klass2)}"
+	def self.join_table(klass1, klass2, field)
+		"og_#{Og.table_prefix}j_#{encode(klass1)}_#{encode(klass2)}_#{field}"
 	end
 
 	# Return an sql string evaluator for the property.
@@ -222,7 +243,10 @@ class Adapter
 					if default = p.meta[:default]
 						field << " DEFAULT #{default.inspect} NOT NULL"
 					end
-					
+				
+					# set unique
+					field << " UNIQUE" if p.meta[:unique]
+
 					# attach extra sql
 					if extra_sql = p.meta[:extra_sql]
 						field << " #{extra_sql}"
@@ -266,9 +290,19 @@ class Adapter
 	end
 
 	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
-	# :section: Managed object enchant methods 
+	# :section: Precompile lifecycle methods.
 	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
+	# Precompile some code that gets executed all the time.
+	# Deletion code is not precompiled, because it is not used
+	# as frequently.
+
+	def eval_lifecycle_methods(klass, db)
+		eval_og_insert(klass, db)
+		eval_og_update(klass, db)
+		eval_og_read(klass, db)
+	end
+		
 	# Generate the property for oid.
 
 	def eval_og_oid(klass)
@@ -281,6 +315,9 @@ class Adapter
 	# The generated code sets the oid when inserting!
 	
 	def eval_og_insert(klass, db)
+
+		# Attach object callbacks.
+		
 		if klass.instance_methods.include?('og_pre_insert')
 			pre_cb = 'og_pre_insert(conn);'
 		else
@@ -300,7 +337,36 @@ class Adapter
 		if klass.instance_methods.include?('og_post_insert_update')
 			post_cb << 'og_post_insert_update(conn);'
 		end
-		
+
+		# Attach observers.
+
+		if observers = klass.__meta[:og_observers]
+			observers.each_with_index do |o, idx|
+				if o.is_a?(Class)
+					obs = "#{o}.instance"
+					o = o.instance
+				else
+					obs = "self.class.__meta[:og_observers][#{idx}]" 
+				end
+
+				if o.respond_to?(:og_pre_insert)
+					pre_cb << "#{obs}.og_pre_insert(conn, self);"
+				end
+
+				if o.respond_to?(:og_post_insert)
+					post_cb << "#{obs}.og_post_insert(conn, self);"
+				end
+
+				if o.respond_to?(:og_pre_insert_update)
+					pre_cb << "#{obs}.og_pre_insert_update(conn, self);"
+				end
+				
+				if o.respond_to?(:og_post_insert_update)
+					post_cb << "#{obs}.og_post_insert_update(conn, self);"
+				end
+			end
+		end
+			
 		klass.class_eval %{
 			def og_insert(conn)
 				#{insert_code(klass, db, pre_cb, post_cb)}
@@ -320,6 +386,8 @@ class Adapter
 
 		sql = "UPDATE #{klass::DBTABLE} SET #{updates.join(', ')} WHERE oid=#\{@oid\}"
 
+		# Attach object callbacks.
+
 		if klass.instance_methods.include?('og_pre_update')
 			pre_cb = 'og_pre_update(conn);'
 		else
@@ -340,6 +408,35 @@ class Adapter
 			post_cb << 'og_post_insert_update(conn);'
 		end
 		
+		# Attach observers.
+
+		if observers = klass.__meta[:og_observers]
+			observers.each_with_index do |o, idx|
+				if o.is_a?(Class)
+					obs = "#{o}.instance"
+					o = o.instance
+				else
+					obs = "self.class.__meta[:og_observers][#{idx}]" 
+				end
+
+				if o.respond_to?(:og_pre_update)
+					pre_cb << "#{obs}.og_pre_update(conn, self);"
+				end
+
+				if o.respond_to?(:og_post_update)
+					post_cb << "#{obs}.og_post_update(conn, self);"
+				end
+
+				if o.respond_to?(:og_pre_insert_update)
+					pre_cb << "#{obs}.og_pre_insert_update(conn, self);"
+				end
+				
+				if o.respond_to?(:og_post_insert_update)
+					post_cb << "#{obs}.og_post_insert_update(conn, self);"
+				end
+			end
+		end
+
 		klass.class_eval %{
 			def og_update(conn)
 				#{pre_cb}
@@ -367,9 +464,46 @@ class Adapter
 			end
 		end
 		
+		# Attach object callbacks.
+
+		if klass.instance_methods.include?('og_pre_read')
+			pre_cb = 'og_pre_read(conn);'
+		else
+			pre_cb = ''
+		end
+
+		if klass.instance_methods.include?('og_post_read')
+			post_cb = 'og_post_read(conn);'
+		else
+			post_cb = ''
+		end
+
+		# Attach observers.
+
+		if observers = klass.__meta[:og_observers]
+			observers.each_with_index do |o, idx|
+				if o.is_a?(Class)
+					obs = "#{o}.instance"
+					o = o.instance
+				else
+					obs = "self.class.__meta[:og_observers][#{idx}]" 
+				end
+
+				if o.respond_to?(:og_pre_read)
+					pre_cb << "#{obs}.og_pre_read(conn, self);"
+				end
+
+				if o.respond_to?(:og_post_read)
+					post_cb << "#{obs}.og_post_read(conn, self);"
+				end
+			end
+		end
+
 		klass.class_eval %{
 	 		def og_read(res, tuple = nil)
+				#{pre_cb}
 				#{code.join('; ')}
+				#{post_cb}
 			end
 		}
 	end				

data/lib/og/adapters/mysql.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: mysql.rb 266 2005-02-28 14:50:48Z gmosx $
+# $Id: mysql.rb 270 2005-03-07 17:52:16Z gmosx $
 
 require 'mysql'
 
@@ -19,6 +19,7 @@ class MysqlAdapter < Adapter
 	def initialize
 		super
 		@typemap.update(TrueClass => 'tinyint')
+		@typecast.update(TrueClass => "#\{:s: ? \"1\" : 'NULL' \}")
 	end
 	
 	def self.escape(str)
@@ -118,6 +119,43 @@ class MysqlAdapter < Adapter
 		res.free if res
 	end
 
+	def create_fields(klass)
+		fields = []
+		
+		klass.__props.each do |p|
+			klass.sql_index(p.symbol) if p.meta[:sql_index]
+				
+			field = "#{p.symbol}"
+			
+			if p.meta and p.meta[:sql]
+				field << " #{p.meta[:sql]}"
+			else
+				field << " #{@typemap[p.klass]}"
+				
+				if p.meta
+					# set default value (gmosx: not that useful in the
+					# current implementation).
+					if default = p.meta[:default]
+						field << " DEFAULT #{default.inspect} NOT NULL"
+					end
+				
+					# set unique
+					# FIXME: correctly handle UNIQUE constrain.
+					# field << " UNIQUE" if p.meta[:unique]
+
+					# attach extra sql
+					if extra_sql = p.meta[:extra_sql]
+						field << " #{extra_sql}"
+					end
+				end
+			end
+			
+			fields << field 
+		end
+
+		return fields
+	end
+
 	def create_table(klass, db)
 		conn = db.get_connection
 
@@ -165,11 +203,11 @@ class MysqlAdapter < Adapter
 		if klass.__meta and joins = klass.__meta[:sql_join] 
 			for data in joins
 				# the class to join to and some options.
-				join_class, options = *data
+				join_name, join_class, options = *data
 				
 				# gmosx: dont use DBTABLE here, perhaps the join class
 				# is not managed yet.
-				join_table = "#{self.class.join_table(klass, join_class)}"
+				join_table = "#{self.class.join_table(klass, join_class, join_name)}"
 				join_src = "#{self.class.encode(klass)}_oid"
 				join_dst = "#{self.class.encode(join_class)}_oid"
 				begin

data/lib/og/adapters/oracle.rb

@@ -1,7 +1,7 @@
 # * Matt Bowen  <matt.bowen@farweststeel.com>
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: oracle.rb 266 2005-02-28 14:50:48Z gmosx $
+# $Id: oracle.rb 270 2005-03-07 17:52:16Z gmosx $
 
 require 'oracle'
 
@@ -28,6 +28,7 @@ class OracleAdapter < Adapter
       Array => 'varchar2(1024)',
       Hash => 'varchar2(1024)'
     )
+		@typecast.update(TrueClass => "#\{:s: ? \"1\" : 'NULL' \}")
   end
 
   def self.timestamp(time = Time.now)
@@ -190,11 +191,11 @@ class OracleAdapter < Adapter
     if klass.__meta and joins = klass.__meta[:sql_join] 
       for data in joins
         # the class to join to and some options.
-        join_class, options = *data
+        join_name, join_class, options = *data
         
         # gmosx: dont use DBTABLE here, perhaps the join class
         # is not managed yet.
-        join_table = "#{self.class.join_table(klass, join_class)}"
+        join_table = "#{self.class.join_table(klass, join_class, join_name)}"
         join_src = "#{self.class.encode(klass)}_oid"
         join_dst = "#{self.class.encode(join_class)}_oid"
         begin

data/lib/og/adapters/psql.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: psql.rb 266 2005-02-28 14:50:48Z gmosx $
+# $Id: psql.rb 270 2005-03-07 17:52:16Z gmosx $
 
 require 'postgres'
 
@@ -137,11 +137,11 @@ class PsqlAdapter < Adapter
 		if klass.__meta and joins = klass.__meta[:sql_join] 
 			for data in joins
 				# the class to join to and some options.
-				join_class, options = *data
+				join_name, join_class, options = *data
 				
 				# gmosx: dont use DBTABLE here, perhaps the join class
 				# is not managed yet.
-				join_table = "#{self.class.join_table(klass, join_class)}"
+				join_table = "#{self.class.join_table(klass, join_class, join_name)}"
 				join_src = "#{self.class.encode(klass)}_oid"
 				join_dst = "#{self.class.encode(join_class)}_oid"
 				begin