og 0.8.0 → 0.9.3

data/README.og

@@ -1,4 +1,4 @@
-= Og 0.8.0
+= Og 0.9.0
 
 Nitro integrates the Og (ObjectGraph) object-relational mapping 
 library. Og	provides transparent serialization of object graphs to a RDBMS 
@@ -41,40 +41,44 @@ The library provides the following features:
 + Hierarchical structures (preorder traversal, materialized paths)
 + Works safely as part of distributed application.
 + Automatic Validation/Constraints.
-+ Simple implementation < 2k lines of code.
++ Simple and clean implementation.
 
 == Download
 
 The latest version of Og can be found at
 
-* http://www.navel.gr/og
+* http://www.rubyforge.com/projects/nitro
 
-Documentation for Og can be found at
-
-* http://www.navel.gr/nitro/og
+Documentation for Og can be found in the distribution.
 
 
 == Requirements
 
 Og requires the following applications or libraries:
 
-* Ruby 1.8.1 and greater (http://www.ruby-lang.org)
-	Version 1.8.2.preview2 is recomended
+* Ruby 1.8.1 and greater 
+	http://www.ruby-lang.org
+	Version 1.8.2 is recomended.
 
-* Ruby-psql (http://www.postgresql.jp/interfaces/ruby/archive/ruby-postgres-0.7.1.tar.gz)
+* Ruby-psql 
+	http://www.postgresql.jp/interfaces/ruby/archive/ruby-postgres-0.7.1.tar.gz
 	Ruby interface to the PostgreSQL RDBMS.
 
-* Ruby-mysql (http://tmtm.org/ja/ruby/mysql/README_en.html)
+* Ruby-mysql 
+	http://tmtm.org/ja/ruby/mysql/README_en.html
 	Ruby interface to the MySQL RDBMS.
 	
-* PostgreSQL (http://www.postgres.org)
+* PostgreSQL 
+	http://www.postgres.org
 	Used for the Database Backend.
 	
-* MySQL (http://www.mysql.org)
+* MySQL 
+	http://www.mysql.org
 	Used for the Database Backend.
 
 Please install the required applications and libraries before continuing
-with the installation of Og.
+with the installation of Og. Only install the libraries needed for
+the backend you plan to use.
 
 
 == Instalation
@@ -82,11 +86,11 @@ with the installation of Og.
 Og is distributed as a RubyGem. First of all make sure you have
 installed RubyGems on your system. Then run the following command:
 
-gem install og-rml
+gem install og
 
 Then try to run the examples/og Example application.
 
-A tar.gz distribution is also available on http://www.navel.gr/og
+A tar.gz distribution is also available on http://www.rubyforge.com/projects/nitro.
 
 
 == Support
@@ -98,7 +102,7 @@ mailto:gm@navel.gr.
 
 == Licence
 
-Copyright (c) 2004 Navel Ltd (http://www.navel.gr)
+Copyright (c) 2004-2005 Navel Ltd (http://www.navel.gr)
 
 Og (http://www.navel.gr/og) is copyrighted free software
 created and maintained by George Moschovitis (mailto:gm@navel.gr)

data/RELEASES.og

@@ -1,3 +1,21 @@
+== Version 0.9.3 was released on 01/02/2005.
+
+A maintenance release.
+
+Most notable additions:
+
+* Og metalanguage relations insert metadata into 
+	the target class, useful for advanced scaffolders.
+
+* Og refer_to meta-language command. 
+
+* Correct handling of booleans.
+
+* Auto-include metalanguage on prop.
+
+* Many bug fixes.
+
+
 == Version 0.8 was released on 12/01/2005.
 
 A snapshot of the latest code. Cool new features,

data/Rakefile

@@ -1,8 +1,6 @@
-# code: 
 # * George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: connection.rb 71 2004-10-18 10:50:22Z gmosx $
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id$
 
 require "rake"
 require "rake/rdoctask"
@@ -52,7 +50,7 @@ if 'nitro' == project
 	#
 	require "lib/nitro/version"
 	
-	PKG_VERSION = $srv_version
+	PKG_VERSION = Nitro::Version 
 	PKG_FILES = FileList[
 		"[A-Z]*", "{bin,benchmark,etc,ext,examples,doc,lib,test,vendor}/**/*" 
 	#	"examples/*.rb"
@@ -87,7 +85,7 @@ else
 	#
 	require "lib/og/version"
 	
-	PKG_VERSION = $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",
@@ -114,7 +112,7 @@ else
 		s.author = "George Moschovitis"
 		s.email = "gm@navel.gr"
 		s.homepage = "http://www.navel.gr/og"
-		s.rubyforge_project = "og-rml"
+		s.rubyforge_project = "nitro"
 	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 198 2004-12-22 11:26:59Z gmosx $
+# $Id: run.rb 202 2005-01-17 10:44:13Z gmosx $
 
 $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
 
@@ -273,7 +273,7 @@ puts '---'
 
 c2.articles.each { |a| puts a.title }
 
-article.del_category(c1)
+article.delete_category(c1)
 
 puts '---'
 

data/lib/glue.rb

@@ -1,12 +1,10 @@
-# = Glue 
-#
 # General libraries used by various projects.
 #
-# code: 
-# * George Moschovitis  <gm@navel.gr>
-#
+#-- 
+# George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: glue.rb 175 2004-11-26 16:11:27Z gmosx $
+# $Id: glue.rb 215 2005-01-24 10:44:05Z gmosx $
+#++
 
 require 'English'
 require 'pp'
@@ -14,10 +12,15 @@ require 'pp'
 require 'glue/property'
 require 'glue/attribute'
 
+# The standard namespace module.
+
+module N; end
+
 class NilClass
+
 	# quite usefull for error tolerant apps.
 	# a bit dangerous? Will have to rethink this.
-	#
+	
 	def empty?
 		return true
 	end
@@ -27,6 +30,7 @@ class Class
 	#--
 	# gmosx: is this really needed?
 	#++
+	
 	def to_i
 		return self.hash
 	end
@@ -34,7 +38,7 @@ end
 
 module Kernel
 
-	# pretty prints an exception/error object
+	# Pretty prints an exception/error object
 	# usefull for helpfull debug messages
 	#
 	# Input:
@@ -42,7 +46,7 @@ module Kernel
 	#
 	# Output:
 	# the pretty printed string
-	#
+	
 	def pp_exception(ex)
 		return %{#{ex.message}\n\tBACKTRACE:\n\t#{ex.backtrace.join("\n\t")}\n\tLOGGED FROM:\n\t#{caller[0]}}
 	end

data/lib/glue/array.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2002-2003 Navel, all rights reserved.
-# $Id: array.rb 165 2004-11-18 12:04:04Z gmosx $
+# $Id: array.rb 202 2005-01-17 10:44:13Z gmosx $
 
 require "sync"
 

data/lib/glue/cache.rb

@@ -3,7 +3,7 @@
 # * Anastasios Koutoumanos  <ak@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: cache.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: cache.rb 202 2005-01-17 10:44:13Z gmosx $
 
 module N;
 

data/lib/glue/flexob.rb

@@ -0,0 +1,12 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id$
+
+require 'ostruct'
+
+# A flexible Object.
+# Temporarily implemented as a simple OpenStruct.
+
+class Flexob < OpenStruct
+
+end

data/lib/glue/hash.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: hash.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: hash.rb 202 2005-01-17 10:44:13Z gmosx $
 
 require "sync"
 

data/lib/glue/inflector.rb

@@ -44,13 +44,13 @@ module Inflector
   end
   
 	# Convert a class to a name.
-	#
+	
 	def name(klass)
 		Inflector.underscore(Inflector.demodulize(klass.to_s))
 	end
 	
 	# Convert a class to a name in plural
-	#
+	
 	def plural_name(klass)
 		Inflector.pluralize(Inflector.underscore(Inflector.demodulize(klass.to_s)))
 	end

data/lib/glue/logger.rb

@@ -1,16 +1,12 @@
-# code:
 # * George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: logger.rb 161 2004-11-18 10:51:51Z gmosx $
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: logger.rb 248 2005-01-31 13:38:34Z gmosx $
 
 require 'logger'
 
-# = Logger
-#
 # A simple wrapper arround the Ruby logger. Mainly for 
 # compatibility purposes.
-#
+
 class Logger
 	alias_method :devel, :debug
 	alias_method :fine, :debug
@@ -42,7 +38,7 @@ class Logger
 	# 
 	# This code comes straight from the dev-utils Gem.
 	# Author: Gavin Sinclair <gsinclair@soyabean.com.au>
-	#
+	
   def trace(expr, style=:p)
     unless expr.respond_to? :to_str
       warn "trace: Can't evaluate the given value: #{caller.first}"

data/lib/glue/misc.rb

@@ -0,0 +1,14 @@
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id$
+
+# Executes a Ruby block without warnings.
+
+def silence_warnings
+	old_verbose, $VERBOSE = $VERBOSE, nil
+	begin
+		yield
+	ensure
+		$VERBOSE = old_verbose
+	end
+end

data/lib/glue/number.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: number.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: number.rb 202 2005-01-17 10:44:13Z gmosx $
 
 module N;
 

data/lib/glue/object.rb

@@ -0,0 +1,26 @@
+# $Id$
+
+class Object #:nodoc:
+  def remove_subclasses_of(superclass)
+    subclasses_of(superclass).each { |subclass| Object.send(:remove_const, subclass) rescue nil }
+  end
+
+  def subclasses_of(superclass)
+    subclasses = []
+    ObjectSpace.each_object(Class) do |k|
+      next if !k.ancestors.include?(superclass) || superclass == k || k.to_s.include?("::") || subclasses.include?(k.to_s)
+      subclasses << k.to_s
+    end
+    subclasses
+  end
+end
+
+class Class #:nodoc:
+  def remove_subclasses
+    Object.remove_subclasses_of(self)
+  end
+
+  def subclasses
+    Object.subclasses_of(self)
+  end
+end

data/lib/glue/pool.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: pool.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: pool.rb 202 2005-01-17 10:44:13Z gmosx $
 
 require "thread"
 require "monitor"

data/lib/glue/property.rb

@@ -1,21 +1,19 @@
-# code:
 # * George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: property.rb 200 2004-12-27 11:24:41Z gmosx $
+# * Michael Neumann  <mneumann@ntecs.de>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: property.rb 248 2005-01-31 13:38:34Z gmosx $
 
 require 'glue/array'
 require 'glue/hash'
 
 module N
 
-# = Property
-#
-# Ruby attributes are typeless and generally this is good. Some times
-# we need extra metadata though, for example in relational mapping,
-# or web form population.
+# Ruby attributes are typeless and generally this is good. 
+# Some times we need extra metadata though, for example in 
+# relational mapping, or web form population.
 #
-# Only Fixnums, Strings, Floats, Times, Booleans are converted.
+# Only Fixnums, Strings, Floats, Times, Booleans are 
+# converted.
 #
 # The default = methods do not force the  types. A special 
 # __force_set method should be used instead.
@@ -24,14 +22,23 @@ module N
 # TODO:
 # Perhaps a sync is needed in evals (!!!!)
 #++
+
 class Property
+
 	# the symbol of the property
+	
 	attr_accessor :symbol
+	
 	# the string representation of the symbol
+	
 	attr_accessor :name
+	
 	# the class of the property
+	
 	attr_accessor :klass
+	
 	# additional metadata (like sql declaration, sql index, etc)
+	
 	attr_accessor :meta
 	
 	def initialize(symbol, klass, meta = {})
@@ -53,7 +60,7 @@ end
 # = PropertyUtils
 #
 # A collection of Property related utility methods.
-#
+
 module PropertyUtils
 
 	# Add accessors to the properties to the given target
@@ -65,6 +72,7 @@ module PropertyUtils
 	#--
 	# gmosx: Perhaps we 'll optimize this in the future.
 	#++
+
 	def self.enchant(target, force = false)
 		unless target.singleton_methods.include?('__props')
 			target.module_eval <<-"end_eval", __FILE__, __LINE__ 
@@ -91,7 +99,7 @@ module PropertyUtils
 	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)
@@ -105,7 +113,7 @@ module PropertyUtils
 	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.
@@ -128,6 +136,7 @@ module PropertyUtils
 			
 		# gmosx: __force_xxx reuses xxx= to allow for easier
 		# overrides.
+
 		if prop.meta[:writer]
 			target.module_eval %{
 				#{prop_setter(prop)}
@@ -154,7 +163,7 @@ module PropertyUtils
 
 	# Generates the property setter code. Can be overriden
 	# to support extra functionality (example: markup)
-	#
+	
 	def self.prop_setter(prop)
 		s = prop.symbol
 		%{
@@ -165,11 +174,53 @@ module PropertyUtils
 	end
 
 	# Get the property metadata for the given symbol.
-	#
+
 	def self.get_prop(klass, sym)
 		return klass.__props.find { |p| p.symbol == sym }
 	end
 
+	# Include meta-language mixins
+	
+	def self.include_meta_mixins(target)
+		target.module_eval %{ include N::Validation } if defined?(N::Validation)
+		# gmosx: TODO, make Og::MetaLanguage equivalent to Validation.
+		target.module_eval %{ extend Og::MetaLanguage } if defined?(Og::MetaLanguage)
+	end
+
+	# Resolves the parameters passed to the propxxx macros
+	# to generate the meta, klass and symbols variables. This
+	# way the common functionality is factored out.
+	#
+	# [+params+]
+	#		The params to resolve.
+	#	[+one_symbol+]
+	#		If true, only resolves one symbol (used in prop).
+
+	def self.resolve_prop_params(*params)
+		meta = {}
+		klass = Object
+		symbols = []
+
+		for param in params.flatten
+			if param.is_a?(Class)
+				klass = param
+			elsif param.is_a?(Symbol)
+				symbols << param
+			elsif param.is_a?(TrueClass) or param.is_a?(TrueClass) 
+				writer = param
+			elsif param.is_a?(Hash)
+				# the meta hash.
+				meta.update(param) { |k, a, b| [a,b].join(' ') }
+			else
+				raise 'Error when defining property!'
+			end
+		end
+
+		raise 'No symbols provided!' if symbols.empty?
+
+		return meta, klass, symbols
+	end
+
 end
 
 end # module
@@ -188,33 +239,19 @@ class Module
 	# --> creates only writer.
 	# prop Fixnum, :oid, writer = true, :sql => "integer PRIMARY KEY"
 	#	--> creates reader and writer.
-	# 
+	 
 	def prop(*params)
-		
-		meta = {}
-		klass = Object
-		
-		for param in params
-			if param.is_a?(Class)
-				klass = param
-			elsif param.is_a?(Symbol)
-				symbol = param
-			elsif param.is_a?(TrueClass) or param.is_a?(TrueClass) 
-				writer = param
-			elsif param.is_a?(Hash)
-				# the meta hash.
-				meta = param
-			else
-				raise "Error when defining property!"
-			end
-		end
+		meta, klass, symbols = N::PropertyUtils.resolve_prop_params(params) 	
+		symbol = symbols.first
 
+		
 		N::PropertyUtils.enchant(self)
 
 		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)
@@ -231,17 +268,17 @@ class Module
 			
 			# 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)
 					N::PropertyUtils.enchant(base)
 					N::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.
-					
-					unless base.included_modules.include?(N::Validation)
-						base.module_eval %{ include N::Validation }  
-					end if defined?(N::Validation)
+			
+					N::PropertyUtils.include_meta_mixins(base)
 					
 					super
 				end
@@ -265,7 +302,8 @@ class Module
 		N::PropertyUtils.add_prop(self, property)
 
 		# gmosx: should be placed AFTER enchant!
-		module_eval %{ include N::Validation } if defined?(N::Validation)
+		
+		N::PropertyUtils.include_meta_mixins(self)
 	end
 
 	# Helper method. Accepts a collection of symbols and generates
@@ -273,24 +311,9 @@ class Module
 	#
 	# Example:
 	#	prop_reader String, :name, :title, :body, :sql => "char(32)"
-	#
+	
 	def prop_reader(*params)
-		meta = {}
-		klass = Object
-		symbols = []
-
-		for param in params
-			if param.is_a?(Class)
-				klass = param
-			elsif param.is_a?(Symbol)
-				symbols << param
-			elsif param.is_a?(Hash)
-				# the meta hash.
-				meta = param
-			else
-				raise "Error when defining property!"
-			end
-		end
+		meta, klass, symbols = N::PropertyUtils.resolve_prop_params(params) 	
 		
 		meta[:reader] = true
 		meta[:writer] = false
@@ -305,25 +328,10 @@ class Module
 	#
 	# Example:
 	#	prop_writer String, :name, :title, :body, :sql => "char(32)"
-	#
+	
 	def prop_writer(*params)
-		meta = {}
-		klass = Object
-		symbols = []
+		meta, klass, symbols = N::PropertyUtils.resolve_prop_params(params) 	
 
-		for param in params
-			if param.is_a?(Class)
-				klass = param
-			elsif param.is_a?(Symbol)
-				symbols << param
-			elsif param.is_a?(Hash)
-				# the meta hash.
-				meta = param
-			else
-				raise 'Error when defining property!'
-			end
-		end
-		
 		meta[:reader] = false
 		meta[:writer] = true
 		
@@ -337,25 +345,10 @@ class Module
 	#
 	# Example:
 	#	prop_accessor String, :name, :title, :body, :sql => "char(32)"
-	#
+	
 	def prop_accessor(*params)
-		meta = {}
-		klass = Object
-		symbols = []
+		meta, klass, symbols = N::PropertyUtils.resolve_prop_params(params) 	
 
-		for param in params
-			if param.is_a?(Class)
-				klass = param
-			elsif param.is_a?(Symbol)
-				symbols << param
-			elsif param.is_a?(Hash)
-				# the meta hash.
-				meta = param
-			else
-				raise "Error when defining property!"
-			end
-		end
-		
 		meta[:reader] = true
 		meta[:writer] = true
 		
@@ -371,6 +364,7 @@ class Module
 	#--
 	# gmosx: crappy implementation, recode.
 	#++
+	
 	def meta(key, val)
 		self.module_eval <<-"end_eval", __FILE__, __LINE__ 
 			@@__meta[key] ||= [] 
@@ -380,4 +374,3 @@ class Module
 	end
 
 end
-