mongoid 0.3.2 → 0.3.3

data/.watchr

@@ -0,0 +1,11 @@
+def run(cmd)
+  puts cmd
+  system cmd
+end
+
+def spec(file)
+  run "spec -O spec/spec.opts #{file}"
+end
+
+watch("spec/.*/*_spec\.rb")  {|md| p md[0]; spec(md[0]) }
+watch('lib/.*/(.*)\.rb')     {|md| p md[1]; spec("spec/unit/mongoid/#{md[1]}_spec.rb") }

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/lib/mongoid.rb

@@ -21,9 +21,9 @@
 require "rubygems"
 
 gem "activesupport", "2.3.4"
-gem "mongodb-mongo", "0.14.1"
+gem "mongo", "0.15.1"
 gem "durran-validatable", "1.7.5"
-gem "mislav-will_paginate", "2.3.11"
+gem "will_paginate", "2.3.11"
 
 require "validatable"
 require "active_support/callbacks"
@@ -32,6 +32,7 @@ require "delegate"
 require "will_paginate/collection"
 require "mongo"
 require "mongoid/associations"
+require "mongoid/criteria"
 require "mongoid/extensions"
 require "mongoid/document"
 

data/lib/mongoid/criteria.rb

@@ -0,0 +1,90 @@
+module Mongoid #:nodoc:
+  class Criteria #:nodoc:
+    attr_reader :selector, :options, :type
+
+    # Supply a hash of arrays for field values that must match every single
+    # element in the array.
+    def all(selections = {})
+      selections.each { |key, value| @selector[key] = { "$all" => value } }; self
+    end
+
+    # Excludes the parameters passed using $ne in the selector.
+    def excludes(exclusions = {})
+      exclusions.each { |key, value| @selector[key] = { "$ne" => value } }; self
+    end
+
+    # Execute the criteria, which will retrieve the results from
+    # the collection.
+    def execute(collection, klass)
+      return klass.new(collection.find_one(@selector, @options)) if type == :first
+      return collection.find(@selector, @options).collect { |doc| klass.new(doc) }
+    end
+
+    # Defines criteria for matching any of the supplied parameters, similar to
+    # a SQL in statement.
+    def in(inclusions = {})
+      inclusions.each { |key, value| @selector[key] = { "$in" => value } }; self
+    end
+
+    # Adds an _id criteria to the selector.
+    def id(object_id)
+      @selector[:_id] = Mongo::ObjectID.from_string(object_id); self
+    end
+
+    # Create the new Criteria object. Does not take any params, just
+    # initializes the selector and options hashes that will be 
+    # eventually passed to the driver.
+    def initialize(type)
+      @selector, @options, @type = {}, {}, type
+    end
+
+    # Limits the number of results returned by the query, usually used in
+    # conjunction with skip() for pagination.
+    def limit(value = 20)
+      @options[:limit] = value; self
+    end
+
+    # The conditions that must prove true on each record in the
+    # database in order for them to be a part of the result set.
+    # This is a hash that maps to a selector in the driver.
+    def select(selector = {})
+      @selector = selector; self
+    end
+
+    # Defines a clause that the criteria should ignore.
+    def not_in(exclusions)
+      exclusions.each { |key, value| @selector[key] = { "$nin" => value } }; self
+    end
+
+    # Define extras for the criteria.
+    def extras(extras)
+      @options = extras; self
+    end
+
+    # Specifies how to sort this Criteria. Current valid params
+    # are: { :field => 1 } or { :field => -1 }
+    def order_by(params = {})
+      @options[:sort] = params; self
+    end
+
+    # Specify what fields to be returned from the database.
+    # Similar to a SQL select field1, field2, field3
+    def only(*args)
+      @options[:fields] = args.flatten; self
+    end
+
+    # Skips the supplied number of records, as offset behaves in traditional
+    # pagination.
+    def skip(value = 0)
+      @options[:skip] = value; self
+    end
+
+    # Translate the supplied arguments into a criteria object.
+    def self.translate(*args)
+      type, params = args[0], args[1] || {}
+      return new(:first).id(type.to_s) if type.is_a?(String)
+      return new(type).select(params.delete(:conditions)).extras(params)
+    end
+
+  end
+end

data/lib/mongoid/document.rb

@@ -45,44 +45,35 @@ module Mongoid #:nodoc:
         collection.drop
       end
 
+      # Defines all the fields that are accessable on the Document
+      # For each field that is defined, a getter and setter will be
+      # added as an instance method to the Document.
+      def fields(*names)
+        @fields ||= []
+        names.flatten.each do |name|
+          @fields << name
+          define_method(name) { read_attribute(name) }
+          define_method("#{name}=") { |value| write_attribute(name, value) }
+        end
+      end
+
       # Find all Documents in several ways.
       # Model.find(:first, :attribute => "value")
       # Model.find(:all, :attribute => "value")
       def find(*args)
-        type, params = args[0], args[1]
-        case type
-        when :all then find_all(params)
-        when :first then find_first(params)
-        else find_first(Mongo::ObjectID.from_string(type.to_s))
-        end
+        Criteria.translate(*args).execute(collection, self)
       end
 
       # Find a single Document given the passed selector, which is a Hash of attributes that
       # must match the Document in the database exactly.
-      def find_first(params = {})
-        case params
-        when Hash then new(collection.find_one(params[:conditions]))
-        else new(collection.find_one(params))
-        end
+      def first(*args)
+        find(:first, *args)
       end
 
       # Find all Documents given the passed selector, which is a Hash of attributes that
       # must match the Document in the database exactly.
-      def find_all(params = {})
-        selector = params.delete(:conditions)
-        collection.find(selector, params).collect { |doc| new(doc) }
-      end
-
-      # Defines all the fields that are accessable on the Document
-      # For each field that is defined, a getter and setter will be
-      # added as an instance method to the Document.
-      def fields(*names)
-        @fields ||= []
-        names.flatten.each do |name|
-          @fields << name
-          define_method(name) { read_attribute(name) }
-          define_method("#{name}=") { |value| write_attribute(name, value) }
-        end
+      def all(*args)
+        find(:all, *args)
       end
 
       # Find all Documents given the supplied criteria, grouped by the fields
@@ -109,7 +100,10 @@ module Mongoid #:nodoc:
       def has_timestamps
         fields :created_at, :last_modified
         class_eval do
-          before_save :update_timestamps
+          before_create \
+            :update_created_at,
+            :update_last_modified
+          before_save :update_last_modified
         end
       end
 
@@ -178,12 +172,13 @@ module Mongoid #:nodoc:
       if @parent
         @parent.save
       else
+        return false unless valid?
         run_callbacks(:before_create) if creating
         run_callbacks(:before_save)
         collection.save(@attributes)
         run_callbacks(:after_create) if creating
         run_callbacks(:after_save)
-        return self
+        creating ? self : true
       end
     end
 
@@ -219,9 +214,15 @@ module Mongoid #:nodoc:
       @attributes[name.to_sym]
     end
 
-    # Update the timestamps on this document.
-    def update_timestamps
+    # Update the created_at field on the Document to the current time. This is
+    # only called on create.
+    def update_created_at
       self.created_at = Time.now
+    end
+
+    # Update the last_modified field on the Document to the current time.
+    # This is only called on create and on save.
+    def update_last_modified
       self.last_modified = Time.now
     end
 

data/mongoid.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2009-10-03}
+  s.date = %q{2009-10-09}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.textile"
   ]
   s.files = [
     ".gitignore",
+     ".watchr",
      "MIT_LICENSE",
      "README.textile",
      "Rakefile",
@@ -27,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/mongoid/associations/factory.rb",
      "lib/mongoid/associations/has_many_association.rb",
      "lib/mongoid/associations/has_one_association.rb",
+     "lib/mongoid/criteria.rb",
      "lib/mongoid/document.rb",
      "lib/mongoid/extensions.rb",
      "lib/mongoid/extensions/array/conversions.rb",
@@ -40,6 +42,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/associations/factory_spec.rb",
      "spec/unit/mongoid/associations/has_many_association_spec.rb",
      "spec/unit/mongoid/associations/has_one_association_spec.rb",
+     "spec/unit/mongoid/criteria_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",
      "spec/unit/mongoid/extensions/object/conversions_spec.rb"
@@ -57,6 +60,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/associations/factory_spec.rb",
      "spec/unit/mongoid/associations/has_many_association_spec.rb",
      "spec/unit/mongoid/associations/has_one_association_spec.rb",
+     "spec/unit/mongoid/criteria_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",
      "spec/unit/mongoid/extensions/object/conversions_spec.rb"

data/spec/integration/mongoid/document_spec.rb

@@ -43,7 +43,7 @@ describe Mongoid::Document do
     context "finding first document" do
 
       it "returns the first document based on the selector provided" do
-        person = Person.find(:first, :title => "Test")
+        person = Person.find(:first, :conditions => { :title => "Test" })
         person.title.should == "Test"
       end
 
@@ -52,7 +52,7 @@ describe Mongoid::Document do
     context "finding by id" do
 
       it "finds the document by the supplied id" do
-        person = Person.find(@person.id)
+        person = Person.find(@person.id.to_s)
         person.id.should == @person.id
       end
 

data/spec/spec_helper.rb

@@ -12,7 +12,6 @@ Mongoid.connect_to("mongoid_test")
 
 Spec::Runner.configure do |config|
   config.mock_with :mocha
-  Mocha::Configuration.prevent(:stubbing_non_existent_method)
 end
 
 class Person < Mongoid::Document

data/spec/unit/mongoid/criteria_spec.rb

@@ -0,0 +1,289 @@
+require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
+
+describe Mongoid::Criteria do
+
+  before do
+    @criteria = Mongoid::Criteria.new(:all)
+  end
+
+  describe "#all" do
+
+    it "adds the $all query to the selector" do
+      @criteria.all(:title => ["title1", "title2"])
+      @criteria.selector.should == { :title => { "$all" => ["title1", "title2"] } }
+    end
+
+    it "returns self" do
+      @criteria.all(:title => [ "title1" ]).should == @criteria
+    end
+
+  end
+
+  describe "#excludes" do
+
+    it "adds the $ne query to the selector" do
+      @criteria.excludes(:title => "Bad Title", :text => "Bad Text")
+      @criteria.selector.should == { :title => { "$ne" => "Bad Title"}, :text => { "$ne" => "Bad Text" } }
+    end
+
+    it "returns self" do
+      @criteria.excludes(:title => "Bad").should == @criteria
+    end
+
+  end
+
+  describe "#execute" do
+
+    context "when type is :first" do
+
+      it "calls find on the collection with the selector and options" do
+        criteria = Mongoid::Criteria.new(:first)
+        collection = mock
+        collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns({})
+        criteria.execute(collection, Person).should be_a_kind_of(Person)
+      end
+
+    end
+
+    context "when type is not :first" do
+
+      it "calls find on the collection with the selector and options" do
+        criteria = Mongoid::Criteria.new(:all)
+        collection = mock
+        collection.expects(:find).with(@criteria.selector, @criteria.options).returns([])
+        criteria.execute(collection, Person).should == []
+      end
+
+    end
+
+  end
+
+  describe "#extras" do
+
+    it "adds the extras to the options" do
+      @criteria.extras({ :skip => 10 })
+      @criteria.options.should == { :skip => 10 }
+    end
+
+    it "returns self" do
+      @criteria.extras({}).should == @criteria
+    end
+
+  end
+
+  describe "#id" do
+
+    it "adds the _id query to the selector" do
+      id = Mongo::ObjectID.new
+      @criteria.id(id.to_s)
+      @criteria.selector.should == { :_id => id }
+    end
+
+    it "returns self" do
+      id = Mongo::ObjectID.new
+      @criteria.id(id.to_s).should == @criteria
+    end
+
+  end
+
+  describe "#in" do
+
+    it "adds the $in clause to the selector" do
+      @criteria.in(:title => ["title1", "title2"], :text => ["test"])
+      @criteria.selector.should == { :title => { "$in" => ["title1", "title2"] }, :text => { "$in" => ["test"] } }
+    end
+
+    it "returns self" do
+      @criteria.in(:title => ["title1"]).should == @criteria
+    end
+
+  end
+
+  describe "#limit" do
+
+    context "when value provided" do
+
+      it "adds the limit to the options" do
+        @criteria.limit(100)
+        @criteria.options.should == { :limit => 100 }
+      end
+
+    end
+
+    context "when value not provided" do
+
+      it "defaults to 20" do
+        @criteria.limit
+        @criteria.options.should == { :limit => 20 }
+      end
+
+    end
+
+    it "returns self" do
+      @criteria.limit.should == @criteria
+    end
+
+  end
+
+  describe "#select" do
+
+    it "adds the clause to the selector" do
+      @criteria.select(:title => "Title", :text => "Text")
+      @criteria.selector.should == { :title => "Title", :text => "Text" }
+    end
+
+    it "returns self" do
+      @criteria.select.should == @criteria
+    end
+
+  end
+
+  describe "#not_in" do
+
+    it "adds the exclusion to the selector" do
+      @criteria.not_in(:title => ["title1", "title2"], :text => ["test"])
+      @criteria.selector.should == { :title => { "$nin" => ["title1", "title2"] }, :text => { "$nin" => ["test"] } }
+    end
+
+    it "returns self" do
+      @criteria.not_in(:title => ["title1"]).should == @criteria
+    end
+
+  end
+
+  describe "#order_by" do
+
+    context "when field names and direction specified" do
+
+      it "adds the sort to the options" do
+        @criteria.order_by(:title => 1, :text => -1)
+        @criteria.options.should == { :sort => { :title => 1, :text => -1 }}
+      end
+
+    end
+
+    it "returns self" do
+      @criteria.order_by.should == @criteria
+    end
+
+  end
+
+  describe "#only" do
+
+    it "adds the options for limiting by fields" do
+      @criteria.only(:title, :text)
+      @criteria.options.should == { :fields => [ :title, :text ] }
+    end
+
+    it "returns self" do
+      @criteria.only.should == @criteria
+    end
+
+  end
+
+  describe "#skip" do
+
+    context "when value provided" do
+
+      it "adds the skip value to the options" do
+        @criteria.skip(20)
+        @criteria.options.should == { :skip => 20 }
+      end
+
+    end
+
+    context "when value not provided" do
+
+      it "defaults to zero" do
+        @criteria.skip
+        @criteria.options.should == { :skip => 0 }
+      end
+
+    end
+
+    it "returns self" do
+      @criteria.skip.should == @criteria
+    end
+
+  end
+
+  describe "#translate" do
+
+    context "single argument as a string" do
+
+      it "creates a new select criteria" do
+        id = Mongo::ObjectID.new
+        criteria = Mongoid::Criteria.translate(id.to_s)
+        criteria.selector.should == { :_id => id }
+      end
+
+    end
+
+    context "multiple arguments" do
+
+      context "when :first, :conditions => {}" do
+
+        before do
+          @criteria = Mongoid::Criteria.translate(:first, :conditions => { :title => "Test" })
+        end
+
+        it "returns a criteria with a selector from the conditions" do
+          @criteria.selector.should == { :title => "Test" }
+        end
+
+        it "returns a criteria with type :first" do
+          @criteria.type.should == :first
+        end
+
+      end
+
+      context "when :all, :conditions => {}" do
+
+        before do
+          @criteria = Mongoid::Criteria.translate(:all, :conditions => { :title => "Test" })
+        end
+
+        it "returns a criteria with a selector from the conditions" do
+          @criteria.selector.should == { :title => "Test" }
+        end
+
+        it "returns a criteria with type :all" do
+          @criteria.type.should == :all
+        end
+
+      end
+
+      context "when :last, :conditions => {}" do
+
+        before do
+          @criteria = Mongoid::Criteria.translate(:last, :conditions => { :title => "Test" })
+        end
+
+        it "returns a criteria with a selector from the conditions" do
+          @criteria.selector.should == { :title => "Test" }
+        end
+
+        it "returns a criteria with type :last" do
+          @criteria.type.should == :last
+        end
+
+      end
+
+      context "when options are provided" do
+
+        before do
+          @criteria = Mongoid::Criteria.translate(:last, :conditions => { :title => "Test" }, :skip => 10)
+        end
+
+        it "adds the criteria and the options" do
+          @criteria.selector.should == { :title => "Test" }
+          @criteria.options.should == { :skip => 10 }
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/mongoid/document_spec.rb

@@ -3,13 +3,15 @@ require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 describe Mongoid::Document do
 
   before do
-    @collection = mock
+    @collection = stub(:name => "people")
     @database = stub(:collection => @collection)
     Mongoid.stubs(:database).returns(@database)
   end
 
   after do
     Person.instance_variable_set(:@collection, nil)
+    @database = nil
+    @collection = nil
   end
 
   describe "#aggregate" do
@@ -43,9 +45,12 @@ describe Mongoid::Document do
 
   describe "#collection" do
 
+    before do
+      @person = Person.new
+    end
+
     it "sets the collection name to the class pluralized" do
-      @database.expects(:collection).with("people").returns(@collection)
-      Person.collection
+      Person.collection.name.should == "people"
     end
 
   end
@@ -121,6 +126,7 @@ describe Mongoid::Document do
 
     before do
       @attributes = { :document_class => "Person" }
+      @criteria = mock
     end
 
     context "when an id is passed in" do
@@ -129,8 +135,9 @@ describe Mongoid::Document do
         @id = Mongo::ObjectID.new
       end
 
-      it "delegates to find_first" do
-        @collection.expects(:find_one).with(Mongo::ObjectID.from_string(@id.to_s)).returns(@attributes)
+      it "delegates to criteria" do
+        Mongoid::Criteria.expects(:translate).with(@id.to_s).returns(@criteria)
+        @criteria.expects(:execute).with(@collection, Person).returns(@attributes)
         Person.find(@id.to_s)
       end
 
@@ -138,8 +145,9 @@ describe Mongoid::Document do
 
     context "when finding first" do
 
-      it "delegates to find_first" do
-        @collection.expects(:find_one).with(:test => "Test" ).returns(@attributes)
+      it "delegates to criteria" do
+        Mongoid::Criteria.expects(:translate).with(:first, :conditions => { :test => "Test" }).returns(@criteria)
+        @criteria.expects(:execute).with(@collection, Person).returns(@attributes)
         Person.find(:first, :conditions => { :test => "Test" })
       end
 
@@ -176,7 +184,7 @@ describe Mongoid::Document do
 
   end
 
-  describe "#find_first" do
+  describe "#first" do
 
     before do
       @attributes = { :document_class => "Person" }
@@ -185,8 +193,8 @@ describe Mongoid::Document do
     context "when a selector is provided" do
 
       it "finds the first document from the collection and instantiates it" do
-        @collection.expects(:find_one).with(:test => "Test").returns(@attributes)
-        Person.find_first(:conditions => {:test => "Test"}).attributes.should == @attributes
+        @collection.expects(:find_one).with({ :test => "Test" }, {}).returns(@attributes)
+        Person.first(:conditions => {:test => "Test"}).attributes.should == @attributes
       end
 
     end
@@ -194,15 +202,15 @@ describe Mongoid::Document do
     context "when a selector is not provided" do
 
       it "finds the first document from the collection and instantiates it" do
-        @collection.expects(:find_one).with(nil).returns(@attributes)
-        Person.find_first.attributes.should == @attributes
+        @collection.expects(:find_one).with(nil, {}).returns(@attributes)
+        Person.first.attributes.should == @attributes
       end
 
     end
 
   end
 
-  describe "#find_all" do
+  describe "#all" do
 
     before do
       @cursor = mock
@@ -214,7 +222,7 @@ describe Mongoid::Document do
       it "finds from the collection and instantiate objects for each returned" do
         @collection.expects(:find).with({ :test => "Test" }, {}).returns(@cursor)
         @cursor.expects(:collect).returns(@people)
-        Person.find_all(:conditions => {:test => "Test"})
+        Person.all(:conditions => {:test => "Test"})
       end
 
     end
@@ -224,7 +232,7 @@ describe Mongoid::Document do
       it "finds from the collection and instantiate objects for each returned" do
         @collection.expects(:find).with(nil, {}).returns(@cursor)
         @cursor.expects(:collect).returns(@people)
-        Person.find_all
+        Person.all
       end
 
     end
@@ -326,10 +334,7 @@ describe Mongoid::Document do
     end
 
     it "adds created_on and last_modified to the document" do
-      @collection.expects(:save).with(@tester.attributes)
-      @tester.save
-      @tester.created_at.should_not be_nil
-      @tester.last_modified.should_not be_nil
+      Tester.instance_variable_get(:@fields).should include(:created_at, :last_modified)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Durran Jordan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-03 00:00:00 -04:00
+date: 2009-10-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,7 @@ extra_rdoc_files:
 - README.textile
 files: 
 - .gitignore
+- .watchr
 - MIT_LICENSE
 - README.textile
 - Rakefile
@@ -73,6 +74,7 @@ files:
 - lib/mongoid/associations/factory.rb
 - lib/mongoid/associations/has_many_association.rb
 - lib/mongoid/associations/has_one_association.rb
+- lib/mongoid/criteria.rb
 - lib/mongoid/document.rb
 - lib/mongoid/extensions.rb
 - lib/mongoid/extensions/array/conversions.rb
@@ -86,6 +88,7 @@ files:
 - spec/unit/mongoid/associations/factory_spec.rb
 - spec/unit/mongoid/associations/has_many_association_spec.rb
 - spec/unit/mongoid/associations/has_one_association_spec.rb
+- spec/unit/mongoid/criteria_spec.rb
 - spec/unit/mongoid/document_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb
 - spec/unit/mongoid/extensions/object/conversions_spec.rb
@@ -125,6 +128,7 @@ test_files:
 - spec/unit/mongoid/associations/factory_spec.rb
 - spec/unit/mongoid/associations/has_many_association_spec.rb
 - spec/unit/mongoid/associations/has_one_association_spec.rb
+- spec/unit/mongoid/criteria_spec.rb
 - spec/unit/mongoid/document_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb
 - spec/unit/mongoid/extensions/object/conversions_spec.rb