og 0.29.0 → 0.30.0

data/ProjectInfo

@@ -2,12 +2,12 @@
 
 TITLE    : &title Og
 NAME     : &pkg og
-VERSION  : '0.29.0'
+VERSION  : '0.30.0'
 STATUS   : beta
 
 AUTHOR   : George Moschovitis
 EMAIL    : &email gm@navel.gr
-HOMEPAGE : "http://www.nitrohq.com"
+HOMEPAGE : "http://www.nitroproject.org"
 
 SUMMARY: State of the art object-relational mapping system.
 
@@ -16,27 +16,26 @@ DESCRIPTION: >
   Og serializes standard Ruby objects to Mysql, Postgres, Sqlite,
   KirbyBase, Filesystem and more.
 
-DEPENDENCIES:
- - [ glue, '= 0.29.0' ]
-
-DISTRIBUTE: [ gem, tgz, zip ]
-
 RUBYFORGE:
   PROJECT: 'nitro'
   USERNAME: 'gmosx'
 
-RDOC:
-  - dir: rdoc
-    options: ['--all', '--inline-source']
-    include:
-      - 'lib/og/**/*'
-      - '[A-Z]*'
+DEPENDENCIES:
+ - [ glue, '= 0.30.0' ]
+
+PACKAGE: !!package
+  distribute: [ gem, tgz, zip ]
+
+RDOC: !!rdoc
+  dir: rdoc
+  options: ['--all', '--inline-source']
+  include:
+    - 'lib/og/**/*'
+    - '[A-Z]*'
 
-# Anything to require upfront?
-#TEST:
-#  fixture: ''
+TEST: !!test
 
-ANNOUNCE:
+ANNOUNCE: !!announce
   to: george.moschovitis@gmail.com
   from: gm@navel.gr
   domain: navel.gr
@@ -48,15 +47,5 @@ ANNOUNCE:
   file: ANN
   slogan: Og (ObjectGraph)
   links:
-    - http://www.nitrohq.com
-
-
-
-
-
-
-
-
-
-
+    - http://www.nitroproject.org
 

data/README

@@ -1,4 +1,4 @@
-= Og 0.29.0 README
+= Og 0.30.0 README
 
 Og (ObjectGraph) is a powerful and elegant object-relational mapping 
 library. Og manages the lifecycle of Ruby objects and  provides 
@@ -21,7 +21,7 @@ Filesystem, Oracle and SQL Server are included.
 
 Og is part of the Nitro project, released as a stand-alone library
 due to popular demand. You can find the ChangeLog in the Nitro 
-distribution (http://www.nitrohq.com).
+distribution (http://www.nitroproject.org).
 
 
 == Features
@@ -73,19 +73,19 @@ doc/RELEASES
 
 The latest version of Og can be found at
 
-* http://www.nitrohq.com
+* http://www.nitroproject.org
 
 == Documentation
 
 Documentation for Og can be found at
 
-* http://www.nitrohq.com
+* http://www.nitroproject.org
 
 Don't forget to read the file doc/RELEASES for usefull
 documentation bits. Also, have a look at the test cases in
 the test directory for examples of usage. Additional examples
 of Og usage can be found at the example distribution of the
-Nitro Web Framework (http://www.nitrohq.com)
+Nitro Web Framework (http://www.nitroproject.org)
 
 You can find a nice tutorial at www.rubygarden.com. Be warned
 that this tutorial describes an earlier version of Og. A *LOT*
@@ -170,7 +170,7 @@ http://rubyforge.org/mailman/listinfo/nitro-general
 Copyright (c) 2004-2006, George 'gmosx' Moschovitis (http://www.gmosx.com).
 Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
 
-Og (http://www.nitrohq.com) is copyrighted free 
+Og (http://www.nitroproject.org) is copyrighted free 
 software created and maintained by George Moschovitis (mailto:gm@navel.gr)
 and released under the standard BSD Licence. For details consult
 the file LICENCE.

data/doc/AUTHORS

@@ -30,6 +30,12 @@ IDEAS, ADDITIONAL CODING, SUPPORT:
 * Ghislain Mary <gmary@lunacymaze.org>
   Bug reports and patches (sqlite3 driver).
 
+* Kashia Buch <kashia@vfemail.net>
+  Patches.
+  
+* Dylan Bruzenak <dylanb@digitalvalence.com>
+  Patches (kirby).
+
 * Matt Bowen <matt.bowen@farweststeel.com>
   Oracle driver, documentation.
 

data/doc/RELEASES

@@ -1,3 +1,39 @@
+== Version 0.30.0
+
+Another pragmatic release. The Nitro development team worked over
+the submitted tickets and provided many bug fixes. More over, there
+are many small improvements along the codebase and as always
+we could not resist adding some cool new features. 
+
+Special thanks fly to Bryan Sotto for making this release
+possible!
+
+Most notable chages:
+  
+* Added Og query by example support. Query the database for an 
+  entity that matches the example. The example is a hash 
+  populated with the property values to search for.
+
+  The provided property values are joined with AND to build
+  the actual query.
+
+  Article.query_by_example :title => 'IBM%', :hits => 2
+  Article.find_with_properties :title => 'IBM%', :hits => 2
+
+* Added type casting support for Og aggregations and
+  calculations.
+      
+* Added many more RDoc comments to the source code.
+  
+* Many, many bug fixes.
+
+* Updated to latest Facets.
+
+Please note that the project home page has been moved to:
+
+http://www.nitroproject.org
+
+
 == Version 0.29.0
 
 A bold step towards maturity. Great care was taken to 

data/lib/glue/hierarchical.rb

@@ -1,6 +1,5 @@
-require 'facet/ormsupport'
-
-require 'glue/paramix'
+require 'facets/more/paramix'
+require 'facets/more/ormsupport'
 
 module Glue
 
@@ -119,7 +118,7 @@ end
 # === Example
 #
 # class Comment
-#    include Hierarchical, :method => :nested_sets
+#    is Hierarchical, :method => :nested_sets
 # end
 #
 # [+:method+]

data/lib/glue/optimistic_locking.rb

@@ -1,4 +1,4 @@
-require 'glue/on_included'
+require 'facets/core/module/on_included'
 
 module Glue
 

data/lib/glue/orderable.rb

@@ -1,12 +1,12 @@
-require 'glue/paramix'
-require 'glue/aspects'
+require 'facets/more/paramix'
+require 'facets/more/aspects'
 
 module Glue
 
 # Attach list/ordering methods to the enchanted class.
 
 module Orderable
-  include Glue::Aspects
+  include ::Aspects
 
   def self.included_with_parameters(base, opt)
     base.module_eval do

data/lib/glue/taggable.rb

@@ -1,7 +1,5 @@
 require 'facet/inflect'
 
-module Glue
-
 # The default Tag implementation. A tag attaches semantics to
 # a given object.
 #--
@@ -83,6 +81,8 @@ 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
@@ -170,20 +170,22 @@ module Taggable
     # INTERSECTION (AND)
   
     def find_with_tags(*names)
-      info = ogmanager.store.join_table_info(self, Tag)
+      relation = relations.reject{|r| r.name != :tags}.first
+      info = ogmanager.store.join_table_info(relation)
       count = names.size
       names = names.map { |n| ogmanager.store.quote(n) }.join(',')
-      sql = %{        
-        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 (o.name in (#{names}))
-        GROUP BY j.article_oid
-        HAVING COUNT(j.article_oid) = #{count};
+      sql = %{
+        SELECT *
+        FROM #{info[:owner_table]} AS o
+        WHERE o.oid IN (
+          SELECT j.#{info[:owner_key]}
+          FROM #{info[:target_table]} AS t
+          JOIN #{info[:table]} AS j
+          ON t.oid = j.#{info[:target_key]}
+          WHERE (t.name IN (#{names}))
+          GROUP BY j.#{info[:owner_key]}
+          HAVING COUNT(j.#{info[:owner_key]}) = #{count}
+        )
       }
       return self.select(sql)
     end
@@ -193,20 +195,21 @@ module Taggable
     # UNION (OR)
   
     def find_with_any_tag(*names)
-      info = ogmanager.store.join_table_info(self, Tag)
+      relation = relations.reject{|r| r.name != :tags}.first
+      info = ogmanager.store.join_table_info(relation)
       count = names.size
       names = names.map { |n| ogmanager.store.quote(n) }.join(',')
       sql = %{        
-        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 (o.name in (#{names}))
-        GROUP BY j.article_oid
+        SELECT *
+        FROM #{info[:owner_table]} AS o
+        WHERE o.oid IN (
+          SELECT j.#{info[:owner_key]}
+          FROM #{info[:target_table]} AS t
+          JOIN #{info[:table]} AS j
+          ON t.oid = j.#{info[:target_key]}
+          WHERE (t.name IN (#{names}))
+          GROUP BY j.#{info[:owner_key]}
+          )
       }
       return self.select(sql)
     end
@@ -220,7 +223,7 @@ module Taggable
     #--
     # FIXME: Og should handle this automatically.
     #++
-    base.send :include, Glue::Aspects
+    base.send :include, ::Aspects
     base.before 'tags.clear', :on => [:og_delete]
   end
   

data/lib/glue/timestamped.rb

@@ -1,13 +1,12 @@
 require 'facet/time/stamp'
-
-require 'glue/aspects'
+require 'facets/more/aspects'
 
 module Glue
 
 # Adds timestamping functionality.
 
 module Timestamped
-  include Glue::Aspects
+  include ::Aspects
 
   property :create_time, Time, :control => :none
   property :update_time, Time, :control => :none
@@ -27,7 +26,7 @@ end
 # module.
 
 module TimestampedOnCreate
-  include Glue::Aspects
+  include ::Aspects
   property :create_time, Time, :control => :none
   before "@create_time = Time.now", :on => :og_insert
 end

data/lib/og.rb

@@ -1,20 +1,20 @@
 # = Og
 #
-# Copyright (c) 2004-2005, George Moschovitis (http://www.gmosx.com)
-# Copyright (c) 2004-2005, Navel Ltd (http://www.navel.gr)
+# Copyright (c) 2004-2006, George Moschovitis (http://www.gmosx.com)
+# Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
 #
-# Og (http://www.nitrohq.com) is copyrighted free software 
+# Og (http://www.nitroproject.org) is copyrighted free software 
 # created and maintained by George Moschovitis (mailto:gm@navel.gr) 
 # and released under the standard BSD Licence. For details 
 # consult the file doc/LICENCE.
 
 require 'facet/synchash'
 require 'facet/syncarray'
+require 'facets/more/aspects'
 
 require 'glue'
 require 'glue/logger'
 require 'glue/validation'
-require 'glue/aspects'
 require 'glue/configuration'
 
 # Og (ObjectGraph) manages Ruby objects and their relations and
@@ -43,7 +43,7 @@ module Og
 
   # The version.
 
-  Version = '0.29.0'
+  Version = '0.30.0'
 
   # Library path.
 
@@ -92,8 +92,7 @@ module Og
   setting :raise_store_exceptions, :default => true, :doc => 'If true raises exceptions on store errors'
 
   # 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).
   
@@ -103,6 +102,11 @@ module Og
   
   setting :cache_port, :default => '9070', :doc => 'Port of the Og cache'
   
+  # A collection of classes that are unmanageable, ie the manager
+  # should ignore them.
+  
+  setting :unmanageable_classes, :default => [], :doc => 'Explicitly unmanageable classes'
+  
   # The active manager
 
   mattr_accessor :manager
@@ -154,6 +158,7 @@ module Og
     end
     alias_method :connect, :setup
     alias_method :options=, :setup
+    alias_method :setup=, :setup
     alias_method :start, :setup
 
     # Helper method.
@@ -162,10 +167,17 @@ module Og
       @@manager.store.escape(str)
     end
 
-    # change thread_safe mode
+    # Quote the string.
+    
+    def quote(str)
+      @@manager.store.quote(str)
+    end
+    
+    # Change thread_safe mode.
+    
     def thread_safe=(bool)
       @@thread_safe = bool
-      @@manager and @@manager.class.managers.each { |m| m.initialize_store }
+#      @@manager and @@manager.class.managers.each { |m| m.initialize_store }
       @@thread_safe
     end
   end

data/lib/og/entity.rb

@@ -38,7 +38,7 @@ module EntityMixin
   # don't pass.
   
   def force_save!(options = nil)
-    self.class.ogmanager.store.force_save(self, options)
+    self.class.ogmanager.store.force_save!(self, options)
   end
 
   # Insert the object in the store.
@@ -158,6 +158,8 @@ module EntityMixin
       ogmanager.store.update_by_sql(self, set, options)
     end
 
+    # :section: Query methods.
+    
     # Find a specific instance of this class according
     # to the given conditions.
     #
@@ -215,11 +217,46 @@ module EntityMixin
       ogmanager.store.select(sql, self)
     end
 
-    # Select one instance using an sqll query.
+    # Select one instance using an sql query.
     
     def select_one(sql)
       ogmanager.store.select_one(sql, self)
     end
+    
+    # Query the database for an entity that matches the example.
+    # The example is a hash populated with the property values
+    # to search for.
+    #
+    # The provided property values are joined with AND to build
+    # the actual query.
+    #
+    # Article.query_by_example :title => 'IBM%', :hits => 2
+    # Article.find_with_properties :title => 'IBM%', :hits => 2
+    
+    def query_by_example(example)
+      condition = []
+      example.each do |k, v|
+        next if v.nil?
+        if v.is_a? String and v =~ /%/
+          condition << "#{k} LIKE #{Og.quote(v)}"
+        else
+          condition << "#{k} = #{Og.quote(v)}"
+        end
+      end
+      
+      condition = condition.join(' AND ')
+
+      options = { 
+        :condition => condition, 
+        :class => self,
+      }
+      
+      options[:type] = self if self.schema_inheritance_child?
+
+      ogmanager.store.find(options)
+    end
+    alias_method :qbe, :query_by_example
+    alias_method :find_with_properties, :query_by_example
 
     # :section: Aggregations / Calculations
 
@@ -234,6 +271,7 @@ module EntityMixin
     # Perform a count query.
     
     def count(options = {})
+      options[:field] = '*'
       calculate('COUNT(*)', options).to_i
     end
     
@@ -241,6 +279,7 @@ module EntityMixin
     # Pass a :group option to return an aggregation. 
     
     def minimum(min, options = {})
+      options[:field] = min
       calculate("MIN(#{min})", options)
     end
     alias_method :min, :minimum
@@ -249,6 +288,7 @@ module EntityMixin
     # Pass a :group option to return an aggregation. 
     
     def maximum(max, options = {})
+      options[:field] = max
       calculate("MAX(#{max})", options)
     end
     alias_method :max, :maximum
@@ -257,6 +297,7 @@ module EntityMixin
     # Pass a :group option to return an aggregation. 
     
     def average(avg, options = {})
+      options[:field] = avg
       calculate("AVG(#{avg})", options)
     end
     alias_method :avg, :average
@@ -265,6 +306,7 @@ module EntityMixin
     # Pass a :group option to return an aggregation. 
     
     def summarize(sum, options = {})
+      options[:field] = sum
       calculate("SUM(#{sum})", options)
     end
     alias_method :sum, :summarize