og 0.20.0 → 0.21.0

data/doc/config.txt

@@ -13,7 +13,7 @@ applications/sites on a single database.
 
 If true, use Ruby's advanced introspection capabilities to 
 automatically manage classes that define properties.
-	
+  
 === Og.create_schema = true
 
 If set to true, Og attempts to recreate the database schema

data/examples/mysql_to_psql.rb

@@ -12,19 +12,19 @@ require 'og'
 # Configure databases.
 
 psql_config = {
-	:destroy => true,
-	:name => 'test',
-	:store => 'psql',
-	:user => 'postgres',
-	:password => 'navelrulez'
+  :destroy => true,
+  :name => 'test',
+  :store => 'psql',
+  :user => 'postgres',
+  :password => 'navelrulez'
 }
 
 mysql_config = {
-	:destroy => true,
-	:name => 'test',
-	:store => 'mysql',
-	:user => 'root',
-	:password => 'navelrulez'
+  :destroy => true,
+  :name => 'test',
+  :store => 'mysql',
+  :user => 'root',
+  :password => 'navelrulez'
 }
 
 # Initialize Og.
@@ -36,11 +36,11 @@ mysql = Og.connect(mysql_config)
 # Looks like an ordinary Ruby object.
 
 class Article
-	property :name, :body, String
+  property :name, :body, String
 
-	def initialize(name = nil, body = nil)
-		@name, @body = name, body
-	end
+  def initialize(name = nil, body = nil)
+    @name, @body = name, body
+  end
 end
 
 # First populate the mysql database.
@@ -62,7 +62,7 @@ psql.manage(Article)
 # Store all articles.
 
 for article in articles
-	article.insert
+  article.insert
 end
 
 # Fetch an article from PostgreSQL

data/examples/run.rb

@@ -9,137 +9,137 @@ $DBG = true
 # A child class.
 
 class Comment
-	property :body, String
-	
-	def initialize(body = nil)
-		@body = body
-	end
-	
-	def to_s
-		return @body
-	end
+  property :body, String
+  
+  def initialize(body = nil)
+    @body = body
+  end
+  
+  def to_s
+    return @body
+  end
 end
 
 # = A Parent class.
 
 class User
-	property :name, String, :unique => true
-	has_many :comments, UserComment
-	
-	def initialize(name = nil)
-		@name = name
-	end
-	
-	def to_s
-		return @name
-	end
+  property :name, String, :unique => true
+  has_many :comments, UserComment
+  
+  def initialize(name = nil)
+    @name = name
+  end
+  
+  def to_s
+    return @name
+  end
 end
 
 
 # A parent class.
 
 class Article
-	property :title, String
-	property :body, String
-
-	# override the default O->R mapping
-
-	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.
-
-	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
-		@options = {}
-		@other_options = {}
-	end
-	
-	def to_s
-		return "#@title: #@body"
-	end
+  property :title, String
+  property :body, String
+
+  # override the default O->R mapping
+
+  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.
+
+  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
+    @options = {}
+    @other_options = {}
+  end
+  
+  def to_s
+    return "#@title: #@body"
+  end
 end
 
 # A parent class.
 
 class Category
-	property :title, String
-	property :body, String
+  property :title, String
+  property :body, String
 
-	# define a 'many to many' relation.	
+  # define a 'many to many' relation.  
 
-	many_to_many Article
-	
-	def initialize(title = nil)
-		@title = title
-	end
+  many_to_many Article
+  
+  def initialize(title = nil)
+    @title = title
+  end
 end
 
 
 # Article comment.
 
 class ArticleComment < Comment
-	belongs_to Article
+  belongs_to Article
 end
 
 # User comment.
 
 class UserComment < Comment
-	belongs_to :author, User
+  belongs_to :author, User
 end
 
 # Another child class.
 
 class Part
-	property :name, String
-	belongs_to Article
-	
-	def initialize(name = nil)
-		@name = name
-	end
-	
-	def to_s
-		return @name
-	end
+  property :name, String
+  belongs_to Article
+  
+  def initialize(name = nil)
+    @name = name
+  end
+  
+  def to_s
+    return @name
+  end
 end
 
 # Og configuration.
 
 config = {
-	:destroy => true, # destroy table created from earlier runs.
-	:store => 'psql',
-	:name => 'test',
-	:user => "postgres",
-	:password => "navelrulez"
+  :destroy => true, # destroy table created from earlier runs.
+  :store => 'psql',
+  :name => 'test',
+  :user => "postgres",
+  :password => "navelrulez"
 }
 
 # Initialize Og

data/install.rb

@@ -1,28 +1,15 @@
 #!/usr/bin/env ruby
 
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: install.rb 32 2005-04-25 12:31:21Z gmosx $
-
 require 'rbconfig'
 require 'ftools'
 
 dst_dir = Config::CONFIG['sitelibdir']
 
 Dir.chdir('lib') do
-	Dir['**/*.rb'].each do |file|
-		File.mkpath File.join(dst_dir, File.dirname(file)), true
-		File.install file, File.join(dst_dir, file), 0644, true
-	end
-end
-
-# gmosx: this is potentially dangerous, rethink.
-
-Dir.chdir('vendor') do
-	Dir['**/*.rb'].each do |file|
-		File.mkpath File.join(dst_dir, File.dirname(file)), true
-		File.install file, File.join(dst_dir, file), 0644, true
-	end
+  Dir['**/*.rb'].each do |file|
+    File.mkpath File.join(dst_dir, File.dirname(file)), true
+    File.install file, File.join(dst_dir, file), 0644, true
+  end
 end
 
 puts %{
@@ -45,3 +32,6 @@ at the command line.
 
 Enjoy the magic of Og!
 }
+
+# * George Moschovitis <gm@navel.gr>
+

data/lib/og.rb

@@ -27,19 +27,20 @@ require 'glue/configuration'
 #
 # The library provides the following features:
 #
-# + Object-Relational mapping.
+# + Object-Relational mapping, automatically maps standard 
+#   Ruby objects to sql schemas
 # + Absolutely no configuration files.
 # + Multiple stores (PostgreSQL, MySQL, SQLite, Oraclei, SqlServer, ..).
-# + Supports non SQL stores.
+# + Supports non SQL stores (in-memory, filesystem, ..).
 # + ActiveRecord-style meta language and db aware methods.
 # + Deserialize to Ruby Objects.
 # + Deserialize sql join queries to Ruby Objects.
 # + Eager associations.
 # + Serialize arbitrary ruby object graphs through YAML.
 # + Connection pooling.
-# + Thread safety (temporarily dissabled).
+# + Thread safety.
 # + SQL transactions.
-#	+ Aspect oriented constructs allow interception of lifecycle callbacks.
+#  + Aspect oriented constructs allow interception of lifecycle callbacks.
 # + Transparent support for cascading deletes for all backends.
 # + Hierarchical structures (nested sets)
 # + Works safely as part of distributed application.
@@ -51,10 +52,10 @@ require 'glue/configuration'
 # metadata types:
 #
 # [+:sql_index+]
-#		Create an sql index for this property.
+#    Create an sql index for this property.
 #
 # [+:unique+]
-#		This value of the property must be unique.
+#    This value of the property must be unique.
 #
 # === Design
 #
@@ -67,78 +68,78 @@ require 'glue/configuration'
 #
 # * og_read
 # * og_insert
-#	* og_update
-#	* og_delete
+#  * og_update
+#  * og_delete
 
 module Og
 
-	# The version.
-
-	Version = '0.20.0'
-
-	# Library path.
-
-	LibPath = File.dirname(__FILE__)
-
-	# 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.
-
-	setting :check_implicit_graph_changes, :default => false, :doc => 'If true, check for implicit changes in the object graph'
-	
-	# If true, only allow reading from the database. Usefull
-	# for maintainance.
-	# WARNING: not implemented yet.
-	
-	setting :read_only_mode, :default => false, :doc => 'If true, only allow reading from the database'
-
-	# 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.
-	#++
-	
-	setting :table_prefix, :default => 'og', :doc => 'Prepend the prefix to all generated SQL table names'
-
-	# 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.
-	
-	setting :create_schema, :default => true, :doc => 'If true, Og tries to create/update the schema in the data store'
-
-	# 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.
-
-	setting :raise_store_exceptions, :default => true, :doc => 'If true raises exceptions on store errors'
-	
-	# Enable/dissable thread safe mode.
-	
-	setting :thread_safe, :default => true, :doc => 'Enable/dissable thread safe mode'
-		
-	# Marker module. If included in a class, the Og automanager
-	# ignores this class.
-
-	module Unmanageable; end
-
-	# The active manager
-	
-	mattr_accessor :manager
-	
-	# Pseudo type for binary data
-	
-	class Blob; end
-	 
+  # The version.
+
+  Version = '0.21.0'
+
+  # Library path.
+
+  LibPath = File.dirname(__FILE__)
+
+  # 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.
+
+  setting :check_implicit_graph_changes, :default => false, :doc => 'If true, check for implicit changes in the object graph'
+  
+  # If true, only allow reading from the database. Usefull
+  # for maintainance.
+  # WARNING: not implemented yet.
+  
+  setting :read_only_mode, :default => false, :doc => 'If true, only allow reading from the database'
+
+  # 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.
+  #++
+  
+  setting :table_prefix, :default => 'og', :doc => 'Prepend the prefix to all generated SQL table names'
+
+  # 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.
+  
+  setting :create_schema, :default => true, :doc => 'If true, Og tries to create/update the schema in the data store'
+
+  # 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.
+
+  setting :raise_store_exceptions, :default => true, :doc => 'If true raises exceptions on store errors'
+  
+  # Enable/dissable thread safe mode.
+  
+  setting :thread_safe, :default => true, :doc => 'Enable/dissable thread safe mode'
+    
+  # Marker module. If included in a class, the Og automanager
+  # ignores this class.
+
+  module Unmanageable; end
+
+  # The active manager
+  
+  mattr_accessor :manager
+  
+  # Pseudo type for binary data
+  
+  class Blob; end
+   
 end
 
 # gmosx: leave this here.