og 0.5.0 → 0.6.0

data/README.og

@@ -1,4 +1,4 @@
-= Og 0.5.0
+= Og 0.6.0
 
 Og (ObjectGraph) is an efficient, yet simple object-relational mapping 
 library. Og	provides transparent serialization of object graphs to a RDBMS 
@@ -28,6 +28,7 @@ The library provides the following features:
 + Absolutely no configuration files.
 + Multiple backends (PostgreSQL, MySQL).
 + ActiveRecord-style meta language and db aware methods.
++ Automatially generates join-tables for many_to_many relations.
 + Deserialize to Ruby Objects or ResultSets.
 + Deserialize sql join queries to Ruby Objects.
 + Serialize arbitrary ruby object graphs through YAML.

data/RELEASES.og

@@ -1,3 +1,13 @@
+== Version 0.6 was released on 13/12/2004.
+
+This is a preview release, the api for the new features is not 
+finalized. This early release gives other developers to offer suggestions
+on the final form of those features.
+
+Most notable additions:
+
+* Og many_to_many relations with auto generation of the join table.
+* Og has_one relation.
 
 == Version 0.5.0 was released on 21/11/2004.
 

data/examples/og/run.rb

@@ -6,7 +6,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: run.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: run.rb 185 2004-12-10 13:29:09Z gmosx $
 
 $:.unshift "../../lib"
 
@@ -55,6 +55,7 @@ class User
 	end
 end
 
+
 # = A parent class
 #
 class Article
@@ -95,6 +96,21 @@ class Article
 	end
 end
 
+# = A parent class
+#
+class Category
+	prop_accessor :title, String
+	prop_accessor :body, String
+
+	# define a 'many to many' relation.	
+	many_to_many Article
+	
+	def initialize(title = nil)
+		@title = title
+	end
+end
+
+
 # = Article comment
 #
 class ArticleComment < Comment
@@ -127,7 +143,6 @@ end
 $log = Logger.new(STDERR); 
 
 # Og configuration.
-
 config = {
 	:address => "localhost",
 	:database => "test",
@@ -249,3 +264,27 @@ part.save!
 
 article.parts.each { |pa| puts pa }
 
+puts "\n\n"
+puts '---'
+
+c1 = Category.new("Category1").save!
+c2 = Category.new("Category2").save!
+
+article.add_category(c1)
+article.add_category(c2)
+
+puts '---'
+
+article.categories.each { |c| puts c.title }
+
+puts '---'
+
+c2.articles.each { |a| puts a.title }
+
+article.del_category(c1)
+
+puts '---'
+
+article.categories.each { |c| puts c.title }
+
+

data/lib/glue.rb

@@ -6,7 +6,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id$
+# $Id: glue.rb 175 2004-11-26 16:11:27Z gmosx $
 
 require "English"
 require "pp"

data/lib/glue/property.rb

@@ -5,7 +5,7 @@
 # * Elias Karakoulakis  <ekarak@ktismata.com>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: property.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: property.rb 185 2004-12-10 13:29:09Z gmosx $
 
 require "glue/array"
 require "glue/hash"
@@ -48,6 +48,10 @@ class Property
 	def ==(other)
 		return @symbol == other.symbol
 	end
+	
+	def to_s
+		return name
+	end
 end
 
 end # module
@@ -236,6 +240,8 @@ class Module
 			}
 		end
 			
+		# gmosx: __force_xxx reuses xxx= to allow for easier
+		# overrides.
 		if writer 
 			module_eval %{
 				def #{s}=(val)
@@ -243,7 +249,7 @@ class Module
 				end
 				
 				def __force_#{s}(val)
-						@#{s} = } + case klass.name
+						self.#{s}=(} + case klass.name
 													when Fixnum.name
 														"val.to_i()"
 													when String.name
@@ -256,7 +262,7 @@ class Module
 														"val.to_i() > 0"
 													else
 														"val"
-												end + %{ 
+												end + %{) 
 				end
 			}
 		end

data/lib/og.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: og.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: og.rb 185 2004-12-10 13:29:09Z gmosx $
 
 require "glue/property"
 require "glue/array"
@@ -10,6 +10,24 @@ require "glue/hash"
 require "glue/time"
 require "glue/pool"
 
+# If true, only allow reading from the database. Usefull
+# for maintainance.
+#
+$og_read_only_mode = false
+
+# If true, the library automatically 'enchants' managed classes.
+# In enchant mode, special db aware methods are added to 
+# managed classes and instances.
+#
+$og_enchant_managed_classes = true
+
+# If true, use Ruby's advanced introspection capabilities to 
+# automatically manage classes tha define properties.
+$og_auto_manage_classes = true
+
+# If true, automatically include the Og meta-language into Module. 
+$og_include_meta_language = true
+
 require "og/meta"
 
 # = Og
@@ -93,21 +111,6 @@ require "og/meta"
 #
 module Og
 
-# If true, only allow reading from the database. Usefull
-# for maintainance.
-#
-$og_read_only_mode = false
-
-# If true, the library automatically 'enchants' managed classes.
-# In enchant mode, special db aware methods are added to 
-# managed classes and instances.
-#
-$og_enchant_managed_classes = true
-
-# If true, use Ruby's advanced introspection capabilities to 
-# automatically manage classes tha define properties.
-$og_auto_manage_classes = true
-
 # = Unmanageable
 #
 # Marker module. If included this in a class, the Og automanager
@@ -328,7 +331,11 @@ class Database
 			def self.all(extra_sql = nil)
 				$og.load_all(#{klass}, extra_sql)
 			end
-			
+
+			def self.count(sql = "SELECT COUNT(*) FROM #{klass::DBTABLE}")
+				$og.count(sql, #{klass})
+			end
+
 			def self.select(sql)
 				$og.select(sql, #{klass})
 			end
@@ -343,6 +350,7 @@ class Database
 			
 			def save
 				$og << self
+				return self
 			end
 			alias_method :save!, :save
 			

data/lib/og/backend.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: backend.rb 155 2004-11-13 20:32:12Z gmosx $
+# $Id: backend.rb 185 2004-12-10 13:29:09Z gmosx $
 
 require "yaml"
 
@@ -16,15 +16,27 @@ module Og
 #
 module Utils
 
-	# The name of the SQL table where objects of this class are stored.
+	# Encode the name of the klass as an sql safe string.
 	# The Module separators are replaced with _ and NOT stripped out so 
 	# that we can convert back to the original notation if needed.
 	# The leading module if available is removed.
 	#
+	def self.encode(klass)
+		"#{klass.name.gsub(/^.*::/, "")}".gsub(/::/, "_").downcase
+	end
+
+	# The name of the SQL table where objects of this class are stored.
+	#
 	def self.table(klass)
-		return "_#{klass.name.gsub(/^.*::/, "")}".gsub(/::/, "_").downcase
+		"_#{encode(klass)}"
 	end
 
+	# The name of the join table for the two given classes.
+	#
+	def self.join_table(klass1, klass2)
+		"_j_#{Og::Utils.encode(klass1)}_#{Og::Utils.encode(klass2)}"
+	end
+	
 	# Returns the props that will be included in the insert query.
 	# For some backends the oid should be stripped.
 	#

data/lib/og/backends/mysql.rb

@@ -3,7 +3,7 @@
 # * Elias Athanasopoulos  <elathan@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: mysql.rb 159 2004-11-18 10:18:30Z gmosx $
+# $Id: mysql.rb 185 2004-12-10 13:29:09Z gmosx $
 
 require "mysql"
 
@@ -302,14 +302,41 @@ class MysqlBackend < Og::Backend
 		
 		# Create indices
 		
-		if klass.__meta
-			for data in klass.__meta[:sql_index]
+		if klass.__meta and indices = klass.__meta[:sql_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(/\(.*\)/, "")
 				exec "CREATE #{pre_sql} INDEX #{klass::DBTABLE}_#{idxname}_idx #{post_sql} ON #{klass::DBTABLE} (#{idx})"  
 			end
+		end
+
+		# Create join tables if needed. Join tables are used in
+		# 'many_to_many' relations.
+		
+		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
+				
+				# gmosx: dont use DBTABLE here, perhaps the join class
+				# is not managed yet.
+				join_table = "#{Og::Utils.join_table(klass, join_class)}"
+				join_src = "#{Og::Utils.encode(klass)}_oid"
+				join_dst = "#{Og::Utils.encode(join_class)}_oid"
+				begin
+					exec "CREATE TABLE #{join_table} ( key1 integer, key2 integer )"
+					exec "CREATE INDEX #{join_table}_key1_idx ON #{join_table} (key1)"
+					exec "CREATE INDEX #{join_table}_key2_idx ON #{join_table} (key2)"
+				rescue => ex
+					if ex.errno == 1050 # table already exists.
+						$log.debug "Join table already exists" if $DBG
+					else
+						raise
+					end
+				end
+			end
 		end		
 	end
 

data/lib/og/backends/psql.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: psql.rb 159 2004-11-18 10:18:30Z gmosx $
+# $Id: psql.rb 185 2004-12-10 13:29:09Z gmosx $
 
 require "postgres"
 
@@ -268,8 +268,8 @@ class PsqlBackend < Og::Backend
 		
 		# Create indices
 		
-		if klass.__meta
-			for data in klass.__meta[:sql_index]
+		if klass.__meta and indices = klass.__meta[:sql_index]
+			for data in indices
 				idx, options = *data
 				idx = idx.to_s
 				pre_sql, post_sql = options[:pre], options[:post]
@@ -304,6 +304,47 @@ class PsqlBackend < Og::Backend
 				raise
 			end
 		end
+		
+		# Create join tables if needed. Join tables are used in
+		# 'many_to_many' relations.
+		
+		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
+				
+				# gmosx: dont use DBTABLE here, perhaps the join class
+				# is not managed yet.
+				join_table = "#{Og::Utils.join_table(klass, join_class)}"
+				join_src = "#{Og::Utils.encode(klass)}_oid"
+				join_dst = "#{Og::Utils.encode(join_class)}_oid"
+				begin
+					exec "CREATE TABLE #{join_table} ( key1 integer, key2 integer )"
+					exec "CREATE INDEX #{join_table}_key1_idx ON #{join_table} (key1)"
+					exec "CREATE INDEX #{join_table}_key2_idx ON #{join_table} (key2)"
+				rescue => ex
+					# gmosx: any idea how to better test this?
+					if ex.to_s =~ /relation .* already exists/i
+						$log.debug "Join table already exists" if $DBG
+					else
+						raise
+					end
+				end
+			end
+		end
+		
+		begin
+			exec(sql)
+			$log.info "Created join table '#{join_table}'."
+		rescue => ex
+			# gmosx: any idea how to better test this?
+			if ex.to_s =~ /relation .* already exists/i
+				$log.debug "Join table already exists" if $DBG
+			else
+				raise
+			end
+		end
+		
 	end
 	
 	# Drop the managed object table

data/lib/og/meta.rb

@@ -2,9 +2,10 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: meta.rb 159 2004-11-18 10:18:30Z gmosx $
+# $Id: meta.rb 185 2004-12-10 13:29:09Z gmosx $
 
 require 'og/backend'
+require 'glue/inflector'
 
 module Og
 
@@ -68,15 +69,13 @@ module MetaLanguage
 		}
 	end
 
-	# Implements a 'has_many' relation.
+	# Implements a 'has_one' relation.
 	# Automatically enchants the calling class with helper methods.
 	#
-	# NOT IMPLEMENTED.
-	# 
 	# Example:
 	#
 	# class MyObject
-	#		has_many AnotherObject, :children
+	#		has_one :children, AnotherObject
 	# end
 	#
 	# creates the code:
@@ -84,10 +83,23 @@ module MetaLanguage
 	# def children; ... end
 	#
 	def has_one(klass, name, options = {})
+		# linkback is the property of the child object that 'links back' 
+		# to this object. 
+		linkback = options[:linkback] || "#{MetaUtils.expand(self)}_oid"
+		
 		module_eval %{
+			@@og_descendants ||= {}
+			@@og_descendants[#{klass}] = :#{linkback} 
+	
+			unless defined?(og_descendants)
+				def self.og_descendants
+					@@og_descendants
+				end
+			end
+			
 			def #{name}(extrasql = nil)
-				$og.select_one("article_oid=\#\@oid \#\{extrasql\}", #{klass})
-			end			
+				$og.select_one("SELECT * FROM #{Utils.table(klass)} WHERE #{linkback}=\#\@oid \#\{extrasql\}", #{klass})
+			end
 		}
 	end	
 	
@@ -97,7 +109,7 @@ module MetaLanguage
 	# Example:
 	#
 	# class MyObject
-	#		has_many AnotherObject, :children
+	#		has_many :children, AnotherObject
 	# end
 	#
 	# creates the code:
@@ -129,11 +141,106 @@ module MetaLanguage
 		}
 	end
 	
+	# Implements a 'many_to_many' relation.
+	# Two objects are associated using an intermediate join table.
+	# Automatically enchants the calling class with helper methods.
+	#
+	# Example:
+	#
+	# class Article
+	#		many_to_many :children, Categories
+	# end
+	#
+	# article.categories
+	# article.del_category
+	# article.add_category
+	#	article.clear_categories
+	#
+	# category.articles
+	# ...
+	#
+	#--
+	# FIXME: make more compatible with other enchant methods.
+	#++
+	def many_to_many(klass, options = {})
+		name1 = options[:name1] || G::Inflector.name(self)
+		pname1 = options[:list_name1] || G::Inflector.plural_name(self) 
+		name2 = options[:name2] || G::Inflector.name(klass)
+		pname2 = options[:list_name2] || G::Inflector.plural_name(klass) 
+	
+		# exit if the class is allready indirectly 'enchanted' from the
+		# other class of the many_to_many relation.
+		return if self.respond_to?(name1)
+	
+		# Add some metadata to the class to allow for automatic join table
+		# calculation.
+		meta :sql_join, [klass, options]
+
+		# gmosx, FIXME: should I update descendants here ?
+
+		# enchant this class
+		
+		module_eval %{
+			def #{pname2}(extrasql = nil)
+				$og.select("SELECT d.* FROM #{Utils.table(klass)} AS d, #{Utils.join_table(self, klass)} AS j WHERE j.key1=\#\@oid AND j.key2=d.oid \#\{extrasql\}", #{klass})
+			end
+
+			def #{pname2}_count(extrasql = nil)
+				$og.select("SELECT COUNT(*) FROM #{Utils.table(klass)} AS d, #{Utils.join_table(self, klass)} AS j WHERE j.key1=\#\@oid AND j.key2=d.oid \#\{extrasql\}", #{klass})
+			end						
+			
+			def add_#{name2}(obj, extra = nil)
+				$og.exec("INSERT INTO #{Utils.join_table(self, klass)} (key1, key2) VALUES (\#\@oid, \#\{obj.oid\})") 
+			end
+			
+			def del_#{name2}(obj_or_oid, extra = nil)
+				$og.exec("DELETE FROM #{Utils.join_table(self, klass)} WHERE key2=\#\{obj_or_oid.to_i\}") 
+			end
+			alias_method :delete_#{name2}, :del_#{name2}
+
+			def clear_#{pname2}
+				$og.exec("DELETE FROM #{Utils.join_table(self, klass)} WHERE key1=\#\@oid") 
+			end			
+		}
+		
+		# indirectly enchant the other class of the relation.
+		
+		klass.module_eval %{
+			def #{pname1}(extrasql = nil)
+				$og.select("SELECT s.* FROM #{Utils.table(self)} AS s, #{Utils.join_table(self, klass)} AS j WHERE j.key2=\#\@oid AND j.key1=s.oid \#\{extrasql\}", #{self})
+			end
+
+			def #{pname1}_count(extrasql = nil)
+				$og.select("SELECT COUNT(*) FROM #{Utils.table(self)} AS s, #{Utils.join_table(self, klass)} AS j WHERE j.key2=\#\@oid AND j.key1=s.oid \#\{extrasql\}", #{self})
+			end
+			
+			def add_#{name1}(obj, extra = nil)
+				$og.exec("INSERT INTO #{Utils.join_table(self, klass)} (key1, key2) VALUES (\#\{obj.oid\}, \#\@oid)") 
+			end
+			
+			def del_#{name1}(obj_or_oid, extra = nil)
+				$og.exec("DELETE FROM #{Utils.join_table(self, klass)} WHERE key1=\#\{obj_or_oid.to_i\}") 
+			end
+			alias_method :delete_#{name1}, :del_#{name1}						
+
+			def clear_#{pname1}
+				$og.exec("DELETE FROM #{Utils.join_table(self, klass)} WHERE key2=\#\@oid") 
+			end			
+		}
+	end
+	alias :has_and_belongs_to_many :many_to_many 
+
 end
 
 end # module
 
-class Module # :nodoc: all
-	include Og::MetaLanguage
+# Include the meta-language extensions into Module. If the flag is
+# false the developer is responsible for including the MetaLanguage
+# module where needed.
+#
+if $og_include_meta_language
+	class Module # :nodoc: all
+		include Og::MetaLanguage
+	end
 end
 

data/lib/og/version.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id$
+# $Id: version.rb 175 2004-11-26 16:11:27Z gmosx $
 
 # The version of Og.
-$og_version = '0.5.0'
+$og_version = '0.6.0'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.1
 specification_version: 1
 name: og
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2004-11-23
+  version: 0.6.0
+date: 2004-12-10
 summary: Og (ObjectGraph)
 require_paths: 
   - lib