og 0.11.0 → 0.12.0

data/ChangeLog

@@ -1,5 +1,155 @@
+07-03-2005  George Moschovitis  <gm@navel.gr>
+
+	* lib/og/adapters/mysql.rb: overide create_fields.
+
+	* examples/why_wiki: updated, added nice urls.
+
+	* lib/nitro/adapters/webrick.rb: use CgiUtils.parse_params and
+	CgiUtils.parse_cookies to be more compatible with FastiCGI, and
+	fix some bugs.
+
+	* examples/blog/roor/base.xsl: moved temporarily here.
+
+	* lib/xsl: deprecated.
+
+	* lib/nitro.rb: removed resolve_action_arguments option.
+
+	* examples/no_xsl_blog/*: updated.
+
+	* RELEASES.og: updated.
+
+	* RELEASES: updated.
+
+	* bin/cluster: deprecated.
+
+	* doc/LICENCE: moved from root.
+
+	* doc/AUTHORS: moved from root.
+
+	* after some fixes, tests pass again.
+
+	* test/nitro/ui/sitemap.rb:  deprecated.
+
+	* lib/nitro/ui/sitemap.rb:  deprecated.
+
+	* lib/nitro/controller.rb (#action_methods): better removal of pp methods,
+	remove Controller methods.
+
+	* lib/nitro/render.rb: no require of nitro, caused problems.
+
+	* lib/og/adapters/*: added typcast overrides to the other
+	adapters.
+
+	* test/og/tc_observer.rb: added tests.
+
+06-03-2005  George Moschovitis  <gm@navel.gr>
+
+	* lib/og/meta.rb: fixed linkback to_s bug.
+
+	* test/og/tc_observer.rb: implemeted, many cases.
+
+	* lib/og.rb: added og_pre_read / og_post_read callbacks.
+
+	* lib/og/adapter.rb (#eval_lifecycle_methods): evaluate callbacks,
+	(#eval_og_insert): evaluate observer callbacks,
+	fix for class observer,
+	(#eval_og_update): evaluate observer callbacks,
+	(#eval_og_update): evaluate observer callbacks.
+
+	* lib/og/observer.rb: scrapped the STUPID rails design,
+	introduced an ultra cool, efficient, and ruby compatible design.
+	(#add_observer): accepts multiple observers.
+
+05-03-2005  George Moschovitis  <gm@navel.gr>
+
+	* examples/blog/root/error.xhtml: click to reload.
+
+	* lib/nitro/runner.rb: added --crawl option.
+	added --render option.
+
+	* examples/blog/root/shader.xsl: fixed base href bug.
+
+	* lib/nitro/template.rb: #() alias, useful in xslt stylesheets.
+
+	* examples/blog/root/*: use scaffolded view_uri.
+
+	* lib/nitro/scaffold.rb: add support for routes.
+	:nosuffix option.
+
+	* lib/nitro/controller.rb (#action): implemented.
+	(#update_routes): implemented.
+	(ActionParam): implemented.
+	(ActionMeta): implemented.
+	(#action_method_arguments): deprecated.
+
+04-03-2005  George Moschovitis  <gm@navel.gr>
+
+	* lib/nitro/controller.rb: introduced the concept of the action
+	keyword.
+
+	* lib/nitro/routing.rb: introduced,
+	(Router): introduced.
+	(#route): works.
+
+	* lib/nitro/dispatcher.rb: added routes map,
+	experimental rewrite support.
+
+	* lib/og/adapters/*: added support for multiple many_to_many relations.
+
+	* test/og/tc_many_to_many.rb: implemented.
+
+	* lib/og/meta.rb: accept :linkback as symbol,
+	added support for multiple many_to_many relations. [mneumann]
+
+	* lib/og/adapter.rb (join_table): encode a field name
+	to allow for multiple many_to_many relations with the same klass. [mneumann]
+
+	* lib/nitro/markup.rb: markup >, <.
+
+	* examples/blog/root/error.xhtml: Introduced and made really
+	useful.
+
+	* lib/nitro/render.rb (#log_error): reimplemented
+	to be more flexible and allow for much better error reporting.
+
+	* lib/nitro/context.rb (#out): override, to catch errors.
+
+	* lib/nitro/shaders.rb (RubyShader): use the TemplateMixin.
+
+	* RELEASES: updated.
+
+	* lib/nitro/template.rb: factored out TemplateMixin,
+	improved API.
+
+03-03-2005  George Moschovitis  <gm@navel.gr>
+
+	* lib/nitro/template.rb: introduced as standalone template engine,
+	pass binding and buffer to store the result.
+
+01-03-2005  George Moschovitis  <gm@navel.gr>
+
+	* lib/og/enchant.rb: COOL: generate finders for all properties,
+	take :unique into account when generating finders,
+	finders use typecast system.
+	find* alias for select* methods.
+	converted Og.db -> @@og_db.
+
+	* lib/og/adapter.rb: use :unique metadata,
+	introduced typecast system.
+
+	* lib/og.rb: better comments.
+
+	* test/og/tc_observer.rb: introduced.
+
+	* lib/og/observer.rb: introduced,
+	(Observable): implemented.
+
+	* lib/nitro/ui/select.rb: deprecated.
+
 28-02-2005  George Moschovitis  <gm@navel.gr>
 
+	* --- VERSION 0.11.0 ---
+
 	* lib/nitro/controller.rb (#action_method_arguments): implemented.
 
 	* lib/nitro.rb: added resolve_action_arguments,

data/README.og

@@ -1,7 +1,7 @@
-= Og 0.11.0
+= Og 0.12.0
 
-Nitro integrates the Og (ObjectGraph) object-relational mapping 
-library. Og	provides transparent serialization of object graphs to a RDBMS 
+(ObjectGraph) is a powerfull object-relational mapping library. Og provides 
+transparent serialization of object graphs to a RDBMS 
 backend. Unlike other similar libraries Og maps standard Ruby
 objects to SQL tables and not vice versa. Og provides a meta language
 to describe the relations between objects, a flexible	and intuitive api 
@@ -36,6 +36,7 @@ The library provides the following features:
 + 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 a distributed application.

data/RELEASES.og

@@ -1,3 +1,43 @@
+== Version 0.12.0 was released on 07/03/2005.
+
+A careful blend of new features and subtle improvements
+to the existing infrastructure. Some important bugs where
+fixed aswell.
+
+Most notable additions:
+
+* Og automatically generates finders for all properties, for
+	even easier (and portable) querying:
+
+	class Article
+		property :title, :body, String
+		property :hits, Fixnum
+		property :create_time, Time
+	end
+
+	you get the finders:
+
+	Article.find_by_title
+	Article.find_by_body
+	Article.find_by_hits
+	Article.find_by_create_time
+
+	The finders take into account the unique constrain, to return
+	an array or just an object as needed.
+
+* Og introduces lifecycle observers to avoid 'poluting' the model
+	objects with excess functionality. You can use every object
+	as observer (duck typing) or extend from an AR style Observer
+	class. The observer callbacks are precompiled in the lifecycle
+	methods only if defined, so the perfomance is not affected
+	in the general case.
+
+* Fixed Og bug: multiple many_to_many relations with the
+	same target class.
+
+* further code cleanup, improved examples and more.
+
+
 == Version 0.11.0 was released on 28/02/2005.
 
 The platform continues to evolve and now supports the 

data/Rakefile

@@ -59,7 +59,7 @@ spec = Gem::Specification.new do |s|
 	s.required_ruby_version = '>= 1.8.0'
 
 	s.files = FileList[
-		'README.og', 'RELEASES.og', 'LICENSE', 'AUTHORS', 'Rakefile', 'ChangeLog*',
+		'README.og', 'RELEASES.og', 'doc/LICENSE', 'doc/AUTHORS', 'Rakefile', 'ChangeLog*',
 		'install.rb',
 		'examples/og/*', 'lib/glue.rb', 'lib/glue/**/*', 'lib/og/**/*', 'lib/og.rb',
 		'test/*og*.rb', 'test/og/*', 'vendor/extensions/**/*'
@@ -69,7 +69,7 @@ spec = Gem::Specification.new do |s|
 	s.autorequire = 'og'
 	
 	s.has_rdoc = true
-	s.extra_rdoc_files = FileList['README.og', 'RELEASES.og', 'LICENSE', 'AUTHORS'].to_a
+	s.extra_rdoc_files = FileList['README.og', 'RELEASES.og', 'doc/LICENSE', 'doc/AUTHORS'].to_a
 	s.rdoc_options << '--main' << 'README.og' << '--title' << 'Og Documentation'
 	s.rdoc_options << '--all' << '--inline-source'
 

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