og 0.21.0 → 0.21.2

data/CHANGELOG

@@ -1,5 +1,49 @@
+28-07-2005  George Moschovitis <gm@navel.gr>
+
+  * lib/og/store/psql.rb: custom eval_og_allocate,
+  fixed inheritance porblem.
+
+  * lib/og/store/sql.rb: factored out eval_og_allocate.
+    
+  * lib/og/store/*: fixed inheritance problem.
+  
+  * lib/og/relation.rb (#enchant): fixed for polymorphic.
+
+27-07-2005  George Moschovitis <gm@navel.gr>
+
+  * lib/og.rb: moved setup from manager.rb here,
+  (#escape): added helper.
+  
+  * lib/og/relation.rb (#setup): refactored,
+  (#enchant): manually update the owner class to handle inherited
+  relations.
+  
+  * slightly modified deborah's patch.
+  
+  * test/og/tc_store.rb: updated,
+  added test for inhertiance/relarion problem.
+  
+  * lib/og/mixin/orderable.rb: updated to latest, passes test.
+  
+  * lib/og/store/sql.rb (#update_by_sql): implemented.
+  
+  * lib/og/entity.rb (#update_by_sql): added.
+  (#update_properties): reimplemented [aleksi],
+  added some nice aliases,
+  (##update): use update_by_sql,
+  (##escape): implemented.
+  
+27-07-2005  Deborah Hooker <deb@ysabel.org>
+
+  * lib/og/store/sql.rb (#ordered_join_table_keys): implemented,
+  (#join): fix,
+  (#unjoin): fix,
+  (#eval_og_create_schema): fix.
+
 24-07-2005  George Moschovitis <gm@navel.gr>
 
+  * --- VERSION 0.21.0 ---
+
   * lib/og/relation/joins_many.rb: fixed the same bugs.
   
   * lib/og/relation/has_many.rb: fixed find_options override

data/README

@@ -1,4 +1,4 @@
-= Og 0.21.0 README
+= Og 0.21.2 README
 
 Og (ObjectGraph) is a powerful and elegant object-relational mapping 
 library. Og manages the lifecycle of Ruby objects and  provides 

data/doc/RELEASES

@@ -1,4 +1,9 @@
-== Version 0.21.0
+== Version 0.21.2
+
+This is a bug fix release. 
+
+
+== Version 0.21.0 was released on 25-07-2005
 
 Some great new features and a lot of fixes. Many patches were 
 contributed by the community to make this is a release you 

data/lib/og.rb

@@ -68,19 +68,19 @@ require 'glue/configuration'
 #
 # * og_read
 # * og_insert
-#  * og_update
-#  * og_delete
+# * og_update
+# * og_delete
 
 module Og
 
   # The version.
 
-  Version = '0.21.0'
+  Version = '0.21.2'
 
   # 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.
@@ -139,6 +139,26 @@ module Og
   # Pseudo type for binary data
   
   class Blob; end
+
+  class << self
+    
+    # Helper method, useful to initialize Og.
+
+    def setup(options = {})
+      m = @@manager = Manager.new(options)
+      m.manage_classes
+      return m
+    end
+    alias_method :connect, :setup
+    alias_method :options=, :setup
+
+    # Helper method.
+    
+    def escape(str)
+      @@manager.store.escape(str)
+    end
+
+  end
    
 end
 

data/lib/og/entity.rb

@@ -27,9 +27,17 @@ module EntityMixin
         self.class.ogmanager.store.update(self, options)
       end
       
-      def update_properties(set)
-        self.class.ogmanager.store.update_properties(self, set)
+      def update_properties(*properties)
+        self.class.ogmanager.store.update(self, :only => properties)
       end
+      alias_method :update_property, :update_properties
+      alias_method :pupdate, :update_properties
+
+      def update_by_sql(set)
+        self.class.ogmanager.store.update_by_sql(self, set)
+      end
+      alias_method :update_sql, :update_by_sql
+      alias_method :supdate, :update_by_sql
       
       # Reload this entity instance from the store.
       
@@ -70,12 +78,9 @@ module EntityMixin
     alias_method :[], :load
     alias_method :exist?, :load
 
-    def update_properties(set, options = nil)
-      ogmanager.store.update_properties(self, set, options)
+    def update(set, options = nil)
+      ogmanager.store.update_by_sql(self, set, options)
     end
-    alias_method :pupdate, :update_properties
-    alias_method :update_property, :update_properties
-    alias_method :batch_update, :update_properties
     
     def find(options = {})
       # gmosx, FIXME: this code seems too complex, 
@@ -120,6 +125,10 @@ module EntityMixin
     end
     alias_method :delete!, :delete
 
+    def escape(str)
+      ogmanager.store.escape(str)
+    end
+
     def transaction(&block)
       ogmanager.store.transaction(&block)
     end

data/lib/og/manager.rb

@@ -184,18 +184,4 @@ class Manager
 
 end
 
-class << self
-  
-# Helper method, useful to initialize Og.
-
-def setup(options = {})
-  m = @@manager = Manager.new(options)
-  m.manage_classes
-  return m
-end
-alias_method :connect, :setup
-alias_method :options=, :setup
-
-end
-
 end

data/lib/og/mixin/orderable.rb

@@ -115,12 +115,12 @@ module Orderable
 
       def increment_position
         @#{position} += 1
-                          update(:only=>[:#{position}])
+        update_property(:#{position})
       end
     
       def decrement_position
         @#{position} -= 1
-        update(:only=>[:#{position}])
+        update_property(:#{position})
       end
 
       def bottom_position
@@ -130,24 +130,24 @@ module Orderable
 
       def set_top_position
         @#{position} = 1
-        update(:only=>[:#{position}])
+        update_property(:#{position})
       end
 
       def set_bottom_position
         @#{position} = bottom_position + 1
-        update(:only=>[:#{position}])
+        update_property(:#{position})
       end
 
       def increment_position_of_higher_items
-        #{base}.update_property("#{position}=(#{position} + 1)", #{cond_and}"#{position} < \#\{@#{position}\}")
+        #{base}.update("#{position}=(#{position} + 1)", #{cond_and}"#{position} < \#\{@#{position}\}")
       end
 
       def increment_position_of_all_items
-        #{base}.update_property("#{position}=(#{position} + 1)", #{cond})
+        #{base}.update("#{position}=(#{position} + 1)", #{cond})
       end
       
       def decrement_position_of_lower_items
-        #{base}.update_property("#{position}=(#{position} - 1)", #{cond_and}"#{position} > \#\{@#{position}\}")
+        #{base}.update("#{position}=(#{position} - 1)", #{cond_and}"#{position} > \#\{@#{position}\}")
       end
     }    
     

data/lib/og/relation.rb

@@ -24,8 +24,19 @@ class Relation
       raise 'Class of target not defined' 
     end
 
+    target_name = if collection
+      :target_plural_name
+    else 
+      :target_singular_name 
+    end
+
     @options[:target_class] = args.pop
+    @options[target_name] = args.first unless args.empty?
+    
+    setup()
+  end
 
+  def setup
     if target_class == Object
       # If the target class is just an Object mark that class
       # as a polymorphic parent class.
@@ -55,9 +66,7 @@ class Relation
     
     # Inflect the relation name.
     
-    unless args.empty?
-      @options[target_name] = args.first
-    else
+    unless @options[target_name]
       @options[target_name] = if collection
         target_class.to_s.demodulize.underscore.downcase.plural.intern 
       else
@@ -123,26 +132,6 @@ class Relation
     end
   end
   
-=begin
-  def resolve_target
-    if target_class.is_a?(Symbol)
-      c = owner_class.name.dup
-      c = "::" + c unless c =~ /::/
-      c.gsub!(/::.*$/, '::')
-      c << target_class.to_s
-      begin
-        klass = constant(c)
-      rescue
-        unless c == target_class
-          c = target_class
-          retry
-        end
-      end
-      @options[:target_class] = klass
-    end        
-  end
-=end
-
   # Resolve a polymorphic target class.
   # Overrided in subclasses.
     
@@ -163,16 +152,26 @@ class Relation
   class << self
 
     def resolve(klass, action)
-      if klass.__meta[:relations]
-        for relation in klass.__meta[:relations]
+      if relations = klass.metadata.relations
+        for relation in klass.metadata.relations
           relation.send(action)
         end
       end    
     end
     
-    def enchant(klass)
-      if klass.__meta[:relations]
-        for relation in klass.__meta[:relations]
+    def enchant(klass)      
+      if relations = klass.metadata.relations
+        # update inherited relations.
+        # gmosx, FIXME: implement a better fix/rethink this!
+        for relation in relations
+          relation[:owner_class] = klass 
+          unless relation.target_class == Object or relation.target_class.metadata.polymorphic
+            relation.setup 
+          end
+        end
+        
+        # enchant.        
+        for relation in relations
           relation.enchant unless relation.target_class == Object
         end
       end

data/lib/og/store/memory.rb

@@ -5,6 +5,8 @@ module Og
 
 # A collection of utilities. Mainly to stay compatible with the
 # SQL based backends.
+#
+# WARNING: This store does not yet support all Og features.
 
 module MemoryUtils
 

data/lib/og/store/psql.rb

@@ -126,7 +126,12 @@ class PsqlStore < SqlStore
   end
 
   def enchant(klass, manager)
-    klass.const_set 'OGSEQ', "#{table(klass)}_oid_seq"
+    if sclass = klass.metadata.superclass
+      klass.const_set 'OGSEQ', "#{table(sclass.first)}_oid_seq"
+    else
+      klass.const_set 'OGSEQ', "#{table(klass)}_oid_seq"
+    end
+
     klass.property :oid, Fixnum, :sql => 'serial PRIMARY KEY'
     super
   end
@@ -265,7 +270,7 @@ private
   #++
 
   def eval_og_insert(klass)
-    props = klass.properties
+    props = klass.properties.dup
     values = props.collect { |p| write_prop(p) }.join(',') 
 
     if klass.metadata.superclass or klass.metadata.subclasses
@@ -287,6 +292,22 @@ private
     }
   end
 
+  def eval_og_allocate(klass)  
+    if klass.metadata.subclasses
+      klass.module_eval %{
+        def self.og_allocate(res, row = 0)
+          Object.constant(res.getvalue(row, 0)).allocate
+        end
+      }
+    else
+      klass.module_eval %{
+        def self.og_allocate(res, row = 0)
+          self.allocate
+        end
+      }
+    end
+  end
+
   def read_row(obj, res, res_row, row)
     res.fields.each_with_index do |field, idx|
       obj.instance_variable_set "@#{field}", res.getvalue(row, idx)

data/lib/og/store/sql.rb

@@ -146,7 +146,8 @@ module SqlUtils
 
   def join_table_key(klass)
     "#{klass.to_s.split('::').last.downcase}_oid"
-  end
+  end
+  
   def join_table_keys(class1, class2)
     if class1 == class2
       # Fix for the self-join case.
@@ -155,6 +156,11 @@ module SqlUtils
       return join_table_key(class1), join_table_key(class2)
     end    
   end
+
+  def ordered_join_table_keys(class1, class2)
+    first, second = join_class_ordering(class1, class2)
+    return join_table_keys(first, second)
+  end
 
   def join_table_info(owner_class, target_class, postfix = nil)
     owner_key, target_key = join_table_keys(owner_class, target_class)
@@ -265,39 +271,27 @@ class SqlStore < Store
 
     klass.module_eval 'def self.table; OGTABLE; end'
   
-    # precompile a class specific allocate method. If this
-    # is an STI parent classes it reads the class from the
-    # resultset.
-    
-    if klass.metadata.subclasses
-      klass.module_eval %{
-        def self.og_allocate(res)
-          Object.constant(res[0]).allocate
-        end
-      }
-    else
-      klass.module_eval %{
-        def self.og_allocate(res)
-          self.allocate
-        end
-      }
-    end
+    eval_og_allocate(klass)
     
     super
 
     unless klass.polymorphic_parent?
-      # create the table if needed.
-
+      # precompile class specific lifecycle methods.      
       eval_og_create_schema(klass)
-#      create_table(klass) if Og.create_schema
-      klass.allocate.og_create_schema(self)
-
-      # precompile class specific lifecycle methods.
-      
       eval_og_insert(klass)
       eval_og_update(klass)
-      eval_og_read(klass)
       eval_og_delete(klass)
+
+      # create the table if needed.
+      klass.allocate.og_create_schema(self)
+
+      # finish up with eval_og_read, since we can't do that
+      # until after the table is created.
+      # Possible FIXME:  This means you can't do any find-type
+      # operations in og_create_schema.  Luckily, you're most
+      # likely to want to do .create, which is covered by 
+       # og_insert.
+      eval_og_read(klass)
     end
   end
 
@@ -324,6 +318,9 @@ class SqlStore < Store
   # If a properties collection is provided, only updates the 
   # selected properties. Pass the required properties as symbols
   # or strings.
+  #--
+  # gmosx, THINH: condition is not really useful here :(
+  #++
   
   def update(obj, options = nil)
     if options and properties = options[:only]
@@ -347,7 +344,15 @@ class SqlStore < Store
   # Update selected properties of an object or class of
   # objects.
   
-  def update_properties(target, set, options = nil)
+  def update_properties(target, *properties)
+    update(target, :only => properties)
+  end
+  alias_method :pupdate, :update_properties
+  alias_method :update_property, :update_properties
+
+  # More generalized method, also allows for batch updates.
+  
+  def update_by_sql(target, set, options = nil)
     set = set.gsub(/@/, '')
     
     if target.is_a?(Class)
@@ -360,8 +365,6 @@ class SqlStore < Store
       sql_update(sql)
     end      
   end
-  alias_method :pupdate, :update_properties
-  alias_method :update_property, :update_properties
 
   # Find a collection of objects.
   #
@@ -425,7 +428,7 @@ class SqlStore < Store
   
   def join(obj1, obj2, table, options = nil)
     first, second = join_object_ordering(obj1, obj2)
-    first_key, second_key = join_table_keys(obj1.class, obj2.class)
+    first_key, second_key = ordered_join_table_keys(obj1.class, obj2.class)
     if options
       exec "INSERT INTO #{table} (#{first_key},#{second_key}, #{options.keys.join(',')}) VALUES (#{first.pk},#{second.pk}, #{options.values.map { |v| quote(v) }.join(',')})"
     else
@@ -438,7 +441,7 @@ class SqlStore < Store
     
   def unjoin(obj1, obj2, table)
     first, second = join_object_ordering(obj1, obj2)
-    first_key, second_key = join_table_keys(obj1, obj2, table)
+    first_key, second_key = ordered_join_table_keys(obj1, obj2, table)
     exec "DELETE FROM #{table} WHERE #{first_key}=#{first.pk} AND #{second_key}=#{second.pk}"    
   end
     
@@ -598,7 +601,7 @@ private
 
   def eval_og_insert(klass)
     pk = klass.pk_symbol
-    props = klass.properties
+    props = klass.properties.dup
     values = props.collect { |p| write_prop(p) }.join(',') 
 
     if klass.metadata.superclass or klass.metadata.subclasses
@@ -696,12 +699,33 @@ private
   def eval_og_create_schema(klass)
     klass.module_eval %{
       def og_create_schema(store)
-        #{Aspects.gen_advice_code(:og_create_schema, klass.advices, :pre) if klass.respond_to?(:advices)}
-        store.send(:create_table, #{klass}) if Og.create_schema
-        #{Aspects.gen_advice_code(:og_create_schema, klass.advices, :post) if klass.respond_to?(:advices)}
+        if Og.create_schema
+          #{Aspects.gen_advice_code(:og_create_schema, klass.advices, :pre) if klass.respond_to?(:advices)}
+          store.send(:create_table, #{klass})
+          #{Aspects.gen_advice_code(:og_create_schema, klass.advices, :post) if klass.respond_to?(:advices)}
+        end
       end
     }
   end
+
+  # Precompile a class specific allocate method. If this is an 
+  # STI parent classes it reads the class from the resultset.
+
+  def eval_og_allocate(klass)  
+    if klass.metadata.subclasses
+      klass.module_eval %{
+        def self.og_allocate(res, row = 0)
+          Object.constant(res[0]).allocate
+        end
+      }
+    else
+      klass.module_eval %{
+        def self.og_allocate(res, row = 0)
+          self.allocate
+        end
+      }
+    end
+  end
   
   # :section: Misc methods.
 
@@ -810,7 +834,7 @@ private
     offset = obj.class.properties.size 
     
     for rel in join_relations 
-      rel_obj = rel[:target_class].og_allocate(res_row)
+      rel_obj = rel[:target_class].og_allocate(res_row, row)
       rel_obj.og_read(res_row, row, offset) 
       offset += rel_obj.class.properties.size 
       obj.instance_variable_set("@#{rel[:name]}", rel_obj)
@@ -830,7 +854,7 @@ private
     
     res_row = res.next
     
-    obj = klass.og_allocate(res_row)
+    obj = klass.og_allocate(res_row, 0)
     
     if options and options[:select]
       read_row(obj, res, res_row, 0)
@@ -860,13 +884,13 @@ private
 
     if options and options[:select]
       res.each_row do |res_row, row|    
-        obj = klass.og_allocate(res_row)
+        obj = klass.og_allocate(res_row, row)
         read_row(obj, res, res_row, row)
         objects << obj
       end
     else
       res.each_row do |res_row, row|    
-        obj = klass.og_allocate(res_row)
+        obj = klass.og_allocate(res_row, row)
         obj.og_read(res_row, row)
         read_join_relations(obj, res_row, row, join_relations) if join_relations
         objects << obj

data/lib/og/store/sqlite.rb

@@ -184,7 +184,7 @@ private
 
   def eval_og_insert(klass)
     pk = klass.primary_key.first
-    props = klass.properties
+    props = klass.properties.dup
     values = props.collect { |p| write_prop(p) }.join(',') 
 
     if klass.metadata.superclass or klass.metadata.subclasses

data/test/og/tc_inheritance.rb

@@ -41,13 +41,22 @@ class TC_OgInheritance < Test::Unit::TestCase # :nodoc: all
       :name => :test
     )  
 =end
-#=begin
+=begin
     @og = Og.setup(
       :destroy => true,
       :store => :sqlite,
       :name => 'test'
     )  
-#=end
+=end
+#=begin
+    @og = Og.setup(
+      :destroy => true,
+      :store => :psql,
+      :name => 'test',
+      :user => 'postgres',
+      :password => 'navelrulez'
+    )  
+#=end    
 =begin
     @og = Og.setup(
       :destroy => true,

data/test/og/tc_relation.rb

@@ -46,7 +46,7 @@ class TestCaseOgRelation < Test::Unit::TestCase # :nodoc: all
     og = Og.setup(:store => :memory, :name => 'test')
     og.manage_classes
 
-    # test refers_to accessor is correctly updated even without reload
+    # test refers_to accessor is correctly updated
     u = User.create("George")
     a = Article.create("Og is a good thing!")
     assert_equal(nil, a.active_user)
@@ -60,7 +60,20 @@ class TestCaseOgRelation < Test::Unit::TestCase # :nodoc: all
     a.active_user = u2
     a.save!
     assert_equal(u2.oid, a.active_user_oid)
+
+    # Note! Og doesn't automatically reload object referred by active_user
+    # so this won't equal.
+    assert_not_equal(u2.object_id, a.active_user.object_id)
+
+    # Even forced reload won't help here as it won't reload relations.
+    a.reload
+    assert_not_equal(u2.object_id, a.active_user.object_id)
+
+    # But forcing enchanted accessor to reload in refers_to.rb helps!
+    a.active_user(true)
     assert_equal(u2.object_id, a.active_user.object_id)
+    # and just to be sure oids are still correct
+    assert_equal(u2.oid, a.active_user_oid)
   end
 end
 

data/test/og/tc_store.rb

@@ -41,6 +41,10 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
     end
   end
 
+  class NewArticle < Article
+    property :more_text, String
+  end
+  
   class Comment
     property :body, String
     property :hits, Fixnum
@@ -85,7 +89,7 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
 #    conversions_test
   end
 =end
-#=begin  
+=begin  
   def test_psql
     @og = Og.setup(
       :destroy => true,
@@ -98,7 +102,7 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
     features_test
     conversions_test
   end
-#=end
+=end
 =begin
   def test_mysql
     @og = Og.setup(
@@ -113,7 +117,7 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
 #    conversions_test
   end
 =end
-=begin
+#=begin
   def test_sqlite
     @og = Og.setup(
       :destroy => true,
@@ -123,7 +127,7 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
     features_test
     conversions_test
   end
-=end
+#=end
 =begin
   def test_memory
     @og = Og.setup(
@@ -229,13 +233,13 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
 
     # update_properties
 
-    assert_equal 4, Comment.update_properties('@hits = @hits + 1')
+    assert_equal 4, Comment.update('@hits = @hits + 1')
     cc = Comment[1]
     assert_equal 1, cc.hits
-    Comment.update_properties('@hits = @hits + 1', :condition => 'oid = 1')
+    Comment.update('@hits = @hits + 1', :condition => 'oid = 1')
     cc.reload
     assert_equal 2, cc.hits
-    cc.update_properties('@hits = @hits + 1')
+    cc.update_by_sql '@hits = @hits + 1'
     cc.reload
     assert_equal 3, cc.hits
 
@@ -249,7 +253,7 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
     
     cc.hits += 1
     cc.body = 'Wow!'
-    cc.update :only => [:hits, :body]
+    cc.update_properties :hits, :body
     cc.reload
     assert_equal 'Wow!', cc.body
         
@@ -314,18 +318,26 @@ class TCOgStore < Test::Unit::TestCase # :nodoc: all
     a.categories << c1
     a.save
     a.categories << c2
-     a.save
-     
-     assert_equal 2, a.categories.size
-     
-     a = Article.find_by_body('Hello').first
-     assert_equal 2, a.categories.size
-     assert_equal 'News', a.categories[0].title
+    a.save
+
+    assert_equal 2, a.categories.size
+
+    a = Article.find_by_body('Hello').first
+    assert_equal 2, a.categories.size
+    assert_equal 'News', a.categories[0].title
+
+    c = Category.find_by_title('News')
+    assert_equal 1, c.articles.size
      
-     c = Category.find_by_title('News')
-     assert_equal 1, c.articles.size
      
-     # bug: self join bug.
+    # bug: extended class and many_to_many.
+
+    na = NewArticle.create('Bug')
+    na.categories << c1
+    na.categories << c2
+    assert_equal 2, na.categories.size
+
+    # bug: self join bug.
      
     b1 = Bugger.create
     b2 = Bugger.create

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: og
 version: !ruby/object:Gem::Version 
-  version: 0.21.0
-date: 2005-07-25 00:00:00 +03:00
+  version: 0.21.2
+date: 2005-07-28 00:00:00 +03:00
 summary: Og (ObjectGraph)
 require_paths: 
   - lib
@@ -124,5 +124,5 @@ dependencies:
         - 
           - "="
           - !ruby/object:Gem::Version 
-            version: 0.21.0
+            version: 0.21.2
       version: