og 0.28.0 → 0.29.0

data/ProjectInfo

@@ -2,7 +2,7 @@
 
 TITLE    : &title Og
 NAME     : &pkg og
-VERSION  : '0.28.0'
+VERSION  : '0.29.0'
 STATUS   : beta
 
 AUTHOR   : George Moschovitis
@@ -17,7 +17,7 @@ DESCRIPTION: >
   KirbyBase, Filesystem and more.
 
 DEPENDENCIES:
- - [ glue, '= 0.28.0' ]
+ - [ glue, '= 0.29.0' ]
 
 DISTRIBUTE: [ gem, tgz, zip ]
 

data/README

@@ -1,4 +1,4 @@
-= Og 0.28.0 README
+= Og 0.29.0 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,3 +1,37 @@
+== Version 0.29.0
+
+A bold step towards maturity. Great care was taken to 
+fix reported bugs and fine tune many aspects of Og.
+As always some great new features where added. Special thanks fly
+to Jonas Pfenniger, Bryan Sotto, Rob Pitt and Guillaume 
+Pierronnet for making this release possible.
+
+Most notable changes:
+
+* Og now supports calculations and aggregations. Here are some
+  examples:
+
+  User.min(:age)
+  User.average(:age)
+  User.maximum(:age)
+  User.min(:age, :group => :profession) # => [..] (aggregation)
+  User.sum(:age, :group => :role) # => [..]
+  
+  and more!
+  
+* Improved Taggable mixin, now provides more helpers and supports
+  tag garbage collection through reference counting.
+  
+* Added a new store for the generalized caching system that is
+  backed by a MemCache server. Useful to extract the last ounch 
+  of performance in a production environment. 
+
+* Many Og bug fixes and optimizations.
+
+* Many, many bug fixes and small improvements throughout the
+  code.
+
+
 == Version 0.28.0
 
 A snapshot of the latest developments. As always, cool new 

data/lib/glue/cacheable.rb

@@ -125,6 +125,7 @@ module Cacheable
   # ...
   
   def self.cache_get(klass, pk)
+    obj.class.ogmanager.cache.get(klass.og_cache_key(pk)) 
   end
 
   # ...
@@ -140,7 +141,8 @@ module Cacheable
   # SQL query) you should call this method explicitly.
 
   def self.cache_delete(klass, pk)
-    key = "og#{klass}:#{pk}"
+    #key = "og#{klass}:#{pk}"
+    key = klass.og_cache_key(pk)
 #   self.og_local_cache.delete(key)
     klass.ogmanager.cache.delete(key)
   end

data/lib/glue/hierarchical.rb

@@ -12,7 +12,7 @@ module Glue
 
 module NestedSets
 
-  def self.included_with_params(base, options)
+  def self.included_with_parameters(base, options)
     c = {
       :left => 'lft',
       :right => 'rgt',
@@ -100,8 +100,8 @@ module NestedSets
         @#{right} = pivot + 2
 
         #{base}.transaction do
-          #{base}.update_property("#{left} = (#{left} + 2)",  #{cond_and}"#{left} >= \#{pivot}")
-          #{base}.update_property("#{right} = (#{right} + 2)", #{cond_and}"#{right} >= \#{pivot}")
+          #{base}.update("#{left} = (#{left} + 2)",  #{cond_and}"#{left} >= \#{pivot}")
+          #{base}.update("#{right} = (#{right} + 2)", #{cond_and}"#{right} >= \#{pivot}")
         end
 
         self.save

data/lib/glue/orderable.rb

@@ -69,7 +69,7 @@ module Orderable
     end
   end #dynamic_feature
 
-  before "add_to_bottom", :on => :og_insert
+  before "add_to_bottom", :on => [:og_insert, :og_update]
   before "decrement_position_of_lower_items", :on => :og_delete
 
   # Move higher.

data/lib/glue/taggable.rb

@@ -1,5 +1,7 @@
 require 'facet/inflect'
 
+module Glue
+
 # The default Tag implementation. A tag attaches semantics to
 # a given object.
 #--
@@ -20,18 +22,49 @@ class Tag
     @count = 0
   end
   
-  #--
-  # FIXME: use update_properties here!
-  #++
+  # Tag an object.
   
   def tag(obj)
-    class_name = obj.class.name
-    method_name = class_name.index('::') ? (class_name =~ /.*?\:\:(.*)/; $1) : class_name
-
-    send(method_name.pluralize.underscore.to_sym) << obj
-    @count += 1
-    save!
+    #--
+    # FIXME: this does not work as expected :( it alters
+    # the @loaded flag in the obj.tags collection without 
+    # setting the @members.
+    # INVESTIGATE: why this happens!
+    #
+    # return if obj.tagged_with?(@name)
+    # class_name = obj.class.name
+    # method_name = class_name.index('::') ? (class_name =~ /.*?\:\:(.*)/; $1) : class_name
+    # send(method_name.pluralize.underscore.to_sym) << obj
+    #++
+    
+    unless obj.tagged_with?(name)
+      obj.tags << self
+      @count += 1
+      update_property :count
+    end        
   end
+  alias_method :link, :tag
+  
+  # Untags an object. If no object is passed, it just decrements
+  # the (reference) count. If the count reaches 0 the tag is
+  # deleted (garbage collection).
+  
+  def untag(obj = nil)
+    if obj
+      # TODO: implement me.
+    end
+    
+    @count -= 1
+    
+    if @count > 0
+      p "-- dec ref count"
+      update_property :count
+    else
+      p "-- count = 0 -> delete"
+      self.delete()
+    end
+  end
+  alias_method :unlink, :untag
 
   # Return all tagged objects from all categories.
   
@@ -50,8 +83,6 @@ class Tag
   end
 end
 
-module Glue
-
 # Add tagging methods to the target class.
 # For more information on the algorithms used surf:
 # http://www.pui.ch/phred/archives/2005/04/tags-database-schemas.html
@@ -87,13 +118,32 @@ module Taggable
       :clear => true
     }.merge(options)
       
-    self.tags.clear if options[:clear]
+    delete_all_tags() if options[:clear]
     
     for name in Taggable.tags_to_names(the_tags)
-      Tag.find_or_create_by_name(name).tag(self) unless self.tagged_with?(name)
+      the_tag = Tag.find_or_create_by_name(name)
+      the_tag.tag(self)
     end    
   end
   alias_method :tag!, :tag  
+  
+  # Delete a single tag from this taggable object.
+  
+  def delete_tag(name)
+    if dtag = (tags.delete_if { |t| t.name == name }).first
+      dtag.unlink
+    end
+  end
+  
+  # Delete all tags from this taggable object.
+  
+  def delete_all_tags
+    for tag in tags
+      tag.unlink
+    end
+    tags.clear
+  end
+  alias_method :clear_tags, :delete_all_tags
 
   # Return the names of the tags.
   
@@ -124,16 +174,16 @@ module Taggable
       count = names.size
       names = names.map { |n| ogmanager.store.quote(n) }.join(',')
       sql = %{        
-        SELECT o.* 
+        SELECT t.* 
         FROM 
           #{info[:first_table]} AS o, 
           #{info[:second_table]} as t, 
           #{info[:table]} as j  
         WHERE o.oid = j.#{info[:first_key]} 
           AND t.oid = j.#{info[:second_key]} 
-          AND (t.name in (#{names}))
-        GROUP BY o.oid
-        HAVING COUNT(o.oid) = #{count};
+          AND (o.name in (#{names}))
+        GROUP BY j.article_oid
+        HAVING COUNT(j.article_oid) = #{count};
       }
       return self.select(sql)
     end
@@ -147,7 +197,7 @@ module Taggable
       count = names.size
       names = names.map { |n| ogmanager.store.quote(n) }.join(',')
       sql = %{        
-        SELECT o.* 
+        SELECT t.* 
         FROM 
           #{info[:first_table]} AS o, 
           #{info[:second_table]} as t, 
@@ -155,8 +205,8 @@ module Taggable
         WHERE 
           o.oid = j.#{info[:first_key]} 
           AND t.oid = j.#{info[:second_key]} 
-          AND (t.name in (#{names}))
-        GROUP BY o.oid
+          AND (o.name in (#{names}))
+        GROUP BY j.article_oid
       }
       return self.select(sql)
     end
@@ -170,7 +220,7 @@ module Taggable
     #--
     # FIXME: Og should handle this automatically.
     #++
-    base.send :include, Aspects
+    base.send :include, Glue::Aspects
     base.before 'tags.clear', :on => [:og_delete]
   end
   

data/lib/glue/timestamped.rb

@@ -7,7 +7,7 @@ module Glue
 # Adds timestamping functionality.
 
 module Timestamped
-  include Aspects
+  include Glue::Aspects
 
   property :create_time, Time, :control => :none
   property :update_time, Time, :control => :none
@@ -27,7 +27,7 @@ end
 # module.
 
 module TimestampedOnCreate
-  include Aspects
+  include Glue::Aspects
   property :create_time, Time, :control => :none
   before "@create_time = Time.now", :on => :og_insert
 end

data/lib/og.rb

@@ -43,7 +43,7 @@ module Og
 
   # The version.
 
-  Version = '0.28.0'
+  Version = '0.29.0'
 
   # Library path.
 
@@ -93,7 +93,7 @@ module Og
 
   # Enable/dissable thread safe mode.
 
-  setting :thread_safe, :default => true, :doc => 'Enable/dissable thread safe mode'
+  #setting :thread_safe, :default => true, :doc => 'Enable/dissable thread safe mode'
 
   # Address of the Og cache (if distributed caching enabled).
   
@@ -107,6 +107,10 @@ module Og
 
   mattr_accessor :manager
 
+  # thread safe state
+
+  mattr_reader :thread_safe
+
   # Pseudo type for binary data
 
   class Blob; end
@@ -124,7 +128,9 @@ module Og
         # additional, faster or enhanced functionality.
 
         options[:called_by_og_setup] = true if options[:called_by_og_setup].nil?
-        
+
+        @@thread_safe = true
+
         m = @@manager = Manager.new(options)        
         m.manage_classes
 
@@ -155,6 +161,13 @@ module Og
     def escape(str)
       @@manager.store.escape(str)
     end
+
+    # change thread_safe mode
+    def thread_safe=(bool)
+      @@thread_safe = bool
+      @@manager and @@manager.class.managers.each { |m| m.initialize_store }
+      @@thread_safe
+    end
   end
 
 end

data/lib/og/entity.rb

@@ -221,13 +221,56 @@ module EntityMixin
       ogmanager.store.select_one(sql, self)
     end
 
+    # :section: Aggregations / Calculations
+
+    # Perform a general aggregation/calculation.
+    
+    def aggregate(term, options = {})
+      options[:class] = self
+      ogmanager.store.calculate(term, options)
+    end
+    alias_method :calculate, :aggregate      
+   
     # Perform a count query.
     
     def count(options = {})
-      options[:class] = self
-      ogmanager.store.count(options)
+      calculate('COUNT(*)', options).to_i
+    end
+    
+    # Find the minimum of a property.
+    # Pass a :group option to return an aggregation. 
+    
+    def minimum(min, options = {})
+      calculate("MIN(#{min})", options)
+    end
+    alias_method :min, :minimum
+
+    # Find the maximum of a property.
+    # Pass a :group option to return an aggregation. 
+    
+    def maximum(max, options = {})
+      calculate("MAX(#{max})", options)
     end
+    alias_method :max, :maximum
 
+    # Find the average of a property.
+    # Pass a :group option to return an aggregation. 
+    
+    def average(avg, options = {})
+      calculate("AVG(#{avg})", options)
+    end
+    alias_method :avg, :average
+
+    # Find the sum of a property. 
+    # Pass a :group option to return an aggregation. 
+    
+    def summarize(sum, options = {})
+      calculate("SUM(#{sum})", options)
+    end
+    alias_method :sum, :summarize
+
+    # :section: Delete/Destroy methods.
+    
     # Delete an instance of this Entity class using the actual
     # instance or the primary key.
 
@@ -497,19 +540,24 @@ private
     def finder(match, args)
       finder = (match.captures.first == 'all_by' ? :find : :find_one)
       attrs = match.captures.last.split('_and_')
-        
-      options = {}
+      options = (annotation[:find_options] || {}).dup
       options = args.pop if args.last.is_a?(Hash)
-
+      relations_map = relations.map{|r| [r.name.to_s,r]}
       condition = attrs.zip(args).map do |name, value|
-        field_name = properties[name.to_sym][:field] ||
-          properties[name.to_sym][:name] ||
-          properties[name.to_sym][:symbol]
-
+        if relation = relations_map.assoc(name)
+          relation = relation.last
+          field_name = relation.foreign_key
+          value = value.send(relation.target_class.primary_key.symbol)          
+        else
+          field_name = properties[name.to_sym][:field] ||
+            properties[name.to_sym][:name] ||
+            properties[name.to_sym][:symbol]
+          end
+        options["#{name}_op".to_sym] = 'IN' if value.is_a?(Array)
         %|#{field_name} #{options.delete("#{name}_op".to_sym) || '='} #{ogmanager.store.quote(value)}|
       end.join(' AND ')
 
-      options.update(
+      options.merge!(
         :class => self,
         :condition => condition
       )

data/lib/og/ez/clause.rb

@@ -95,7 +95,8 @@ module Caboose
         when :between
           @negate ? ["#{@table_prefix}#{@name} NOT BETWEEN ? AND ?", @value.begin, @value.end] : ["#{@table_prefix}#{@name} BETWEEN ? AND ?", @value.begin, @value.end] 
         when :in
-          @negate ? ["#{@table_prefix}#{@name} NOT IN (?)", @value.to_a] : ["#{@table_prefix}#{@name} IN (?)", @value.to_a] 
+#          @negate ? ["#{@table_prefix}#{@name} NOT IN (?)", @value.to_a] : ["#{@table_prefix}#{@name} IN (?)", @value.to_a] 
+          @negate ? ["#{@table_prefix}#{@name} NOT IN (?*)", @value.to_a] : ["#{@table_prefix}#{@name} IN (?*)", @value.to_a]
         else
           ["#{@table_prefix}#{@name} #{@test} ?", @value]
         end

data/lib/og/manager.rb

@@ -13,13 +13,18 @@ class Manager
   def self.managers
     managers = []
     ObjectSpace.each_object(self) { |o| managers << o }
-    managers
+    return managers
   end
 
   def self.managed?(klass)
     self.managers.any? { |m| m.managed? klass }
   end
 
+  def self.managed_classes
+    managed = self.managers.collect {|m| m.managed_classes}
+    managed.flatten
+  end
+
   # Information about an Entity class.
 
   class EntityInfo
@@ -56,28 +61,51 @@ class Manager
   def initialize(options)
     @options = options
     @entities = {}
-    @pool = Pool.new
 
     @store_class = Store.for_name(options[:store])
     @store_class.destroy(options) if options[:destroy]
     @store_class.destroy_tables(options) if options[:destroy_tables]
+    init_store
+  end
+
+  def initialize_store
+    if @pool
+      close_store
+    end
 
     if Og.thread_safe
+      @pool = Pool.new
       (options[:connection_count] || 5).times do
-        @pool << @store_class.new(options)
+        @pool << @store_class.new(@options)
       end
     else
-      @store = @store_class.new(options)
+      @store = @store_class.new(@options)
+    end
+  end
+  alias :init_store :initialize_store 
+
+  # used when changing thread_safe mode
+  
+  def close_store
+    if @pool.empty?
+      @store.close
+    else
+      @pool.each { |s| s.close }
+      @pool.clear
     end
+    @pool = nil
   end
 
   # Get a store from the pool.
 
   def get_store
-    if Og.thread_safe
+    if @pool
       thread = Thread.current
 
       unless st = thread[:og_store] and st.is_a?(@store_class)
+        if 0 == @pool.size()
+          initialize_store()
+        end
         st = @pool.pop()
         thread[:og_store] = st
       end
@@ -93,7 +121,7 @@ class Manager
   # Return a store to the pool.
 
   def put_store
-    if Og.thread_safe
+    if @pool
       thread = Thread.current
 
       if conn = thread[:og_store]
@@ -150,7 +178,7 @@ class Manager
   #++
 
   def manageable?(klass)
-    klass.respond_to?(:properties) and (!klass.properties.empty?) # and !self.class.managed?(klass) # and klass.ann.self.polymorphic.nil?
+    klass.respond_to?(:properties) and (!klass.properties.empty?) # and klass.ann.self.polymorphic.nil?
   end
 
   # Is the class managed by Og?
@@ -186,6 +214,7 @@ class Manager
 
   def manage_classes(*classes)
     classes = manageable_classes.flatten # if classes.empty? FIXME!
+    classes = classes.reject { |c| self.class.managed?(c) }
 
     classes.each { |c| Relation.resolve_targets(c) }
     classes.each { |c| Relation.resolve_polymorphic_markers(c) }
@@ -194,6 +223,7 @@ class Manager
     # The polymorpic resolution step creates more manageable classes.
 
     classes = manageable_classes.flatten # if classes.empty? FIXME!
+    classes = classes.reject { |c| self.class.managed?(c) }
 
     Logger.debug "Og manageable classes: #{classes.inspect}" if $DBG
 
@@ -241,3 +271,4 @@ end
 
 # * George Moschovitis <gm@navel.gr>
 # * Guillaume Pierronnet <guillaume.pierronnet@laposte.net>
+# * Rob Pitt