og 0.18.1 → 0.19.0

data/CHANGELOG

@@ -1,5 +1,128 @@
+17-06-2005  George Moschovitis <gm@navel.gr>
+
+	* examples/run.rb: fixes to make it run again.
+	
+	* README: updated.
+
+15-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/og/store/psql.rb: minor changes while applying michael's
+	patch.
+	
+	* yeah, the new code passes tc_store.rb
+	
+	* lib/og/sql.rb: don't create tables for polymorphic parents.
+
+	* lib/og/entity.rb (#polymorphic_parent?): implemented
+
+	* lib/og/relation/has_many.rb: (#initialize): imply belongs_to
+	relation if missing!,
+	(#resolve): gets symbol for resolve method.
+	
+	* lib/og/relation.rb: fixes for polymorphic relations,
+	(#initialize): fix for non polymorphic.
+
+15-06-2005  Michael Neumann <mneumann@ntecs.de>
+
+	* lib/og.rb (Blob): introduced.
+
+14-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/og/relation.rb: added support for polymorphic relations,
+	(#polymorphic?): added.
+	
+	* back from vacations, lets rock!
+
+09-06-2005  George Moschovitis <gm@navel.gr>
+
+	* test/og/tc_polymorphic.rb: introduced.
+
+08-06-2005  George Moschovitis <gm@navel.gr>
+
+	* doc/AUTHORS: updated.
+	
+	* lib/og/store/mysql.rb: added :table_type options so you can
+	use InnoDB tables.
+
+07-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/og/manager.rb (#manage): call specialized enchanting 
+	code.
+	
+	* lib/og/mixin/optimistic_locking.rb: after some fixes it kinda
+	works,
+	correclty overloads #update.
+	overload #save.
+
+06-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/og/store/*: implemented sql_update for psql, mysql, sqlite3.
+	
+	* lib/og/mixin/optimistic_locking.rb: introduced,
+	(#update_with_lock): implemented.
+	
+	* test/og/tc_store.rb: added extra tests for extra functionality,
+	updated ...update tests.
+	
+	* lib/og/entity.rb (#select/#select_one): added,
+	added exist? alias.
+	
+	* lib/og/store/sql.rb: (#read_one): use ensure res.close [ghislain]
+	(#read_all): ditto,
+	(#select): implemented,
+	(#select_one): implemented.
+	Auto add SELECT * FROM table if missing for extra convienience,
+	(#find): handle :sql option.
+	added exist? alias,
+	(#sql_update): introduced.
+	(#update, #update_properties): use sql_update.
+	(#update_condition): implemented.
+	use update_condition to simplify the code.
+	(#update): new more flexible interface.
+
+05-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/og/store/*: adapted og insert in all stores.
+	
+	* COOL: SuperClass.all returns an array of subclasses, 
+	correctly typed.
+	
+	* lib/og/store/sql.rb: added more comments, cleaned up,
+	sanitized usage of res, row and res_row,
+	(#og_allocate): implemented.
+
+04-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/og/entity.rb (#all): correctly passes :type find option
+	for STI classes.
+	
+	* lib/og/store/mysql.rb (#eval_og_insert): handle STI.
+	
+	* lib/og/store/sql.rb (#fields_for_class): calculates extra
+	fields for STI tables,
+	(#find): added support for type in finders.
+	
+	* doc/AUTHORS: updated.
+	
+	* lib/og/entity.rb (#schema_inheritance): added.
+	
+	* lib/og/manager.rb (#manageable?): introduced,
+	(#manage): keep inheritance metadata,
+	first resolve inheritance.
+
+03-06-2005  George Moschovitis <gm@navel.gr>
+
+	* test/og/tc_inheritance.rb: introduced.
+
+02-06-2005 Ghislain Mary <gmary@lunacymaze.org>
+
+	* lib/og/store/sqlite.rb: fixed typo.
+	(#og_insert): fixet last_insert_rowid calculation.
+
 29-05-2005  George Moschovitis <gm@navel.gr>
 
+	* --- VERSION 0.18.0 ---
+	
 	* lib/og/relation/has_many.rb: takes :order into account.
 	
 	* lib/og/entity.rb (#find/#all): take find_options into account,

data/README

@@ -58,8 +58,19 @@ The latest version of Og can be found at
 
 * http://nitro.rubyforge.org
 
-Documentation for Og can be found in the distribution. You can find
-a nice tutorial at www.rubygarden.com.
+== Documentation
+
+Documentation for Og can be found at
+
+* http://nitro.rubyforge.org
+
+Don't forget to read the file doc/RELEASES for usefull
+documentation bits. Also, have a look at the test cases in
+the test directory for examples of usage.
+
+You can find a nice tutorial at www.rubygarden.com. Be warned
+that this tutorial describes an earlier version of Og. A *LOT*
+of new features have been added in the meantime.
 
 
 == Requirements

data/doc/AUTHORS

@@ -13,10 +13,13 @@ IDEAS, ADDITIONAL CODING, SUPPORT:
 	Design, additional coding.
 
 *	Matt Bowen <matt.bowen@farweststeel.com>
-	Additional code and documentation.
+	Oracle dirver, documentation.
 
 *	Julien Perrot <jperrot@exosec.fr>
 	Bug reports and patches.
 
+* Ghislain Mary <gmary@lunacymaze.org>
+	Bug reports and patches (sqlite3 driver).
+
 * Thomas Quas <tquas@yahoo.com>
 	Ideas, bug reports, unit tests.

data/doc/RELEASES

@@ -1,4 +1,75 @@
-== Version 0.18.0
+== Version 0.19.0
+
+Og reloaded part 2: Another superb release introducing a balanced 
+mix of innovative new features, common but useful stuff and bug 
+fixes. 
+
+Some notable changes:
+
+* Og polymorphic relations. A groundbreaking feature made possible
+	by Og's unique design and Ruby's power. Let's use an example 
+	to explain the concept:
+	
+	class Comment
+		...
+		belongs_to Object # polymorphic marker
+	end
+	
+	class User
+		...
+		has_many Comment
+	end
+	
+	class Article
+		...
+		has_many Comment
+	end
+	
+	u = User.new
+	u.comments << User::Comment('Hello')
+	
+	a = Article.new
+	a.comments << Article::Comment('Wow!')
+	
+	User::Comment and Article::Comment where automatically created
+	by Og and are serialized in different tables (also automatically
+	created by Og). This is the	next step in DRY!
+
+* Og now supports inheritance using the well known Single Table
+	Inheritance pattern. Thanks to Og's advanced design the pattern
+	is fully encapsulated:
+	
+	class Document
+		...
+		schema_inheritance
+	end
+	
+	class Article < Document
+		..
+	end
+	
+	class Photo < Document
+		..
+	end
+	
+	Document.all # => includes Articles and Photos
+	Article.all # => only Articles
+	
+	User.documents # => Articles and Photos
+	User.documents(:type => Photo) # => only photos.
+
+	Btw, this feature is orthogonal to the polymorphic relations
+	feature just described, giving the developer great 
+	flexibility.
+
+* Integrated an SQLite3 patch by Ghislain Mary.
+
+* Integrated PostgreSQL binary data patch by Michael Neumann.
+
+* Fixed all reported bugs.
+
+
+== Version 0.18.0 was released on 01/06/2005.
 
 Mainly a bug fix release. Many small improvements were 
 implemented. All reported bugs were fixed, as well as bugs found 

data/examples/run.rb

@@ -204,7 +204,7 @@ Article.all.each { |a| puts a }
 # when there are many updates or you dont care about speed. 
 # You can also update specific fields
 a2.title = 'A specific title'
-a2.update(:title)
+a2.update(:properties => [:title])
 
 puts "\n\n"
 Article.all.each { |a| puts a }
@@ -245,8 +245,8 @@ article.parts.each { |pa| puts pa }
 puts "\n\n"
 puts '---'
 
-c1 = Category.new('Category1').save!
-c2 = Category.new('Category2').save!
+c1 = Category.create('Category1')
+c2 = Category.create('Category2')
 
 article.categories << c1
 article.categories << c2

data/lib/og.rb

@@ -73,7 +73,7 @@ module Og
 
 	# The version.
 
-	Version = '0.18.1'
+	Version = '0.19.0'
 
 	# Library path.
 
@@ -133,6 +133,11 @@ module Og
 	# The active manager
 	
 	mattr_accessor :manager
+	
+	# Pseudo type for binary data
+	
+	class Blob; end
+	 
 end
 
 # gmosx: leave this here.
@@ -141,3 +146,5 @@ require 'og/manager'
 require 'og/errors'
 require 'og/types'
 require 'og/validation'
+
+# * George Moschovitis <gm@navel.gr>

data/lib/og/collection.rb

@@ -170,3 +170,6 @@ private
 end
 
 end
+
+# * George Moschovitis <gm@navel.gr>
+# *	Julien Perrot <jperrot@exosec.fr>

data/lib/og/entity.rb

@@ -12,9 +12,9 @@ module EntityMixin
 		base.extend(ClassMethods)
 
 		base.module_eval <<-end_eval, __FILE__, __LINE__ 
-			def save
-				self.class.ogmanager.store.save(self)
-				return self
+			def save(options = nil)
+				self.class.ogmanager.store.save(self, options)
+#				return self
 			end
 			alias_method :save!, :save
 
@@ -23,9 +23,8 @@ module EntityMixin
 				return self
 			end
 						
-			def update(*properties)
-				properties = nil if properties.empty?
-				self.class.ogmanager.store.update(self, properties)
+			def update(options = nil)
+				self.class.ogmanager.store.update(self, options)
 			end
 			
 			def update_properties(set)
@@ -62,6 +61,7 @@ module EntityMixin
 			ogmanager.store.load(pk, self)
 		end
 		alias_method :[], :load
+		alias_method :exist?, :load
 
 		def update_properties(set, options = nil)
 			ogmanager.store.update_properties(self, set, options)
@@ -75,6 +75,9 @@ module EntityMixin
 				options = find_options.first.update(options)
 			end
 			options[:class] = self
+			if self.metadata.superclass
+				options[:type] = self
+			end
 			ogmanager.store.find(options)
 		end
 		alias_method :all, :find
@@ -86,6 +89,14 @@ module EntityMixin
 		alias_method :one, :find_one
 		alias_method :first, :find_one
 
+		def select(sql)
+			ogmanager.store.select(sql, self)
+		end
+
+		def select_one(sql)
+			ogmanager.store.select_one(sql, self)
+		end
+		
 		def count(options = {})
 			options[:class] = self
 			ogmanager.store.count(options)
@@ -122,8 +133,17 @@ module EntityMixin
 		def order(order_str)
 			meta :find_options, :order => order_str
 		end
-	end
+		
+		def schema_inheritance
+			meta :schema_inheritance
+		end
 
+		# Is this entity a polymorphic parent?
+				
+		def polymorphic_parent?
+			self.to_s == self.metadata.polymorphic.to_s
+		end
+	end
 end
 
 # A helper class.

data/lib/og/manager.rb

@@ -83,6 +83,23 @@ class Manager
 		end
 	end	
 
+	# Resolves the inheritance for a class.
+	
+	def resolve_inheritance(klass)
+		if has_super?(klass)
+			sclass = klass.superclass
+			klass.meta :superclass, sclass
+			klass.meta :schema_inheritance
+			sclass.meta :subclasses, klass
+		end
+	end
+
+	# Resolve polymorphic relations.
+	
+	def resolve_polymorphic(klass)
+		Relations.resolve_polymorphic(klass)
+	end
+
 	# Manage a class. Converts the class to an Entity.
 
 	def manage(klass)
@@ -90,6 +107,11 @@ class Manager
 		
 		info = EntityInfo.new(klass)
 
+		# ensure that the superclass is managed before the
+		# subclass.
+
+		manage(klass.superclass) if has_super?(klass)
+		
 		klass.module_eval %{
 			def ==(other)
 				other ? @#{klass.primary_key.first} == other.#{klass.primary_key.first} : false
@@ -103,10 +125,20 @@ class Manager
 		
 		# FIXME: uggly!
 		store.enchant(klass, self); put_store
+
+		# Call special class enchanting code.
+		
+		klass.enchant if klass.respond_to?(:enchant)
 		
 		@entities[klass] = info
 	end
 
+	# Is this class manageable by Og?
+	
+	def manageable?(klass)
+		klass.respond_to?(:__props) and (!klass.__props.empty?)
+	end
+
 	# Is the class managed by Og? 
 
 	def managed?(klass)
@@ -114,6 +146,13 @@ class Manager
 	end
 	alias_method :entity?, :managed?
 
+	# Has this class a superclass?
+
+	def has_super?(klass)
+		manageable?(sclass = klass.superclass) and 
+				(klass.metadata.schema_inheritance || sclass.metadata.schema_inheritance)
+	end
+
 	# Use Ruby's advanced reflection features to find
 	# all manageable classes. Managable are all classes that 
 	# define Properties.
@@ -122,7 +161,7 @@ class Manager
 		classes = []
 
 		ObjectSpace.each_object(Class) do |c|
-			if c.respond_to?(:__props) and (!c.__props.empty?)
+			if manageable?(c)
 				classes << c
 			end
 		end
@@ -135,8 +174,12 @@ class Manager
 	# Manage a collection of classes.
 	
 	def manage_classes(*classes)
-		classes = manageable_classes if classes.empty?
-		classes.flatten.each { |c| manage(c) }
+		classes = manageable_classes.flatten if classes.empty?
+		classes.each { |c| resolve_inheritance(c) }
+		classes.each { |c| Relation.resolve(c, :resolve_target) }
+		classes.each { |c| Relation.resolve(c, :resolve_polymorphic) }
+		classes.each { |c| Relation.resolve(c, :resolve_options) }
+		classes.each { |c| manage(c) }
 	end
 
 end