mongo_odm 0.2.2 → 0.2.3

data/README.rdoc

@@ -51,8 +51,9 @@ A piece of code is better than a hundred of words:
   #   "color"  : null,
   #   "radius" : 1 }
 
-  all_shapes = Shape.find.to_a
-  
+  all_shapes = Shape.find # Returns a criteria object. It will execute the query and instance the objects once you iterate over it
+
+  all_shapes.to_a
   # Returns all the shapes; notice they are of different classes:
   # [ #<Shape x: 0.0, y: 5.0, color: nil, name: "Point", _id: {"$oid"=>"4be97178715dd2c4be000006"}>,
   #   #<Circle x: 1.0, y: 1.0, color: nil, radius: 1.0, _id: {"$oid"=>"4be97293715dd2c4be000008"}> ]
@@ -65,6 +66,28 @@ to have the attribute "_class" set to the name of the class you want to use as t
   # Returns:
   # #<Circle x: 12.0, y: 5.0, color: nil, radius: 1.0>
 
+And because any query method returns a MongoODM::Criteria object, you can concatenate them to nest several conditions (like if they were ActiveRecord scopes):
+
+  Shape.find(:radius => 1).find({}, {:sort => [:color, :asc]}) # Returns a criteria object. Once you iterate over it, it will run a query with both the :radius selector and :sort order.
+  
+You can also define your own class methods that returns criteria objects, and concatenate them to obtain a single criteria with all the conditions merged in the calls order:
+
+  class Shape
+    def self.with_radius(n)
+      find(:radius => n)
+    end
+    
+    def self.ordered_by_color
+      find({}, {:sort => [:color, :asc]})
+    end
+  end
+  
+  Shape.with_radius(1).ordered_by_color # Returns the same criteria than the previous example
+
+Take a look at the Mongo Ruby driver documentation for the 'find' method to see the available options:
+
+http://api.mongodb.org/ruby/1.0.8/Mongo/Collection.html#find-instance_method
+
 = Associations
 
 To embed just one copy of another class, just define the field type of that class. The class just need to respond to the "type_cast" class method and the "to_mongo" instance method. Example:
@@ -235,21 +258,68 @@ To reference the associated objects instead of embed them, for now you need to d
 
 For now, the available callbacks are: after_initialize, before_save, after_save
 
+Example:
+
+  class User
+    include MongoODM::Document
+
+    field :encrypted_password
+    attr_accessor :password
+    
+    before_save :encrypt_password
+    
+    def encrypt_password
+      return if self.password.blank?
+      self.encrypted_password = encrypt(password)
+    end
+    protected :encrypt_password
+  end
+
 = Validations
 
 All the validation methods defined in ActiveModel::Validations are included
 
+Example:
+
+  class User
+    field :email
+    
+    validates_presence_of :email
+    validates_uniqueness_of :email, :case_sensitive => false
+    validates_format_of :email, :with => /^([a-zA-Z0-9_\.\-\+])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/
+  end
+
 = Dirty
 
 All the dirty object methods defined in ActiveModel::Dirty are included
 
+Example:
+
+  class User
+    field :email
+  end
+  
+  user = User.new
+  user.email = "hello@h1labs.com"
+  user.email_changed? # Returns true
+  user.email_change # Returns [nil, "hello@h1labs.com"]
+  user.changes # Returns {"email" => [nil, "hello@h1labs.com"]}
+
 = TODO
 
+ * Support join of different concatenated find calls to a single criteria object
  * Add helpers to define attributes as referenced objects
+ * Allow to specify different database connections with each document definition
  * Increase rspec coverage
  * Document, document, document!
  * Create useful modules to make common operations easier (versioning, localization, etc)
 
+= More
+
+For now, take a look at the Mongo Ruby driver syntax:
+
+http://api.mongodb.org/ruby/1.0.8/index.html
+
 = Copyright
 
 Copyright © 2010 Carlos Paramio. See LICENSE for details.

data/lib/mongo_odm/criteria.rb

@@ -2,18 +2,33 @@
 module MongoODM
 
   class Criteria
-    def initialize(collection, selector = {}, opts = {})
-      @collection, @selector, @opts = collection, selector, opts
+    def initialize(klass, selector = {}, opts = {})
+      @klass, @selector, @opts = klass, selector, opts
     end
     
     def find(selector = {}, opts = {})
-      @selector.merge!(selector)
-      @opts.merge!(opts)
-      self
+      _merge_criteria(selector, opts)
     end
     
     def method_missing(method_name, *args)
-      @collection.find(@selector, @opts).send(method_name, *args)
+      if @klass.methods.include?(method_name)
+        result = @klass.send(method_name, *args)
+        if result.is_a?(Criteria)
+          selector = result.instance_variable_get("@selector")
+          opts = result.instance_variable_get("@opts")
+          _merge_criteria(selector, opts)
+        else
+          result
+        end
+      else
+        @klass.collection.find(@selector, @opts).send(method_name, *args)
+      end
+    end
+    
+    def _merge_criteria(selector, opts)
+      @selector.merge!(selector)
+      @opts.merge!(opts)
+      self
     end
   end
 

data/lib/mongo_odm/document/persistence.rb

@@ -76,7 +76,7 @@ module MongoODM
         end
         
         def find(*args)
-          MongoODM::Criteria.new(collection, *args)
+          MongoODM::Criteria.new(self, *args)
         end
         
         def destroy_all(*args)

data/lib/mongo_odm/version.rb

@@ -2,6 +2,6 @@
 module MongoODM
   VERSION_MAJOR = "0"
   VERSION_MINOR = "2"
-  VERSION_BUILD = "2"
+  VERSION_BUILD = "3"
   VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_BUILD}"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Carlos Paramio
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-29 00:00:00 +02:00
+date: 2010-08-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency