og 0.23.0 → 0.24.0

data/ProjectInfo

@@ -0,0 +1,58 @@
+--- %YAML:1.0
+
+TITLE    : &title Og
+NAME     : &pkg og
+VERSION  : '0.24.0'
+STATUS   : beta
+
+AUTHOR   : George Moschovitis
+EMAIL    : &email gm@navel.gr
+HOMEPAGE : "http://www.nitrohq.com"
+
+SUMMARY: State of the art object-relational mapping system.
+
+DESCRIPTION: >
+  Object Graph (Og) is a state of the art ORM system.
+  Og serializes standard Ruby objects to Mysql, Postgres, Sqlite,
+  KirbyBase, Filesystem and more.
+
+DEPENDENCIES:
+ - [ glue, '= 0.24.0' ]
+
+DISTRIBUTE: [ gem, tgz, zip ]
+
+RUBYFORGE:
+  PROJECT: 'nitro'
+  USERNAME: 'gmosx'
+
+# Anything to require upfront?
+#TEST:
+#  fixture: ''
+
+ANNOUNCE:
+  to: george.moschovitis@gmail.com
+  from: gm@navel.gr
+  domain: navel.gr
+  server: mail
+  port: 25 #587
+  account: gm@navel.gr
+  authtype: login  #cram_md5 #plain
+  sectype: tls # ~, tls, ssl (tls is broke)
+  file: ANN
+  slogan: Og (ObjectGraph)
+  
+  
+  
+  links:
+    - http://www.nitrohq.com
+
+
+
+
+
+
+
+
+
+
+

data/README

@@ -1,4 +1,4 @@
-= Og 0.23.0 README
+= Og 0.24.0 README
 
 Og (ObjectGraph) is a powerful and elegant object-relational mapping 
 library. Og manages the lifecycle of Ruby objects and  provides 
@@ -16,7 +16,7 @@ automatically generates join tables for many_to_many relations
 and provides a collection of usefull Mixins to synthesize 
 common Entities.
 
-Adapters for PostgreSQL, MySQL, SQLite3, Memory, Filesystem,
+Adapters for PostgreSQL, MySQL, SQLite3, KirbyBase, Memory, Filesystem,
 Oracle and SQL Server are included.
 
 Og is part of the Nitro project, released as a stand-alone library
@@ -29,10 +29,10 @@ distribution (http://www.nitrohq.com).
 The library provides the following features:
 
 * Object-Relational mapping, automatically maps standard 
-  Ruby objects to sql schemas
+  Ruby objects to sql schemas.
 * Absolutely no configuration files.
 * Multiple stores (PostgreSQL, MySQL, SQLite, Oraclei, SqlServer, ..).
-* Supports non SQL stores (in-memory, filesystem, ..).
+* Supports non SQL stores (KirbyBase, Memory, filesystem, ..).
 * Can 'reverse engineer' legacy database schemase.
 * Fine-grained or High-level customization of the generated
   schema.
@@ -50,6 +50,7 @@ The library provides the following features:
 * SQL transactions.
 * Aspect oriented constructs allow interception of lifecycle callbacks.
 * Transparent support for cascading deletes for all backends.
+* Can annotate and manage existing Ruby classes.
 * Hierarchical structures (nested sets)
 * Works safely as part of distributed application.
 * Optimistic locking.

data/Rakefile

@@ -10,7 +10,7 @@ Name = Release[/\D+/].sub(/\-+$/, '') || 'unknown'
 Version = Release[/[\d.]+/] || 'unknown'
 
 AuthorName, AuthorMail = 'George Moschovitis', 'gm@navel.gr'
-RubyVersion = '1.8.2' 
+RubyVersion = '1.8.3' 
 
 # Description = (readme[/README\s+(.+?)\n\n/m, 1] || "unknown").gsub(/\s+/, " ")
 # Summary = Description[/^.+?>/] || "unknown"
@@ -62,7 +62,7 @@ spec = Gem::Specification.new do |s|
   #s.add_dependency 'sqlite3-ruby', '>= 1.0.0'
   #s.add_dependency 'mysql', '>= 2.5.1'
 
-  s.required_ruby_version = '>= 1.8.2'
+  s.required_ruby_version = '= 1.8.3'
 
   s.files = FileList[
     '[A-Z]*', 'install.rb', '{bin,benchmark,examples,doc,lib,test,vendor}/**/*' 

data/doc/AUTHORS

@@ -9,23 +9,26 @@ IDEAS, ADDITIONAL CODING, SUPPORT:
 * Michael Neumann <mneumann@ntecs.de>
   Design, additional coding and bug reports.
 
-* Anastasios Koutoumanos <ak@navel.gr>
-  Design, additional coding.
-
-*  Matt Bowen <matt.bowen@farweststeel.com>
-  Oracle driver, documentation.
-
 * Ysabel <deb@ysabel.org>
   Refactoring, patches.
   
+* Guillaume Pierronnet <guillaume.pierronnet@laposte.net>
+  Tons of patches.
+
 * Aleksi Niemela <Aleksi.Niemela@cs.helsinki.fi>
   Bug reports and patches.
+  
+* Anastasios Koutoumanos <ak@navel.gr>
+  Design, additional coding.
 
-*  Julien Perrot <jperrot@exosec.fr>
+* Julien Perrot <jperrot@exosec.fr>
   Bug reports and patches.
 
 * Ghislain Mary <gmary@lunacymaze.org>
   Bug reports and patches (sqlite3 driver).
 
+* Matt Bowen <matt.bowen@farweststeel.com>
+  Oracle driver, documentation.
+
 * Thomas Quas <tquas@yahoo.com>
   Ideas, bug reports, unit tests.

data/doc/RELEASES

@@ -1,3 +1,111 @@
+== Version 0.24.0
+
+A snapshot of the latest developments. This version features
+many requested features and many many smaller features and
+bug fixes.
+
+Most notable additions:
+
+* Totaly recoded annotation / property system. The property
+  system is now based on Facet annotations and inheritors.
+  You can now annotate every object, attribute or method
+  in Nitro. For example you can annotate your actions with
+  routing rules or sitemap strings etc, etc. One unified
+  system for annotations and metadata is used throughout
+  the whole Framework.
+
+* Implemented one of the most requested features. An Og
+  frontend for KirbyBase. The KirbyBase store does not yet
+  support all features, but is really useful. For example
+  it can power the Spark wiki example. Switching between
+  KirbyBase, Mysql, Postgres, Sqlite, etc by changing
+  one line of code is really cool ;-)
+  
+* Better Seperation of Concerns for Og managed classes. Og
+  can now annotate and handle classes from other libraries.
+  Lets say you have the following class:
+  
+  class User
+    attr_accessor :name
+    attr_accessor :body
+  end
+  
+  Using Ruby's open classes and Nitro's advanced annotation
+  system you can easily prepare this class for Og management
+  
+  class User
+    ann :user, :klass => String
+    ann :body, :klass => String
+  end
+  
+  or even better:
+  
+  class User
+    property :user, String
+    property :body, String
+  end
+  
+  This style promotes SOC: You define your classes in one
+  place and annotate them for Og in another place.
+  
+* Simple Og automatic evolution system. Lets say you have a class Article
+
+  class Article
+    property :title, String
+    property :nbody, String
+    property :dumy, Fixnum
+  end
+  
+  lets you want to change your 
+  class to this one:
+
+  class NewArticle
+    property :ntitle, String
+    property :nbody, String
+    property :new, Float
+  end
+
+  First you export the database:
+  
+  og.export
+
+  Then you import the database. Some rules
+  are needed when renaming classes or properties. 
+  New properties or deleted properties are handled
+  automatically.
+
+  rules = {
+    :Article => {
+      :self => :NewArticle, # rename the class
+      :title => :ntitle,
+      :body => :nbody
+    }
+  }
+  og.import :evolution => rules
+
+  Thats all. In a future version this will be integrated into
+  the default runner scripts.
+
+* Og helpers to create simple rdbms management scripts. Here 
+  is an example:
+
+  mysql "-u root -p", <<-END
+    drop database if exists weblog_development;
+    create database weblog_development;
+    grant all on weblog_development.* to #{`id -un`.strip}@localhost;
+  END
+  
+  At the moment this is only available for Mysql.
+
+* Cleaned up Og implementation.
+
+* Fixed minor Ruby 1.8.3 compatibility issues.
+
+* Even better integration with Ruby Facets.
+
+* Tons of bug fixes and small but useful features.
+
+
 == Version 0.23.0
 
 The summer vacations are over and there is a brand new Nitro 

data/lib/og.rb

@@ -13,8 +13,6 @@ require 'mega/syncarray'
 
 require 'glue'
 require 'glue/logger'
-require 'glue/attribute'
-require 'glue/property'
 require 'glue/validation'
 require 'glue/aspects'
 require 'glue/configuration'
@@ -45,7 +43,7 @@ module Og
 
   # The version.
 
-  Version = '0.23.0'
+  Version = '0.24.0'
 
   # Library path.
 

data/lib/og/collection.rb

@@ -64,7 +64,7 @@ class Collection
   # Load the members of the collection.  
 
   def load_members
-    unless @loaded
+    unless @loaded or @owner.unsaved?
       @members = @owner.send(@find_proc, @find_options)
       @loaded = true
     end
@@ -73,7 +73,7 @@ class Collection
   
   # Reload the collection.
   
-  def reload(options)
+  def reload(options = {})
     # gmosx, NOOO: this was a bug! it corrupts the default options.
     #  @find_options = options
     @members = @owner.send(@find_proc, options)
@@ -172,7 +172,7 @@ class Collection
   
   def remove_all
     @owner.transaction do
-      @members.each { |obj| @owner.send(@remove_proc, obj) }
+      self.each { |obj| @owner.send(@remove_proc, obj) }
     end
     @members.clear
   end
@@ -183,7 +183,7 @@ class Collection
   
   def delete_all
     @owner.transaction do
-      @members.each { |obj| obj.delete }
+      self.each { |obj| obj.delete }
     end
     @members.clear
   end

data/lib/og/entity.rb

@@ -1,4 +1,5 @@
 require 'og/relation'
+require 'og/mixin/schema_inheritance_base'
 
 module Og
 
@@ -48,8 +49,8 @@ module EntityMixin
 
       # Delete this entity instance from the store.
       
-      def delete
-        self.class.ogmanager.store.delete(self)
+      def delete(cascade = true)
+        self.class.ogmanager.store.delete(self, self.class, cascade)
       end
       alias_method :delete!, :delete
 
@@ -65,9 +66,27 @@ module EntityMixin
       def og_quote(obj)
         self.class.ogmanager.store.quote(obj)
       end      
+      
+      def assign_properties(values, options = {})
+        Property.populate_object(self, values, options)
+        return self
+      end
+      alias_method :assign, :assign_properties
     end_eval
 
-    base.send(:include, RelationMacros)
+    base.send :include, RelationDSL
+
+    # If base is a Module setup a propageting
+    # append_features method.
+    
+    unless base.is_a? Class
+      base.module_eval do
+        def self.append_features(cbase)
+          super
+          cbase.send :include, EntityMixin
+        end
+      end
+    end
   end
 
   module ClassMethods
@@ -78,6 +97,11 @@ module EntityMixin
       return obj
     end
 
+    def assign_properties(values, options)
+      Property.fill(self.new, values, options)
+    end
+    alias_method :assign, :assign_properties
+
     # Load an instance of this Entity class using the primary
     # key.
             
@@ -92,16 +116,13 @@ module EntityMixin
     end
     
     def find(options = {})
-      # gmosx, FIXME: this code seems too complex, 
-      # improve this!
-      
-      if find_options = self.__meta[:find_options]
+      if find_options = self.ann.this[:find_options]
         options = find_options.first.dup.update(options)
       end
+
       options[:class] = self
-      if self.metadata.superclass
-        options[:type] = self
-      end
+      options[:type] = self if self.schema_inheritance_child?
+      
       ogmanager.store.find(options)
     end
     alias_method :all, :find
@@ -129,11 +150,24 @@ module EntityMixin
     # Delete an instance of this Entity class using the actual
     # instance or the primary key.
     
-    def delete(obj_or_pk)
-      ogmanager.store.delete(obj_or_pk, self)
+    def delete(obj_or_pk, cascade = true)
+      ogmanager.store.delete(obj_or_pk, self, cascade)
     end
     alias_method :delete!, :delete
 
+    # Delete all objects of this Entity class.
+    #--
+    # TODO: add cascade option.
+    #++
+    
+    def delete_all
+      ogmanager.store.delete_all(self)
+    end
+
+    def destroy
+      ogmanager.store.send :destroy, self
+    end
+    
     def escape(str)
       ogmanager.store.escape(str)
     end
@@ -149,16 +183,16 @@ module EntityMixin
     end
         
     def primary_key
-      unless @__meta and @__meta[:primary_key]
-        self.meta :primary_key, Entity.resolve_primary_key(self)
+      if ann.this.primary_key.nil?
+        ann :this, :primary_key => Entity.resolve_primary_key(self)
       end
-      @__meta[:primary_key].flatten
+      return ann.this.primary_key
     end
     
     # Set the default find options for this entity.
     
     def set_find_options(options)
-      meta :find_options, options
+      ann :this, :find_options => options
     end
     alias_method :find_options, :set_find_options
 
@@ -166,34 +200,59 @@ module EntityMixin
     # The Single Table Inheritance pattern is used.
         
     def set_schema_inheritance
-      meta :schema_inheritance
+      include Og::SchemaInheritanceBase
     end
     alias_method :schema_inheritance, :set_schema_inheritance
+
+    def schema_inheritance?
+      ancestors.include? Og::SchemaInheritanceBase
+    end
+
+    def schema_inheritance_child?
+      schema_inheritance? and superclass.respond_to?(:schema_inheritance?)
+    end
+
+    def schema_inheritance_root?
+      schema_inheritance? and (!superclass.respond_to?(:schema_inheritance?))
+    end
+
+    #--
+    # farms/rp: is there not another way to access the root class?
+    #++
     
+    def schema_inheritance_root_class
+      klass = self
+      until !Og.manager.manageable?(klass) or klass.schema_inheritance_root?
+        klass = klass.superclass
+      end
+      return klass
+    end
+
     # Set the default order option for this entity.
     
     def set_order(order_str)
-      meta :find_options, :order => order_str
+      # FIXME
+      # self.ann :this, :find_options, :order => order_str
     end
     alias_method :order, :set_order 
 
     # Set a custom table name.
     
     def set_sql_table(table)
-      meta :sql_table, table.to_s
+      ann :this, :sql_table => table.to_s
     end
     alias_method :set_table, :set_sql_table
 
     # Set the primary key.
     
     def set_primary_key(pk, pkclass = Fixnum)
-      meta :primary_key, pk, pkclass
+      ann :this, :primary_key => Property.new(:symbol => pk, :klass => pkclass)
     end
 
     # Is this entity a polymorphic parent?
         
     def polymorphic_parent?
-      self.to_s == self.metadata.polymorphic.to_s
+      self.to_s == self.ann.this.polymorphic.to_s
     end
 
     # Used internally to fix the forward reference problem.
@@ -204,24 +263,34 @@ module EntityMixin
   end
 end
 
-# A helper class.
+# An Og Managed class. Also contains helper
+# methods.
 
 class Entity 
   class << self
     def resolve_primary_key(klass)
-      if pk = klass.__meta[:primary_key]
+      # Is the class annotated with a primary key?
+      
+      if pk = klass.ann.this[:primary_key]
         return pk
       end
-      for p in klass.properties
-        if p.meta[:primary_key]
-          return p.symbol, p.klass
+      
+      # Search the properties, try to find one annotated as primary_key.
+      
+      for p in klass.properties.values
+        if p.primary_key
+          return Property.new(:symbol => p.symbol, :klass => p.klass)
         end
       end
-      return :oid, Fixnum
+      
+      # The default primary key is oid.
+      
+      return Property.new(:symbol => :oid, :klass => Fixnum)
     end
   end
   
   include EntityMixin
 end
 
+
 end