og 0.31.0 → 0.40.0

data/doc/{AUTHORS → CONTRIBUTORS}

@@ -1,46 +1,62 @@
 MAIN DEVELOPER:
 
-* George Moschovitis <gm@navel.gr>
+* George Moschovitis <george.moschovitis@gmail.com>
   Project leader, architecture and design, main coder, 
   documentation, maintainer.
   
 IDEAS, ADDITIONAL CODING, SUPPORT:
 
-* Michael Neumann <mneumann@ntecs.de>
-  Design, additional coding and bug reports.
+* Jonathan Buch <jonathan.buch@gmail.com>
+  Patches.
+  
+* Fabian Buch <fabian@fabian-buch.de>
+  Patches.
 
+* Michael Fellinger <m.fellinger@gmail.com>
+  Patches, bug fixes.
+  
+* Rob Pitt <rob@motionpath.co.uk>
+  Patches, Bug fixes.
+      
 * Ysabel <deb@ysabel.org>
   Refactoring, patches.
 
 * Thomas Sawyer <transfire@gmail.com>
-  Refactoring, code cleanup.
+  Refactoring, patches, code cleanup.
 
 * Guillaume Pierronnet <guillaume.pierronnet@laposte.net>
   Tons of patches.
 
+* Michael Neumann <mneumann@ntecs.de>
+  Design, additional coding and bug reports.
+
 * Aleksi Niemela <Aleksi.Niemela@cs.helsinki.fi>
   Bug reports and patches.
   
-* Anastasios Koutoumanos <ak@navel.gr>
-  Design, additional coding.
-
 * Julien Perrot <jperrot@exosec.fr>
   Bug reports and patches.
 
 * Ghislain Mary <gmary@lunacymaze.org>
   Bug reports and patches (sqlite3 driver).
 
-* Kashia Buch <kashia@vfemail.net>
-  Patches.
+* Dirk Barnikel <dirk.barnikel@gmx.de>
+  Initial Revisable code.
   
 * Dylan Bruzenak <dylanb@digitalvalence.com>
   Patches (kirby).
 
 * Matt Bowen <matt.bowen@farweststeel.com>
-  Oracle driver, documentation.
+  Old Oracle driver, documentation.
 
 * Aidan Rogers <aidan@infurious.com>
   Bug reports, patches.
+
+* Darrick W <darrick@innatesoftware.com>
+  Patches.
+  
+* Anastasios Koutoumanos <ak@navel.gr>
+  Design, additional coding.
     
 * Thomas Quas <tquas@yahoo.com>
   Ideas, bug reports, unit tests.
+

data/doc/LICENSE

@@ -1,7 +1,6 @@
 The BSD License
 
-Copyright (c) 2004-2005, George 'gmosx' Moschovitis. (http://www.gmosx.com)
-Copyright (c) 2004-2005, Navel Ltd. (http://www.navel.gr)
+Copyright (c) 2004-2006, George K. Moschovitis. (http://www.gmosx.com)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without 
@@ -15,7 +14,7 @@ notice, this list of conditions and the following disclaimer.
 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 
+* Neither the name of Og nor the names of its contributors may be 
 used to endorse or promote products derived from this software 
 without specific prior written permission.
 

data/doc/RELEASES

@@ -1,12 +1,61 @@
-== Version 0.31.0
+== Version 0.40.0
 
-* Increased size of ogtype field in STI tables to 50 from 30.
+This is the biggest release yet! Tons of new wonderful features,
+code refactoring, bug fixes, documentation improvements and so
+much more.
 
-* Made Og (Mysql) respect the port option when creating and dropping databases.
+Special thanks for this release fly to Jonas Pfeniger, 
+Jonathan/Fabian Buch and Michael Fellinger.
 
-* Added thread_safe to Og.setup options.
+Most notable changes:
+
+* Fully transparent Og managed objects. No need to use the 
+  special property notation. Just use the standard attr_accessor
+  macro:
+  
+  class User
+    attr_accessor :name, String, :sql => 'VARCHAR(32)
+    attr_accessor :password, String
+    attr_accessor :age, :login_count, Fixnum
+  
+    belongs_to :group
+    has_many :comments
+    joins_many :categories
+  end
+  
+  Og automatically detects and manages this class!
+  
+* The Og adapter model was re-engineered from scratch. The new
+  adapter code is better refactored. It is now extremely easy to
+  write new adapters for various RDBMS systems.
+  
+* Og build mode. This avoids multiple sql queries when you are
+  'building' (ie attaching related objects) a new object.
+
+* You can now easily lookup Og entities by name:
+
+  u = User[1] # classic
+  
+  or
+  
+  u = User['gmosx'] # this works as well!
+  
+  for the new method to work you need to annotate the attribute
+  to use for named lookups:
+  
+  class User
+    attr_accessor :name, String, :key => true
+    ..
+  end  
+
+* Og set attribute, a nice helper to set only some attributes.
+
+  b = Book[1]
+  b.set_attribute :title => 'Hello' # updates only title in the DB
+  b.instance_attribute_set '@title', 'Hello' # Ruby style
+  b.set_attributes :title => '1', :hits => 3
 
-* Added #to_xml method to Og managed objects.
+* Many more bug fixes and smaller improvements.
 
 == Version 0.30.0
 
@@ -490,10 +539,10 @@ tagging to your appplication.
     ..
   end
 
-  article.tag('navel', 'gmosx', 'nitro')
+  article.tag('great', 'gmosx', 'nitro')
   article.tags
   article.tag_names
-  Article.find_with_tags('navel', 'gmosx')
+  Article.find_with_tags('great', 'gmosx')
   Article.find_with_any_tag('name', 'gmosx')
 
   t = Article::Tag.find_by_name('ruby')

data/doc/tutorial.txt

@@ -91,7 +91,7 @@ attribute that contains metadata is called a property. For
 each attr* method, there is a corresponding prop* method. That is,
 
     attr          => prop
-    attr_accessor => prop_accessor
+    attr_accessor => attr_accessor
     attr_reader   => prop_reader
     attr_writer   => prop_writer
 
@@ -100,25 +100,25 @@ Here are the class definitions using the property mechanism:
 require 'og'
 
 class Category
-    prop_accessor :name, String
+    attr_accessor :name, String
 end
 
 class Post
-    prop_accessor :title, String
-    prop_accessor :body, String
-    prop_accessor :author, String
-    prop_accessor :create_time, Time
-    prop_accessor :hits, Fixnum
+    attr_accessor :title, String
+    attr_accessor :body, String
+    attr_accessor :author, String
+    attr_accessor :create_time, Time
+    attr_accessor :hits, Fixnum
 end
 
 class Comment
-    prop_accessor :title, String
-    prop_accessor :body, String
-    prop_accessor :author, String
-    prop_accessor :create_time, Time
+    attr_accessor :title, String
+    attr_accessor :body, String
+    attr_accessor :author, String
+    attr_accessor :create_time, Time
 end
 
-Notice that the prop_accessor works similar to Ruby's attr_accessor. 
+Notice that the attr_accessor works similar to Ruby's attr_accessor. 
 Here are some examples:
 
 prop :title, true, String
@@ -154,7 +154,7 @@ db = Og::Database.new(
     :database => 'test',
     :adapter  => 'psql',
     :user     => 'postgres',
-    :password => 'navelrulez'
+    :password => 'gmrulez'
 )
 
 Now you are ready to save your first object into Postgres. Add the following code:
@@ -574,7 +574,7 @@ db = Og::Database.new(
     :database => 'test',
     :adapter  => 'mysql',
     :user     => 'postgres',
-    :password => 'navelrulez'
+    :password => 'gmrulez'
 )
 
 A new MySQL database is automatically created along with all tables, indices, etc. You get all 
@@ -587,7 +587,7 @@ You betcha! You can to find more about Og by reading the available RDoc document
 
 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.
+mailto:george.moschovitis@gmail.com.
 
 A Nitro specific mailing list is also available. You can post questions about
 Og to this list. Please subscribe to nitro-general@rubyforge.com. The homepage 

data/lib/glue/cacheable.rb

@@ -1,4 +1,4 @@
-require 'facets/core/module/class_extension'
+require 'facet/classmethods'
 
 module Glue
 
@@ -7,7 +7,6 @@ module Glue
 #
 # If you use a distributed cache (drb, memcache, etc) , you may 
 # have to start a separate server.
-#
 #--
 # gmosx, WARNING: If the file lib/og/entity.rb is changed
 # this file should be updated to reflect the changes!
@@ -15,7 +14,7 @@ module Glue
 
 module Cacheable
 
-  class_extension do
+  class_methods do
   
     def after_enchant(base)
       base.module_eval do
@@ -150,5 +149,3 @@ module Cacheable
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/hierarchical.rb

@@ -11,7 +11,7 @@ module Glue
 
 module NestedSets
 
-  def self.included_with_parameters(base, options)
+  def self.included_with_parameters base, options
     c = {
       :left => 'lft',
       :right => 'rgt',
@@ -140,6 +140,3 @@ module Hierarchical
 end
 
 end 
-
-# * George Moschovitis <gm@navel.gr>
-# * Aleksi Niemela <Aleksi.Niemela@cs.helsinki.fi>

data/lib/glue/optimistic_locking.rb

@@ -51,5 +51,3 @@ module Locking
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/orderable.rb

@@ -4,72 +4,79 @@ require 'facets/more/aspects'
 module Glue
 
 # Attach list/ordering methods to the enchanted class.
+#
+# === Comments
+#
+# If you use the scope option, you have to set he parent (scope)
+# of the object before inserting to have correct ordering.
 
 module Orderable
-  include ::Aspects
+  include Aspects
 
   def self.included_with_parameters(base, opt)
-    base.module_eval do
 
-      opt_position = opt[:position] || 'position'
+    # The attribute to use to keep the position.
+    
+    opt_position = opt.fetch(:position, 'position')
 
-      opt_type = opt[:type] || Fixnum
+    # The type of the position attribute.
+    
+    opt_type = opt.fetch(:type, Fixnum)
 
-      # provide a user defined condition.
-      
-      opt_condition = opt[:condition]
+    # A user defined condition.
+    
+    opt_condition = opt[:condition]
 
-      # provide a condition based on a key field (?)
-      
-      opt_scope = opt[:scope]
+    # A condition based on a key field (?)
+    
+    opt_scope = opt[:scope]
 
-      # clean scope field.
-      
-      if opt_scope
-        if opt_scope.to_s !~ /_oid$/
-          opt_scope = "#{opt_scope}_oid".to_sym
-        else
-          opt_scope = opt_scope.to_sym
-        end
+    # clean scope field.
+    
+    if opt_scope
+      if opt_scope.to_s !~ /_oid$/
+        opt_scope = "#{opt_scope}_oid".to_sym
+      else
+        opt_scope = opt_scope.to_sym
       end
+    end
+
+    base.module_eval %{
+      attr_accessor :#{opt_position}, #{opt_type}
 
-      define_method :orderable_position do
-        opt_position
+      def orderable_attribute
+        #{opt_position.inspect}
+      end
+          
+      def orderable_position
+        @#{opt_position}
       end
 
-      define_method :orderable_type do
-        opt_type
+      def orderable_position= (pos)
+        @#{opt_position} = pos
       end
 
-      define_method :orderable_scope do
-        opt_scope
+      def orderable_type
+        #{opt_type}
+      end
+   
+      def orderable_scope
+        #{opt_scope.inspect}
       end
 
-      define_method :orderable_condition do
+      def orderable_condition
         scope = orderable_scope
         if scope
           scope_value = send(scope)
-          scope = scope_value ? "#{scope} = #{scope_value}" : "#{scope} IS NULL"
+          scope = scope_value ? "\#{scope} = \#{scope_value}" : "\#{scope} IS NULL"
         end
-        return [ opt_condition, scope ].compact
+        return [ #{opt_condition.inspect}, scope ].compact
       end
+    }
 
-      # How to check if property is already defined?
-      
-      unless method_defined?( opt_position )
-        define_method( opt_position ) do @position ; end
-        define_method( "#{opt_position}=" ) do |x| @position = x ; end
-        property opt_position, opt_type
-      end
+  end 
 
-      # Use position for general reference.
-      
-      attr_accessor :position
-
-    end
-  end #dynamic_feature
-
-  before "add_to_bottom", :on => [:og_insert, :og_update]
+  before "add_to_bottom", :on => :og_insert
   before "decrement_position_of_lower_items", :on => :og_delete
 
   # Move higher.
@@ -82,7 +89,7 @@ module Orderable
       end
     end
   end
-
+  
   # Move lower.
   
   def move_lower
@@ -115,22 +122,22 @@ module Orderable
   # Move to a specific position.
   
   def move_to(dest_position)
-    return if @position == dest_position
+    return if self.orderable_position == dest_position
 
-    pos = orderable_position
+    pos = orderable_attribute
     con = orderable_condition
 
     self.class.transaction do
-      if @position < dest_position
+      if orderable_position < dest_position
         adj = "#{pos} = #{pos} - 1"
-        con = con + [ "#{pos} > #{@position}", "#{pos} <= #{dest_position}" ]
+        con = con + [ "#{pos} > #{orderable_position}", "#{pos} <= #{dest_position}" ]
       else
         adj = "#{pos} = #{pos} + 1"
-        con = con + [ "#{pos} < #{@position}", "#{pos} >= #{dest_position}" ]
+        con = con + [ "#{pos} < #{orderable_position}", "#{pos} >= #{dest_position}" ]
       end
       self.class.update( adj, :condition => con.join(' AND ') )
-      @position = dest_position
-      update_property(pos.to_sym)
+      self.orderable_position = dest_position
+      update_attribute(orderable_attribute)
     end
 
     self
@@ -141,7 +148,7 @@ module Orderable
   end
 
   def add_to_bottom
-    @position = bottom_position + 1
+    self.orderable_position = bottom_position + 1
   end
 
   def add_to
@@ -149,15 +156,15 @@ module Orderable
   end
 
   def higher_item
-    pos = orderable_position
-    con = orderable_condition + [ "#{pos} = #{@position - 1}" ]
+    pos = orderable_attribute
+    con = orderable_condition + [ "#{pos} = #{orderable_position - 1}" ]
     self.class.one( :condition => con.join(' AND ') )
   end
   alias_method :previous_item, :higher_item
 
   def lower_item
-    pos = orderable_position
-    con = orderable_condition + [ "#{pos} = #{@position + 1}" ]
+    pos = orderable_attribute
+    con = orderable_condition + [ "#{pos} = #{orderable_position + 1}" ]
     self.class.one( :condition => con.join(' AND ') )
   end
   alias_method :next_item, :lower_item
@@ -168,7 +175,7 @@ module Orderable
   alias_method :first_item, :top_item
 
   def bottom_item
-    pos = orderable_position
+    pos = orderable_attribute
     con = orderable_condition
     con = con.empty? ? nil : con.join(' AND ')
     self.class.one(:condition => con, :order => "#{pos} DESC", :limit => 1)
@@ -176,62 +183,59 @@ module Orderable
   alias_method :last_item, :last_item
 
   def top?
-    @position == 1
+    self.orderable_position == 1
   end
   alias_method :first?, :top?
 
   def bottom?
-    @position == bottom_position
+    self.orderable_position == bottom_position
   end
   alias_method :last?, :bottom?
 
   def increment_position
-    @position += 1
-    update_property(orderable_position.to_sym)
+    self.orderable_position += 1
+    update_attribute(self.orderable_attribute)
   end
 
   def decrement_position
-    @position -= 1
-    update_property(orderable_position.to_sym)
+    self.orderable_position -= 1
+    update_attribute(self.orderable_attribute)
   end
 
   def bottom_position
     item = bottom_item
-    item ? item.send(orderable_position) : 0
+    item ? (item.orderable_position || 0) : 0
   end
 
   def set_top_position
-    @position = 1
-    update_property(orderable_position.to_sym)
+    self.orderable_position = 1
+    update_attribute(orderable_attribute)
   end
 
   def set_bottom_position
-    @position = bottom_position + 1
-    update_property(orderable_position.to_sym)
+    self.orderable_position = bottom_position + 1
+    update_attribute(orderable_attribute)
   end
 
   def increment_position_of_higher_items
-    pos = orderable_position
-    con = orderable_condition + [ "#{pos} < #{@position}" ]
+    pos = orderable_attribute
+    con = orderable_condition + [ "#{pos} < #{orderable_position}" ]
     self.class.update "#{pos}=(#{pos} + 1)",  :condition => con.join(' AND ')
   end
 
   def increment_position_of_all_items
-    pos = orderable_position
+    pos = orderable_attribute
     con = orderable_condition
     con = con.empty? ? nil : con.join(' AND ')
     self.class.update "#{pos}=(#{pos} + 1)", :condition => con 
   end
 
   def decrement_position_of_lower_items
-    pos = orderable_position
-    con = orderable_condition + [ "#{pos} > #{@position}" ]
+    pos = orderable_attribute
+    con = orderable_condition + [ "#{pos} > #{orderable_position}" ]
     self.class.update "#{pos}=(#{pos} - 1)",  :condition => con.join(' AND ')
   end
 
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Thomas Sawyer <transfire@gmail.com>