og 0.16.0 → 0.17.0

data/examples/run.rb

@@ -1,8 +1,4 @@
 # A simple example to demonstrate the Og library.
-#
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004 Navel, all rights reserved.
-# $Id: run.rb 1 2005-04-11 11:04:30Z gmosx $
 
 require 'og'
 
@@ -13,7 +9,7 @@ $DBG = true
 # A child class.
 
 class Comment
-	prop_accessor :body, String
+	property :body, String
 	
 	def initialize(body = nil)
 		@body = body
@@ -24,20 +20,10 @@ class Comment
 	end
 end
 
-# forward declaration
-class ArticleComment < Comment; end
+# = A Parent class.
 
-# forward declaration
-class UserComment < Comment; end
-
-# forward declaration
-class Part; end
-
-# = A Parent class
-#
 class User
-	prop_accessor :name, String
-	
+	property :name, String, :unique => true
 	has_many :comments, UserComment
 	
 	def initialize(name = nil)
@@ -53,31 +39,44 @@ end
 # A parent class.
 
 class Article
-	prop_accessor :title, String
-	prop_accessor :body, String
+	property :title, String
+	property :body, String
+
 	# override the default O->R mapping
-	prop_accessor :level, Fixnum, :sql => "smallint DEFAULT 1"
+
+	property :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
+
+	property :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
+
+	# many to many relation.
+	
+	many_to_many Category
 	
 	# 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
@@ -93,11 +92,12 @@ end
 # A parent class.
 
 class Category
-	prop_accessor :title, String
-	prop_accessor :body, String
+	property :title, String
+	property :body, String
 
 	# define a 'many to many' relation.	
-	many_to_many :articles, Article
+
+	many_to_many Article
 	
 	def initialize(title = nil)
 		@title = title
@@ -108,7 +108,7 @@ end
 # Article comment.
 
 class ArticleComment < Comment
-	belongs_to :article, Article
+	belongs_to Article
 end
 
 # User comment.
@@ -120,8 +120,8 @@ end
 # Another child class.
 
 class Part
-	prop_accessor :name, String
-	belongs_to :article, Article
+	property :name, String
+	belongs_to Article
 	
 	def initialize(name = nil)
 		@name = name
@@ -133,68 +133,50 @@ class Part
 end
 
 # Og configuration.
-config = {
-	:database => "test",
-	:adapter => "sqlite",
-	:connection_count => 2
-}
-=begin
-config = {
-#	:address => "localhost",
-	:database => "test",
-	:adapter => "psql",
-	:user => "postgres",
-	:password => "navelrulez",
-	:connection_count => 1
-}
 
 config = {
-	:address => "localhost",
-	:database => "test",
-	:backend => "mysql",
-	:user => "root",
-	:password => "navelrulez",
-	:connection_count => 1
+	:destroy => true, # destroy table created from earlier runs.
+	:store => 'psql',
+	:name => 'test',
+	:user => "postgres",
+	:password => "navelrulez"
 }
-=end
-# Cleanup the database for earlier executions
-
-Og::Database.drop!(config)
 
 # Initialize Og
 
-db = Og::Database.new(config)
+db = Og.setup(config)
 
 # Create some articles
 
-a1 = Article.new("Title1", "Body1")
-a1.save!
+a1 = Article.new('Title1', 'Body1')
+a1.save
 
 # shortcut
-a2 = Article.create("Title2", "Body2")
+
+a2 = Article.create('Title2', 'Body2')
 
 puts "\n\n"
 puts "* Get and print all articles:"
-articles = Article.all()
+articles = Article.all
 articles.each { |a| puts a }
 
 # Create some comments
 
-c1 = ArticleComment.new("Comment 1")
+c1 = ArticleComment.new('Comment 1')
 c1.article = a1
-c1.save!
+c1.save
 
-c2 = ArticleComment.new("Comment 2")
+c2 = ArticleComment.new('Comment 2')
 # alternative way to set the parent.
 c2.article_oid = a1.oid
 # an alternative way to save 
-db << c2
+db.store << c2
 
 # an alternative (easier and cooler) way to add children in a 
 # has_many relation:
-c3 = ArticleComment.new("Comment 3")
+c3 = ArticleComment.new('Comment 3')
 # add_comment is automatically added by Og.
-a1.add_comment(c3)
+a1.comments << c3
 
 puts "\n\n"
 puts "* Print all all comments for article 1:"
@@ -206,11 +188,11 @@ a1.comments.each { |c| puts c }
 puts "\n\n"
 puts "* comments with sql finetunings:"
 # use a standard SQL limit clause
-a1.comments("LIMIT 2").each { |c| puts c }
+a1.comments(:limit => 2).each { |c| puts c }
 
 
 # Change a managed object
-a1.title = "Changed Title"
+a1.title = 'Changed Title'
 # Og knows that this is a managed object and executes
 # an SQL UPDATE instead of an SQL INSERT
 a1.save!
@@ -220,21 +202,24 @@ 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'"
+# You can also update specific fields
+a2.title = 'A specific title'
+a2.update(:title)
 
 puts "\n\n"
 Article.all.each { |a| puts a }
 
 # delete an object
+puts '-----------------1'
 ArticleComment.delete(c3)
+puts '-----------------2'
 
 puts "\n\n"
 ArticleComment.all.each { |a| puts a }
 
 
 # Serialize a hash
-a1.options = { "k1" => "val1", "k2" => "val2" }
+a1.options = { :k1 => 'val1', :k2 => 'val2' }
 a1.save!
 
 # lookup an object
@@ -243,15 +228,15 @@ article = Article[a1.oid]
 puts "\n\n"
 puts article.options.inspect
 
-u = User.new("gmosx")
+u = User.new('gmosx')
 u.save!
 
 article = Article[1]
 # you can also lookup by the name property.
-article.author = User["gmosx"]  
+article.author = User.find_by_name('gmosx')  
 article.save!
 
-part = Part.new("admin")
+part = Part.new('admin')
 part.article = article
 part.save!
 
@@ -260,11 +245,11 @@ article.parts.each { |pa| puts pa }
 puts "\n\n"
 puts '---'
 
-c1 = Category.new("Category1").save!
-c2 = Category.new("Category2").save!
+c1 = Category.new('Category1').save!
+c2 = Category.new('Category2').save!
 
-article.add_category(c1)
-article.add_category(c2)
+article.categories << c1
+article.categories << c2
 
 puts '---'
 
@@ -274,13 +259,13 @@ puts '---'
 
 c2.articles.each { |a| puts a.title }
 
-article.delete_category(c1)
+article.categories.delete(c1)
 
 puts '---'
 
 article.categories.each { |c| puts c.title }
 
 # create and save the article in one step.
-article = Article.create("title", "body")
+article = Article.create('title', 'body')
 
 puts '--', article.oid

data/install.rb

@@ -2,7 +2,7 @@
 
 # * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: install.rb 1 2005-04-11 11:04:30Z gmosx $
+# $Id: install.rb 32 2005-04-25 12:31:21Z gmosx $
 
 require 'rbconfig'
 require 'ftools'

data/lib/og.rb

@@ -1,6 +1,11 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: og.rb 20 2005-04-15 15:18:36Z gmosx $
+# = Og
+#
+# Copyright (c) 2004-2005, George Moschovitis (http://www.gmosx.com)
+# Copyright (c) 2004-2005, Navel Ltd (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 doc/LICENCE.
 
 require 'glue'
 require 'glue/logger'
@@ -14,8 +19,9 @@ require 'glue/inflector'
 require 'glue/validation'
 require 'glue/aspects'
 
-# Og (ObjectGraph) is an efficient, yet simple Object-Relational 
-# mapping library. 
+# Og (ObjectGraph) manages Ruby objects and their relations and
+# provides transparent and efficient object-relational mapping
+# and querying mechanisms.
 #
 # === Features
 #
@@ -23,30 +29,22 @@ require 'glue/aspects'
 #
 # + Object-Relational mapping.
 # + Absolutely no configuration files.
-# + Multiple backends (PostgreSQL, MySQL, SQLite, Oracle).
+# + Multiple stores (PostgreSQL, MySQL, SQLite, Oraclei, SqlServer, ..).
+# + Supports non SQL stores.
 # + ActiveRecord-style meta language and db aware methods.
 # + Deserialize to Ruby Objects.
-# + Deserialize sql join queries to Ruby Objects (temporarily dissabled).
+# + Deserialize sql join queries to Ruby Objects.
+# + Eager associations.
 # + Serialize arbitrary ruby object graphs through YAML.
 # + Connection pooling.
-# + Thread safety.
+# + Thread safety (temporarily dissabled).
 # + SQL transactions.
-# + Lifecycle callbacks.
-# + Lifecycle observers.
+#	+ Aspect oriented constructs allow interception of lifecycle callbacks.
 # + Transparent support for cascading deletes for all backends.
-# + Hierarchical structures (preorder traversal, materialized paths)
+# + Hierarchical structures (nested sets)
 # + Works safely as part of distributed application.
 # + Simple implementation.
 #
-# === Meta language
-#
-# primary_key :pid (NOT IMPLEMENTED)
-# name_key :name (NOT IMPLEMENTED)
-# prop_accessor Fixnum, :pid, :sql => "smallint DEFAULT 1"
-# has_many Child, :children
-# many_to_many Role, :roles
-# sql_index :pid
-#
 # === Property Metadata
 #
 # Og defines, reserves and uses the following property 
@@ -58,64 +56,31 @@ require 'glue/aspects'
 # [+: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. 
-#
-# 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
-# the point. Instead of .name(), to_s() is used so the methods
-# are more flexible (they accept class names too!!)
-#
 # Og allows the serialization of arbitrary Ruby objects. Just
 # mark them as Object (or Array or Hash) in the prop_accessor
 # and the engine will serialize a YAML dump of the object.
 # Arbitrary object graphs are supported too.
 #
-# This is NOT a singleton, an application may access multiple
-# databases.
-#
-# The og.xxx methods are more flexible and allow you to use
-# multiple databases for example.
-# 
-# === Managed Objects Lifecycle Callbacks
-#
-# * og_pre_read
-# * og_post_read
-# * og_pre_insert
-# * og_post_insert
-#	* og_pre_update
-# * og_post_update
-# * og_pre_insert_update
-# * og_post_insert_update
-# * self.og_pre_delete
+# === Lifecycle Callbacks
 #
-# 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 
-# 
-# * Support prepared statements (pgsql)
-# * Support stored procedures (pgsql)
-# * Support caching.
-# * Deserialize to OpenStruct.
-# * Better documentation.
+# * og_read
+# * og_insert
+#	* og_update
+#	* og_delete
 
 module Og
 
 	# The version.
 
-	Version = '0.16.0'
+	Version = '0.17.0'
 
 	# Library path.
 
 	LibPath = File.dirname(__FILE__)
 
-	# If true, check for implicti changes in the object 
+	# If true, check for implicit changes in the object 
 	# graph. For example when you add an object to a parent
 	# the object might be removed from his previous parent.
 	# In this case Og emmits a warning.
@@ -128,63 +93,35 @@ module Og
 	
 	mattr_accessor :read_only_mode, false
 
-	# If true, the library automatically 'enchants' managed classes.
-	# In enchant mode, special db aware methods are added to 
-	# managed classes and instances.
-	# If false, Og enchants only classes that define properties.
-	
-	mattr_accessor :enchant_managed_classes, true
-	
-	# If true, use Ruby's advanced introspection capabilities to 
-	# automatically manage classes tha define properties.
-	
-	mattr_accessor :auto_manage_classes, true
-
-	# If true, automatically include the Og meta-language into Module. 
-	# If false, the polution of the Module object is avoided. However 
-	# if you include a prop_accessor or a managed Mixin in your
-	# object MetaLanguage gets automatically extended in the class.
-	
-	mattr_accessor :include_meta_language, true
-	
-	# Attach the following prefix to all generated SQL table names.
+	# Prepend the following prefix to all generated SQL table names.
 	# Usefull on hosting scenarios where you have to run multiple
 	# web applications/sites on a single database.
+	# 
+	# Don't set the table_prefix to nil, or you may face problems 
+	# with reserved words on some RDBM systems. For example User 
+	# maps to user which is reserved in postgresql). The prefix 
+	# should start with an alphanumeric character to be compatible 
+	# with all RDBM systems (most notable Oracle).
+	#--
+	# TODO: move this to the sql store.
+	#++
 	
-	mattr_accessor :table_prefix, nil
+	mattr_accessor :table_prefix, 'og'
 
 	# If true, Og tries to create/update the schema in the
-	# data store. For production/live environments set this to false
-	# and only set to true when the object model is upadated.
-	# For debug/development environments this should stay true
-	# for convienience.
+	# data store. For production/live environments set this to 
+	# false and only set to true when the object model is 
+	# upadated. For debug/development environments this should 
+	# stay true for convienience.
 	
 	mattr_accessor :create_schema, true
 
-	# If true raises exceptions on database errors, usefull when
+	# If true raises exceptions on store errors, usefull when
 	# debugging. For production environments it should probably be 
 	# set to false to make the application more fault tolerant.
 
-	mattr_accessor :raise_db_exceptions, true
-	
-	# The active database. Og allows you to access multiple
-	# databases from a single application.
+	mattr_accessor :raise_store_exceptions, true
 	
-	mattr_accessor :db
-
-	# Set the active database.
-
-	def self.use(db)
-		@@db = db
-		@@db.get_connection
-	end
-
-	# The adapter of the active database.
-
-	def self.adapter
-		@@db.adapter
-	end
-
 	# Marker module. If included in a class, the Og automanager
 	# ignores this class.
 
@@ -194,5 +131,7 @@ end
 
 # gmosx: leave this here.
 
-require 'og/database'
+require 'og/manager'
+require 'og/errors'
+require 'og/types'
 require 'og/validation'