og 0.20.0 → 0.21.0

data/doc/RELEASES

@@ -1,4 +1,73 @@
-== Version 0.20.0
+== Version 0.21.0
+
+Some great new features and a lot of fixes. Many patches were 
+contributed by the community to make this is a release you 
+will love!
+
+Some notable changes:
+
+* Og dynamic queries. You can inject caclulated or join attributes
+  to your objects. Here is an example:
+  
+  class Item
+    property :quantity, Fixnum
+    property :unit_price, Float
+    
+    def initialize(quantity, unit_price)
+      @quantity = quantity
+      @unit_price = unit_price
+    end
+  end
+  
+  Item.create 2, 3.0
+  item = Item.find_one :select => 'quantity*unit_price as total_price'
+  item.total_price # => 6.0
+  
+  Please note that total_price is a dynamically injected 
+  attribute. Now you can combine SQL's powerful query features
+  with the simplicity and elegance of Og.
+
+* Og customized join tables allows you to use any Ruby object
+  as the join relation between other objects. Here comes an 
+  example:
+  
+  class Category
+    property :title, String
+  end
+
+  class Article
+    property :title, String
+  end
+  
+  class ArticleToCategory
+    property :rate, Float
+    has_one Article
+    has_one Category
+  end
+  
+  c1 = Category.create
+  c2 = Category.create
+
+  a = Article.create
+  a.categories.add(c1, :rate => 2.3) 
+  a.categories.add(c2, :rate => 1.2) 
+
+  for c in a.categories
+    p a.category_join_data(c).rate
+  end
+  
+* Og collections size() is now optimized.
+
+* Og join code support refactoring. The new code is easier to read,
+  more customizable and generates more efficient code by default.
+
+* Updated the documentation.
+    
+* Fixed all reported or discovered bugs, many smaller 
+  improvements.
+
+
+== Version 0.20.0 was released on 12-07-2005.
 
 A bug fix release.
 
@@ -9,16 +78,16 @@ Some notable changes:
 * Fixed Mysql store reconnect bug.
 
 * Og falls back to pure ruby adapters for Mysql and Postgres, to 
-	make it easier to run out of the box. Please, don't forget to 
-	switch to the natively compiled adapters for production sites.
+  make it easier to run out of the box. Please, don't forget to 
+  switch to the natively compiled adapters for production sites.
 
 * :uniq keyword
 
 * fix for self join.
 
 * Many, many, many bug fixes and small improvements. This release
-	fixes all reported bugs in the spirit of out zero-bug tolerance
-	philosophy.	
+  fixes all reported bugs in the spirit of out zero-bug tolerance
+  philosophy.  
 
 
 == Version 0.19.0 was released on 31/05/2005.
@@ -30,60 +99,60 @@ fixes.
 Some notable changes:
 
 * Og polymorphic relations. A groundbreaking feature made possible
-	by Og's unique design and Ruby's power. Let's use an example 
-	to explain the concept:
-	
-	class Comment
-		...
-		belongs_to Object # polymorphic marker
-	end
-	
-	class User
-		...
-		has_many Comment
-	end
-	
-	class Article
-		...
-		has_many Comment
-	end
-	
-	u = User.new
-	u.comments << User::Comment('Hello')
-	
-	a = Article.new
-	a.comments << Article::Comment('Wow!')
-	
-	User::Comment and Article::Comment where automatically created
-	by Og and are serialized in different tables (also automatically
-	created by Og). This is the	next step in DRY!
+  by Og's unique design and Ruby's power. Let's use an example 
+  to explain the concept:
+  
+  class Comment
+    ...
+    belongs_to Object # polymorphic marker
+  end
+  
+  class User
+    ...
+    has_many Comment
+  end
+  
+  class Article
+    ...
+    has_many Comment
+  end
+  
+  u = User.new
+  u.comments << User::Comment('Hello')
+  
+  a = Article.new
+  a.comments << Article::Comment('Wow!')
+  
+  User::Comment and Article::Comment where automatically created
+  by Og and are serialized in different tables (also automatically
+  created by Og). This is the  next step in DRY!
 
 * Og now supports inheritance using the well known Single Table
-	Inheritance pattern. Thanks to Og's advanced design the pattern
-	is fully encapsulated:
-	
-	class Document
-		...
-		schema_inheritance
-	end
-	
-	class Article < Document
-		..
-	end
-	
-	class Photo < Document
-		..
-	end
-	
-	Document.all # => includes Articles and Photos
-	Article.all # => only Articles
-	
-	User.documents # => Articles and Photos
-	User.documents(:type => Photo) # => only photos.
-
-	Btw, this feature is orthogonal to the polymorphic relations
-	feature just described, giving the developer great 
-	flexibility.
+  Inheritance pattern. Thanks to Og's advanced design the pattern
+  is fully encapsulated:
+  
+  class Document
+    ...
+    schema_inheritance
+  end
+  
+  class Article < Document
+    ..
+  end
+  
+  class Photo < Document
+    ..
+  end
+  
+  Document.all # => includes Articles and Photos
+  Article.all # => only Articles
+  
+  User.documents # => Articles and Photos
+  User.documents(:type => Photo) # => only photos.
+
+  Btw, this feature is orthogonal to the polymorphic relations
+  feature just described, giving the developer great 
+  flexibility.
 
 * Integrated an SQLite3 patch by Ghislain Mary.
 
@@ -103,15 +172,15 @@ patches.
 Some notable changes:
 
 * Thread safe mode was added again in Og. This works nice with
-	the Webrick server.
-	
+  the Webrick server.
+  
 * New order macro in Og to set default ordering for each
-	entity. The has_many collections respect the order setting.
+  entity. The has_many collections respect the order setting.
 
 * Fixes in the SQLite adapter.
 
 * No warnings in the Posrgres adapter.
-	
+  
 * Cleaned up some source files.
 
 
@@ -128,139 +197,139 @@ that made this version possible.
 Most notable additions:
 
 * Extremely clean source code. Better names are used thorougout.
-	Extra care was taken to make all features more orthogonal.
-	
+  Extra care was taken to make all features more orthogonal.
+  
 * Brand new relation mechanism. The 'enchanting' of entities 
-	(managed classes) happens in multiple passes to be more
-	flexible. Totaly separated graph/metadata creation and serialization
-	code generation. The Graph metadata can be used for advanced
-	scaffolding, testing and more.
+  (managed classes) happens in multiple passes to be more
+  flexible. Totaly separated graph/metadata creation and serialization
+  code generation. The Graph metadata can be used for advanced
+  scaffolding, testing and more.
 
 * Support for fully customizable primary keys. You are no longer
-	forced to use xxx_oid primary keys. Appart from the extra 
-	flexibility this feature provides this is an essential step
-	towards the planed 'reverse engineering' mode that will allow the
-	use of existing schemas with Og.
-	
+  forced to use xxx_oid primary keys. Appart from the extra 
+  flexibility this feature provides this is an essential step
+  towards the planed 'reverse engineering' mode that will allow the
+  use of existing schemas with Og.
+  
 * More elegant inspection mechanism. Example:
 
-	Article.relation(:user) # => Og::BelongsTo(...)
-	Article.relations # => [...]
-	Article.properties # => [...]
+  Article.relation(:user) # => Og::BelongsTo(...)
+  Article.relations # => [...]
+  Article.properties # => [...]
 
 * Joins_many relation, as an alias for one way, join table relations.
 
 * Support for 'active' collections. Active collection are
-	synchronized with the backend Store and provide a more elegant
-	interface and the opportunity for 'session' caching:
-	
-	article.comments << Comment.new
-	
-	instead of 
-	
-	article.add_comment(Comment.new) # this is also allowed though.
-	
-	p article.comments
-	p article.comments.size # the results of the first query is cached
+  synchronized with the backend Store and provide a more elegant
+  interface and the opportunity for 'session' caching:
+  
+  article.comments << Comment.new
+  
+  instead of 
+  
+  article.add_comment(Comment.new) # this is also allowed though.
+  
+  p article.comments
+  p article.comments.size # the results of the first query is cached
 
 * Eager relations.
 
-	comments = Article.comments(:include => User)
+  comments = Article.comments(:include => User)
 
-	for comment in comments
-		p comment.user.name
-	end
-	
-	Elegantly solves the N+1 query problem by using one join
-	query.
+  for comment in comments
+    p comment.user.name
+  end
+  
+  Elegantly solves the N+1 query problem by using one join
+  query.
 
 * No need for forward references when defining relations. Now,
-	the following code magically works:
-	
-	class User
-	  has_many Comment # works even though Comment is not defined!
-	end
-	
-	class Comment
-		belongs_to User
-	end
-	 
+  the following code magically works:
+  
+  class User
+    has_many Comment # works even though Comment is not defined!
+  end
+  
+  class Comment
+    belongs_to User
+  end
+   
 * Use inflection where possible to infer missing configuration
-	options. For example
-	
-	class Article
-		belongs_to User # infects relation name :user
-		...
-		
+  options. For example
+  
+  class Article
+    belongs_to User # infects relation name :user
+    ...
+    
 * New, lean and mean Store interface. The code needed to teach 
-	Og how to  serialize objects to backend store is dramatically
-	reduced. The new interface is SQL agnostic, so non SQL-RDBM's 
-	stores are possible.
-	
+  Og how to  serialize objects to backend store is dramatically
+  reduced. The new interface is SQL agnostic, so non SQL-RDBM's 
+  stores are possible.
+  
 * SQL agnostic querying interface, compatible with non-sql 
-	Stores. Here is an example:
-	
-	Article.find(
-		:condition => 'hits > 2 AND rate > 3', 
-		:order => 'title',
-		:offset => 30,
-		:limit => 10
-	)
+  Stores. Here is an example:
+  
+  Article.find(
+    :condition => 'hits > 2 AND rate > 3', 
+    :order => 'title',
+    :offset => 30,
+    :limit => 10
+  )
 
 * More elegant (and non-sql store compatible) way for selective 
-	updates:
+  updates:
 
-	article.title = 'Changed'
-	article.hits += 1
-	article.update(:title, :hits)
+  article.title = 'Changed'
+  article.hits += 1
+  article.update(:title, :hits)
 
 * New, in-memory store that support all features. This is a pure
-	ruby solution useful for experimentation. It will also serve
-	as the base for the forthcoming madeleine Store implementation.
+  ruby solution useful for experimentation. It will also serve
+  as the base for the forthcoming madeleine Store implementation.
 
 * Allow for multiple stores in one application. A great example,
-	mysql_to_psql is provided. This example uses Og's powerfull
-	features to automatically convert a Mysql database to a 
-	PostgreSQL database. Database migration was never easier.
-	
+  mysql_to_psql is provided. This example uses Og's powerfull
+  features to automatically convert a Mysql database to a 
+  PostgreSQL database. Database migration was never easier.
+  
 * Uses the excellent Facets utility collection to further
-	clenup and minimize the code.
+  clenup and minimize the code.
 
 * Managed classes or Entities should include the EntityMixin
-	or extend the Entity class. Example:
-	
-	class Article < Entity
-		..
-	end
-	
-	class Article 
-		include EntityMixin
-	end
-	
-	This is done to avoid the Module module like in earlier
-	versions of Og. However, Og is can infer the need to include
-	the Managed mixin in typical cases:
-	
-	class Article
-		property :title, String 
-		# when a property is defined Og automatically converts the
-		# class to an Entity
-	end
-	
-	class Article < AnExistingManagedEntity
-		# also includes the mixin
-		...
-		
-	class Article
-		include AModuleThatDefinesProperties
-		...
+  or extend the Entity class. Example:
+  
+  class Article < Entity
+    ..
+  end
+  
+  class Article 
+    include EntityMixin
+  end
+  
+  This is done to avoid the Module module like in earlier
+  versions of Og. However, Og is can infer the need to include
+  the Managed mixin in typical cases:
+  
+  class Article
+    property :title, String 
+    # when a property is defined Og automatically converts the
+    # class to an Entity
+  end
+  
+  class Article < AnExistingManagedEntity
+    # also includes the mixin
+    ...
+    
+  class Article
+    include AModuleThatDefinesProperties
+    ...
 
 * Improved support for og_delete interception.
 
 * Support for nested transactions.
-	
+  
 * Many, many smaller features and changes.
-	
+  
 Check out the file test/og/tc_store.rb for a demonstration of
 the new features. The stores for Oracle and SqlServer are not
 converted yet.
@@ -274,28 +343,28 @@ new features and a major cleanup of the source code.
 Most notable additions:
 
 * Aspect Oriented Programming support. This new system
-	is used to reimplement features such as Controller filters,
-	Og callbacks and Og observers. By using this unified
-	system you can now add Observers to controllers and use
-	a metalanguage for wraping Og object callbacks:
-
-	class Controller
- 		pre :force_login, :where => :prepend
- 		wrap Benchmark, :on => :index
- 		post :taraa, :on => login
-	end
+  is used to reimplement features such as Controller filters,
+  Og callbacks and Og observers. By using this unified
+  system you can now add Observers to controllers and use
+  a metalanguage for wraping Og object callbacks:
+
+  class Controller
+     pre :force_login, :where => :prepend
+     wrap Benchmark, :on => :index
+     post :taraa, :on => login
+  end
  
-	module Timestamped
- 		pre :on => :og_insert { |this| this.create_time = Time.now }
-		pre :on => :og_update { |this| this.update_time = Time.now }
-		pre :on => [:og_insert, :og_update] { |this| this.create_time = Time.now }
-	end
+  module Timestamped
+     pre :on => :og_insert { |this| this.create_time = Time.now }
+    pre :on => :og_update { |this| this.update_time = Time.now }
+    pre :on => [:og_insert, :og_update] { |this| this.create_time = Time.now }
+  end
 
-	This feature will be used extensivelly  in future versions
-	to improve logging, the shaders and more.
+  This feature will be used extensivelly  in future versions
+  to improve logging, the shaders and more.
 
 * Major cleanup of the source. Converted the N namespace to
-	Nitro. 
+  Nitro. 
 
 * Add Og Timestamped mixin.
 
@@ -317,28 +386,28 @@ Most notable additions:
 * NestedSets mixin:
 
   class Comment
-		include NestedSets
-	end
+    include NestedSets
+  end
 
-	or
+  or
 
-	class Comment
-		include Hierarchical, :method => :nested_sets
-	end
+  class Comment
+    include Hierarchical, :method => :nested_sets
+  end
 
-	c.add_comment(child_comment)
-	c.full_children
-	c.direct_children
-	c.children
+  c.add_comment(child_comment)
+  c.full_children
+  c.direct_children
+  c.children
  
-	this is a reimplementation of the SqlTraversable mixin
-	available in older versions.
+  this is a reimplementation of the SqlTraversable mixin
+  available in older versions.
  
 * New implementation of Orderable mixin:
 
   class Comment
     property :body, String
-		belongs_to :article, Article
+    belongs_to :article, Article
     include Orderable, :scope => article
   end
 
@@ -389,33 +458,33 @@ fixed aswell.
 Most notable additions:
 
 * Og automatically generates finders for all properties, for
-	even easier (and portable) querying:
+  even easier (and portable) querying:
 
-	class Article
-		property :title, :body, String
-		property :hits, Fixnum
-		property :create_time, Time
-	end
+  class Article
+    property :title, :body, String
+    property :hits, Fixnum
+    property :create_time, Time
+  end
 
-	you get the finders:
+  you get the finders:
 
-	Article.find_by_title
-	Article.find_by_body
-	Article.find_by_hits
-	Article.find_by_create_time
+  Article.find_by_title
+  Article.find_by_body
+  Article.find_by_hits
+  Article.find_by_create_time
 
-	The finders take into account the unique constrain, to return
-	an array or just an object as needed.
+  The finders take into account the unique constrain, to return
+  an array or just an object as needed.
 
 * Og introduces lifecycle observers to avoid 'poluting' the model
-	objects with excess functionality. You can use every object
-	as observer (duck typing) or extend from an AR style Observer
-	class. The observer callbacks are precompiled in the lifecycle
-	methods only if defined, so the perfomance is not affected
-	in the general case.
+  objects with excess functionality. You can use every object
+  as observer (duck typing) or extend from an AR style Observer
+  class. The observer callbacks are precompiled in the lifecycle
+  methods only if defined, so the perfomance is not affected
+  in the general case.
 
 * Fixed Og bug: multiple many_to_many relations with the
-	same target class.
+  same target class.
 
 * further code cleanup, improved examples and more.
 
@@ -429,35 +498,35 @@ improvements to make programming even more enjoyable. Many
 thanks to Matt Bowen for his help with this release.
 
 Most notable additions:
-	
+  
 * Documentation (doc/og_tutorial.txt, doc/og_config.txt)
 
 * Og Oracle adapter.
 
 * Og provides advanced metadata for the managed objects
 
-	class Article
-		property :title, String
-		property :body, String
-		has_many :comments, Comment
-	end
+  class Article
+    property :title, String
+    property :body, String
+    has_many :comments, Comment
+  end
 
-	par = Article.properties_and_relations
-	=> [Property(:title), Property(:body), Og::HasMany(:comments)]
+  par = Article.properties_and_relations
+  => [Property(:title), Property(:body), Og::HasMany(:comments)]
 
-	par[2].klass
-	=> Comment
+  par[2].klass
+  => Comment
 
-	par[2].meta[:linkback]
-	=> :article_oid
+  par[2].meta[:linkback]
+  => :article_oid
 
 * Og Typemacros, here is an example:
 
-	def VarChar(size)
-		return String, :sql => "NOT NULL VARCHAR(#{size})"
-	end
+  def VarChar(size)
+    return String, :sql => "NOT NULL VARCHAR(#{size})"
+  end
 
-	property :title, VarChar(30)
+  property :title, VarChar(30)
 
 * Option for faster startup, skip schema check.
 
@@ -478,7 +547,7 @@ Most notable additions:
   adapter subsystem.
 
 * New SQLite3 Og adapter, improvements in MySQL and PostgreSQL 
-	adapters (needs version 1.1.0 of Sqlite3-Ruby).
+  adapters (needs version 1.1.0 of Sqlite3-Ruby).
 
 * Better GemSpec for easier installation by RubyGems.
 
@@ -498,7 +567,7 @@ A maintenance release.
 Most notable additions:
 
 * Og metalanguage relations insert metadata into 
-	the target class, useful for advanced scaffolders.
+  the target class, useful for advanced scaffolders.
 
 * Og refer_to meta-language command. 
 
@@ -520,29 +589,29 @@ Most notable additions:
 
 * New automatic validation system:
 
-	class User
-		prop_accessor :name, :password, String
-		validate_confirmation :password
-		validate_length :name, :range => 2..12
-	end
+  class User
+    prop_accessor :name, :password, String
+    validate_confirmation :password
+    validate_length :name, :range => 2..12
+  end
 
-	u = User.new(...)
-	unless u.valid?
-		p u.errors.on(:name)
-		p u.errors[:password]
-	end
+  u = User.new(...)
+  unless u.valid?
+    p u.errors.on(:name)
+    p u.errors[:password]
+  end
 
 * No global variables in Og. 
 
 * Recoded Og to allow for future support of multiple databases 
-	(even on different RDBMS systems) on a single application.
+  (even on different RDBMS systems) on a single application.
 
 * cleaned up backend code.
 
 * More unit tests.
 
 * Supports Ruby 1.8.2
-	
+  
 
 == Version 0.7 was released on 27/12/2004.
 
@@ -555,7 +624,7 @@ 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.
+  from Mixins.
 * new automatically generated methods in Og.
 * MockDatabase leverages the FlexMock object for easier unit testing.
 
@@ -593,4 +662,3 @@ 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.
 
-