og 0.6.0 → 0.7.0

data/README.og

@@ -1,15 +1,16 @@
 = Og 0.6.0
 
-Og (ObjectGraph) is an efficient, yet simple object-relational mapping 
+Nitro integrates the Og (ObjectGraph) 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 
 for querieng the database, raw access to the SQL language if needed 
 (for example to fine tune the automatically generated SQL tables, or 
-for custom queries), suports deserialization to Ruby objects or tuples 
+for custom queries), suports deserialization to Ruby objects or tuples,
+automatically generates join tables for many_to_many relations 
 and provides a collection of usefull Mixins to synthesize common 
-Objects.
+Entities.
 
 Og is a combination of the best features of Active Record and the
 former O-R mapping library included in Nitro (NDB). Adapters for

data/RELEASES.og

@@ -1,3 +1,18 @@
+== Version 0.7 was released on 27/12/2004.
+
+A snapshot of the latest code. Many fixes and new features result
+in a more mature product. Many thanks to the ruby hackers that sent
+suggestions and patches used in this release!
+
+Most notable additions:
+
+* Totaly recoded prop_accessor mechanism, avoids polution of the Module
+  class.
+* prop_accessors for Modules, allows synthesizing of managed objects
+	from Mixins.
+* new automatically generated methods in Og.
+* MockDatabase leverages the FlexMock object for easier unit testing.
+
 == Version 0.6 was released on 13/12/2004.
 
 This is a preview release, the api for the new features is not 

data/Rakefile

@@ -0,0 +1,135 @@
+# code: 
+# * George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: connection.rb 71 2004-10-18 10:50:22Z gmosx $
+
+require "rake"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+require "rake/testtask"
+require "rubygems"
+
+#project = 'nitro'
+project = 'og'
+
+# ----------------------------------------------------------------------
+
+desc "Default Task"
+task :default => :package
+
+# ----------------------------------------------------------------------
+
+# Run the tests
+
+Rake::TestTask.new do |t|
+	t.libs << "test"
+	t.test_files = FileList["test/**/tc*.rb"].exclude("**/tc*og*.rb")
+	t.verbose = true
+end
+
+# Run all tests
+
+Rake::TestTask.new(:test_all) do |t|
+	t.libs << "test"
+	t.test_files = FileList["test/**/tc*.rb"]
+	t.verbose = true
+end
+
+# ----------------------------------------------------------------------
+
+Rake::RDocTask.new do |rd|
+	rd.main = "README"
+	rd.rdoc_dir = "rdoc"
+	rd.rdoc_files.include("README", "lib/**/*.rb")
+end
+	
+# ----------------------------------------------------------------------
+
+if 'nitro' == project
+	
+	# Nitro GemSpec
+	#
+	require "lib/nitro/version"
+	
+	PKG_VERSION = $srv_version
+	PKG_FILES = FileList[
+		"[A-Z]*", "{bin,benchmark,etc,ext,examples,doc,lib,test,vendor}/**/*" 
+	#	"examples/*.rb"
+	].exclude(".svn/**/*").exclude("*.og").exclude("**/*.log")
+	
+	spec = Gem::Specification.new do |s|
+		s.name = "nitro"
+		s.version = PKG_VERSION
+		s.summary = "Web Engine"
+		s.description = "An efficient, yet simple engine for Web Applications"
+		# s.add_dependency("postgres-pr", ">= 0.3.0")
+		#	s.add_dependency("postgres", ">= 0.7.1")
+		#	s.add_dependency("extensions", ">= 0.5")
+		s.required_ruby_version = ">= 1.8.1"
+		s.files = PKG_FILES.to_a 
+		s.require_path = "lib"
+		s.autorequire = "nitro"
+		s.has_rdoc = true
+		s.extra_rdoc_files = FileList["[A-Z]*"].exclude("*.og").to_a
+		s.rdoc_options << "--main" << "README" << "--title" << "Nitro Documentation"
+		s.test_files = []
+		s.bindir = "bin"
+		s.author = "George Moschovitis"
+		s.email = "gm@navel.gr"
+		s.homepage = "http://www.navel.gr/nitro"
+		s.rubyforge_project = "nitro"
+	end
+
+else
+
+	# Og stand-alone GemSpec
+	#
+	require "lib/og/version"
+	
+	PKG_VERSION = $og_version
+	PKG_FILES = FileList[
+		"README.og", "RELEASES.og", "LICENSE", "AUTHORS", "Rakefile", "ChangeLog*", 
+		"examples/og/*", "lib/glue.rb", "lib/glue/**/*", "lib/og/**/*", "lib/og.rb",
+		"test/*og*.rb", "test/og/*"
+	].exclude(".svn/**/*").exclude("**/*.log")
+	
+	spec = Gem::Specification.new do |s|
+		s.name = 'og'
+		s.version = PKG_VERSION
+		s.summary = 'Og (ObjectGraph)'
+		s.description = 'An efficient and transparent Object-Relational mapping library'
+		#	s.add_dependency("postgres", ">= 0.7.1")
+		#	s.add_dependency("extensions", ">= 0.5")
+		# s.add_dependency("builder")
+		s.required_ruby_version = ">= 1.8.1"
+		s.files = PKG_FILES.to_a 
+		s.require_path = "lib"
+		s.autorequire = "og"
+		s.has_rdoc = true
+		s.extra_rdoc_files = FileList["README.og", "RELEASES.og", "LICENSE", "AUTHORS"].to_a
+		s.rdoc_options << "--main" << "README.og" << "--title" << "Og Documentation"
+		s.test_files = []
+		s.bindir = "bin"
+		s.author = "George Moschovitis"
+		s.email = "gm@navel.gr"
+		s.homepage = "http://www.navel.gr/og"
+		s.rubyforge_project = "og-rml"
+	end
+
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.package_dir = "dist"
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+# ----------------------------------------------------------------------
+
+desc "Install the gem"
+task :install => :repackage do
+  sh "gem install --local --no-rdoc dist/nitro-#{PKG_VERSION}.gem"
+end
+
+# vim: ft=ruby

data/examples/og/README

@@ -1,4 +1,11 @@
 = Og Example
 
+== run.rb
+
 A simple example that demonstrates some Og features. The example
 automatically creates a 'test' database.
+
+== mock_example.rb
+
+Demonstrates how easily the Og infrastructure can be mocked,
+for easy test unit writing.

data/examples/og/mock_example.rb

@@ -0,0 +1,58 @@
+# = Og Mocking Example 
+#
+# A simple example to demonstrate how to mock Og.
+# Very useful in test units.
+#
+# code: 
+# * George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: run.rb 185 2004-12-10 13:29:09Z gmosx $
+
+$LOAD_PATH.unshift '../../lib'
+
+require 'rubygems'
+require 'flexmock'
+require 'og'
+require 'og/mock'
+require 'logger'
+
+$log = Logger.new($stderr)
+
+class Article
+	prop_accessor :body, String
+
+	def initialize(body = nil)
+		@body = body
+	end
+end
+
+class SimpleTest < Test::Unit::TestCase
+
+	def setup
+		$og = Og::MockDatabase.new
+	end
+
+	def teardown
+		$og = nil
+	end
+
+	def test_me
+		mocks = [
+			Article.new('body1'),
+			Article.new('body2'),
+			Article.new('body3')
+		]
+		$og.mock_handle(:load_all) { |klass, extrasql| mocks }
+
+		# differnt ways to call the mocked method...
+		puts 'Here are the articles:', Article.all
+		puts 'Here are the articles:', Article.load_all
+		puts 'Here are the articles:', $og.load_all(Article)
+
+		# 3 times called
+		assert_equal(3, $og.mock_count(:load_all))
+	end
+
+end
+

data/examples/og/run.rb

@@ -6,7 +6,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: run.rb 185 2004-12-10 13:29:09Z gmosx $
+# $Id: run.rb 198 2004-12-22 11:26:59Z gmosx $
 
 $:.unshift "../../lib"
 
@@ -103,7 +103,7 @@ class Category
 	prop_accessor :body, String
 
 	# define a 'many to many' relation.	
-	many_to_many Article
+	many_to_many :articles, Article
 	
 	def initialize(title = nil)
 		@title = title
@@ -141,7 +141,6 @@ end
 # Initialize a logger.
 
 $log = Logger.new(STDERR); 
-
 # Og configuration.
 config = {
 	:address => "localhost",
@@ -199,9 +198,11 @@ c2.article_oid = a1.oid
 # managed objects).
 $og << c2
 
+# an alternative (easier and cooler) way to add children in a 
+# has_many relation:
 c3 = ArticleComment.new("Comment 3")
-c3.article = a1
-c3.save!
+# add_comment is automatically added by Og.
+a1.add_comment(c3)
 
 puts "\n\n"
 puts "* Print all all comments for article 1:"
@@ -287,4 +288,7 @@ puts '---'
 
 article.categories.each { |c| puts c.title }
 
+# create and save the article in one step.
+article = Article.create("title", "body")
 
+puts '--', article.oid

data/lib/glue/property.rb

@@ -2,10 +2,9 @@
 # * George Moschovitis  <gm@navel.gr>
 # design:
 # * Anastastios Koutoumanos  <ak@navel.gr>
-# * Elias Karakoulakis  <ekarak@ktismata.com>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: property.rb 185 2004-12-10 13:29:09Z gmosx $
+# $Id: property.rb 200 2004-12-27 11:24:41Z gmosx $
 
 require "glue/array"
 require "glue/hash"
@@ -25,10 +24,8 @@ module G
 #
 #--
 # TODO:
-# Inject only the really needd methods into Module.
 # Perhaps a sync is needed in evals (!!!!)
 #++
-#
 class Property
 	# the symbol of the property
 	attr_accessor :symbol
@@ -36,7 +33,7 @@ class Property
 	attr_accessor :name
 	# the class of the property
 	attr_accessor :klass
-	# additional metadata (like sql declaratio, sql index, etc)
+	# additional metadata (like sql declaration, sql index, etc)
 	attr_accessor :meta
 	
 	def initialize(symbol, klass, meta = {})
@@ -52,6 +49,119 @@ class Property
 	def to_s
 		return name
 	end
+
+end
+
+# = PropertyUtils
+#
+# A collection of Property related utility methods.
+#
+module PropertyUtils
+
+	# Add accessors to the properties to the given target
+	# (Module or Class). For simplicity also create the
+	# meta accessors. 
+	#--
+	# gmosx: Perhaps we 'll optimize this in the future.
+	#++
+	def self.enchant(target)
+		unless target.singleton_methods.include?('__props')
+			target.module_eval <<-"end_eval", __FILE__, __LINE__ 
+				@@__meta = G::SafeHash.new
+				@@__props = G::SafeArray.new
+				
+				def self.__props
+					@@__props
+				end
+
+				def self.__props=(props)
+					@@__props = props
+				end
+				
+				def self.__meta
+					@@__meta
+				end
+
+				def self.__meta=(meta)
+					@@__meta = meta
+				end
+			end_eval
+		end
+	end
+
+	# Copy properties from src (Module or Class) to dest.
+	#
+	def self.copy_props(src, dest)
+		src.__props.each do |p|
+			add_prop(dest, p)
+		end
+		
+		# copy the metadata.
+		src.__meta.each do |k, val|
+			val.each { |v| dest.meta(k, v) } if val
+		end
+	end
+
+	# Add the property to the target (Class or Module)
+	#
+	def self.add_prop(target, prop)
+		if idx = target.__props.index(prop)
+			# override in case of duplicates. Keep the order of the props.
+			target.__props[idx] = prop
+		else
+			target.__props << prop
+		end
+		
+		# Precompile the property read/write methods
+
+		s, klass = prop.symbol, prop.klass
+
+		if prop.meta[:reader]
+			target.module_eval %{
+				def #{s}
+					return @#{s}
+				end
+			}
+		end
+			
+		# gmosx: __force_xxx reuses xxx= to allow for easier
+		# overrides.
+		if prop.meta[:writer]
+			target.module_eval %{
+				#{prop_setter(prop)}
+				
+				def __force_#{s}(val)
+						self.#{s}=(} + case klass.name
+													when Fixnum.name
+														"val.to_i()"
+													when String.name
+														"val.to_s()"
+													when Float.name
+														"val.to_f()"
+													when Time.name
+														"Time.parse(val.to_s())"
+													when TrueClass.name, FalseClass.name
+														"val.to_i() > 0"
+													else
+														"val"
+												end + %{) 
+				end
+			}
+		end
+	end
+
+	# Generates the property setter code. Can be overriden
+	# to support extra functionality (example: markup)
+	#
+	def self.prop_setter(prop)
+		s = prop.symbol
+		%{
+			def #{s}=(val)
+				@#{s} = val
+			end
+		}
+	end
+	
 end
 
 end # module
@@ -90,36 +200,55 @@ class Module
 			end
 		end
 
-		unless self.methods.include?("__props")
-			eval %{
-				# Properties
-				# An array is used to enforce order.
-				def __props
-					@__props
-				end
+		G::PropertyUtils.enchant(self)
 
-				def __props=(props)
-					@__props = props
+		if self.is_a?(Class)
+			
+			# Add some extra code to append features to 
+			# subclasses.
+			self.module_eval <<-"end_eval", __FILE__, __LINE__
+
+				def self.inherited(sub)
+					G::PropertyUtils.enchant(sub)
+					G::PropertyUtils.copy_props(self, sub)
+					# gmosx: We have to define @@__props first to avoid reusing
+					# the hash from the module. super must stay at the end.
+					super
 				end
-				
-				def __meta
-					@__meta
+
+			end_eval
+
+		else
+			
+			# Add some extra code for modules to append
+			# their features to classes that include it.
+			self.module_eval <<-"end_eval", __FILE__, __LINE__
+
+				def self.append_features(base)
+					G::PropertyUtils.enchant(base)
+					G::PropertyUtils.copy_props(self, base)
+					# gmosx: We have to define @@__props first to avoid reusing
+					# the hash from the module. super must stay at the end.
+					super
 				end
 
-				def __meta=(meta)
-					@__meta = meta
-				end				
-			}
+			end_eval
+			
 		end
-
-		@__props = G::SafeArray.new() unless @__props
-				
+		
 		property = G::Property.new(symbol, klass, meta)
 		
 		reader = meta[:reader] || true
 		writer = writer || meta[:writer] || false
-		
-		__add_prop(property, reader, writer)
+	
+		meta[:reader] = true if meta[:reader].nil?
+		if defined?(writer)
+			meta[:writer] = writer 
+		else
+			meta[:writer] = true if meta[:writer].nil?
+		end
+
+		G::PropertyUtils.add_prop(self, property)
 	end
 
 	# Helper method. Accepts a collection of symbols and generates
@@ -218,90 +347,20 @@ class Module
 		end
 	end
 	
-	# Add the property
-	#
-	def __add_prop(prop, reader = true, writer = true)
-		if idx = @__props.index(prop)
-			# override in case of duplicates. Keep the order of the props.
-			@__props[idx] = prop
-		else
-			@__props << prop
-		end
-		
-		# Precompile the property read/write methods
-
-		s, klass = prop.symbol, prop.klass 
-
-		if reader		
-			module_eval %{
-				def #{s}
-					return @#{s}
-				end
-			}
-		end
-			
-		# gmosx: __force_xxx reuses xxx= to allow for easier
-		# overrides.
-		if writer 
-			module_eval %{
-				def #{s}=(val)
-					@#{s} = val
-				end
-				
-				def __force_#{s}(val)
-						self.#{s}=(} + case klass.name
-													when Fixnum.name
-														"val.to_i()"
-													when String.name
-														"val.to_s()"
-													when Float.name
-														"val.to_f()"
-													when Time.name
-														"Time.parse(val.to_s())"
-													when TrueClass.name, FalseClass.name
-														"val.to_i() > 0"
-													else
-														"val"
-												end + %{) 
-				end
-			}
-		end
-	end
 	
-	# Attach metadata 
-	#
+	# Attach metadata. 
+	# Guard against duplicates, no need to keep order.
+	# This method uses closures :)
+	#--
+	# gmosx: crappy implementation, recode.
+	#++
 	def meta(key, val)
-		@__meta = G::SafeHash.new unless @__meta
-
-		@__meta[key] = [] unless @__meta[key]
-
-		# guard against duplicates, no need to keep order.
-		@__meta[key].delete_if { |v| val == v }
-		@__meta[key] << val			
+		self.module_eval <<-"end_eval", __FILE__, __LINE__ 
+			@@__meta[key] ||= [] 
+			@@__meta[key].delete_if { |v| val == v }
+			@@__meta[key] << val			
+		end_eval
 	end
-	
-	# This method is typically called before including other
-	# modules to preserve properties order. 
-	#
-	def inherit_meta(mod = superclass)
-		# concat props.
-		if mod.__props
-			@__props = G::SafeArray.new unless @__props
-			
-			mod.__props.each { |p|
-				__add_prop(p)
-			} 
-		end
 
-		# concat metadata
-		if mod.__meta
-			mod.__meta.each { |k, val|
-				val.each { |v|
-					meta(k, v)
-				} if val
-			}
-		end
-	end
-	
 end