mongoid 0.11.6 → 0.11.7

data/HISTORY

@@ -1,3 +1,16 @@
+=== 0.11.7
+- Added #sum to criteria which takes a single field
+  to aggregate on. Example: Person.sum(:age) would
+  return a float that was the sum of all people's
+  ages in the db.
+
+- Fixed issue with queries from parent classes always
+  casting the returned documents to the parent.
+
+- Fixed singleton require issue.
+
+- Group queries now run as db commands
+
 === 0.11.6
 - Allow namespaced documents to default with:
   "namespace_modelname"

data/VERSION

@@ -1 +1 @@
-0.11.6
+0.11.7

data/lib/mongoid.rb

@@ -28,6 +28,7 @@ gem "leshill-will_paginate", ">= 2.3.11"
 
 require "delegate"
 require "observer"
+require "singleton"
 require "time"
 require "validatable"
 require "active_support/callbacks"
@@ -48,6 +49,7 @@ require "mongoid/extensions"
 require "mongoid/errors"
 require "mongoid/field"
 require "mongoid/finders"
+require "mongoid/memoization"
 require "mongoid/timestamps"
 require "mongoid/versioning"
 require "mongoid/document"

data/lib/mongoid/associations.rb

@@ -11,6 +11,10 @@ module Mongoid # :nodoc:
   module Associations #:nodoc:
     def self.included(base)
       base.class_eval do
+        # Associations need to inherit down the chain.
+        class_inheritable_accessor :associations
+        self.associations = {}.with_indifferent_access
+
         include InstanceMethods
         extend ClassMethods
       end
@@ -35,9 +39,6 @@ module Mongoid # :nodoc:
     end
 
     module ClassMethods
-      def associations
-        @associations ||= {}.with_indifferent_access
-      end
       # Adds the association back to the parent document. This macro is
       # necessary to set the references from the child back to the parent
       # document. If a child does not define this association calling
@@ -198,22 +199,16 @@ module Mongoid # :nodoc:
 
       protected
       # Adds the association to the associations hash with the type as the key,
-      # then adds the accessors for the association.
+      # then adds the accessors for the association. The defined setters and
+      # getters for the associations will perform the necessary memoization.
       def add_association(type, options)
         name = options.name
         associations[name] = type
         define_method(name) do
-          return instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
-          proxy = type.instantiate(self, options)
-          instance_variable_set("@#{name}", proxy)
+          memoized(name) { type.instantiate(self, options) }
         end
         define_method("#{name}=") do |object|
-          proxy = type.update(object, self, options)
-          if instance_variable_defined?("@#{name}")
-            remove_instance_variable("@#{name}")
-          else
-            instance_variable_set("@#{name}", proxy)
-          end
+          reset(name) { type.update(object, self, options) }
         end
       end
     end

data/lib/mongoid/criteria.rb

@@ -48,9 +48,8 @@ module Mongoid #:nodoc:
     # Example:
     #
     # <tt>criteria.select(:field1).where(:field1 => "Title").aggregate(Person)</tt>
-    def aggregate(klass = nil)
-      @klass = klass if klass
-      @klass.collection.group(@options[:fields], @selector, { :count => 0 }, AGGREGATE_REDUCE)
+    def aggregate
+      @klass.collection.group(@options[:fields], @selector, { :count => 0 }, AGGREGATE_REDUCE, true)
     end
 
     # Adds a criterion to the +Criteria+ that specifies values that must all
@@ -165,9 +164,13 @@ module Mongoid #:nodoc:
         @options[:fields],
         @selector,
         { :group => [] },
-        GROUP_REDUCE
+        GROUP_REDUCE,
+        true
       ).collect do |docs|
-        docs["group"] = docs["group"].collect { |attrs| @klass.instantiate(attrs) }; docs
+        docs["group"] = docs["group"].collect do |attrs|
+          attrs["_type"].constantize.instantiate(attrs)
+        end
+        docs
       end
     end
 
@@ -230,7 +233,7 @@ module Mongoid #:nodoc:
       sorting = [[:_id, :asc]] unless sorting
       opts[:sort] = sorting.collect { |option| [ option[0], option[1].invert ] }
       attributes = @klass.collection.find_one(@selector, opts)
-      attributes ? @klass.instantiate(attributes) : nil
+      attributes ? attributes["_type"].constantize.instantiate(attributes) : nil
     end
 
     # Adds a criterion to the +Criteria+ that specifies the maximum number of
@@ -338,7 +341,7 @@ module Mongoid #:nodoc:
     # <tt>Criteria.select(:name).where(:name = "Chrissy").one</tt>
     def one
       attributes = @klass.collection.find_one(@selector, @options.dup)
-      attributes ? @klass.instantiate(attributes) : nil
+      attributes ? attributes["_type"].constantize.instantiate(attributes) : nil
     end
 
     alias :first :one
@@ -418,6 +421,26 @@ module Mongoid #:nodoc:
       @options[:skip] = value; self
     end
 
+    SUM_REDUCE = "function(obj, prev) { prev.sum += obj.[field]; }"
+    # Sum the criteria. This will take the internally built selector and options
+    # and pass them on to the Ruby driver's +group()+ method on the collection. The
+    # collection itself will be retrieved from the class provided, and once the
+    # query has returned it will provided a grouping of keys with sums.
+    #
+    # Example:
+    #
+    # <tt>criteria.select(:field1).where(:field1 => "Title").sum</tt>
+    def sum(field)
+      collection = @klass.collection.group(
+        @options[:fields],
+        @selector,
+        { :sum => 0 },
+        SUM_REDUCE.gsub("[field]", field.to_s),
+        true
+      )
+      collection.first["sum"]
+    end
+
     # Translate the supplied arguments into a +Criteria+ object.
     #
     # If the passed in args is a single +String+, then it will
@@ -490,7 +513,7 @@ module Mongoid #:nodoc:
       attributes = @klass.collection.find(@selector, @options.dup)
       if attributes
         @count = attributes.count
-        attributes.collect { |doc| @klass.instantiate(doc) }
+        attributes.collect { |doc| doc["_type"].constantize.instantiate(doc) }
       else
         []
       end

data/lib/mongoid/document.rb

@@ -4,7 +4,7 @@ module Mongoid #:nodoc:
     def self.included(base)
       base.class_eval do
         include ActiveSupport::Callbacks
-        include Associations, Attributes, Commands, Observable, Validatable
+        include Associations, Attributes, Commands, Memoization, Observable, Validatable
         include InstanceMethods
 
         extend ClassMethods

data/lib/mongoid/finders.rb

@@ -128,6 +128,22 @@ module Mongoid #:nodoc:
       Criteria.new(self).only(*args)
     end
 
+    # Convenience method for returning the sum of a specified field for all
+    # documents in the database.
+    #
+    # Options:
+    #
+    # field: The field to use when calculating the sum.
+    #
+    # Example:
+    #
+    # <tt>Person.sum(:age)</tt>
+    #
+    # Returns: <tt>Float</tt> of the sum.
+    def sum(field)
+      Criteria.new(self).sum(field)
+    end
+
     # Entry point for creating a new criteria from a Document. This will
     # instantiate a new +Criteria+ object with the supplied select criterion
     # already added to it.

data/lib/mongoid/memoization.rb

@@ -0,0 +1,27 @@
+module Mongoid #:nodoc
+  module Memoization
+
+    # Handles cases when accessing an association that should be memoized in
+    # the Mongoid specific manner.
+    def memoized(name, &block)
+      var = "@#{name}"
+      if instance_variable_defined?(var)
+        return instance_variable_get(var)
+      end
+      value = yield
+      instance_variable_set(var, value)
+    end
+
+    # Mongoid specific behavior is to remove the memoized object when setting
+    # the association, or if it wasn't previously memoized it will get set.
+    def reset(name, &block)
+      var = "@#{name}"
+      value = yield
+      if instance_variable_defined?(var)
+        remove_instance_variable(var)
+      else
+        instance_variable_set(var, value)
+      end
+    end
+  end
+end

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.11.6"
+  s.version = "0.11.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2010-01-05}
+  s.date = %q{2010-01-06}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.textile"
@@ -68,6 +68,7 @@ Gem::Specification.new do |s|
      "lib/mongoid/extensions/time/conversions.rb",
      "lib/mongoid/field.rb",
      "lib/mongoid/finders.rb",
+     "lib/mongoid/memoization.rb",
      "lib/mongoid/timestamps.rb",
      "lib/mongoid/versioning.rb",
      "mongoid.gemspec",
@@ -121,6 +122,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/extensions/time/conversions_spec.rb",
      "spec/unit/mongoid/field_spec.rb",
      "spec/unit/mongoid/finders_spec.rb",
+     "spec/unit/mongoid/memoization_spec.rb",
      "spec/unit/mongoid/timestamps_spec.rb",
      "spec/unit/mongoid/versioning_spec.rb",
      "spec/unit/mongoid_spec.rb"
@@ -179,6 +181,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/extensions/time/conversions_spec.rb",
      "spec/unit/mongoid/field_spec.rb",
      "spec/unit/mongoid/finders_spec.rb",
+     "spec/unit/mongoid/memoization_spec.rb",
      "spec/unit/mongoid/timestamps_spec.rb",
      "spec/unit/mongoid/versioning_spec.rb",
      "spec/unit/mongoid_spec.rb"

data/perf/benchmark.rb

@@ -1,5 +1,6 @@
 require "rubygems"
 require "ruby-prof"
+require "benchmark"
 require "mongoid"
 
 connection = Mongo::Connection.new
@@ -10,7 +11,6 @@ Mongoid.database.collection("people").drop
 class Person
   include Mongoid::Document
   include Mongoid::Timestamps
-  include Mongoid::Versioning
   field :birth_date, :type => Date
   has_one :name
   has_one :address
@@ -19,7 +19,6 @@ end
 
 class Name
   include Mongoid::Document
-  include Mongoid::Timestamps
   field :given
   field :family
   field :middle
@@ -28,7 +27,6 @@ end
 
 class Address
   include Mongoid::Document
-  include Mongoid::Timestamps
   field :street
   field :city
   field :state
@@ -39,36 +37,39 @@ end
 
 class Phone
   include Mongoid::Document
-  include Mongoid::Timestamps
   field :country_code, :type => Integer
   field :number
   field :phone_type
   belongs_to :person, :inverse_of => :phones
 end
 
-RubyProf.start
+# RubyProf.start
 
 puts "Starting benchmark..."
 
-1000.times do |n|
-  person = Person.new(:birth_date => Date.new(1970, 1, 1))
-  name = Name.new(:given => "James", :family => "Kirk", :middle => "Tiberius")
-  address = Address.new(
-    :street => "1 Starfleet Command Way",
-    :city => "San Francisco",
-    :state => "CA",
-    :post_code => "94133",
-    :type => "Work"
-  )
-  phone = Phone.new(:country_code => 1, :number => "415-555-1212", :type => "Mobile")
-  person.name = name
-  person.address = address
-  person.phones << phone
-  person.save
+Benchmark.bm do |bm|
+  bm.report("Mongoid") do
+    10000.times do |n|
+      person = Person.new(:birth_date => Date.new(1970, 1, 1))
+      name = Name.new(:given => "James", :family => "Kirk", :middle => "Tiberius")
+      address = Address.new(
+        :street => "1 Starfleet Command Way",
+        :city => "San Francisco",
+        :state => "CA",
+        :post_code => "94133",
+        :type => "Work"
+      )
+      phone = Phone.new(:country_code => 1, :number => "415-555-1212", :type => "Mobile")
+      person.name = name
+      person.address = address
+      person.phones << phone
+      person.save
+    end
+  end
 end
 
-result = RubyProf.stop
-printer = RubyProf::FlatPrinter.new(result)
-printer.print(STDOUT, 0)
+# result = RubyProf.stop
+# printer = RubyProf::FlatPrinter.new(result)
+# printer.print(STDOUT, 0)
 
 # Mongoid.database.collection("people").drop

data/spec/integration/mongoid/criteria_spec.rb

@@ -2,16 +2,34 @@ require "spec_helper"
 
 describe Mongoid::Criteria do
 
-  before do
-    @person = Person.create(:title => "Sir", :age => 33, :aliases => ["D", "Durran"])
-  end
+  describe "#sum" do
+
+    before do
+      10.times do |n|
+        Person.create(:title => "Sir", :age => 5, :aliases => ["D", "Durran"])
+      end
+    end
+
+    after do
+      Person.delete_all
+    end
+
+    it "provides sums for all the fields provided" do
+      Person.where(:age.gt => 3).sum(:age).should == 50.0
+    end
 
-  after do
-    Person.delete_all
   end
 
   describe "#where" do
 
+    before do
+      @person = Person.create(:title => "Sir", :age => 33, :aliases => ["D", "Durran"])
+    end
+
+    after do
+      Person.delete_all
+    end
+
     context "with complex criterion" do
 
       context "#all" do

data/spec/integration/mongoid/inheritance_spec.rb

@@ -87,6 +87,24 @@ describe Mongoid::Document do
 
   end
 
+  context "when document has subclasses" do
+
+    before do
+      @firefox = Firefox.create(:name => "firefox")
+    end
+
+    after do
+      Firefox.delete_all
+    end
+
+    it "returns subclasses for querying parents" do
+      firefox = Canvas.where(:name => "firefox").first
+      firefox.should be_a_kind_of(Firefox)
+      firefox.should == @firefox
+    end
+
+  end
+
   context "deleting subclasses" do
 
     before do

data/spec/unit/mongoid/attributes_spec.rb

@@ -104,6 +104,7 @@ describe Mongoid::Attributes do
       context "when allowing dynamic fields" do
 
         before do
+          Mongoid.allow_dynamic_fields = true
           @person = Person.new(@attributes)
         end
 

data/spec/unit/mongoid/criteria_spec.rb

@@ -4,6 +4,7 @@ describe Mongoid::Criteria do
 
   before do
     @criteria = Mongoid::Criteria.new(Person)
+    @canvas_criteria = Mongoid::Criteria.new(Canvas)
   end
 
   describe "#[]" do
@@ -32,22 +33,6 @@ describe Mongoid::Criteria do
 
   describe "#aggregate" do
 
-    context "when klass provided" do
-
-      before do
-        @reduce = "function(obj, prev) { prev.count++; }"
-        @criteria = Mongoid::Criteria.new(Person)
-        @collection = mock
-        Person.expects(:collection).returns(@collection)
-      end
-
-      it "calls group on the collection with the aggregate js" do
-        @collection.expects(:group).with([:field1], {:_type => { "$in" => ["Doctor", "Person"] }}, {:count => 0}, @reduce)
-        @criteria.only(:field1).aggregate
-      end
-
-    end
-
     context "when klass not provided" do
 
       before do
@@ -57,8 +42,8 @@ describe Mongoid::Criteria do
       end
 
       it "calls group on the collection with the aggregate js" do
-        @collection.expects(:group).with([:field1], {:_type => { "$in" => ["Doctor", "Person"] }}, {:count => 0}, @reduce)
-        @criteria.only(:field1).aggregate(Person)
+        @collection.expects(:group).with([:field1], {:_type => { "$in" => ["Doctor", "Person"] }}, {:count => 0}, @reduce, true)
+        @criteria.only(:field1).aggregate
       end
 
     end
@@ -246,7 +231,9 @@ describe Mongoid::Criteria do
       before do
         @collection = mock
         Person.expects(:collection).returns(@collection)
-        @collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns({ :title => "Sir" })
+        @collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns(
+          { "title" => "Sir", "_type" => "Person" }
+        )
       end
 
       it "calls find on the collection with the selector and options" do
@@ -271,6 +258,23 @@ describe Mongoid::Criteria do
 
     end
 
+    context "when document is a subclass of the class queried from" do
+
+      before do
+        @collection = mock
+        Canvas.expects(:collection).returns(@collection)
+        @collection.expects(:find_one).with(@canvas_criteria.selector, @canvas_criteria.options).returns(
+          { "name" => "Firefox", "_type" => "Firefox" }
+        )
+      end
+
+      it "instantiates the subclass" do
+        criteria = Mongoid::Criteria.new(Canvas)
+        criteria.first.should be_a_kind_of(Firefox)
+      end
+
+    end
+
   end
 
   describe "#excludes" do
@@ -335,7 +339,7 @@ describe Mongoid::Criteria do
   describe "#group" do
 
     before do
-      @grouping = [{ "title" => "Sir", "group" => [{ "title" => "Sir", "age" => 30 }] }]
+      @grouping = [{ "title" => "Sir", "group" => [{ "title" => "Sir", "age" => 30, "_type" => "Person" }] }]
     end
 
     context "when klass provided" do
@@ -348,7 +352,7 @@ describe Mongoid::Criteria do
       end
 
       it "calls group on the collection with the aggregate js" do
-        @collection.expects(:group).with([:field1], {:_type => { "$in" => ["Doctor", "Person"] }}, {:group => []}, @reduce).returns(@grouping)
+        @collection.expects(:group).with([:field1], {:_type => { "$in" => ["Doctor", "Person"] }}, {:group => []}, @reduce, true).returns(@grouping)
         @criteria.only(:field1).group
       end
 
@@ -363,7 +367,7 @@ describe Mongoid::Criteria do
       end
 
       it "calls group on the collection with the aggregate js" do
-        @collection.expects(:group).with([:field1], {:_type => { "$in" => ["Doctor", "Person"] }}, {:group => []}, @reduce).returns(@grouping)
+        @collection.expects(:group).with([:field1], {:_type => { "$in" => ["Doctor", "Person"] }}, {:group => []}, @reduce, true).returns(@grouping)
         @criteria.only(:field1).group
       end
 
@@ -415,7 +419,9 @@ describe Mongoid::Criteria do
       before do
         @collection = mock
         Person.expects(:collection).returns(@collection)
-        @collection.expects(:find_one).with(@criteria.selector, { :sort => [[:title, :desc]] }).returns({ :title => "Sir" })
+        @collection.expects(:find_one).with(@criteria.selector, { :sort => [[:title, :desc]] }).returns(
+          { "title" => "Sir", "_type" => "Person" }
+        )
       end
 
       it "calls find on the collection with the selector and sort options reversed" do
@@ -446,7 +452,9 @@ describe Mongoid::Criteria do
       before do
         @collection = mock
         Person.expects(:collection).returns(@collection)
-        @collection.expects(:find_one).with(@criteria.selector, { :sort => [[:_id, :desc]] }).returns({ :title => "Sir" })
+        @collection.expects(:find_one).with(@criteria.selector, { :sort => [[:_id, :desc]] }).returns(
+          { "title" => "Sir", "_type" => "Person" }
+        )
       end
 
       it "defaults to sort by id" do
@@ -661,7 +669,9 @@ describe Mongoid::Criteria do
       before do
         @collection = mock
         Person.expects(:collection).returns(@collection)
-        @collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns({ :title => "Sir" })
+        @collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns(
+          { "title"=> "Sir", "_type" => "Person" }
+        )
       end
 
       it "calls find on the collection with the selector and options" do
@@ -830,6 +840,25 @@ describe Mongoid::Criteria do
 
   end
 
+  describe "#sum" do
+
+    context "when klass not provided" do
+
+      before do
+        @reduce = "function(obj, prev) { prev.sum += obj.age; }"
+        @collection = mock
+        Person.expects(:collection).returns(@collection)
+      end
+
+      it "calls group on the collection with the aggregate js" do
+        @collection.expects(:group).with(nil, {:_type => { "$in" => ["Doctor", "Person"] }}, {:sum => 0}, @reduce, true).returns([{"sum" => 50.0}])
+        @criteria.sum(:age)
+      end
+
+    end
+
+  end
+
   describe ".translate" do
 
     context "with a single argument" do

data/spec/unit/mongoid/finders_spec.rb

@@ -295,6 +295,21 @@ describe Mongoid::Finders do
 
   end
 
+  describe ".sum" do
+
+    before do
+      @criteria = mock
+    end
+
+    it "returns the sum of a new criteria" do
+      Mongoid::Criteria.expects(:new).returns(@criteria)
+      @criteria.expects(:sum).with(:age).returns(50.0)
+      sum = Person.sum(:age)
+      sum.should == 50.0
+    end
+
+  end
+
   describe ".where" do
 
     it "returns a new criteria with select conditions added" do

data/spec/unit/mongoid/memoization_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe Mongoid::Memoization do
+
+  let(:memo) { "Memo" }
+
+  before do
+    @person = Person.new
+  end
+
+  describe "#memoized" do
+
+    context "when variable has been defined" do
+
+      before do
+        @person.instance_variable_set("@memo", memo)
+      end
+
+      it "returns the memoized value" do
+        @person.memoized(:memo) { nil }.should == memo
+      end
+
+    end
+
+    context "when variable has not been defined" do
+
+      it "returns the new value" do
+        @person.memoized(:memo) { memo }.should == memo
+      end
+
+      it "memoizes the new value" do
+        @person.memoized(:memo) { memo }
+        @person.instance_variable_get("@memo").should == memo
+      end
+
+    end
+
+  end
+
+  describe "#reset" do
+
+    context "when variable has been defined" do
+
+      before do
+        @person.instance_variable_set("@memo", memo)
+      end
+
+      it "removes the memoized value" do
+        @person.reset(:memo) { nil }
+        @person.instance_variable_defined?("@memo").should be_false
+      end
+
+      it "returns the new value" do
+        @person.reset(:memo) { memo }.should == memo
+      end
+
+    end
+
+    context "when variable has not been defined" do
+
+      it "memoizes the new value" do
+        @person.reset(:memo) { memo }
+        @person.instance_variable_get("@memo").should == memo
+      end
+
+      it "returns the value" do
+        @person.reset(:memo) { memo }.should == memo
+      end
+
+    end
+
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.11.6
+  version: 0.11.7
 platform: ruby
 authors: 
 - Durran Jordan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-05 00:00:00 -05:00
+date: 2010-01-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -134,6 +134,7 @@ files:
 - lib/mongoid/extensions/time/conversions.rb
 - lib/mongoid/field.rb
 - lib/mongoid/finders.rb
+- lib/mongoid/memoization.rb
 - lib/mongoid/timestamps.rb
 - lib/mongoid/versioning.rb
 - mongoid.gemspec
@@ -187,6 +188,7 @@ files:
 - spec/unit/mongoid/extensions/time/conversions_spec.rb
 - spec/unit/mongoid/field_spec.rb
 - spec/unit/mongoid/finders_spec.rb
+- spec/unit/mongoid/memoization_spec.rb
 - spec/unit/mongoid/timestamps_spec.rb
 - spec/unit/mongoid/versioning_spec.rb
 - spec/unit/mongoid_spec.rb
@@ -267,6 +269,7 @@ test_files:
 - spec/unit/mongoid/extensions/time/conversions_spec.rb
 - spec/unit/mongoid/field_spec.rb
 - spec/unit/mongoid/finders_spec.rb
+- spec/unit/mongoid/memoization_spec.rb
 - spec/unit/mongoid/timestamps_spec.rb
 - spec/unit/mongoid/versioning_spec.rb
 - spec/unit/mongoid_spec.rb