og 0.5.0

data/AUTHORS

@@ -0,0 +1,19 @@
+MAIN DEVELOPER:
+
+* George Moschovitis  <gm@navel.gr>
+	Project Leader, Architecture and Design, main coder, documentation, 
+	maintainer.
+	
+IDEAS, ADDITIONAL CODING, SUPPORT:
+
+* Anastasios Koutoumanos  <ak@navel.gr>
+	Design, additional coding.
+
+* Elias Athanasopoulos  <elathan@navel.gr>
+	Additional coding.
+
+* Elias Karakoulakis  <ekarak@navel.gr>
+	Additional design.
+
+* Kostas Nasis  <kostas@nasis.com>
+	Ideas and bug reports.

data/LICENSE

@@ -0,0 +1,32 @@
+The BSD License
+
+Copyright (c) 2004, Navel Ltd. (http://www.navel.gr)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are 
+met:
+
+* Redistributions of source code must retain the above copyright 
+notice, this list of conditions and the following disclaimer.
+	
+* Redistributions in binary form must reproduce the above copyright 
+notice, this list of conditions and the following disclaimer in the 
+documentation and/or other materials provided with the distribution.
+	
+* Neither the name of Navel nor the names of its contributors may be 
+used to endorse or promote products derived from this software 
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.og

@@ -0,0 +1,104 @@
+= Og 0.5.0
+
+Og (ObjectGraph) is an efficient, yet simple 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 
+and provides a collection of usefull Mixins to synthesize common 
+Objects.
+
+Og is a combination of the best features of Active Record and the
+former O-R mapping library included in Nitro (NDB). Adapters for
+PostgreSQL and MySQL are included.
+
+Og is part of the Nitro project, released as a stand-alone library
+due to popular demand. You can find the ChangeLog in the Nitro 
+distribution (http://www.navel.gr/nitro).
+
+
+== Features
+
+The library provides the following features:
+
++ Object-Relational mapping.
++ Absolutely no configuration files.
++ Multiple backends (PostgreSQL, MySQL).
++ ActiveRecord-style meta language and db aware methods.
++ Deserialize to Ruby Objects or ResultSets.
++ Deserialize sql join queries to Ruby Objects.
++ Serialize arbitrary ruby object graphs through YAML.
++ Connection pooling.
++ Thread safety.
++ SQL transactions.
++ Lifecycle callbacks.
++ Transparent support for cascading deletes for all backends.
++ Hierarchical structures (preorder traversal, materialized paths)
++ Works safely as part of distributed application.
++ Simple implementation < 2k lines of code.
+
+== Download
+
+The latest version of Og can be found at
+
+* http://www.navel.gr/og
+
+Documentation for Og can be found at
+
+* http://www.navel.gr/nitro/og
+
+
+== 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-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 interface to the MySQL RDBMS.
+	
+* PostgreSQL (http://www.postgres.org)
+	Used for the Database Backend.
+	
+* MySQL (http://www.mysql.org)
+	Used for the Database Backend.
+
+Please install the required applications and libraries before continuing
+with the installation of Og.
+
+
+== Instalation
+
+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
+
+Then try to run the examples/og Example application.
+
+A tar.gz distribution is also available on http://www.navel.gr/og
+
+
+== Support
+
+For any questions regarding Og, feel free to ask on the ruby-talk 
+mailing list (which is mirrored to comp.lang.ruby) or contact 
+mailto:gm@navel.gr.
+
+
+== Licence
+
+Copyright (c) 2004 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)
+and released under the standard BSD Licence. For details consult
+the file LICENCE.
+

data/RELEASES.og

@@ -0,0 +1,23 @@
+
+== Version 0.5.0 was released on 21/11/2004.
+
+New standalone version. SQL indices can be defined again.
+
+
+== Version 0.5.0 was released on 01/11/2004.
+
+Renamed to Og (ObjectGraph) Og combines the best features of Active
+Record and NDB. A fully working MySQL adapter is also provided.
+Moreover the code base is further cleaned up. Small improvements 
+to the application configuration system. This version is integrated
+in Nitro.
+
+
+== Version 0.2 was released on 07-10-2004. 
+
+The sofware is actually usable but not tested in a production environment. 
+Comments from the Ruby community are critical in order to fix possible 
+bugs and improve the API. Suggestions for missing features are also 
+welcome. This version only supports the Postgres Database.
+
+

data/examples/og/README

@@ -0,0 +1,4 @@
+= Og Example
+
+A simple example that demonstrates some Og features. The example
+automatically creates a 'test' database.

data/examples/og/run.rb

@@ -0,0 +1,251 @@
+# = Og Example 
+#
+# A simple example to demonstrate the Og library.
+#
+# code: 
+# * George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id: run.rb 167 2004-11-23 14:03:10Z gmosx $
+
+$:.unshift "../../lib"
+
+require "glue/logger"
+require "og"
+
+# Full debug information.
+$DBG = true
+
+# = A child class
+#
+class Comment
+	prop_accessor :body, String
+	
+	def initialize(body = nil)
+		@body = body
+	end
+	
+	def to_s
+		return @body
+	end
+end
+
+# forward declaration
+class ArticleComment < Comment; end
+
+# forward declaration
+class UserComment < Comment; end
+
+# forward declaration
+class Part; end
+
+# = A Parent class
+#
+class User
+	prop_accessor :name, String
+	
+	has_many :comments, UserComment
+	
+	def initialize(name = nil)
+		@name = name
+	end
+	
+	def to_s
+		return @name
+	end
+end
+
+# = A parent class
+#
+class Article
+	prop_accessor :title, String
+	prop_accessor :body, String
+	# override the default O->R mapping
+	prop_accessor :level, Fixnum, :sql => "smallint DEFAULT 1"
+	# store a Ruby Hash in the Database. YAML
+	# is used for serializing the attribute.
+	# no need to define the class, but you can if you want.
+	prop_accessor :options
+	# exactly like the standard Ruby attr creates only the reader.
+	prop :create_time, Time
+	
+	# define comment relation:
+	has_many :comments, ArticleComment
+	
+	has_many :parts, Part
+	
+	# define author relation:
+	belongs_to :author, User
+	
+	# this attribute is NOT stored in the db.
+	attr_accessor :other_options
+	
+	# Managed object constructors with no args, take *args 
+	# as parameter to allow for Mixin chaining.
+	#
+	def initialize(title = nil, body = nil)
+		@title, @body = title, body
+		@create_time = Time.now
+		@options = {}
+		@other_options = {}
+	end
+	
+	def to_s
+		return "#@title: #@body"
+	end
+end
+
+# = Article comment
+#
+class ArticleComment < Comment
+	belongs_to :article, Article
+end
+
+# = User comment
+#
+class UserComment < Comment
+	belongs_to :author, User
+end
+
+# = Another child class
+#
+class Part
+	prop_accessor :name, String
+	belongs_to :article, Article
+	
+	def initialize(name = nil)
+		@name = name
+	end
+	
+	def to_s
+		return @name
+	end
+end
+
+# Initialize a logger.
+
+$log = Logger.new(STDERR); 
+
+# Og configuration.
+
+config = {
+	:address => "localhost",
+	:database => "test",
+	:backend => "psql",
+	:user => "postgres",
+	:password => "navelrulez",
+	:connection_count => 1
+}
+=begin
+config = {
+	:address => "localhost",
+	:database => "test",
+	:backend => "mysql",
+	:user => "root",
+	:password => "navelrulez",
+	:connection_count => 1
+}
+=end
+# Cleanup the database for earlier executions
+
+Og::Database.drop_db!(config)
+
+# Initialize Og
+
+$og = Og::Database.new(config)
+
+# Get an Og connection for this thread.
+
+$og.get_connection
+
+# Create some articles
+
+a1 = Article.new("Title1", "Body1")
+a1.save!
+
+a2 = Article.new("Title2", "Body2")
+a2.save!
+
+puts "\n\n"
+puts "* Get and print all articles:"
+articles = Article.all()
+articles.each { |a| puts a }
+
+# Create some comments
+
+c1 = ArticleComment.new("Comment 1")
+c1.article = a1
+c1.save!
+
+c2 = ArticleComment.new("Comment 2")
+# alternative way to set the parent.
+c2.article_oid = a1.oid
+# an alternative way to save (add to the $og 'virtal collection' of
+# managed objects).
+$og << c2
+
+c3 = ArticleComment.new("Comment 3")
+c3.article = a1
+c3.save!
+
+puts "\n\n"
+puts "* Print all all comments for article 1:"
+a1.comments.each { |c| puts c }
+
+# Most Og commands allow you to fine-tune the low level
+# SQL code by passing extra_sql parameters, here is an
+# example
+puts "\n\n"
+puts "* comments with sql finetunings:"
+# use a standard SQL limit clause
+a1.comments("LIMIT 2").each { |c| puts c }
+
+
+# Change a managed object
+a1.title = "Changed Title"
+# Og knows that this is a managed object and executes
+# an SQL UPDATE instead of an SQL INSERT
+a1.save!
+
+puts "\n\n"
+Article.all.each { |a| puts a }
+
+# The previous command updates the whole object. It is used
+# when there are many updates or you dont care about speed. 
+# To update only specific fields use pupdate or properties_update
+a2.pupdate! "title='A specific title'"
+
+puts "\n\n"
+Article.all.each { |a| puts a }
+
+# delete an object
+ArticleComment.delete(c3)
+
+puts "\n\n"
+ArticleComment.all.each { |a| puts a }
+
+
+# Serialize a hash
+a1.options = { "k1" => "val1", "k2" => "val2" }
+a1.save!
+
+# lookup an object
+article = Article[a1.oid]
+
+puts "\n\n"
+puts article.options.inspect
+
+u = User.new("gmosx")
+u.save!
+
+article = Article[1]
+# you can also lookup by the name property.
+article.author = User["gmosx"]  
+article.save!
+
+part = Part.new("admin")
+part.article = article
+part.save!
+
+article.parts.each { |pa| puts pa }
+

data/lib/glue.rb

@@ -0,0 +1,52 @@
+# = Glue 
+#
+# General libraries used by various projects.
+#
+# code: 
+# * George Moschovitis  <gm@navel.gr>
+#
+# (c) 2004 Navel, all rights reserved.
+# $Id$
+
+require "English"
+require "pp"
+
+require 'glue/property'
+
+class NilClass
+	# quite usefull for error tolerant apps.
+	# a bit dangerous? Will have to rethink this.
+	#
+	def empty?
+		return true
+	end
+end
+
+class Class
+	#--
+	# gmosx: is this really needed?
+	#++
+	def to_i()
+		return self.hash()
+	end
+end
+
+module Kernel
+	# pretty prints an exception/error object
+	# usefull for helpfull debug messages
+	#
+	# Input:
+	# The Exception/StandardError object
+	#
+	# 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
+
+end
+
+# predefine some comonly used objects
+
+EMPTY_STRING = ""