og 0.10.0 → 0.11.0

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 259 2005-02-15 08:54:54Z gmosx $
+# $Id: psql.rb 266 2005-02-28 14:50:48Z gmosx $
 
 require 'postgres'
 
@@ -8,7 +8,7 @@ require 'og/adapter'
 require 'og/connection'
 require 'glue/attribute'
 
-class Og
+module Og
 
 # The PostgreSQL adapter. This adapter communicates with 
 # an PostgreSQL rdbms. For extra documentation see 
@@ -30,24 +30,6 @@ class PsqlAdapter < Adapter
 		return nil unless date
 		return "#{date.year}-#{date.month}-#{date.mday}" 
 	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 "'#\{#{self.class}.escape(@#{p.symbol})\}'"
-		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} ? \"'t'\" : 'NULL' \}"
-		else 
-			return %|#\{@#{p.symbol} ? "'#\{#{self.class}.escape(@#{p.symbol}.to_yaml)\}'" : "''"\}|
-		end
-	end		
 
 	def read_prop(p, idx)
 		if p.klass.ancestors.include?(Integer)
@@ -94,7 +76,7 @@ class PsqlAdapter < Adapter
 	end
 
 	def new_connection(db)
-		return Og::PsqlConnection.new(db)
+		return PsqlConnection.new(db)
 	end
 
 	def calc_field_index(klass, db)
@@ -116,7 +98,7 @@ class PsqlAdapter < Adapter
 
 		sql = "CREATE TABLE #{klass::DBTABLE} (#{fields.join(', ')}"
 		
-		# Create table constrains
+		# Create table constrains.
 		
 		if klass.__meta and constrains = klass.__meta[:sql_constrain]
 			sql << ", #{constrains.join(', ')}"
@@ -124,7 +106,7 @@ class PsqlAdapter < Adapter
 		
 		sql << ") WITHOUT OIDS;"
 		
-		# Create indices
+		# Create indices.
 		
 		if klass.__meta and indices = klass.__meta[:sql_index]
 			for data in indices
@@ -226,6 +208,11 @@ class PsqlConnection < Connection
 		end
 	end
 
+	def close
+		@store.close
+		super
+	end
+
 	def query(sql)
 		Logger.debug sql if $DBG
 		begin

data/lib/og/adapters/sqlite.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: sqlite.rb 259 2005-02-15 08:54:54Z gmosx $
+# $Id: sqlite.rb 263 2005-02-23 13:45:08Z gmosx $
 
 require 'sqlite3'
 require 'fileutils'
@@ -9,7 +9,7 @@ require 'og/adapter'
 require 'og/connection'
 require 'glue/attribute'
 
-class Og
+module Og
 
 # The SQLite adapter. This adapter communicates with 
 # an SQLite3 rdbms. For extra documentation see 
@@ -79,7 +79,7 @@ class SqliteAdapter < Adapter
 	end
 
 	def new_connection(db)
-		return Og::SqliteConnection.new(db)
+		return SqliteConnection.new(db)
 	end
 
 	def calc_field_index(klass, db)

data/lib/og/backend.rb

@@ -1,12 +1,12 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: backend.rb 249 2005-02-04 14:03:00Z gmosx $
+# $Id: backend.rb 263 2005-02-23 13:45:08Z gmosx $
 
 require 'yaml'
 
 require 'og/connection'
 
-class Og
+module Og
 
 # Abstract backend. A backend communicates with the RDBMS.
 # This is the base class for the various backend implementations.

data/lib/og/connection.rb

@@ -1,8 +1,8 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: connection.rb 254 2005-02-10 12:44:05Z gmosx $
+# $Id: connection.rb 265 2005-02-24 08:46:54Z gmosx $
 
-class Og; 
+module Og; 
 
 require 'glue/property'
 require 'glue/array'
@@ -12,7 +12,7 @@ require 'glue/time'
 # functionality. A backend specific implementation file (driver) 
 # implements all methods.
 #
-# == Future 
+# === Future 
 #
 # - support caching.
 # - support prepared statements.
@@ -41,7 +41,6 @@ class Connection
 	# Close the connection to the database.
 	
 	def close
-		@store.close
 		Logger.debug "Closed DB connection." if $DBG
 	end
 
@@ -283,11 +282,12 @@ class Connection
 		end
 		
 		# TODO: implement this as stored procedure? naaah.
+		# TODO: also handle many_to_many relations.
 
 		transaction do |tx|
 			tx.exec "DELETE FROM #{klass::DBTABLE} WHERE oid=#{oid}"
-			if cascade and klass.__meta.include?(:has)
-				klass.__meta[:has].each do |dclass, linkback|
+			if cascade and klass.__meta.include?(:descendants)
+				klass.__meta[:descendants].each do |dclass, linkback|
 					tx.exec "DELETE FROM #{dclass::DBTABLE} WHERE #{linkback}=#{oid}"
 				end
 			end

data/lib/og/database.rb

@@ -1,6 +1,6 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: database.rb 255 2005-02-10 12:45:32Z gmosx $
+# $Id: database.rb 265 2005-02-24 08:46:54Z gmosx $
 
 require 'glue/logger'
 require 'glue/attribute'
@@ -13,7 +13,7 @@ require 'glue/pool'
 require 'og/enchant'
 require 'og/meta'
 
-class Og
+module Og
 	
 # Encapsulates an Og Database.
 
@@ -87,8 +87,8 @@ class Database
 				end
 			end
 			
-			Logger.info "Og auto manages the following classes:"
-			Logger.info "#{classes_to_manage.inspect}"
+			Logger.debug "Og auto manages the following classes:"
+			Logger.debug "#{classes_to_manage.inspect}"
 			
 			manage_classes(*classes_to_manage)
 		end
@@ -201,7 +201,7 @@ class Database
 		}
 
 		# Create the schema for this class if not available.
-		@adapter.create_table(klass, self)				
+		@adapter.create_table(klass, self) if Og.create_schema				
 
 		# Precompile some code that gets executed all the time.
 		# Deletion code is not precompiled, because it is not used

data/lib/og/enchant.rb

@@ -1,8 +1,8 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: meta.rb 198 2004-12-22 11:26:59Z gmosx $
+# $Id$
 
-class Og
+module Og
 
 module Enchant
 
@@ -60,6 +60,10 @@ module Enchant
 				Og.db.delete(obj_or_oid, #{klass})
 			end
 
+			def self.properties_and_relations
+				@@__meta[:props_and_relations]
+			end
+
 			def each(&block)
 				all.each(&block)
 			end

data/lib/og/meta.rb

@@ -1,17 +1,29 @@
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: meta.rb 254 2005-02-10 12:44:05Z gmosx $
+# $Id: meta.rb 266 2005-02-28 14:50:48Z gmosx $
 #--
 # TODO:
 # - precreate the meta sql statements as much as possible to 
 #   avoid string interpolations.
 #++
 
-require 'og/adapter'
 require 'glue/inflector'
+require 'og/adapter'
+require 'og/typemacros'
 
-class Og
+module Og
 
+class Relation < N::Property
+	alias foreign_class klass
+end
+
+class Has < Relation; end
+class HasMany < Has; end
+class HasOne < Has; end
+class ManyToMany < Has; end
+class BelongsTo < Relation; end
+class RefersTo < Relation; end
+	
 # Some useful meta-language utilities.
 
 module MetaUtils # :nodoc: all
@@ -31,6 +43,9 @@ module MetaUtils # :nodoc: all
 	# in order to avoid forward declarations a symbol is given instead
 	# of a class. Other times on class is given at all, and 
 	# the inflection mechanism is used to infer the class name.
+	#--
+	# This is not used yet.
+	#++
 
 	def self.resolve_class(name, klass)
 		klass ||= N::Inflector.camelize(name)
@@ -86,7 +101,7 @@ module MetaLanguage
 		prop_eval << ", :sql => '#{options[:sql]}'" if options[:sql]
 		prop_eval << ", :extra_sql => '#{options[:extra_sql]}'" if options[:extra_sql]
 
-		meta :belongs_to, klass
+		meta :props_and_relations, BelongsTo.new(name, klass, :property => "#{name}_oid".intern)
 		
 		module_eval %{
 			#{prop_eval}
@@ -122,7 +137,8 @@ module MetaLanguage
 
 		linkback = options[:linkback] || "#{MetaUtils.expand(self)}_oid"
 		
-		meta :has, [klass, linkback]
+		meta :descendants, klass, linkback
+		meta :props_and_relations, HasOne.new(name, klass, :linkback => linkback)
 		
 		module_eval %{
 			def #{name}(extrasql = nil)
@@ -141,12 +157,17 @@ module MetaLanguage
 	# Example:
 	#
 	# class MyObject
-	#		has_many :children, AnotherObject
+	#		has_many :articles, Article
 	# end
 	#
 	# creates the code:
 	#
-	# def children; ... end
+	# obj.articles 
+	# obj.add_article(article)
+	# obj.add_article do |a|
+	#		a.title = 'Title'
+	#		a.body = 'Body'
+	#	end
 	
 	def has_many(name, klass, options = {})
 		name_s = N::Inflector.singularize(name.to_s)
@@ -159,7 +180,8 @@ module MetaLanguage
 		# keep belongs to metadata, useful for 
 		# reflection/scaffolding.
 
-		meta :has, [klass, linkback]
+		meta :descendants, klass, linkback
+		meta :props_and_relations, HasMany.new(name, klass, :linkback => linkback)
 
 		module_eval %{
 			def #{name}(extrasql = nil)
@@ -170,7 +192,8 @@ module MetaLanguage
 				Og.db.count("SELECT COUNT(*) FROM #{Og::Adapter.table(klass)} WHERE #{linkback}=\#\@oid \#\{extrasql\}")
 			end			
 
-			def add_#{name_s}(obj, extra = nil)
+			def add_#{name_s}(obj = nil)
+				yield(obj = #{klass}.new) unless obj
 				obj.#{linkback} = @oid
 				obj.save!
 			end
@@ -196,6 +219,7 @@ module MetaLanguage
 	# article.categories
 	# article.del_category
 	# article.add_category
+	# article.add_category { |c| ... }
 	#	article.clear_categories
 	#
 	# category.articles
@@ -210,7 +234,7 @@ module MetaLanguage
 		list_m = options[:linkback] || N::Inflector.plural_name(self) 
 		prop_m = N::Inflector.singularize(list_m)
 	
-		# exit if the class is allready indirectly 'enchanted' from the
+		# Exit if the class is allready indirectly 'enchanted' from the
 		# other class of the many_to_many relation.
 
 		return if self.respond_to?(prop_m)
@@ -218,27 +242,31 @@ module MetaLanguage
 		# Add some metadata to the class to allow for automatic join table
 		# calculation.
 
-		meta :sql_join, [klass, options]
+		meta :sql_join, klass, options
+
+		# FIXME: should add metadata for cascading delete.
 
-		meta :many_to_many, klass
-		klass.meta :many_to_many, self 
+		meta :props_and_relations, ManyToMany.new(prop_o, klass)
+		klass.meta :props_and_relations, ManyToMany.new(prop_m, self)
 
-		# enchant this class
+		# Enchant this class
 		
 		module_eval %{
 			def #{list_o}(extrasql = nil)
-				Og.db.select("SELECT d.* FROM #{Og::Adapter.table(klass)} AS d, #{Og::Adapter.join_table(self, klass)} AS j WHERE j.key1=\#\@oid AND j.key2=d.oid \#\{extrasql\}", #{klass})
-			end
+				Og.db.select("SELECT d.* FROM #{Og::Adapter.table(klass)} d, #{Og::Adapter.join_table(self, klass)} j WHERE j.key1=\#\@oid AND j.key2=d.oid \#\{extrasql\}", #{klass})
+		end
 
 			def #{list_o}_count(extrasql = nil)
-				Og.db.select("SELECT COUNT(*) FROM #{Og::Adapter.table(klass)} AS d, #{Og::Adapter.join_table(self, klass)} AS j WHERE j.key1=\#\@oid AND j.key2=d.oid \#\{extrasql\}", #{klass})
+				Og.db.select("SELECT COUNT(*) FROM #{Og::Adapter.table(klass)} d, #{Og::Adapter.join_table(self, klass)} j WHERE j.key1=\#\@oid AND j.key2=d.oid \#\{extrasql\}", #{klass})
 			end						
 			
-			def add_#{prop_o}(obj, extra = nil)
+			def add_#{prop_o}(obj = nil)
+				yield(obj = #{klass}.new) unless obj
+				obj.save! unless obj.oid
 				Og.db.exec("INSERT INTO #{Og::Adapter.join_table(self, klass)} (key1, key2) VALUES (\#\@oid, \#\{obj.oid\})") 
 			end
 			
-			def delete_#{prop_o}(obj_or_oid, extra = nil)
+			def delete_#{prop_o}(obj_or_oid)
 				Og.db.exec("DELETE FROM #{Og::Adapter.join_table(self, klass)} WHERE key2=\#\{obj_or_oid.to_i\}") 
 			end
 
@@ -251,18 +279,20 @@ module MetaLanguage
 		
 		klass.module_eval %{
 			def #{list_m}(extrasql = nil)
-				Og.db.select("SELECT s.* FROM #{Og::Adapter.table(self)} AS s, #{Og::Adapter.join_table(self, klass)} AS j WHERE j.key2=\#\@oid AND j.key1=s.oid \#\{extrasql\}", #{self})
+				Og.db.select("SELECT s.* FROM #{Og::Adapter.table(self)} s, #{Og::Adapter.join_table(self, klass)} j WHERE j.key2=\#\@oid AND j.key1=s.oid \#\{extrasql\}", #{self})
 			end
 
 			def #{list_m}_count(extrasql = nil)
-				Og.db.select("SELECT COUNT(*) FROM #{Og::Adapter.table(self)} AS s, #{Og::Adapter.join_table(self, klass)} AS j WHERE j.key2=\#\@oid AND j.key1=s.oid \#\{extrasql\}", #{self})
+				Og.db.select("SELECT COUNT(*) FROM #{Og::Adapter.table(self)} s, #{Og::Adapter.join_table(self, klass)} j WHERE j.key2=\#\@oid AND j.key1=s.oid \#\{extrasql\}", #{self})
 			end
 			
-			def add_#{prop_m}(obj, extra = nil)
+			def add_#{prop_m}(obj = nil)
+				yield(obj = #{self}.new) unless obj
+				obj.save! unless obj.oid
 				Og.db.exec("INSERT INTO #{Og::Adapter.join_table(self, klass)} (key1, key2) VALUES (\#\{obj.oid\}, \#\@oid)") 
 			end
 			
-			def delete_#{prop_m}(obj_or_oid, extra = nil)
+			def delete_#{prop_m}(obj_or_oid)
 				Og.db.exec("DELETE FROM #{Og::Adapter.join_table(self, klass)} WHERE key1=\#\{obj_or_oid.to_i\}") 
 			end
 
@@ -300,8 +330,8 @@ module MetaLanguage
 		prop_eval << ", :sql => '#{options[:sql]}'" if options[:sql]
 		prop_eval << ", :extra_sql => '#{options[:extra_sql]}'" if options[:extra_sql]
 
-		meta :refers_to, klass
-		klass.meta :has, [self, "#{name}_oid"]
+		meta :props_and_relations, RefersTo.new(name, klass, :property => "#{name}_oid".intern)
+		klass.meta :descendants, self, "#{name}_oid".intern
 		
 		module_eval %{
 			#{prop_eval}
@@ -321,7 +351,7 @@ module MetaLanguage
 	# methods are generated.
 
 	def joins(klass, options = {})
-		meta :joins, [klass, options]
+		meta :joins, klass, options
 	end
 
 end

data/lib/og/mock.rb

@@ -7,7 +7,7 @@ require 'flexmock'
 
 require 'og'
 
-class Og
+module Og
 	
 # A utility object to Mock a Database in test units.
 # Extends the standard FlexMock object.

data/lib/og/typemacros.rb

@@ -0,0 +1,23 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: typemacros.rb 267 2005-02-28 14:52:41Z gmosx $
+
+module Og
+
+# Some useful type macros to help when defining managed 
+# objects. You can easily code your own type macros.
+# Just return the array that should be passed
+#
+# === Example
+#
+# property :name, Og.VarChar(30)
+
+def VarChar(size)
+	return String, :sql => "VARCHAR(#{size})"
+end
+
+NotNull = {:sql => "NOT NULL"}.freeze
+
+Null = {:sql => "NULL"}.freeze
+
+end